legacy-libs/google-proto-files/google/ads/googleads/v1/resources/shared_set.proto

   1 // Copyright 2019 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 //
  15
  16 syntax = "proto3";
  17
  18 package google.ads.googleads.v1.resources;
  19
  20 import "google/ads/googleads/v1/enums/shared_set_status.proto";
  21 import "google/ads/googleads/v1/enums/shared_set_type.proto";
  22 import "google/protobuf/wrappers.proto";
  23 import "google/api/annotations.proto";
  24
  25 option csharp_namespace = "Google.Ads.GoogleAds.V1.Resources";
  26 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/resources;resources";
  27 option java_multiple_files = true;
  28 option java_outer_classname = "SharedSetProto";
  29 option java_package = "com.google.ads.googleads.v1.resources";
  30 option objc_class_prefix = "GAA";
  31 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Resources";
  32 option ruby_package = "Google::Ads::GoogleAds::V1::Resources";
  33 // Proto file describing the SharedSet resource.
  34
  35 // SharedSets are used for sharing criterion exclusions across multiple
  36 // campaigns.
  37 message SharedSet {
  38   // The resource name of the shared set.
  39   // Shared set resource names have the form:
  40   //
  41   // `customers/{customer_id}/sharedSets/{shared_set_id}`
  42   string resource_name = 1;
  43
  44   // The ID of this shared set. Read only.
  45   google.protobuf.Int64Value id = 2;
  46
  47   // The type of this shared set: each shared set holds only a single kind
  48   // of resource. Required. Immutable.
  49   google.ads.googleads.v1.enums.SharedSetTypeEnum.SharedSetType type = 3;
  50
  51   // The name of this shared set. Required.
  52   // Shared Sets must have names that are unique among active shared sets of
  53   // the same type.
  54   // The length of this string should be between 1 and 255 UTF-8 bytes,
  55   // inclusive.
  56   google.protobuf.StringValue name = 4;
  57
  58   // The status of this shared set. Read only.
  59   google.ads.googleads.v1.enums.SharedSetStatusEnum.SharedSetStatus status = 5;
  60
  61   // The number of shared criteria within this shared set. Read only.
  62   google.protobuf.Int64Value member_count = 6;
  63
  64   // The number of campaigns associated with this shared set. Read only.
  65   google.protobuf.Int64Value reference_count = 7;
  66 }