xref: /aosp_15_r20/external/googleapis/google/ads/searchads360/v0/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.searchads360.v0.resources;
18
19import "google/api/field_behavior.proto";
20import "google/api/resource.proto";
21
22option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources";
23option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources";
24option java_multiple_files = true;
25option java_outer_classname = "AudienceProto";
26option java_package = "com.google.ads.searchads360.v0.resources";
27option objc_class_prefix = "GASA360";
28option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources";
29option ruby_package = "Google::Ads::SearchAds360::V0::Resources";
30
31// Proto file describing the Audience resource.
32
33// Audience is an effective targeting option that lets you
34// intersect different segment attributes, such as detailed demographics and
35// affinities, to create audiences that represent sections of your target
36// segments.
37message Audience {
38  option (google.api.resource) = {
39    type: "searchads360.googleapis.com/Audience"
40    pattern: "customers/{customer_id}/audiences/{audience_id}"
41  };
42
43  // Immutable. The resource name of the audience.
44  // Audience names have the form:
45  //
46  // `customers/{customer_id}/audiences/{audience_id}`
47  string resource_name = 1 [
48    (google.api.field_behavior) = IMMUTABLE,
49    (google.api.resource_reference) = {
50      type: "searchads360.googleapis.com/Audience"
51    }
52  ];
53
54  // Output only. ID of the audience.
55  int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
56
57  // Required. Name of the audience. It should be unique across all
58  // audiences. It must have a minimum length of 1 and
59  // maximum length of 255.
60  string name = 4 [(google.api.field_behavior) = REQUIRED];
61
62  // Description of this audience.
63  string description = 5;
64}
65