• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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/campaign_shared_set_status.proto";
20import "google/api/field_behavior.proto";
21import "google/api/resource.proto";
22
23option csharp_namespace = "Google.Ads.GoogleAds.V14.Resources";
24option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/resources;resources";
25option java_multiple_files = true;
26option java_outer_classname = "CampaignSharedSetProto";
27option java_package = "com.google.ads.googleads.v14.resources";
28option objc_class_prefix = "GAA";
29option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Resources";
30option ruby_package = "Google::Ads::GoogleAds::V14::Resources";
31
32// Proto file describing the CampaignSharedSet resource.
33
34// CampaignSharedSets are used for managing the shared sets associated with a
35// campaign.
36message CampaignSharedSet {
37  option (google.api.resource) = {
38    type: "googleads.googleapis.com/CampaignSharedSet"
39    pattern: "customers/{customer_id}/campaignSharedSets/{campaign_id}~{shared_set_id}"
40  };
41
42  // Immutable. The resource name of the campaign shared set.
43  // Campaign shared set resource names have the form:
44  //
45  // `customers/{customer_id}/campaignSharedSets/{campaign_id}~{shared_set_id}`
46  string resource_name = 1 [
47    (google.api.field_behavior) = IMMUTABLE,
48    (google.api.resource_reference) = {
49      type: "googleads.googleapis.com/CampaignSharedSet"
50    }
51  ];
52
53  // Immutable. The campaign to which the campaign shared set belongs.
54  optional string campaign = 5 [
55    (google.api.field_behavior) = IMMUTABLE,
56    (google.api.resource_reference) = {
57      type: "googleads.googleapis.com/Campaign"
58    }
59  ];
60
61  // Immutable. The shared set associated with the campaign. This may be a
62  // negative keyword shared set of another customer. This customer should be a
63  // manager of the other customer, otherwise the campaign shared set will exist
64  // but have no serving effect. Only negative keyword shared sets can be
65  // associated with Shopping campaigns. Only negative placement shared sets can
66  // be associated with Display mobile app campaigns.
67  optional string shared_set = 6 [
68    (google.api.field_behavior) = IMMUTABLE,
69    (google.api.resource_reference) = {
70      type: "googleads.googleapis.com/SharedSet"
71    }
72  ];
73
74  // Output only. The status of this campaign shared set. Read only.
75  google.ads.googleads.v14.enums.CampaignSharedSetStatusEnum
76      .CampaignSharedSetStatus status = 2
77      [(google.api.field_behavior) = OUTPUT_ONLY];
78}
79