OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/adexchange.buyer": { | 5 "https://www.googleapis.com/auth/adexchange.buyer": { |
6 "description": "Manage your Ad Exchange buyer account config
uration" | 6 "description": "Manage your Ad Exchange buyer account config
uration" |
7 } | 7 } |
8 } | 8 } |
9 } | 9 } |
10 }, | 10 }, |
11 "basePath": "", | 11 "basePath": "", |
12 "baseUrl": "https://adexchangebuyer.googleapis.com/", | 12 "baseUrl": "https://adexchangebuyer.googleapis.com/", |
13 "batchPath": "batch", | 13 "batchPath": "batch", |
14 "canonicalName": "AdExchangeBuyerII", | 14 "canonicalName": "AdExchangeBuyerII", |
15 "description": "Accesses the latest features for managing Ad Exchange accoun
ts, Real-Time Bidding configurations and auction metrics, and Marketplace progra
mmatic deals.", | 15 "description": "Accesses the latest features for managing Ad Exchange accoun
ts, Real-Time Bidding configurations and auction metrics, and Marketplace progra
mmatic deals.", |
16 "discoveryVersion": "v1", | 16 "discoveryVersion": "v1", |
17 "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/g
uides/client-access/", | 17 "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/g
uides/client-access/", |
18 "icons": { | 18 "icons": { |
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
21 }, | 21 }, |
22 "id": "adexchangebuyer2:v2beta1", | 22 "id": "adexchangebuyer2:v2beta1", |
23 "kind": "discovery#restDescription", | 23 "kind": "discovery#restDescription", |
24 "name": "adexchangebuyer2", | 24 "name": "adexchangebuyer2", |
25 "ownerDomain": "google.com", | 25 "ownerDomain": "google.com", |
26 "ownerName": "Google", | 26 "ownerName": "Google", |
27 "parameters": { | 27 "parameters": { |
28 "access_token": { | 28 "oauth_token": { |
29 "description": "OAuth access token.", | 29 "description": "OAuth 2.0 token for the current user.", |
| 30 "location": "query", |
| 31 "type": "string" |
| 32 }, |
| 33 "bearer_token": { |
| 34 "description": "OAuth bearer token.", |
| 35 "location": "query", |
| 36 "type": "string" |
| 37 }, |
| 38 "upload_protocol": { |
| 39 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
30 "location": "query", | 40 "location": "query", |
31 "type": "string" | 41 "type": "string" |
32 }, | 42 }, |
33 "prettyPrint": { | 43 "prettyPrint": { |
34 "default": "true", | 44 "default": "true", |
35 "description": "Returns response with indentations and line breaks."
, | 45 "description": "Returns response with indentations and line breaks."
, |
36 "location": "query", | 46 "location": "query", |
37 "type": "boolean" | 47 "type": "boolean" |
38 }, | 48 }, |
39 "key": { | 49 "uploadType": { |
40 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 50 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
41 "location": "query", | 51 "location": "query", |
42 "type": "string" | 52 "type": "string" |
43 }, | 53 }, |
44 "quotaUser": { | |
45 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
46 "location": "query", | |
47 "type": "string" | |
48 }, | |
49 "pp": { | |
50 "default": "true", | |
51 "description": "Pretty-print response.", | |
52 "location": "query", | |
53 "type": "boolean" | |
54 }, | |
55 "fields": { | 54 "fields": { |
56 "description": "Selector specifying which fields to include in a par
tial response.", | 55 "description": "Selector specifying which fields to include in a par
tial response.", |
57 "location": "query", | 56 "location": "query", |
58 "type": "string" | 57 "type": "string" |
59 }, | 58 }, |
60 "alt": { | |
61 "default": "json", | |
62 "description": "Data format for response.", | |
63 "enum": [ | |
64 "json", | |
65 "media", | |
66 "proto" | |
67 ], | |
68 "enumDescriptions": [ | |
69 "Responses with Content-Type of application/json", | |
70 "Media download with context-dependent Content-Type", | |
71 "Responses with Content-Type of application/x-protobuf" | |
72 ], | |
73 "location": "query", | |
74 "type": "string" | |
75 }, | |
76 "$.xgafv": { | 59 "$.xgafv": { |
77 "description": "V1 error format.", | 60 "description": "V1 error format.", |
78 "enum": [ | 61 "enum": [ |
79 "1", | 62 "1", |
80 "2" | 63 "2" |
81 ], | 64 ], |
82 "enumDescriptions": [ | 65 "enumDescriptions": [ |
83 "v1 error format", | 66 "v1 error format", |
84 "v2 error format" | 67 "v2 error format" |
85 ], | 68 ], |
86 "location": "query", | 69 "location": "query", |
87 "type": "string" | 70 "type": "string" |
88 }, | 71 }, |
89 "callback": { | 72 "callback": { |
90 "description": "JSONP", | 73 "description": "JSONP", |
91 "location": "query", | 74 "location": "query", |
92 "type": "string" | 75 "type": "string" |
93 }, | 76 }, |
94 "oauth_token": { | 77 "alt": { |
95 "description": "OAuth 2.0 token for the current user.", | 78 "default": "json", |
| 79 "description": "Data format for response.", |
| 80 "enum": [ |
| 81 "json", |
| 82 "media", |
| 83 "proto" |
| 84 ], |
| 85 "enumDescriptions": [ |
| 86 "Responses with Content-Type of application/json", |
| 87 "Media download with context-dependent Content-Type", |
| 88 "Responses with Content-Type of application/x-protobuf" |
| 89 ], |
96 "location": "query", | 90 "location": "query", |
97 "type": "string" | 91 "type": "string" |
98 }, | 92 }, |
99 "uploadType": { | 93 "access_token": { |
100 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 94 "description": "OAuth access token.", |
101 "location": "query", | 95 "location": "query", |
102 "type": "string" | 96 "type": "string" |
103 }, | 97 }, |
104 "bearer_token": { | 98 "key": { |
105 "description": "OAuth bearer token.", | 99 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
106 "location": "query", | 100 "location": "query", |
107 "type": "string" | 101 "type": "string" |
108 }, | 102 }, |
109 "upload_protocol": { | 103 "quotaUser": { |
110 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 104 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
111 "location": "query", | 105 "location": "query", |
112 "type": "string" | 106 "type": "string" |
| 107 }, |
| 108 "pp": { |
| 109 "default": "true", |
| 110 "description": "Pretty-print response.", |
| 111 "location": "query", |
| 112 "type": "boolean" |
113 } | 113 } |
114 }, | 114 }, |
115 "protocol": "rest", | 115 "protocol": "rest", |
116 "resources": { | 116 "resources": { |
117 "accounts": { | 117 "accounts": { |
118 "resources": { | 118 "resources": { |
119 "clients": { | 119 "clients": { |
120 "methods": { | 120 "methods": { |
121 "update": { | 121 "get": { |
122 "description": "Updates an existing client buyer.", | 122 "description": "Gets a client buyer with a given cli
ent account ID.", |
123 "httpMethod": "PUT", | 123 "httpMethod": "GET", |
124 "id": "adexchangebuyer2.accounts.clients.update", | 124 "id": "adexchangebuyer2.accounts.clients.get", |
125 "parameterOrder": [ | 125 "parameterOrder": [ |
126 "accountId", | 126 "accountId", |
127 "clientAccountId" | 127 "clientAccountId" |
128 ], | 128 ], |
129 "parameters": { | 129 "parameters": { |
130 "clientAccountId": { | 130 "accountId": { |
131 "description": "Unique numerical account ID
of the client to update. (required)", | 131 "description": "Numerical account ID of the
client's sponsor buyer. (required)", |
132 "format": "int64", | 132 "format": "int64", |
133 "location": "path", | 133 "location": "path", |
134 "required": true, | 134 "required": true, |
135 "type": "string" | 135 "type": "string" |
136 }, | 136 }, |
137 "accountId": { | 137 "clientAccountId": { |
138 "description": "Unique numerical account ID
for the buyer of which the client buyer\nis a customer; the sponsor buyer to upd
ate a client for. (required)", | 138 "description": "Numerical account ID of the
client buyer to retrieve. (required)", |
139 "format": "int64", | 139 "format": "int64", |
140 "location": "path", | 140 "location": "path", |
141 "required": true, | 141 "required": true, |
142 "type": "string" | 142 "type": "string" |
143 } | 143 } |
144 }, | 144 }, |
145 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", | 145 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", |
146 "request": { | |
147 "$ref": "Client" | |
148 }, | |
149 "response": { | 146 "response": { |
150 "$ref": "Client" | 147 "$ref": "Client" |
151 }, | 148 }, |
152 "scopes": [ | 149 "scopes": [ |
153 "https://www.googleapis.com/auth/adexchange.buye
r" | 150 "https://www.googleapis.com/auth/adexchange.buye
r" |
154 ] | 151 ] |
155 }, | 152 }, |
156 "get": { | 153 "list": { |
157 "description": "Gets a client buyer with a given cli
ent account ID.", | 154 "description": "Lists all the clients for the curren
t sponsor buyer.", |
158 "httpMethod": "GET", | 155 "httpMethod": "GET", |
159 "id": "adexchangebuyer2.accounts.clients.get", | 156 "id": "adexchangebuyer2.accounts.clients.list", |
| 157 "parameterOrder": [ |
| 158 "accountId" |
| 159 ], |
| 160 "parameters": { |
| 161 "accountId": { |
| 162 "description": "Unique numerical account ID
of the sponsor buyer to list the clients for.", |
| 163 "format": "int64", |
| 164 "location": "path", |
| 165 "required": true, |
| 166 "type": "string" |
| 167 }, |
| 168 "pageSize": { |
| 169 "description": "Requested page size. The ser
ver may return fewer clients than requested.\nIf unspecified, the server will pi
ck an appropriate default.", |
| 170 "format": "int32", |
| 171 "location": "query", |
| 172 "type": "integer" |
| 173 }, |
| 174 "pageToken": { |
| 175 "description": "A token identifying a page o
f results the server should return.\nTypically, this is the value of\nListClient
sResponse.nextPageToken\nreturned from the previous call to the\naccounts.client
s.list method.", |
| 176 "location": "query", |
| 177 "type": "string" |
| 178 } |
| 179 }, |
| 180 "path": "v2beta1/accounts/{accountId}/clients", |
| 181 "response": { |
| 182 "$ref": "ListClientsResponse" |
| 183 }, |
| 184 "scopes": [ |
| 185 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 186 ] |
| 187 }, |
| 188 "update": { |
| 189 "description": "Updates an existing client buyer.", |
| 190 "httpMethod": "PUT", |
| 191 "id": "adexchangebuyer2.accounts.clients.update", |
160 "parameterOrder": [ | 192 "parameterOrder": [ |
161 "accountId", | 193 "accountId", |
162 "clientAccountId" | 194 "clientAccountId" |
163 ], | 195 ], |
164 "parameters": { | 196 "parameters": { |
165 "clientAccountId": { | 197 "accountId": { |
166 "description": "Numerical account ID of the
client buyer to retrieve. (required)", | 198 "description": "Unique numerical account ID
for the buyer of which the client buyer\nis a customer; the sponsor buyer to upd
ate a client for. (required)", |
167 "format": "int64", | 199 "format": "int64", |
168 "location": "path", | 200 "location": "path", |
169 "required": true, | 201 "required": true, |
170 "type": "string" | 202 "type": "string" |
171 }, | 203 }, |
172 "accountId": { | 204 "clientAccountId": { |
173 "description": "Numerical account ID of the
client's sponsor buyer. (required)", | 205 "description": "Unique numerical account ID
of the client to update. (required)", |
174 "format": "int64", | 206 "format": "int64", |
175 "location": "path", | 207 "location": "path", |
176 "required": true, | 208 "required": true, |
177 "type": "string" | 209 "type": "string" |
178 } | 210 } |
179 }, | 211 }, |
180 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", | 212 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", |
181 "response": { | |
182 "$ref": "Client" | |
183 }, | |
184 "scopes": [ | |
185 "https://www.googleapis.com/auth/adexchange.buye
r" | |
186 ] | |
187 }, | |
188 "create": { | |
189 "description": "Creates a new client buyer.", | |
190 "httpMethod": "POST", | |
191 "id": "adexchangebuyer2.accounts.clients.create", | |
192 "parameterOrder": [ | |
193 "accountId" | |
194 ], | |
195 "parameters": { | |
196 "accountId": { | |
197 "description": "Unique numerical account ID
for the buyer of which the client buyer\nis a customer; the sponsor buyer to cre
ate a client for. (required)", | |
198 "format": "int64", | |
199 "location": "path", | |
200 "required": true, | |
201 "type": "string" | |
202 } | |
203 }, | |
204 "path": "v2beta1/accounts/{accountId}/clients", | |
205 "request": { | 213 "request": { |
206 "$ref": "Client" | 214 "$ref": "Client" |
207 }, | 215 }, |
208 "response": { | 216 "response": { |
209 "$ref": "Client" | 217 "$ref": "Client" |
210 }, | 218 }, |
211 "scopes": [ | 219 "scopes": [ |
212 "https://www.googleapis.com/auth/adexchange.buye
r" | 220 "https://www.googleapis.com/auth/adexchange.buye
r" |
213 ] | 221 ] |
214 }, | 222 }, |
215 "list": { | 223 "create": { |
216 "description": "Lists all the clients for the curren
t sponsor buyer.", | 224 "description": "Creates a new client buyer.", |
217 "httpMethod": "GET", | 225 "httpMethod": "POST", |
218 "id": "adexchangebuyer2.accounts.clients.list", | 226 "id": "adexchangebuyer2.accounts.clients.create", |
219 "parameterOrder": [ | 227 "parameterOrder": [ |
220 "accountId" | 228 "accountId" |
221 ], | 229 ], |
222 "parameters": { | 230 "parameters": { |
223 "pageSize": { | |
224 "description": "Requested page size. The ser
ver may return fewer clients than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | |
225 "format": "int32", | |
226 "location": "query", | |
227 "type": "integer" | |
228 }, | |
229 "accountId": { | 231 "accountId": { |
230 "description": "Unique numerical account ID
of the sponsor buyer to list the clients for.", | 232 "description": "Unique numerical account ID
for the buyer of which the client buyer\nis a customer; the sponsor buyer to cre
ate a client for. (required)", |
231 "format": "int64", | 233 "format": "int64", |
232 "location": "path", | 234 "location": "path", |
233 "required": true, | 235 "required": true, |
234 "type": "string" | 236 "type": "string" |
235 }, | |
236 "pageToken": { | |
237 "description": "A token identifying a page o
f results the server should return.\nTypically, this is the value of\nListClient
sResponse.nextPageToken\nreturned from the previous call to the\naccounts.client
s.list method.", | |
238 "location": "query", | |
239 "type": "string" | |
240 } | 237 } |
241 }, | 238 }, |
242 "path": "v2beta1/accounts/{accountId}/clients", | 239 "path": "v2beta1/accounts/{accountId}/clients", |
| 240 "request": { |
| 241 "$ref": "Client" |
| 242 }, |
243 "response": { | 243 "response": { |
244 "$ref": "ListClientsResponse" | 244 "$ref": "Client" |
245 }, | 245 }, |
246 "scopes": [ | 246 "scopes": [ |
247 "https://www.googleapis.com/auth/adexchange.buye
r" | 247 "https://www.googleapis.com/auth/adexchange.buye
r" |
248 ] | 248 ] |
249 } | 249 } |
250 }, | 250 }, |
251 "resources": { | 251 "resources": { |
252 "users": { | 252 "invitations": { |
253 "methods": { | 253 "methods": { |
254 "update": { | 254 "get": { |
255 "description": "Updates an existing client u
ser.\nOnly the user status can be changed on update.", | 255 "description": "Retrieves an existing client
user invitation.", |
256 "httpMethod": "PUT", | 256 "httpMethod": "GET", |
257 "id": "adexchangebuyer2.accounts.clients.use
rs.update", | 257 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", |
258 "parameterOrder": [ | 258 "parameterOrder": [ |
259 "accountId", | 259 "accountId", |
260 "clientAccountId", | 260 "clientAccountId", |
261 "userId" | 261 "invitationId" |
262 ], | 262 ], |
263 "parameters": { | 263 "parameters": { |
264 "clientAccountId": { | 264 "invitationId": { |
265 "description": "Numerical account ID
of the client buyer that the user to be retrieved\nis associated with. (require
d)", | 265 "description": "Numerical identifier
of the user invitation to retrieve. (required)", |
266 "format": "int64", | |
267 "location": "path", | |
268 "required": true, | |
269 "type": "string" | |
270 }, | |
271 "userId": { | |
272 "description": "Numerical identifier
of the user to retrieve. (required)", | |
273 "format": "int64", | 266 "format": "int64", |
274 "location": "path", | 267 "location": "path", |
275 "required": true, | 268 "required": true, |
276 "type": "string" | 269 "type": "string" |
277 }, | 270 }, |
278 "accountId": { | 271 "accountId": { |
279 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | 272 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
280 "format": "int64", | 273 "format": "int64", |
281 "location": "path", | 274 "location": "path", |
282 "required": true, | 275 "required": true, |
283 "type": "string" | 276 "type": "string" |
| 277 }, |
| 278 "clientAccountId": { |
| 279 "description": "Numerical account ID
of the client buyer that the user invitation\nto be retrieved is associated wit
h. (required)", |
| 280 "format": "int64", |
| 281 "location": "path", |
| 282 "required": true, |
| 283 "type": "string" |
284 } | 284 } |
285 }, | 285 }, |
286 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", | 286 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations/{invitationId}", |
287 "request": { | |
288 "$ref": "ClientUser" | |
289 }, | |
290 "response": { | 287 "response": { |
291 "$ref": "ClientUser" | 288 "$ref": "ClientUserInvitation" |
292 }, | 289 }, |
293 "scopes": [ | 290 "scopes": [ |
294 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 291 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
295 ] | 292 ] |
296 }, | 293 }, |
297 "get": { | 294 "list": { |
298 "description": "Retrieves an existing client
user.", | 295 "description": "Lists all the client users i
nvitations for a client\nwith a given account ID.", |
299 "httpMethod": "GET", | 296 "httpMethod": "GET", |
300 "id": "adexchangebuyer2.accounts.clients.use
rs.get", | 297 "id": "adexchangebuyer2.accounts.clients.inv
itations.list", |
301 "parameterOrder": [ | 298 "parameterOrder": [ |
302 "accountId", | 299 "accountId", |
303 "clientAccountId", | 300 "clientAccountId" |
304 "userId" | |
305 ], | 301 ], |
306 "parameters": { | 302 "parameters": { |
307 "clientAccountId": { | 303 "pageToken": { |
308 "description": "Numerical account ID
of the client buyer\nthat the user to be retrieved is associated with. (require
d)", | 304 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stClientUserInvitationsResponse.nextPageToken\nreturned from the previous call t
o the\nclients.invitations.list\nmethod.", |
309 "format": "int64", | 305 "location": "query", |
310 "location": "path", | |
311 "required": true, | |
312 "type": "string" | |
313 }, | |
314 "userId": { | |
315 "description": "Numerical identifier
of the user to retrieve. (required)", | |
316 "format": "int64", | |
317 "location": "path", | |
318 "required": true, | |
319 "type": "string" | 306 "type": "string" |
320 }, | 307 }, |
321 "accountId": { | 308 "accountId": { |
322 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | 309 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
323 "format": "int64", | 310 "format": "int64", |
324 "location": "path", | 311 "location": "path", |
325 "required": true, | 312 "required": true, |
326 "type": "string" | 313 "type": "string" |
| 314 }, |
| 315 "pageSize": { |
| 316 "description": "Requested page size.
Server may return fewer clients than requested.\nIf unspecified, server will pi
ck an appropriate default.", |
| 317 "format": "int32", |
| 318 "location": "query", |
| 319 "type": "integer" |
| 320 }, |
| 321 "clientAccountId": { |
| 322 "description": "Numerical account ID
of the client buyer to list invitations for.\n(required)\nYou must either speci
fy a string representation of a\nnumerical account identifier or the `-` charact
er\nto list all the invitations for all the clients\nof a given sponsor buyer.", |
| 323 "location": "path", |
| 324 "required": true, |
| 325 "type": "string" |
327 } | 326 } |
328 }, | 327 }, |
329 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", | 328 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", |
330 "response": { | 329 "response": { |
331 "$ref": "ClientUser" | 330 "$ref": "ListClientUserInvitationsRespon
se" |
332 }, | 331 }, |
333 "scopes": [ | 332 "scopes": [ |
334 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 333 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
335 ] | 334 ] |
336 }, | 335 }, |
337 "list": { | 336 "create": { |
338 "description": "Lists all the known client u
sers for a specified\nsponsor buyer account ID.", | 337 "description": "Creates and sends out an ema
il invitation to access\nan Ad Exchange client buyer account.", |
339 "httpMethod": "GET", | 338 "httpMethod": "POST", |
340 "id": "adexchangebuyer2.accounts.clients.use
rs.list", | 339 "id": "adexchangebuyer2.accounts.clients.inv
itations.create", |
341 "parameterOrder": [ | 340 "parameterOrder": [ |
342 "accountId", | 341 "accountId", |
343 "clientAccountId" | 342 "clientAccountId" |
344 ], | 343 ], |
345 "parameters": { | 344 "parameters": { |
346 "clientAccountId": { | |
347 "description": "The account ID of th
e client buyer to list users for. (required)\nYou must specify either a string r
epresentation of a\nnumerical account identifier or the `-` character\nto list a
ll the client users for all the clients\nof a given sponsor buyer.", | |
348 "location": "path", | |
349 "required": true, | |
350 "type": "string" | |
351 }, | |
352 "pageSize": { | |
353 "description": "Requested page size.
The server may return fewer clients than requested.\nIf unspecified, the server
will pick an appropriate default.", | |
354 "format": "int32", | |
355 "location": "query", | |
356 "type": "integer" | |
357 }, | |
358 "accountId": { | 345 "accountId": { |
359 "description": "Numerical account ID
of the sponsor buyer of the client to list users for.\n(required)", | 346 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
360 "format": "int64", | 347 "format": "int64", |
361 "location": "path", | 348 "location": "path", |
362 "required": true, | 349 "required": true, |
363 "type": "string" | 350 "type": "string" |
364 }, | 351 }, |
365 "pageToken": { | 352 "clientAccountId": { |
366 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stClientUsersResponse.nextPageToken\nreturned from the previous call to the\nacc
ounts.clients.users.list method.", | 353 "description": "Numerical account ID
of the client buyer that the user\nshould be associated with. (required)", |
367 "location": "query", | 354 "format": "int64", |
| 355 "location": "path", |
| 356 "required": true, |
368 "type": "string" | 357 "type": "string" |
369 } | 358 } |
370 }, | 359 }, |
371 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users", | 360 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", |
| 361 "request": { |
| 362 "$ref": "ClientUserInvitation" |
| 363 }, |
372 "response": { | 364 "response": { |
373 "$ref": "ListClientUsersResponse" | 365 "$ref": "ClientUserInvitation" |
374 }, | 366 }, |
375 "scopes": [ | 367 "scopes": [ |
376 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 368 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
377 ] | 369 ] |
378 } | 370 } |
379 } | 371 } |
380 }, | 372 }, |
381 "invitations": { | 373 "users": { |
382 "methods": { | 374 "methods": { |
383 "create": { | 375 "list": { |
384 "description": "Creates and sends out an ema
il invitation to access\nan Ad Exchange client buyer account.", | 376 "description": "Lists all the known client u
sers for a specified\nsponsor buyer account ID.", |
385 "httpMethod": "POST", | 377 "httpMethod": "GET", |
386 "id": "adexchangebuyer2.accounts.clients.inv
itations.create", | 378 "id": "adexchangebuyer2.accounts.clients.use
rs.list", |
387 "parameterOrder": [ | 379 "parameterOrder": [ |
388 "accountId", | 380 "accountId", |
389 "clientAccountId" | 381 "clientAccountId" |
390 ], | 382 ], |
391 "parameters": { | 383 "parameters": { |
| 384 "pageToken": { |
| 385 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stClientUsersResponse.nextPageToken\nreturned from the previous call to the\nacc
ounts.clients.users.list method.", |
| 386 "location": "query", |
| 387 "type": "string" |
| 388 }, |
| 389 "accountId": { |
| 390 "description": "Numerical account ID
of the sponsor buyer of the client to list users for.\n(required)", |
| 391 "format": "int64", |
| 392 "location": "path", |
| 393 "required": true, |
| 394 "type": "string" |
| 395 }, |
| 396 "pageSize": { |
| 397 "description": "Requested page size.
The server may return fewer clients than requested.\nIf unspecified, the server
will pick an appropriate default.", |
| 398 "format": "int32", |
| 399 "location": "query", |
| 400 "type": "integer" |
| 401 }, |
392 "clientAccountId": { | 402 "clientAccountId": { |
393 "description": "Numerical account ID
of the client buyer that the user\nshould be associated with. (required)", | 403 "description": "The account ID of th
e client buyer to list users for. (required)\nYou must specify either a string r
epresentation of a\nnumerical account identifier or the `-` character\nto list a
ll the client users for all the clients\nof a given sponsor buyer.", |
| 404 "location": "path", |
| 405 "required": true, |
| 406 "type": "string" |
| 407 } |
| 408 }, |
| 409 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users", |
| 410 "response": { |
| 411 "$ref": "ListClientUsersResponse" |
| 412 }, |
| 413 "scopes": [ |
| 414 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 415 ] |
| 416 }, |
| 417 "get": { |
| 418 "description": "Retrieves an existing client
user.", |
| 419 "httpMethod": "GET", |
| 420 "id": "adexchangebuyer2.accounts.clients.use
rs.get", |
| 421 "parameterOrder": [ |
| 422 "accountId", |
| 423 "clientAccountId", |
| 424 "userId" |
| 425 ], |
| 426 "parameters": { |
| 427 "userId": { |
| 428 "description": "Numerical identifier
of the user to retrieve. (required)", |
394 "format": "int64", | 429 "format": "int64", |
395 "location": "path", | 430 "location": "path", |
396 "required": true, | 431 "required": true, |
397 "type": "string" | 432 "type": "string" |
398 }, | 433 }, |
399 "accountId": { | 434 "accountId": { |
400 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | 435 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
401 "format": "int64", | 436 "format": "int64", |
402 "location": "path", | 437 "location": "path", |
403 "required": true, | 438 "required": true, |
404 "type": "string" | 439 "type": "string" |
| 440 }, |
| 441 "clientAccountId": { |
| 442 "description": "Numerical account ID
of the client buyer\nthat the user to be retrieved is associated with. (require
d)", |
| 443 "format": "int64", |
| 444 "location": "path", |
| 445 "required": true, |
| 446 "type": "string" |
405 } | 447 } |
406 }, | 448 }, |
407 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", | 449 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", |
408 "request": { | |
409 "$ref": "ClientUserInvitation" | |
410 }, | |
411 "response": { | 450 "response": { |
412 "$ref": "ClientUserInvitation" | 451 "$ref": "ClientUser" |
413 }, | 452 }, |
414 "scopes": [ | 453 "scopes": [ |
415 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 454 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
416 ] | 455 ] |
417 }, | 456 }, |
418 "get": { | 457 "update": { |
419 "description": "Retrieves an existing client
user invitation.", | 458 "description": "Updates an existing client u
ser.\nOnly the user status can be changed on update.", |
420 "httpMethod": "GET", | 459 "httpMethod": "PUT", |
421 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", | 460 "id": "adexchangebuyer2.accounts.clients.use
rs.update", |
422 "parameterOrder": [ | 461 "parameterOrder": [ |
423 "accountId", | 462 "accountId", |
424 "clientAccountId", | 463 "clientAccountId", |
425 "invitationId" | 464 "userId" |
426 ], | 465 ], |
427 "parameters": { | 466 "parameters": { |
428 "clientAccountId": { | 467 "userId": { |
429 "description": "Numerical account ID
of the client buyer that the user invitation\nto be retrieved is associated wit
h. (required)", | 468 "description": "Numerical identifier
of the user to retrieve. (required)", |
430 "format": "int64", | |
431 "location": "path", | |
432 "required": true, | |
433 "type": "string" | |
434 }, | |
435 "invitationId": { | |
436 "description": "Numerical identifier
of the user invitation to retrieve. (required)", | |
437 "format": "int64", | 469 "format": "int64", |
438 "location": "path", | 470 "location": "path", |
439 "required": true, | 471 "required": true, |
440 "type": "string" | 472 "type": "string" |
441 }, | 473 }, |
442 "accountId": { | 474 "accountId": { |
443 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | 475 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
444 "format": "int64", | 476 "format": "int64", |
445 "location": "path", | |
446 "required": true, | |
447 "type": "string" | |
448 } | |
449 }, | |
450 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations/{invitationId}", | |
451 "response": { | |
452 "$ref": "ClientUserInvitation" | |
453 }, | |
454 "scopes": [ | |
455 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
456 ] | |
457 }, | |
458 "list": { | |
459 "description": "Lists all the client users i
nvitations for a client\nwith a given account ID.", | |
460 "httpMethod": "GET", | |
461 "id": "adexchangebuyer2.accounts.clients.inv
itations.list", | |
462 "parameterOrder": [ | |
463 "accountId", | |
464 "clientAccountId" | |
465 ], | |
466 "parameters": { | |
467 "clientAccountId": { | |
468 "description": "Numerical account ID
of the client buyer to list invitations for.\n(required)\nYou must either speci
fy a string representation of a\nnumerical account identifier or the `-` charact
er\nto list all the invitations for all the clients\nof a given sponsor buyer.", | |
469 "location": "path", | |
470 "required": true, | |
471 "type": "string" | |
472 }, | |
473 "pageSize": { | |
474 "description": "Requested page size.
Server may return fewer clients than requested.\nIf unspecified, server will pi
ck an appropriate default.", | |
475 "format": "int32", | |
476 "location": "query", | |
477 "type": "integer" | |
478 }, | |
479 "accountId": { | |
480 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
481 "format": "int64", | |
482 "location": "path", | 477 "location": "path", |
483 "required": true, | 478 "required": true, |
484 "type": "string" | 479 "type": "string" |
485 }, | 480 }, |
486 "pageToken": { | 481 "clientAccountId": { |
487 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stClientUserInvitationsResponse.nextPageToken\nreturned from the previous call t
o the\nclients.invitations.list\nmethod.", | 482 "description": "Numerical account ID
of the client buyer that the user to be retrieved\nis associated with. (require
d)", |
488 "location": "query", | 483 "format": "int64", |
| 484 "location": "path", |
| 485 "required": true, |
489 "type": "string" | 486 "type": "string" |
490 } | 487 } |
491 }, | 488 }, |
492 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", | 489 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", |
| 490 "request": { |
| 491 "$ref": "ClientUser" |
| 492 }, |
493 "response": { | 493 "response": { |
494 "$ref": "ListClientUserInvitationsRespon
se" | 494 "$ref": "ClientUser" |
495 }, | 495 }, |
496 "scopes": [ | 496 "scopes": [ |
497 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 497 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
498 ] | 498 ] |
499 } | 499 } |
500 } | 500 } |
501 } | 501 } |
502 } | 502 } |
503 } | 503 } |
504 } | 504 } |
505 } | 505 } |
506 }, | 506 }, |
507 "revision": "20170118", | 507 "revision": "20170206", |
508 "rootUrl": "https://adexchangebuyer.googleapis.com/", | 508 "rootUrl": "https://adexchangebuyer.googleapis.com/", |
509 "schemas": { | 509 "schemas": { |
| 510 "Client": { |
| 511 "description": "A client resource represents a client buyer—an
agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associ
ated with the client buyer have restricted access to\nthe Ad Exchange Marketplac
e and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngra
nted to the client buyer.\nAll fields are required unless otherwise specified.", |
| 512 "id": "Client", |
| 513 "properties": { |
| 514 "clientName": { |
| 515 "description": "Name used to represent this client to publis
hers.\nYou may have multiple clients that map to the same entity,\nbut for each
client the combination of `clientName` and entity\nmust be unique.\nYou can spec
ify this field as empty.", |
| 516 "type": "string" |
| 517 }, |
| 518 "role": { |
| 519 "description": "The role which is assigned to the client buy
er. Each role implies a set of\npermissions granted to the client. Must be one o
f `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.", |
| 520 "enum": [ |
| 521 "CLIENT_ROLE_UNSPECIFIED", |
| 522 "CLIENT_DEAL_VIEWER", |
| 523 "CLIENT_DEAL_NEGOTIATOR", |
| 524 "CLIENT_DEAL_APPROVER" |
| 525 ], |
| 526 "enumDescriptions": [ |
| 527 "A placeholder for an undefined client role.", |
| 528 "Users associated with this client can see publisher dea
l offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve
deals.\nIf this client is visible to publishers, they can send deal proposals\nt
o this client.", |
| 529 "Users associated with this client can respond to deal p
roposals\nsent to them by publishers. They can also initiate deal proposals\nof
their own.", |
| 530 "Users associated with this client can approve eligible
deals\non your behalf. Some deals may still explicitly require publisher\nfinali
zation. If this role is not selected, the sponsor buyer\nwill need to manually a
pprove each of their deals." |
| 531 ], |
| 532 "type": "string" |
| 533 }, |
| 534 "visibleToSeller": { |
| 535 "description": "Whether the client buyer will be visible to
sellers.", |
| 536 "type": "boolean" |
| 537 }, |
| 538 "entityId": { |
| 539 "description": "Numerical identifier of the client entity.\n
The entity can be an advertiser, a brand, or an agency.\nThis identifier is uniq
ue among all the entities with the same type.\n\nA list of all known advertisers
with their identifiers is available in the\n[advertisers.txt](https://storage.g
oogleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all know
n brands with their identifiers is available in the\n[brands.txt](https://storag
e.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known
agencies with their identifiers is available in the\n[agencies.txt](https://stor
age.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.", |
| 540 "format": "int64", |
| 541 "type": "string" |
| 542 }, |
| 543 "clientAccountId": { |
| 544 "description": "The globally-unique numerical ID of the clie
nt.\nThe value of this field is ignored in create and update operations.", |
| 545 "format": "int64", |
| 546 "type": "string" |
| 547 }, |
| 548 "entityName": { |
| 549 "description": "The name of the entity. This field is automa
tically fetched based on\nthe type and ID.\nThe value of this field is ignored i
n create and update operations.", |
| 550 "type": "string" |
| 551 }, |
| 552 "status": { |
| 553 "description": "The status of the client buyer.", |
| 554 "enum": [ |
| 555 "CLIENT_STATUS_UNSPECIFIED", |
| 556 "DISABLED", |
| 557 "ACTIVE" |
| 558 ], |
| 559 "enumDescriptions": [ |
| 560 "A placeholder for an undefined client status.", |
| 561 "A client that is currently disabled.", |
| 562 "A client that is currently active." |
| 563 ], |
| 564 "type": "string" |
| 565 }, |
| 566 "entityType": { |
| 567 "description": "The type of the client entity: `ADVERTISER`,
`BRAND`, or `AGENCY`.", |
| 568 "enum": [ |
| 569 "ENTITY_TYPE_UNSPECIFIED", |
| 570 "ADVERTISER", |
| 571 "BRAND", |
| 572 "AGENCY" |
| 573 ], |
| 574 "enumDescriptions": [ |
| 575 "A placeholder for an undefined client entity type. Shou
ld not be used.", |
| 576 "An advertiser.", |
| 577 "A brand.", |
| 578 "An advertising agency." |
| 579 ], |
| 580 "type": "string" |
| 581 } |
| 582 }, |
| 583 "type": "object" |
| 584 }, |
510 "ClientUser": { | 585 "ClientUser": { |
511 "description": "A client user is created under a client buyer and ha
s restricted access to\nthe Ad Exchange Marketplace and certain other sections\n
of the Ad Exchange Buyer UI based on the role\ngranted to the associated client
buyer.\n\nThe only way a new client user can be created is via accepting an\nema
il invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fi
elds are required unless otherwise specified.", | 586 "description": "A client user is created under a client buyer and ha
s restricted access to\nthe Ad Exchange Marketplace and certain other sections\n
of the Ad Exchange Buyer UI based on the role\ngranted to the associated client
buyer.\n\nThe only way a new client user can be created is via accepting an\nema
il invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fi
elds are required unless otherwise specified.", |
512 "id": "ClientUser", | 587 "id": "ClientUser", |
513 "properties": { | 588 "properties": { |
514 "email": { | |
515 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", | |
516 "type": "string" | |
517 }, | |
518 "clientAccountId": { | |
519 "description": "Numerical account ID of the client buyer\nwi
th which the user is associated; the\nbuyer must be a client of the current spon
sor buyer.\nThe value of this field is ignored in an update operation.", | |
520 "format": "int64", | |
521 "type": "string" | |
522 }, | |
523 "status": { | 589 "status": { |
524 "description": "The status of the client user.", | 590 "description": "The status of the client user.", |
525 "enum": [ | 591 "enum": [ |
526 "USER_STATUS_UNSPECIFIED", | 592 "USER_STATUS_UNSPECIFIED", |
527 "PENDING", | 593 "PENDING", |
528 "ACTIVE", | 594 "ACTIVE", |
529 "DISABLED" | 595 "DISABLED" |
530 ], | 596 ], |
531 "enumDescriptions": [ | 597 "enumDescriptions": [ |
532 "A placeholder for an undefined user status.", | 598 "A placeholder for an undefined user status.", |
533 "A user who was already created but hasn't accepted the
invitation yet.", | 599 "A user who was already created but hasn't accepted the
invitation yet.", |
534 "A user that is currently active.", | 600 "A user that is currently active.", |
535 "A user that is currently disabled." | 601 "A user that is currently disabled." |
536 ], | 602 ], |
537 "type": "string" | 603 "type": "string" |
538 }, | 604 }, |
539 "userId": { | 605 "userId": { |
540 "description": "The unique numerical ID of the client user\n
that has accepted an invitation.\nThe value of this field is ignored in an updat
e operation.", | 606 "description": "The unique numerical ID of the client user\n
that has accepted an invitation.\nThe value of this field is ignored in an updat
e operation.", |
541 "format": "int64", | 607 "format": "int64", |
542 "type": "string" | 608 "type": "string" |
| 609 }, |
| 610 "email": { |
| 611 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", |
| 612 "type": "string" |
| 613 }, |
| 614 "clientAccountId": { |
| 615 "description": "Numerical account ID of the client buyer\nwi
th which the user is associated; the\nbuyer must be a client of the current spon
sor buyer.\nThe value of this field is ignored in an update operation.", |
| 616 "format": "int64", |
| 617 "type": "string" |
543 } | 618 } |
544 }, | 619 }, |
545 "type": "object" | 620 "type": "object" |
546 }, | 621 }, |
547 "ClientUserInvitation": { | 622 "ClientUserInvitation": { |
548 "description": "An invitation for a new client user to get access to
the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.
", | 623 "description": "An invitation for a new client user to get access to
the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.
", |
549 "id": "ClientUserInvitation", | 624 "id": "ClientUserInvitation", |
550 "properties": { | 625 "properties": { |
551 "email": { | 626 "email": { |
552 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", | 627 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", |
553 "type": "string" | 628 "type": "string" |
554 }, | 629 }, |
555 "clientAccountId": { | 630 "clientAccountId": { |
556 "description": "Numerical account ID of the client buyer\nth
at the invited user is associated with.\nThe value of this field is ignored in c
reate operations.", | 631 "description": "Numerical account ID of the client buyer\nth
at the invited user is associated with.\nThe value of this field is ignored in c
reate operations.", |
557 "format": "int64", | 632 "format": "int64", |
558 "type": "string" | 633 "type": "string" |
559 }, | 634 }, |
560 "invitationId": { | 635 "invitationId": { |
561 "description": "The unique numerical ID of the invitation th
at is sent to the user.\nThe value of this field is ignored in create operations
.", | 636 "description": "The unique numerical ID of the invitation th
at is sent to the user.\nThe value of this field is ignored in create operations
.", |
562 "format": "int64", | 637 "format": "int64", |
563 "type": "string" | 638 "type": "string" |
564 } | 639 } |
565 }, | 640 }, |
566 "type": "object" | 641 "type": "object" |
567 }, | 642 }, |
| 643 "ListClientUsersResponse": { |
| 644 "id": "ListClientUsersResponse", |
| 645 "properties": { |
| 646 "nextPageToken": { |
| 647 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subseq
uent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of
results.", |
| 648 "type": "string" |
| 649 }, |
| 650 "users": { |
| 651 "description": "The returned list of client users.", |
| 652 "items": { |
| 653 "$ref": "ClientUser" |
| 654 }, |
| 655 "type": "array" |
| 656 } |
| 657 }, |
| 658 "type": "object" |
| 659 }, |
568 "ListClientUserInvitationsResponse": { | 660 "ListClientUserInvitationsResponse": { |
569 "id": "ListClientUserInvitationsResponse", | 661 "id": "ListClientUserInvitationsResponse", |
570 "properties": { | 662 "properties": { |
571 "nextPageToken": { | 663 "nextPageToken": { |
572 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in
the subsequent call to the\nclients.invitations.list\nmethod to retrieve the nex
t\npage of results.", | 664 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in
the subsequent call to the\nclients.invitations.list\nmethod to retrieve the nex
t\npage of results.", |
573 "type": "string" | 665 "type": "string" |
574 }, | 666 }, |
575 "invitations": { | 667 "invitations": { |
576 "description": "The returned list of client users.", | 668 "description": "The returned list of client users.", |
577 "items": { | 669 "items": { |
578 "$ref": "ClientUserInvitation" | 670 "$ref": "ClientUserInvitation" |
579 }, | 671 }, |
580 "type": "array" | 672 "type": "array" |
581 } | 673 } |
582 }, | 674 }, |
583 "type": "object" | 675 "type": "object" |
584 }, | |
585 "ListClientUsersResponse": { | |
586 "id": "ListClientUsersResponse", | |
587 "properties": { | |
588 "users": { | |
589 "description": "The returned list of client users.", | |
590 "items": { | |
591 "$ref": "ClientUser" | |
592 }, | |
593 "type": "array" | |
594 }, | |
595 "nextPageToken": { | |
596 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subseq
uent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of
results.", | |
597 "type": "string" | |
598 } | |
599 }, | |
600 "type": "object" | |
601 }, | |
602 "Client": { | |
603 "description": "A client resource represents a client buyer—an
agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associ
ated with the client buyer have restricted access to\nthe Ad Exchange Marketplac
e and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngra
nted to the client buyer.\nAll fields are required unless otherwise specified.", | |
604 "id": "Client", | |
605 "properties": { | |
606 "visibleToSeller": { | |
607 "description": "Whether the client buyer will be visible to
sellers.", | |
608 "type": "boolean" | |
609 }, | |
610 "status": { | |
611 "description": "The status of the client buyer.", | |
612 "enum": [ | |
613 "CLIENT_STATUS_UNSPECIFIED", | |
614 "DISABLED", | |
615 "ACTIVE" | |
616 ], | |
617 "enumDescriptions": [ | |
618 "A placeholder for an undefined client status.", | |
619 "A client that is currently disabled.", | |
620 "A client that is currently active." | |
621 ], | |
622 "type": "string" | |
623 }, | |
624 "entityType": { | |
625 "description": "The type of the client entity: `ADVERTISER`,
`BRAND`, or `AGENCY`.", | |
626 "enum": [ | |
627 "ENTITY_TYPE_UNSPECIFIED", | |
628 "ADVERTISER", | |
629 "BRAND", | |
630 "AGENCY" | |
631 ], | |
632 "enumDescriptions": [ | |
633 "A placeholder for an undefined client entity type. Shou
ld not be used.", | |
634 "An advertiser.", | |
635 "A brand.", | |
636 "An advertising agency." | |
637 ], | |
638 "type": "string" | |
639 }, | |
640 "role": { | |
641 "description": "The role which is assigned to the client buy
er. Each role implies a set of\npermissions granted to the client. Must be one o
f `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.", | |
642 "enum": [ | |
643 "CLIENT_ROLE_UNSPECIFIED", | |
644 "CLIENT_DEAL_VIEWER", | |
645 "CLIENT_DEAL_NEGOTIATOR", | |
646 "CLIENT_DEAL_APPROVER" | |
647 ], | |
648 "enumDescriptions": [ | |
649 "A placeholder for an undefined client role.", | |
650 "Users associated with this client can see publisher dea
l offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve
deals.\nIf this client is visible to publishers, they can send deal proposals\nt
o this client.", | |
651 "Users associated with this client can respond to deal p
roposals\nsent to them by publishers. They can also initiate deal proposals\nof
their own.", | |
652 "Users associated with this client can approve eligible
deals\non your behalf. Some deals may still explicitly require publisher\nfinali
zation. If this role is not selected, the sponsor buyer\nwill need to manually a
pprove each of their deals." | |
653 ], | |
654 "type": "string" | |
655 }, | |
656 "clientName": { | |
657 "description": "Name used to represent this client to publis
hers.\nYou may have multiple clients that map to the same entity,\nbut for each
client the combination of `clientName` and entity\nmust be unique.\nYou can spec
ify this field as empty.", | |
658 "type": "string" | |
659 }, | |
660 "clientAccountId": { | |
661 "description": "The globally-unique numerical ID of the clie
nt.\nThe value of this field is ignored in create and update operations.", | |
662 "format": "int64", | |
663 "type": "string" | |
664 }, | |
665 "entityId": { | |
666 "description": "Numerical identifier of the client entity.\n
The entity can be an advertiser, a brand, or an agency.\nThis identifier is uniq
ue among all the entities with the same type.\n\nA list of all known advertisers
with their identifiers is available in the\n[advertisers.txt](https://storage.g
oogleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all know
n brands with their identifiers is available in the\n[brands.txt](https://storag
e.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known
agencies with their identifiers is available in the\n[agencies.txt](https://stor
age.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.", | |
667 "format": "int64", | |
668 "type": "string" | |
669 }, | |
670 "entityName": { | |
671 "description": "The name of the entity. This field is automa
tically fetched based on\nthe type and ID.\nThe value of this field is ignored i
n create and update operations.", | |
672 "type": "string" | |
673 } | |
674 }, | |
675 "type": "object" | |
676 }, | 676 }, |
677 "ListClientsResponse": { | 677 "ListClientsResponse": { |
678 "id": "ListClientsResponse", | 678 "id": "ListClientsResponse", |
679 "properties": { | 679 "properties": { |
680 "nextPageToken": { | 680 "nextPageToken": { |
681 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent
call to the\naccounts.clients.list method\nto retrieve the next page of results
.", | 681 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent
call to the\naccounts.clients.list method\nto retrieve the next page of results
.", |
682 "type": "string" | 682 "type": "string" |
683 }, | 683 }, |
684 "clients": { | 684 "clients": { |
685 "description": "The returned list of clients.", | 685 "description": "The returned list of clients.", |
686 "items": { | 686 "items": { |
687 "$ref": "Client" | 687 "$ref": "Client" |
688 }, | 688 }, |
689 "type": "array" | 689 "type": "array" |
690 } | 690 } |
691 }, | 691 }, |
692 "type": "object" | 692 "type": "object" |
693 } | 693 } |
694 }, | 694 }, |
695 "servicePath": "", | 695 "servicePath": "", |
696 "title": "Ad Exchange Buyer API II", | 696 "title": "Ad Exchange Buyer API II", |
697 "version": "v2beta1" | 697 "version": "v2beta1" |
698 } | 698 } |
OLD | NEW |