/
ad_partner_service.proto
139 lines (120 loc) · 4.98 KB
/
ad_partner_service.proto
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
// 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.admanager.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Ads.AdManager.V1";
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
option java_multiple_files = true;
option java_outer_classname = "AdPartnerServiceProto";
option java_package = "com.google.ads.admanager.v1";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\AdManager\\V1";
// Provides methods for handling AdPartner objects.
service AdPartnerService {
option (google.api.default_host) = "admanager.googleapis.com";
// API to retrieve a AdPartner object.
rpc GetAdPartner(GetAdPartnerRequest) returns (AdPartner) {
option (google.api.http) = {
get: "/v1/{name=networks/*/adPartners/*}"
};
option (google.api.method_signature) = "name";
}
// API to retrieve a list of AdPartner objects.
rpc ListAdPartners(ListAdPartnersRequest) returns (ListAdPartnersResponse) {
option (google.api.http) = {
get: "/v1/{parent=networks/*}/adPartners"
};
option (google.api.method_signature) = "parent";
}
}
// The AdPartner resource.
message AdPartner {
option (google.api.resource) = {
type: "admanager.googleapis.com/AdPartner"
pattern: "networks/{network_code}/adPartners/{ad_partner}"
plural: "adPartners"
singular: "adPartner"
};
// Identifier. The resource name of the AdPartner.
// Format: `networks/{network_code}/adPartners/{ad_partner_id}`
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
}
// Request object for GetAdPartner method.
message GetAdPartnerRequest {
// Required. The resource name of the AdPartner.
// Format: `networks/{network_code}/adPartners/{ad_partner_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "admanager.googleapis.com/AdPartner"
}
];
}
// Request object for ListAdPartners method.
message ListAdPartnersRequest {
// Required. The parent, which owns this collection of AdPartners.
// Format: `networks/{network_code}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "admanager.googleapis.com/Network"
}
];
// Optional. The maximum number of AdPartners to return. The service may
// return fewer than this value. If unspecified, at most 50 AdPartners will be
// returned. The maximum value is 1000; values above 1000 will be coerced to
// 1000.
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
// Optional. A page token, received from a previous `ListAdPartners` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListAdPartners` must
// match the call that provided the page token.
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. Expression to filter the response.
// See syntax details at
// https://developers.google.com/ad-manager/api/beta/filters
string filter = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. Expression to specify sorting order.
// See syntax details at
// https://developers.google.com/ad-manager/api/beta/filters#order
string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
// Optional. Number of individual resources to skip while paginating.
int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
}
// Response object for ListAdPartnersRequest containing matching AdPartner
// resources.
message ListAdPartnersResponse {
// The AdPartner from the specified network.
repeated AdPartner ad_partners = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
// Total number of AdPartners.
// If a filter was included in the request, this reflects the total number
// after the filtering is applied.
//
// `total_size` will not be calculated in the response unless it has been
// included in a response field mask. The response field mask can be provided
// to the method by using the URL parameter `$fields` or `fields`, or by using
// the HTTP/gRPC header `X-Goog-FieldMask`.
//
// For more information, see
// https://developers.google.com/ad-manager/api/beta/field-masks
int32 total_size = 3;
}