// Copyright 2023 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.v15.services; import "google/ads/googleads/v15/enums/response_content_type.proto"; import "google/ads/googleads/v15/resources/customer_negative_criterion.proto"; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/api/resource.proto"; import "google/rpc/status.proto"; option csharp_namespace = "Google.Ads.GoogleAds.V15.Services"; option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v15/services;services"; option java_multiple_files = true; option java_outer_classname = "CustomerNegativeCriterionServiceProto"; option java_package = "com.google.ads.googleads.v15.services"; option objc_class_prefix = "GAA"; option php_namespace = "Google\\Ads\\GoogleAds\\V15\\Services"; option ruby_package = "Google::Ads::GoogleAds::V15::Services"; // Proto file describing the Customer Negative Criterion service. // Service to manage customer negative criteria. service CustomerNegativeCriterionService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; // Creates or removes criteria. Operation statuses are returned. // // List of thrown errors: // [AuthenticationError]() // [AuthorizationError]() // [CriterionError]() // [DatabaseError]() // [FieldError]() // [HeaderError]() // [InternalError]() // [MutateError]() // [QuotaError]() // [RequestError]() rpc MutateCustomerNegativeCriteria(MutateCustomerNegativeCriteriaRequest) returns (MutateCustomerNegativeCriteriaResponse) { option (google.api.http) = { post: "/v15/customers/{customer_id=*}/customerNegativeCriteria:mutate" body: "*" }; option (google.api.method_signature) = "customer_id,operations"; } } // Request message for // [CustomerNegativeCriterionService.MutateCustomerNegativeCriteria][google.ads.googleads.v15.services.CustomerNegativeCriterionService.MutateCustomerNegativeCriteria]. message MutateCustomerNegativeCriteriaRequest { // Required. The ID of the customer whose criteria are being modified. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The list of operations to perform on individual criteria. repeated CustomerNegativeCriterionOperation operations = 2 [(google.api.field_behavior) = REQUIRED]; // 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; // The response content type setting. Determines whether the mutable resource // or just the resource name should be returned post mutation. google.ads.googleads.v15.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5; } // A single operation (create or remove) on a customer level negative criterion. message CustomerNegativeCriterionOperation { // The mutate operation. oneof operation { // Create operation: No resource name is expected for the new criterion. google.ads.googleads.v15.resources.CustomerNegativeCriterion create = 1; // Remove operation: A resource name for the removed criterion is expected, // in this format: // // `customers/{customer_id}/customerNegativeCriteria/{criterion_id}` string remove = 2 [(google.api.resource_reference) = { type: "googleads.googleapis.com/CustomerNegativeCriterion" }]; } } // Response message for customer negative criterion mutate. message MutateCustomerNegativeCriteriaResponse { // 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 (for example, auth // errors), we return an RPC level error. google.rpc.Status partial_failure_error = 3; // All results for the mutate. repeated MutateCustomerNegativeCriteriaResult results = 2; } // The result for the criterion mutate. message MutateCustomerNegativeCriteriaResult { // Returned for successful operations. string resource_name = 1 [(google.api.resource_reference) = { type: "googleads.googleapis.com/CustomerNegativeCriterion" }]; // The mutated criterion with only mutable fields after mutate. The field will // only be returned when response_content_type is set to "MUTABLE_RESOURCE". google.ads.googleads.v15.resources.CustomerNegativeCriterion customer_negative_criterion = 2; }