legacy-libs/google-proto-files/google/ads/googleads/v1/services/keyword_plan_negative_keyword_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_negative_keyword.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 = "KeywordPlanNegativeKeywordServiceProto";
  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 negative keyword service.
  35
  36 // Service to manage Keyword Plan negative keywords.
  37 service KeywordPlanNegativeKeywordService {
  38   // Returns the requested plan in full detail.
  39   rpc GetKeywordPlanNegativeKeyword(GetKeywordPlanNegativeKeywordRequest) returns (google.ads.googleads.v1.resources.KeywordPlanNegativeKeyword) {
  40     option (google.api.http) = {
  41       get: "/v1/{resource_name=customers/*/keywordPlanNegativeKeywords/*}"
  42     };
  43   }
  44
  45   // Creates, updates, or removes Keyword Plan negative keywords. Operation
  46   // statuses are returned.
  47   rpc MutateKeywordPlanNegativeKeywords(MutateKeywordPlanNegativeKeywordsRequest) returns (MutateKeywordPlanNegativeKeywordsResponse) {
  48     option (google.api.http) = {
  49       post: "/v1/customers/{customer_id=*}/keywordPlanNegativeKeywords:mutate"
  50       body: "*"
  51     };
  52   }
  53 }
  54
  55 // Request message for
  56 // [KeywordPlanNegativeKeywordService.GetKeywordPlanNegativeKeyword][google.ads.googleads.v1.services.KeywordPlanNegativeKeywordService.GetKeywordPlanNegativeKeyword].
  57 message GetKeywordPlanNegativeKeywordRequest {
  58   // The resource name of the plan to fetch.
  59   string resource_name = 1;
  60 }
  61
  62 // Request message for
  63 // [KeywordPlanNegativeKeywordService.MutateKeywordPlanNegativeKeywords][google.ads.googleads.v1.services.KeywordPlanNegativeKeywordService.MutateKeywordPlanNegativeKeywords].
  64 message MutateKeywordPlanNegativeKeywordsRequest {
  65   // The ID of the customer whose negative keywords are being modified.
  66   string customer_id = 1;
  67
  68   // The list of operations to perform on individual Keyword Plan negative
  69   // keywords.
  70   repeated KeywordPlanNegativeKeywordOperation operations = 2;
  71
  72   // If true, successful operations will be carried out and invalid
  73   // operations will return errors. If false, all operations will be carried
  74   // out in one transaction if and only if they are all valid.
  75   // Default is false.
  76   bool partial_failure = 3;
  77
  78   // If true, the request is validated but not executed. Only errors are
  79   // returned, not results.
  80   bool validate_only = 4;
  81 }
  82
  83 // A single operation (create, update, remove) on a Keyword Plan negative
  84 // keyword.
  85 message KeywordPlanNegativeKeywordOperation {
  86   // The FieldMask that determines which resource fields are modified in an
  87   // update.
  88   google.protobuf.FieldMask update_mask = 4;
  89
  90   // The mutate operation.
  91   oneof operation {
  92     // Create operation: No resource name is expected for the new Keyword Plan
  93     // negative keyword.
  94     google.ads.googleads.v1.resources.KeywordPlanNegativeKeyword create = 1;
  95
  96     // Update operation: The Keyword Plan negative keyword expected to have a
  97     // valid resource name.
  98     google.ads.googleads.v1.resources.KeywordPlanNegativeKeyword update = 2;
  99
 100     // Remove operation: A resource name for the removed Keyword Plan negative
 101     // keywords expected in this format:
 102     //
 103     //
 104     // `customers/{customer_id}/keywordPlanNegativeKeywords/{kp_negative_keyword_id}`
 105     string remove = 3;
 106   }
 107 }
 108
 109 // Response message for a Keyword Plan negative keyword mutate.
 110 message MutateKeywordPlanNegativeKeywordsResponse {
 111   // Errors that pertain to operation failures in the partial failure mode.
 112   // Returned only when partial_failure = true and all errors occur inside the
 113   // operations. If any errors occur outside the operations (e.g. auth errors),
 114   // we return an RPC level error.
 115   google.rpc.Status partial_failure_error = 3;
 116
 117   // All results for the mutate.
 118   repeated MutateKeywordPlanNegativeKeywordResult results = 2;
 119 }
 120
 121 // The result for the Keyword Plan negative keyword mutate.
 122 message MutateKeywordPlanNegativeKeywordResult {
 123   // Returned for successful operations.
 124   string resource_name = 1;
 125 }