xref: /aosp_15_r20/external/googleapis/google/ads/googleads/v16/resources/user_interest.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.ads.googleads.v16.resources;
18
19import "google/ads/googleads/v16/common/criterion_category_availability.proto";
20import "google/ads/googleads/v16/enums/user_interest_taxonomy_type.proto";
21import "google/api/field_behavior.proto";
22import "google/api/resource.proto";
23
24option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources";
25option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources";
26option java_multiple_files = true;
27option java_outer_classname = "UserInterestProto";
28option java_package = "com.google.ads.googleads.v16.resources";
29option objc_class_prefix = "GAA";
30option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources";
31option ruby_package = "Google::Ads::GoogleAds::V16::Resources";
32
33// Proto file describing the User Interest resource.
34
35// A user interest: a particular interest-based vertical to be targeted.
36message UserInterest {
37  option (google.api.resource) = {
38    type: "googleads.googleapis.com/UserInterest"
39    pattern: "customers/{customer_id}/userInterests/{user_interest_id}"
40  };
41
42  // Output only. The resource name of the user interest.
43  // User interest resource names have the form:
44  //
45  // `customers/{customer_id}/userInterests/{user_interest_id}`
46  string resource_name = 1 [
47    (google.api.field_behavior) = OUTPUT_ONLY,
48    (google.api.resource_reference) = {
49      type: "googleads.googleapis.com/UserInterest"
50    }
51  ];
52
53  // Output only. Taxonomy type of the user interest.
54  google.ads.googleads.v16.enums.UserInterestTaxonomyTypeEnum
55      .UserInterestTaxonomyType taxonomy_type = 2
56      [(google.api.field_behavior) = OUTPUT_ONLY];
57
58  // Output only. The ID of the user interest.
59  optional int64 user_interest_id = 8
60      [(google.api.field_behavior) = OUTPUT_ONLY];
61
62  // Output only. The name of the user interest.
63  optional string name = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
64
65  // Output only. The parent of the user interest.
66  optional string user_interest_parent = 10 [
67    (google.api.field_behavior) = OUTPUT_ONLY,
68    (google.api.resource_reference) = {
69      type: "googleads.googleapis.com/UserInterest"
70    }
71  ];
72
73  // Output only. True if the user interest is launched to all channels and
74  // locales.
75  optional bool launched_to_all = 11
76      [(google.api.field_behavior) = OUTPUT_ONLY];
77
78  // Output only. Availability information of the user interest.
79  repeated google.ads.googleads.v16.common.CriterionCategoryAvailability
80      availabilities = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
81}
82