xref: /aosp_15_r20/external/googleapis/google/ads/googleads/v16/resources/combined_audience.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/enums/combined_audience_status.proto";
20import "google/api/field_behavior.proto";
21import "google/api/resource.proto";
22
23option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources";
24option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources";
25option java_multiple_files = true;
26option java_outer_classname = "CombinedAudienceProto";
27option java_package = "com.google.ads.googleads.v16.resources";
28option objc_class_prefix = "GAA";
29option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources";
30option ruby_package = "Google::Ads::GoogleAds::V16::Resources";
31
32// Proto file describing the Combined Audience resource.
33
34// Describe a resource for combined audiences which includes different
35// audiences.
36message CombinedAudience {
37  option (google.api.resource) = {
38    type: "googleads.googleapis.com/CombinedAudience"
39    pattern: "customers/{customer_id}/combinedAudiences/{combined_audience_id}"
40  };
41
42  // Immutable. The resource name of the combined audience.
43  // Combined audience names have the form:
44  //
45  // `customers/{customer_id}/combinedAudience/{combined_audience_id}`
46  string resource_name = 1 [
47    (google.api.field_behavior) = IMMUTABLE,
48    (google.api.resource_reference) = {
49      type: "googleads.googleapis.com/CombinedAudience"
50    }
51  ];
52
53  // Output only. ID of the combined audience.
54  int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
55
56  // Output only. Status of this combined audience. Indicates whether the
57  // combined audience is enabled or removed.
58  google.ads.googleads.v16.enums.CombinedAudienceStatusEnum
59      .CombinedAudienceStatus status = 3
60      [(google.api.field_behavior) = OUTPUT_ONLY];
61
62  // Output only. Name of the combined audience. It should be unique across all
63  // combined audiences.
64  string name = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
65
66  // Output only. Description of this combined audience.
67  string description = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
68}
69