aboutsummaryrefslogtreecommitdiff
path: root/google/ads/googleads/v0/services/ad_parameter_service.proto
diff options
context:
space:
mode:
Diffstat (limited to 'google/ads/googleads/v0/services/ad_parameter_service.proto')
-rw-r--r--google/ads/googleads/v0/services/ad_parameter_service.proto124
1 files changed, 124 insertions, 0 deletions
diff --git a/google/ads/googleads/v0/services/ad_parameter_service.proto b/google/ads/googleads/v0/services/ad_parameter_service.proto
new file mode 100644
index 000000000..af044b306
--- /dev/null
+++ b/google/ads/googleads/v0/services/ad_parameter_service.proto
@@ -0,0 +1,124 @@
+// 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/ad_parameter.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 = "AdParameterServiceProto";
+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 Ad Parameter service.
+
+// Service to manage ad parameters.
+service AdParameterService {
+ // Returns the requested ad parameter in full detail.
+ rpc GetAdParameter(GetAdParameterRequest)
+ returns (google.ads.googleads.v0.resources.AdParameter) {
+ option (google.api.http) = {
+ get: "/v0/{resource_name=customers/*/adParameters/*}"
+ };
+ }
+
+ // Creates, updates, or removes ad parameters. Operation statuses are
+ // returned.
+ rpc MutateAdParameters(MutateAdParametersRequest)
+ returns (MutateAdParametersResponse) {
+ option (google.api.http) = {
+ post: "/v0/customers/{customer_id=*}/adParameters:mutate"
+ body: "*"
+ };
+ }
+}
+
+// Request message for
+// [AdParameterService.GetAdParameter][google.ads.googleads.v0.services.AdParameterService.GetAdParameter]
+message GetAdParameterRequest {
+ // The resource name of the ad parameter to fetch.
+ string resource_name = 1;
+}
+
+// Request message for
+// [AdParameterService.MutateAdParameters][google.ads.googleads.v0.services.AdParameterService.MutateAdParameters]
+message MutateAdParametersRequest {
+ // The ID of the customer whose ad parameters are being modified.
+ string customer_id = 1;
+
+ // The list of operations to perform on individual ad parameters.
+ repeated AdParameterOperation 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 ad parameter.
+message AdParameterOperation {
+ // 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 ad parameter.
+ google.ads.googleads.v0.resources.AdParameter create = 1;
+
+ // Update operation: The ad parameter is expected to have a valid resource
+ // name.
+ google.ads.googleads.v0.resources.AdParameter update = 2;
+
+ // Remove operation: A resource name for the ad parameter to remove is
+ // expected in this format:
+ //
+ //
+ // `customers/{customer_id}/adParameters/{ad_group_id}_{criterion_id}_{parameter_index}`
+ string remove = 3;
+ }
+}
+
+// Response message for an ad parameter mutate.
+message MutateAdParametersResponse {
+ // 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 MutateAdParameterResult results = 2;
+}
+
+// The result for the ad parameter mutate.
+message MutateAdParameterResult {
+ // The resource name returned for successful operations.
+ string resource_name = 1;
+}