aboutsummaryrefslogtreecommitdiff
path: root/google/ads/googleads/v1/services/keyword_plan_campaign_service.proto
diff options
context:
space:
mode:
Diffstat (limited to 'google/ads/googleads/v1/services/keyword_plan_campaign_service.proto')
-rw-r--r--google/ads/googleads/v1/services/keyword_plan_campaign_service.proto121
1 files changed, 0 insertions, 121 deletions
diff --git a/google/ads/googleads/v1/services/keyword_plan_campaign_service.proto b/google/ads/googleads/v1/services/keyword_plan_campaign_service.proto
deleted file mode 100644
index b702598d3..000000000
--- a/google/ads/googleads/v1/services/keyword_plan_campaign_service.proto
+++ /dev/null
@@ -1,121 +0,0 @@
-// Copyright 2019 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.v1.services;
-
-import "google/ads/googleads/v1/resources/keyword_plan_campaign.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.V1.Services";
-option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/services;services";
-option java_multiple_files = true;
-option java_outer_classname = "KeywordPlanCampaignServiceProto";
-option java_package = "com.google.ads.googleads.v1.services";
-option objc_class_prefix = "GAA";
-option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Services";
-option ruby_package = "Google::Ads::GoogleAds::V1::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.v1.resources.KeywordPlanCampaign) {
- option (google.api.http) = {
- get: "/v1/{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: "/v1/customers/{customer_id=*}/keywordPlanCampaigns:mutate"
- body: "*"
- };
- }
-}
-
-// Request message for [KeywordPlanCampaignService.GetKeywordPlanCampaign][google.ads.googleads.v1.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.v1.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;
-
- // 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 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.v1.resources.KeywordPlanCampaign create = 1;
-
- // Update operation: The Keyword Plan campaign is expected to have a valid
- // resource name.
- google.ads.googleads.v1.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 {
- // 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 MutateKeywordPlanCampaignResult results = 2;
-}
-
-// The result for the Keyword Plan campaign mutate.
-message MutateKeywordPlanCampaignResult {
- // Returned for successful operations.
- string resource_name = 1;
-}