aboutsummaryrefslogtreecommitdiff
path: root/google/ads/googleads/v1/services/customer_label_service.proto
diff options
context:
space:
mode:
Diffstat (limited to 'google/ads/googleads/v1/services/customer_label_service.proto')
-rw-r--r--google/ads/googleads/v1/services/customer_label_service.proto111
1 files changed, 0 insertions, 111 deletions
diff --git a/google/ads/googleads/v1/services/customer_label_service.proto b/google/ads/googleads/v1/services/customer_label_service.proto
deleted file mode 100644
index 1e09ba860..000000000
--- a/google/ads/googleads/v1/services/customer_label_service.proto
+++ /dev/null
@@ -1,111 +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/customer_label.proto";
-import "google/api/annotations.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 = "CustomerLabelServiceProto";
-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 Customer Label service.
-
-// Service to manage labels on customers.
-service CustomerLabelService {
- // Returns the requested customer-label relationship in full detail.
- rpc GetCustomerLabel(GetCustomerLabelRequest) returns (google.ads.googleads.v1.resources.CustomerLabel) {
- option (google.api.http) = {
- get: "/v1/{resource_name=customers/*/customerLabels/*}"
- };
- }
-
- // Creates and removes customer-label relationships.
- // Operation statuses are returned.
- rpc MutateCustomerLabels(MutateCustomerLabelsRequest) returns (MutateCustomerLabelsResponse) {
- option (google.api.http) = {
- post: "/v1/customers/{customer_id=*}/customerLabels:mutate"
- body: "*"
- };
- }
-}
-
-// Request message for [CustomerLabelService.GetCustomerLabel][google.ads.googleads.v1.services.CustomerLabelService.GetCustomerLabel].
-message GetCustomerLabelRequest {
- // The resource name of the customer-label relationship to fetch.
- string resource_name = 1;
-}
-
-// Request message for [CustomerLabelService.MutateCustomerLabels][google.ads.googleads.v1.services.CustomerLabelService.MutateCustomerLabels].
-message MutateCustomerLabelsRequest {
- // ID of the customer whose customer-label relationships are being modified.
- string customer_id = 1;
-
- // The list of operations to perform on customer-label relationships.
- repeated CustomerLabelOperation 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, remove) on a customer-label relationship.
-message CustomerLabelOperation {
- // The mutate operation.
- oneof operation {
- // Create operation: No resource name is expected for the new customer-label
- // relationship.
- google.ads.googleads.v1.resources.CustomerLabel create = 1;
-
- // Remove operation: A resource name for the customer-label relationship
- // being removed, in this format:
- //
- // `customers/{customer_id}/customerLabels/{label_id}`
- string remove = 2;
- }
-}
-
-// Response message for a customer labels mutate.
-message MutateCustomerLabelsResponse {
- // 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 MutateCustomerLabelResult results = 2;
-}
-
-// The result for a customer label mutate.
-message MutateCustomerLabelResult {
- // Returned for successful operations.
- string resource_name = 1;
-}