1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
// 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/shared_set.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 = "SharedSetServiceProto";
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 Shared Set service.
// Service to manage shared sets.
service SharedSetService {
// Returns the requested shared set in full detail.
rpc GetSharedSet(GetSharedSetRequest) returns (google.ads.googleads.v1.resources.SharedSet) {
option (google.api.http) = {
get: "/v1/{resource_name=customers/*/sharedSets/*}"
};
}
// Creates, updates, or removes shared sets. Operation statuses are returned.
rpc MutateSharedSets(MutateSharedSetsRequest) returns (MutateSharedSetsResponse) {
option (google.api.http) = {
post: "/v1/customers/{customer_id=*}/sharedSets:mutate"
body: "*"
};
}
}
// Request message for [SharedSetService.GetSharedSet][google.ads.googleads.v1.services.SharedSetService.GetSharedSet].
message GetSharedSetRequest {
// The resource name of the shared set to fetch.
string resource_name = 1;
}
// Request message for [SharedSetService.MutateSharedSets][google.ads.googleads.v1.services.SharedSetService.MutateSharedSets].
message MutateSharedSetsRequest {
// The ID of the customer whose shared sets are being modified.
string customer_id = 1;
// The list of operations to perform on individual shared sets.
repeated SharedSetOperation 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 an shared set.
message SharedSetOperation {
// 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 shared set.
google.ads.googleads.v1.resources.SharedSet create = 1;
// Update operation: The shared set is expected to have a valid resource
// name.
google.ads.googleads.v1.resources.SharedSet update = 2;
// Remove operation: A resource name for the removed shared set is expected,
// in this format:
//
// `customers/{customer_id}/sharedSets/{shared_set_id}`
string remove = 3;
}
}
// Response message for a shared set mutate.
message MutateSharedSetsResponse {
// 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 MutateSharedSetResult results = 2;
}
// The result for the shared set mutate.
message MutateSharedSetResult {
// Returned for successful operations.
string resource_name = 1;
}
|
