xref: /aosp_15_r20/external/googleapis/google/ads/googleads/v14/resources/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.v14.resources;
18
19import "google/ads/googleads/v14/common/audiences.proto";
20import "google/ads/googleads/v14/enums/audience_status.proto";
21import "google/api/field_behavior.proto";
22import "google/api/resource.proto";
23
24option csharp_namespace = "Google.Ads.GoogleAds.V14.Resources";
25option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/resources;resources";
26option java_multiple_files = true;
27option java_outer_classname = "AudienceProto";
28option java_package = "com.google.ads.googleads.v14.resources";
29option objc_class_prefix = "GAA";
30option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Resources";
31option ruby_package = "Google::Ads::GoogleAds::V14::Resources";
32
33// Proto file describing the Audience resource.
34
35// Audience is an effective targeting option that lets you
36// intersect different segment attributes, such as detailed demographics and
37// affinities, to create audiences that represent sections of your target
38// segments.
39message Audience {
40  option (google.api.resource) = {
41    type: "googleads.googleapis.com/Audience"
42    pattern: "customers/{customer_id}/audiences/{audience_id}"
43  };
44
45  // Immutable. The resource name of the audience.
46  // Audience names have the form:
47  //
48  // `customers/{customer_id}/audiences/{audience_id}`
49  string resource_name = 1 [
50    (google.api.field_behavior) = IMMUTABLE,
51    (google.api.resource_reference) = {
52      type: "googleads.googleapis.com/Audience"
53    }
54  ];
55
56  // Output only. ID of the audience.
57  int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
58
59  // Output only. Status of this audience. Indicates whether the audience
60  // is enabled or removed.
61  google.ads.googleads.v14.enums.AudienceStatusEnum.AudienceStatus status = 3
62      [(google.api.field_behavior) = OUTPUT_ONLY];
63
64  // Required. Name of the audience. It should be unique across all
65  // audiences. It must have a minimum length of 1 and
66  // maximum length of 255.
67  string name = 4 [(google.api.field_behavior) = REQUIRED];
68
69  // Description of this audience.
70  string description = 5;
71
72  // Positive dimensions specifying the audience composition.
73  repeated google.ads.googleads.v14.common.AudienceDimension dimensions = 6;
74
75  // Negative dimension specifying the audience composition.
76  google.ads.googleads.v14.common.AudienceExclusionDimension
77      exclusion_dimension = 7;
78}
79