xref: /aosp_15_r20/external/googleapis/google/ads/googleads/v15/resources/topic_constant.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.v15.resources;
18
19import "google/api/field_behavior.proto";
20import "google/api/resource.proto";
21
22option csharp_namespace = "Google.Ads.GoogleAds.V15.Resources";
23option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v15/resources;resources";
24option java_multiple_files = true;
25option java_outer_classname = "TopicConstantProto";
26option java_package = "com.google.ads.googleads.v15.resources";
27option objc_class_prefix = "GAA";
28option php_namespace = "Google\\Ads\\GoogleAds\\V15\\Resources";
29option ruby_package = "Google::Ads::GoogleAds::V15::Resources";
30
31// Proto file describing the Topic Constant resource.
32
33// Use topics to target or exclude placements in the Google Display Network
34// based on the category into which the placement falls (for example,
35// "Pets & Animals/Pets/Dogs").
36message TopicConstant {
37  option (google.api.resource) = {
38    type: "googleads.googleapis.com/TopicConstant"
39    pattern: "topicConstants/{topic_id}"
40  };
41
42  // Output only. The resource name of the topic constant.
43  // topic constant resource names have the form:
44  //
45  // `topicConstants/{topic_id}`
46  string resource_name = 1 [
47    (google.api.field_behavior) = OUTPUT_ONLY,
48    (google.api.resource_reference) = {
49      type: "googleads.googleapis.com/TopicConstant"
50    }
51  ];
52
53  // Output only. The ID of the topic.
54  optional int64 id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
55
56  // Output only. Resource name of parent of the topic constant.
57  optional string topic_constant_parent = 6 [
58    (google.api.field_behavior) = OUTPUT_ONLY,
59    (google.api.resource_reference) = {
60      type: "googleads.googleapis.com/TopicConstant"
61    }
62  ];
63
64  // Output only. The category to target or exclude. Each subsequent element in
65  // the array describes a more specific sub-category. For example,
66  // {"Pets & Animals", "Pets", "Dogs"} represents the
67  // "Pets & Animals/Pets/Dogs" category. List of available topic categories at
68  // https://developers.google.com/google-ads/api/reference/data/verticals
69  repeated string path = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
70}
71