1 // Copyright 2019 Google LLC.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
18 package google.ads.googleads.v1.services;
20 import "google/ads/googleads/v1/resources/remarketing_action.proto";
21 import "google/api/annotations.proto";
22 import "google/protobuf/field_mask.proto";
23 import "google/protobuf/wrappers.proto";
24 import "google/rpc/status.proto";
26 option csharp_namespace = "Google.Ads.GoogleAds.V1.Services";
27 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/services;services";
28 option java_multiple_files = true;
29 option java_outer_classname = "RemarketingActionServiceProto";
30 option java_package = "com.google.ads.googleads.v1.services";
31 option objc_class_prefix = "GAA";
32 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Services";
33 option ruby_package = "Google::Ads::GoogleAds::V1::Services";
34 // Proto file describing the Remarketing Action service.
36 // Service to manage remarketing actions.
37 service RemarketingActionService {
38 // Returns the requested remarketing action in full detail.
39 rpc GetRemarketingAction(GetRemarketingActionRequest) returns (google.ads.googleads.v1.resources.RemarketingAction) {
40 option (google.api.http) = {
41 get: "/v1/{resource_name=customers/*/remarketingActions/*}"
45 // Creates or updates remarketing actions. Operation statuses are returned.
46 rpc MutateRemarketingActions(MutateRemarketingActionsRequest) returns (MutateRemarketingActionsResponse) {
47 option (google.api.http) = {
48 post: "/v1/customers/{customer_id=*}/remarketingActions:mutate"
54 // Request message for [RemarketingActionService.GetRemarketingAction][google.ads.googleads.v1.services.RemarketingActionService.GetRemarketingAction].
55 message GetRemarketingActionRequest {
56 // The resource name of the remarketing action to fetch.
57 string resource_name = 1;
60 // Request message for [RemarketingActionService.MutateRemarketingActions][google.ads.googleads.v1.services.RemarketingActionService.MutateRemarketingActions].
61 message MutateRemarketingActionsRequest {
62 // The ID of the customer whose remarketing actions are being modified.
63 string customer_id = 1;
65 // The list of operations to perform on individual remarketing actions.
66 repeated RemarketingActionOperation operations = 2;
68 // If true, successful operations will be carried out and invalid
69 // operations will return errors. If false, all operations will be carried
70 // out in one transaction if and only if they are all valid.
72 bool partial_failure = 3;
74 // If true, the request is validated but not executed. Only errors are
75 // returned, not results.
76 bool validate_only = 4;
79 // A single operation (create, update) on a remarketing action.
80 message RemarketingActionOperation {
81 // FieldMask that determines which resource fields are modified in an update.
82 google.protobuf.FieldMask update_mask = 4;
84 // The mutate operation.
86 // Create operation: No resource name is expected for the new remarketing
88 google.ads.googleads.v1.resources.RemarketingAction create = 1;
90 // Update operation: The remarketing action is expected to have a valid
92 google.ads.googleads.v1.resources.RemarketingAction update = 2;
96 // Response message for remarketing action mutate.
97 message MutateRemarketingActionsResponse {
98 // Errors that pertain to operation failures in the partial failure mode.
99 // Returned only when partial_failure = true and all errors occur inside the
100 // operations. If any errors occur outside the operations (e.g. auth errors),
101 // we return an RPC level error.
102 google.rpc.Status partial_failure_error = 3;
104 // All results for the mutate.
105 repeated MutateRemarketingActionResult results = 2;
108 // The result for the remarketing action mutate.
109 message MutateRemarketingActionResult {
110 // Returned for successful operations.
111 string resource_name = 1;