diff options
Diffstat (limited to 'google/ads/googleads/v0/services/keyword_plan_campaign_service.proto')
-rw-r--r-- | google/ads/googleads/v0/services/keyword_plan_campaign_service.proto | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/google/ads/googleads/v0/services/keyword_plan_campaign_service.proto b/google/ads/googleads/v0/services/keyword_plan_campaign_service.proto new file mode 100644 index 000000000..126c38274 --- /dev/null +++ b/google/ads/googleads/v0/services/keyword_plan_campaign_service.proto @@ -0,0 +1,102 @@ +// 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_campaign.proto"; +import "google/api/annotations.proto"; +import "google/protobuf/field_mask.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 = "KeywordPlanCampaignServiceProto"; +option java_package = "com.google.ads.googleads.v0.services"; +option objc_class_prefix = "GAA"; +option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Services"; +// Proto file describing the keyword plan campaign service. + +// Service to manage Keyword Plan campaigns. +service KeywordPlanCampaignService { + // Returns the requested Keyword Plan campaign in full detail. + rpc GetKeywordPlanCampaign(GetKeywordPlanCampaignRequest) returns (google.ads.googleads.v0.resources.KeywordPlanCampaign) { + option (google.api.http) = { + get: "/v0/{resource_name=customers/*/keywordPlanCampaigns/*}" + }; + } + + // Creates, updates, or removes Keyword Plan campaigns. Operation statuses are + // returned. + rpc MutateKeywordPlanCampaigns(MutateKeywordPlanCampaignsRequest) returns (MutateKeywordPlanCampaignsResponse) { + option (google.api.http) = { + post: "/v0/customers/{customer_id=*}/keywordPlanCampaigns:mutate" + body: "*" + }; + } +} + +// Request message for [KeywordPlanCampaignService.GetKeywordPlanCampaign][google.ads.googleads.v0.services.KeywordPlanCampaignService.GetKeywordPlanCampaign]. +message GetKeywordPlanCampaignRequest { + // The resource name of the Keyword Plan campaign to fetch. + string resource_name = 1; +} + +// Request message for +// [KeywordPlanCampaignService.MutateKeywordPlanCampaigns][google.ads.googleads.v0.services.KeywordPlanCampaignService.MutateKeywordPlanCampaigns]. +message MutateKeywordPlanCampaignsRequest { + // The ID of the customer whose Keyword Plan campaigns are being modified. + string customer_id = 1; + + // The list of operations to perform on individual Keyword Plan campaigns. + repeated KeywordPlanCampaignOperation operations = 2; +} + +// A single operation (create, update, remove) on a Keyword Plan campaign. +message KeywordPlanCampaignOperation { + // 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 + // campaign. + google.ads.googleads.v0.resources.KeywordPlanCampaign create = 1; + + // Update operation: The Keyword Plan campaign is expected to have a valid + // resource name. + google.ads.googleads.v0.resources.KeywordPlanCampaign update = 2; + + // Remove operation: A resource name for the removed Keyword Plan campaign + // is expected, in this format: + // + // `customers/{customer_id}/keywordPlanCampaigns/{keywordPlan_campaign_id}` + string remove = 3; + } +} + +// Response message for a Keyword Plan campaign mutate. +message MutateKeywordPlanCampaignsResponse { + // All results for the mutate. + repeated MutateKeywordPlanCampaignResult results = 2; +} + +// The result for the Keyword Plan campaign mutate. +message MutateKeywordPlanCampaignResult { + // Returned for successful operations. + string resource_name = 1; +} |