xref: /aosp_15_r20/external/googleapis/google/ads/googleads/v14/resources/shared_set.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/enums/shared_set_status.proto";
20import "google/ads/googleads/v14/enums/shared_set_type.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 = "SharedSetProto";
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 SharedSet resource.
34
35// SharedSets are used for sharing criterion exclusions across multiple
36// campaigns.
37message SharedSet {
38  option (google.api.resource) = {
39    type: "googleads.googleapis.com/SharedSet"
40    pattern: "customers/{customer_id}/sharedSets/{shared_set_id}"
41  };
42
43  // Immutable. The resource name of the shared set.
44  // Shared set resource names have the form:
45  //
46  // `customers/{customer_id}/sharedSets/{shared_set_id}`
47  string resource_name = 1 [
48    (google.api.field_behavior) = IMMUTABLE,
49    (google.api.resource_reference) = {
50      type: "googleads.googleapis.com/SharedSet"
51    }
52  ];
53
54  // Output only. The ID of this shared set. Read only.
55  optional int64 id = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
56
57  // Immutable. The type of this shared set: each shared set holds only a single
58  // kind of resource. Required. Immutable.
59  google.ads.googleads.v14.enums.SharedSetTypeEnum.SharedSetType type = 3
60      [(google.api.field_behavior) = IMMUTABLE];
61
62  // The name of this shared set. Required.
63  // Shared Sets must have names that are unique among active shared sets of
64  // the same type.
65  // The length of this string should be between 1 and 255 UTF-8 bytes,
66  // inclusive.
67  optional string name = 9;
68
69  // Output only. The status of this shared set. Read only.
70  google.ads.googleads.v14.enums.SharedSetStatusEnum.SharedSetStatus status = 5
71      [(google.api.field_behavior) = OUTPUT_ONLY];
72
73  // Output only. The number of shared criteria within this shared set. Read
74  // only.
75  optional int64 member_count = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
76
77  // Output only. The number of campaigns associated with this shared set. Read
78  // only.
79  optional int64 reference_count = 11
80      [(google.api.field_behavior) = OUTPUT_ONLY];
81}
82