legacy-libs/google-proto-files/google/ads/googleads/v1/services/campaign_shared_set_service.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.services;
  19
  20 import "google/ads/googleads/v1/resources/campaign_shared_set.proto";
  21 import "google/api/annotations.proto";
  22 import "google/protobuf/wrappers.proto";
  23 import "google/rpc/status.proto";
  24
  25 option csharp_namespace = "Google.Ads.GoogleAds.V1.Services";
  26 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/services;services";
  27 option java_multiple_files = true;
  28 option java_outer_classname = "CampaignSharedSetServiceProto";
  29 option java_package = "com.google.ads.googleads.v1.services";
  30 option objc_class_prefix = "GAA";
  31 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Services";
  32 option ruby_package = "Google::Ads::GoogleAds::V1::Services";
  33 // Proto file describing the Campaign Shared Set service.
  34
  35 // Service to manage campaign shared sets.
  36 service CampaignSharedSetService {
  37   // Returns the requested campaign shared set in full detail.
  38   rpc GetCampaignSharedSet(GetCampaignSharedSetRequest) returns (google.ads.googleads.v1.resources.CampaignSharedSet) {
  39     option (google.api.http) = {
  40       get: "/v1/{resource_name=customers/*/campaignSharedSets/*}"
  41     };
  42   }
  43
  44   // Creates or removes campaign shared sets. Operation statuses are returned.
  45   rpc MutateCampaignSharedSets(MutateCampaignSharedSetsRequest) returns (MutateCampaignSharedSetsResponse) {
  46     option (google.api.http) = {
  47       post: "/v1/customers/{customer_id=*}/campaignSharedSets:mutate"
  48       body: "*"
  49     };
  50   }
  51 }
  52
  53 // Request message for [CampaignSharedSetService.GetCampaignSharedSet][google.ads.googleads.v1.services.CampaignSharedSetService.GetCampaignSharedSet].
  54 message GetCampaignSharedSetRequest {
  55   // The resource name of the campaign shared set to fetch.
  56   string resource_name = 1;
  57 }
  58
  59 // Request message for [CampaignSharedSetService.MutateCampaignSharedSets][google.ads.googleads.v1.services.CampaignSharedSetService.MutateCampaignSharedSets].
  60 message MutateCampaignSharedSetsRequest {
  61   // The ID of the customer whose campaign shared sets are being modified.
  62   string customer_id = 1;
  63
  64   // The list of operations to perform on individual campaign shared sets.
  65   repeated CampaignSharedSetOperation operations = 2;
  66
  67   // If true, successful operations will be carried out and invalid
  68   // operations will return errors. If false, all operations will be carried
  69   // out in one transaction if and only if they are all valid.
  70   // Default is false.
  71   bool partial_failure = 3;
  72
  73   // If true, the request is validated but not executed. Only errors are
  74   // returned, not results.
  75   bool validate_only = 4;
  76 }
  77
  78 // A single operation (create, remove) on an campaign shared set.
  79 message CampaignSharedSetOperation {
  80   // The mutate operation.
  81   oneof operation {
  82     // Create operation: No resource name is expected for the new campaign
  83     // shared set.
  84     google.ads.googleads.v1.resources.CampaignSharedSet create = 1;
  85
  86     // Remove operation: A resource name for the removed campaign shared set is
  87     // expected, in this format:
  88     //
  89     //
  90     // `customers/{customer_id}/campaignSharedSets/{campaign_id}~{shared_set_id}`
  91     string remove = 3;
  92   }
  93 }
  94
  95 // Response message for a campaign shared set mutate.
  96 message MutateCampaignSharedSetsResponse {
  97   // Errors that pertain to operation failures in the partial failure mode.
  98   // Returned only when partial_failure = true and all errors occur inside the
  99   // operations. If any errors occur outside the operations (e.g. auth errors),
 100   // we return an RPC level error.
 101   google.rpc.Status partial_failure_error = 3;
 102
 103   // All results for the mutate.
 104   repeated MutateCampaignSharedSetResult results = 2;
 105 }
 106
 107 // The result for the campaign shared set mutate.
 108 message MutateCampaignSharedSetResult {
 109   // Returned for successful operations.
 110   string resource_name = 1;
 111 }