legacy-libs/google-proto-files/google/ads/googleads/v1/services/ad_group_criterion_label_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/ad_group_criterion_label.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 = "AdGroupCriterionLabelServiceProto";
  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 Ad Group Criterion Label service.
  34
  35 // Service to manage labels on ad group criteria.
  36 service AdGroupCriterionLabelService {
  37   // Returns the requested ad group criterion label in full detail.
  38   rpc GetAdGroupCriterionLabel(GetAdGroupCriterionLabelRequest) returns (google.ads.googleads.v1.resources.AdGroupCriterionLabel) {
  39     option (google.api.http) = {
  40       get: "/v1/{resource_name=customers/*/adGroupCriterionLabels/*}"
  41     };
  42   }
  43
  44   // Creates and removes ad group criterion labels.
  45   // Operation statuses are returned.
  46   rpc MutateAdGroupCriterionLabels(MutateAdGroupCriterionLabelsRequest) returns (MutateAdGroupCriterionLabelsResponse) {
  47     option (google.api.http) = {
  48       post: "/v1/customers/{customer_id=*}/adGroupCriterionLabels:mutate"
  49       body: "*"
  50     };
  51   }
  52 }
  53
  54 // Request message for
  55 // [AdGroupCriterionLabelService.GetAdGroupCriterionLabel][google.ads.googleads.v1.services.AdGroupCriterionLabelService.GetAdGroupCriterionLabel].
  56 message GetAdGroupCriterionLabelRequest {
  57   // The resource name of the ad group criterion label to fetch.
  58   string resource_name = 1;
  59 }
  60
  61 // Request message for
  62 // [AdGroupCriterionLabelService.MutateAdGroupCriterionLabels][google.ads.googleads.v1.services.AdGroupCriterionLabelService.MutateAdGroupCriterionLabels].
  63 message MutateAdGroupCriterionLabelsRequest {
  64   // ID of the customer whose ad group criterion labels are being modified.
  65   string customer_id = 1;
  66
  67   // The list of operations to perform on ad group criterion labels.
  68   repeated AdGroupCriterionLabelOperation operations = 2;
  69
  70   // If true, successful operations will be carried out and invalid
  71   // operations will return errors. If false, all operations will be carried
  72   // out in one transaction if and only if they are all valid.
  73   // Default is false.
  74   bool partial_failure = 3;
  75
  76   // If true, the request is validated but not executed. Only errors are
  77   // returned, not results.
  78   bool validate_only = 4;
  79 }
  80
  81 // A single operation (create, remove) on an ad group criterion label.
  82 message AdGroupCriterionLabelOperation {
  83   // The mutate operation.
  84   oneof operation {
  85     // Create operation: No resource name is expected for the new ad group
  86     // label.
  87     google.ads.googleads.v1.resources.AdGroupCriterionLabel create = 1;
  88
  89     // Remove operation: A resource name for the ad group criterion label
  90     // being removed, in this format:
  91     //
  92     //
  93     // `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}_{criterion_id}_{label_id}`
  94     string remove = 2;
  95   }
  96 }
  97
  98 // Response message for an ad group criterion labels mutate.
  99 message MutateAdGroupCriterionLabelsResponse {
 100   // Errors that pertain to operation failures in the partial failure mode.
 101   // Returned only when partial_failure = true and all errors occur inside the
 102   // operations. If any errors occur outside the operations (e.g. auth errors),
 103   // we return an RPC level error.
 104   google.rpc.Status partial_failure_error = 3;
 105
 106   // All results for the mutate.
 107   repeated MutateAdGroupCriterionLabelResult results = 2;
 108 }
 109
 110 // The result for an ad group criterion label mutate.
 111 message MutateAdGroupCriterionLabelResult {
 112   // Returned for successful operations.
 113   string resource_name = 1;
 114 }