diff options
Diffstat (limited to 'google/ads/googleads/v0/services/keyword_plan_ad_group_service.proto')
-rw-r--r-- | google/ads/googleads/v0/services/keyword_plan_ad_group_service.proto | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/google/ads/googleads/v0/services/keyword_plan_ad_group_service.proto b/google/ads/googleads/v0/services/keyword_plan_ad_group_service.proto new file mode 100644 index 000000000..d598a91c9 --- /dev/null +++ b/google/ads/googleads/v0/services/keyword_plan_ad_group_service.proto @@ -0,0 +1,125 @@ +// Copyright 2018 Google LLC. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +syntax = "proto3"; + +package google.ads.googleads.v0.services; + +import "google/ads/googleads/v0/resources/keyword_plan_ad_group.proto"; +import "google/api/annotations.proto"; +import "google/protobuf/field_mask.proto"; +import "google/protobuf/wrappers.proto"; +import "google/rpc/status.proto"; + +option csharp_namespace = "Google.Ads.GoogleAds.V0.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/services;services"; +option java_multiple_files = true; +option java_outer_classname = "KeywordPlanAdGroupServiceProto"; +option java_package = "com.google.ads.googleads.v0.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V0::Services"; + +// Proto file describing the keyword plan ad group service. + +// Service to manage Keyword Plan ad groups. +service KeywordPlanAdGroupService { + // Returns the requested Keyword Plan ad group in full detail. + rpc GetKeywordPlanAdGroup(GetKeywordPlanAdGroupRequest) + returns (google.ads.googleads.v0.resources.KeywordPlanAdGroup) { + option (google.api.http) = { + get: "/v0/{resource_name=customers/*/keywordPlanAdGroups/*}" + }; + } + + // Creates, updates, or removes Keyword Plan ad groups. Operation statuses are + // returned. + rpc MutateKeywordPlanAdGroups(MutateKeywordPlanAdGroupsRequest) + returns (MutateKeywordPlanAdGroupsResponse) { + option (google.api.http) = { + post: "/v0/customers/{customer_id=*}/keywordPlanAdGroups:mutate" + body: "*" + }; + } +} + +// Request message for +// [KeywordPlanAdGroupService.GetKeywordPlanAdGroup][google.ads.googleads.v0.services.KeywordPlanAdGroupService.GetKeywordPlanAdGroup]. +message GetKeywordPlanAdGroupRequest { + // The resource name of the Keyword Plan ad group to fetch. + string resource_name = 1; +} + +// Request message for +// [KeywordPlanAdGroupService.MutateKeywordPlanAdGroups][google.ads.googleads.v0.services.KeywordPlanAdGroupService.MutateKeywordPlanAdGroups]. +message MutateKeywordPlanAdGroupsRequest { + // The ID of the customer whose Keyword Plan ad groups are being modified. + string customer_id = 1; + + // The list of operations to perform on individual Keyword Plan ad groups. + repeated KeywordPlanAdGroupOperation operations = 2; + + // If true, successful operations will be carried out and invalid + // operations will return errors. If false, all operations will be carried + // out in one transaction if and only if they are all valid. + // Default is false. + bool partial_failure = 3; + + // If true, the request is validated but not executed. Only errors are + // returned, not results. + bool validate_only = 4; +} + +// A single operation (create, update, remove) on a Keyword Plan ad group. +message KeywordPlanAdGroupOperation { + // The FieldMask that determines which resource fields are modified in an + // update. + google.protobuf.FieldMask update_mask = 4; + + // The mutate operation. + oneof operation { + // Create operation: No resource name is expected for the new Keyword Plan + // ad group. + google.ads.googleads.v0.resources.KeywordPlanAdGroup create = 1; + + // Update operation: The Keyword Plan ad group is expected to have a valid + // resource name. + google.ads.googleads.v0.resources.KeywordPlanAdGroup update = 2; + + // Remove operation: A resource name for the removed Keyword Plan ad group + // is expected, in this format: + // + // `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}` + string remove = 3; + } +} + +// Response message for a Keyword Plan ad group mutate. +message MutateKeywordPlanAdGroupsResponse { + // Errors that pertain to operation failures in the partial failure mode. + // Returned only when partial_failure = true and all errors occur inside the + // operations. If any errors occur outside the operations (e.g. auth errors), + // we return an RPC level error. + google.rpc.Status partial_failure_error = 3; + + // All results for the mutate. + repeated MutateKeywordPlanAdGroupResult results = 2; +} + +// The result for the Keyword Plan ad group mutate. +message MutateKeywordPlanAdGroupResult { + // Returned for successful operations. + string resource_name = 1; +} |