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