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 "pp": { | 28 "uploadType": { |
29 "default": "true", | 29 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
30 "description": "Pretty-print response.", | |
31 "location": "query", | |
32 "type": "boolean" | |
33 }, | |
34 "bearer_token": { | |
35 "description": "OAuth bearer token.", | |
36 "location": "query", | 30 "location": "query", |
37 "type": "string" | 31 "type": "string" |
38 }, | 32 }, |
39 "oauth_token": { | |
40 "description": "OAuth 2.0 token for the current user.", | |
41 "location": "query", | |
42 "type": "string" | |
43 }, | |
44 "upload_protocol": { | |
45 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
46 "location": "query", | |
47 "type": "string" | |
48 }, | |
49 "prettyPrint": { | |
50 "default": "true", | |
51 "description": "Returns response with indentations and line breaks."
, | |
52 "location": "query", | |
53 "type": "boolean" | |
54 }, | |
55 "fields": { | 33 "fields": { |
56 "description": "Selector specifying which fields to include in a par
tial response.", | 34 "description": "Selector specifying which fields to include in a par
tial response.", |
57 "location": "query", | 35 "location": "query", |
58 "type": "string" | 36 "type": "string" |
59 }, | 37 }, |
60 "uploadType": { | |
61 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
62 "location": "query", | |
63 "type": "string" | |
64 }, | |
65 "callback": { | |
66 "description": "JSONP", | |
67 "location": "query", | |
68 "type": "string" | |
69 }, | |
70 "$.xgafv": { | 38 "$.xgafv": { |
71 "description": "V1 error format.", | 39 "description": "V1 error format.", |
72 "enum": [ | 40 "enum": [ |
73 "1", | 41 "1", |
74 "2" | 42 "2" |
75 ], | 43 ], |
76 "enumDescriptions": [ | 44 "enumDescriptions": [ |
77 "v1 error format", | 45 "v1 error format", |
78 "v2 error format" | 46 "v2 error format" |
79 ], | 47 ], |
80 "location": "query", | 48 "location": "query", |
81 "type": "string" | 49 "type": "string" |
82 }, | 50 }, |
| 51 "callback": { |
| 52 "description": "JSONP", |
| 53 "location": "query", |
| 54 "type": "string" |
| 55 }, |
83 "alt": { | 56 "alt": { |
84 "default": "json", | 57 "default": "json", |
85 "description": "Data format for response.", | 58 "description": "Data format for response.", |
86 "enum": [ | 59 "enum": [ |
87 "json", | 60 "json", |
88 "media", | 61 "media", |
89 "proto" | 62 "proto" |
90 ], | 63 ], |
91 "enumDescriptions": [ | 64 "enumDescriptions": [ |
92 "Responses with Content-Type of application/json", | 65 "Responses with Content-Type of application/json", |
93 "Media download with context-dependent Content-Type", | 66 "Media download with context-dependent Content-Type", |
94 "Responses with Content-Type of application/x-protobuf" | 67 "Responses with Content-Type of application/x-protobuf" |
95 ], | 68 ], |
96 "location": "query", | 69 "location": "query", |
97 "type": "string" | 70 "type": "string" |
98 }, | 71 }, |
| 72 "key": { |
| 73 "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.", |
| 74 "location": "query", |
| 75 "type": "string" |
| 76 }, |
99 "access_token": { | 77 "access_token": { |
100 "description": "OAuth access token.", | 78 "description": "OAuth access token.", |
101 "location": "query", | 79 "location": "query", |
102 "type": "string" | 80 "type": "string" |
103 }, | 81 }, |
104 "key": { | |
105 "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", | |
107 "type": "string" | |
108 }, | |
109 "quotaUser": { | 82 "quotaUser": { |
110 "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.", | 83 "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", | 84 "location": "query", |
112 "type": "string" | 85 "type": "string" |
| 86 }, |
| 87 "pp": { |
| 88 "default": "true", |
| 89 "description": "Pretty-print response.", |
| 90 "location": "query", |
| 91 "type": "boolean" |
| 92 }, |
| 93 "bearer_token": { |
| 94 "description": "OAuth bearer token.", |
| 95 "location": "query", |
| 96 "type": "string" |
| 97 }, |
| 98 "oauth_token": { |
| 99 "description": "OAuth 2.0 token for the current user.", |
| 100 "location": "query", |
| 101 "type": "string" |
| 102 }, |
| 103 "upload_protocol": { |
| 104 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 105 "location": "query", |
| 106 "type": "string" |
| 107 }, |
| 108 "prettyPrint": { |
| 109 "default": "true", |
| 110 "description": "Returns response with indentations and line breaks."
, |
| 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 "filterSets": { | 119 "clients": { |
120 "methods": { | 120 "methods": { |
121 "get": { | 121 "update": { |
122 "description": "Retrieves the requested filter set f
or the account with the given account\nID.", | 122 "description": "Updates an existing client buyer.", |
123 "httpMethod": "GET", | 123 "httpMethod": "PUT", |
124 "id": "adexchangebuyer2.accounts.filterSets.get", | 124 "id": "adexchangebuyer2.accounts.clients.update", |
125 "parameterOrder": [ | 125 "parameterOrder": [ |
126 "accountId", | 126 "accountId", |
127 "filterSetId" | 127 "clientAccountId" |
128 ], | 128 ], |
129 "parameters": { | 129 "parameters": { |
130 "filterSetId": { | 130 "accountId": { |
131 "description": "The ID of the filter set to
get.", | 131 "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)", |
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": "Account ID of the buyer.", | 138 "description": "Unique numerical account ID
of the client to update. (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}/filterSets/{fi
lterSetId}", | 145 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", |
| 146 "request": { |
| 147 "$ref": "Client" |
| 148 }, |
146 "response": { | 149 "response": { |
147 "$ref": "FilterSet" | 150 "$ref": "Client" |
| 151 }, |
| 152 "scopes": [ |
| 153 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 154 ] |
| 155 }, |
| 156 "create": { |
| 157 "description": "Creates a new client buyer.", |
| 158 "httpMethod": "POST", |
| 159 "id": "adexchangebuyer2.accounts.clients.create", |
| 160 "parameterOrder": [ |
| 161 "accountId" |
| 162 ], |
| 163 "parameters": { |
| 164 "accountId": { |
| 165 "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)", |
| 166 "format": "int64", |
| 167 "location": "path", |
| 168 "required": true, |
| 169 "type": "string" |
| 170 } |
| 171 }, |
| 172 "path": "v2beta1/accounts/{accountId}/clients", |
| 173 "request": { |
| 174 "$ref": "Client" |
| 175 }, |
| 176 "response": { |
| 177 "$ref": "Client" |
148 }, | 178 }, |
149 "scopes": [ | 179 "scopes": [ |
150 "https://www.googleapis.com/auth/adexchange.buye
r" | 180 "https://www.googleapis.com/auth/adexchange.buye
r" |
151 ] | 181 ] |
152 }, | 182 }, |
153 "list": { | 183 "list": { |
154 "description": "Lists all filter sets for the accoun
t with the given account ID.", | 184 "description": "Lists all the clients for the curren
t sponsor buyer.", |
155 "httpMethod": "GET", | 185 "httpMethod": "GET", |
156 "id": "adexchangebuyer2.accounts.filterSets.list", | 186 "id": "adexchangebuyer2.accounts.clients.list", |
157 "parameterOrder": [ | 187 "parameterOrder": [ |
158 "accountId" | 188 "accountId" |
159 ], | 189 ], |
160 "parameters": { | 190 "parameters": { |
161 "pageToken": { | 191 "pageToken": { |
162 "description": "A token identifying a page o
f results the server should return.\nTypically, this is the value of\nListFilter
SetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.fil
terSets.list\nmethod.", | 192 "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.", |
163 "location": "query", | 193 "location": "query", |
164 "type": "string" | 194 "type": "string" |
165 }, | 195 }, |
166 "accountId": { | |
167 "description": "Account ID of the buyer.", | |
168 "format": "int64", | |
169 "location": "path", | |
170 "required": true, | |
171 "type": "string" | |
172 }, | |
173 "pageSize": { | 196 "pageSize": { |
174 "description": "Requested page size. The ser
ver may return fewer results than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 197 "description": "Requested page size. The ser
ver may return fewer clients than requested.\nIf unspecified, the server will pi
ck an appropriate default.", |
175 "format": "int32", | 198 "format": "int32", |
176 "location": "query", | 199 "location": "query", |
177 "type": "integer" | 200 "type": "integer" |
178 } | 201 }, |
179 }, | |
180 "path": "v2beta1/accounts/{accountId}/filterSets", | |
181 "response": { | |
182 "$ref": "ListFilterSetsResponse" | |
183 }, | |
184 "scopes": [ | |
185 "https://www.googleapis.com/auth/adexchange.buye
r" | |
186 ] | |
187 }, | |
188 "create": { | |
189 "description": "Creates the specified filter set for
the account with the given account ID.", | |
190 "httpMethod": "POST", | |
191 "id": "adexchangebuyer2.accounts.filterSets.create", | |
192 "parameterOrder": [ | |
193 "accountId" | |
194 ], | |
195 "parameters": { | |
196 "accountId": { | 202 "accountId": { |
197 "description": "Account ID of the buyer.", | 203 "description": "Unique numerical account ID
of the sponsor buyer to list the clients for.", |
198 "format": "int64", | |
199 "location": "path", | |
200 "required": true, | |
201 "type": "string" | |
202 }, | |
203 "isTransient": { | |
204 "description": "Whether the filter set is tr
ansient, or should be persisted indefinitely.\nBy default, filter sets are not t
ransient.\nIf transient, it will be available for at least 1 hour after creation
.", | |
205 "location": "query", | |
206 "type": "boolean" | |
207 } | |
208 }, | |
209 "path": "v2beta1/accounts/{accountId}/filterSets", | |
210 "request": { | |
211 "$ref": "FilterSet" | |
212 }, | |
213 "response": { | |
214 "$ref": "FilterSet" | |
215 }, | |
216 "scopes": [ | |
217 "https://www.googleapis.com/auth/adexchange.buye
r" | |
218 ] | |
219 }, | |
220 "delete": { | |
221 "description": "Deletes the requested filter set fro
m the account with the given account\nID.", | |
222 "httpMethod": "DELETE", | |
223 "id": "adexchangebuyer2.accounts.filterSets.delete", | |
224 "parameterOrder": [ | |
225 "accountId", | |
226 "filterSetId" | |
227 ], | |
228 "parameters": { | |
229 "accountId": { | |
230 "description": "Account ID of the buyer.", | |
231 "format": "int64", | |
232 "location": "path", | |
233 "required": true, | |
234 "type": "string" | |
235 }, | |
236 "filterSetId": { | |
237 "description": "The ID of the filter set to
delete.", | |
238 "format": "int64", | 204 "format": "int64", |
239 "location": "path", | 205 "location": "path", |
240 "required": true, | 206 "required": true, |
241 "type": "string" | 207 "type": "string" |
242 } | 208 } |
243 }, | 209 }, |
244 "path": "v2beta1/accounts/{accountId}/filterSets/{fi
lterSetId}", | 210 "path": "v2beta1/accounts/{accountId}/clients", |
245 "response": { | 211 "response": { |
246 "$ref": "Empty" | 212 "$ref": "ListClientsResponse" |
247 }, | 213 }, |
248 "scopes": [ | 214 "scopes": [ |
249 "https://www.googleapis.com/auth/adexchange.buye
r" | 215 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 216 ] |
| 217 }, |
| 218 "get": { |
| 219 "description": "Gets a client buyer with a given cli
ent account ID.", |
| 220 "httpMethod": "GET", |
| 221 "id": "adexchangebuyer2.accounts.clients.get", |
| 222 "parameterOrder": [ |
| 223 "accountId", |
| 224 "clientAccountId" |
| 225 ], |
| 226 "parameters": { |
| 227 "accountId": { |
| 228 "description": "Numerical account ID of the
client's sponsor buyer. (required)", |
| 229 "format": "int64", |
| 230 "location": "path", |
| 231 "required": true, |
| 232 "type": "string" |
| 233 }, |
| 234 "clientAccountId": { |
| 235 "description": "Numerical account ID of the
client buyer to retrieve. (required)", |
| 236 "format": "int64", |
| 237 "location": "path", |
| 238 "required": true, |
| 239 "type": "string" |
| 240 } |
| 241 }, |
| 242 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", |
| 243 "response": { |
| 244 "$ref": "Client" |
| 245 }, |
| 246 "scopes": [ |
| 247 "https://www.googleapis.com/auth/adexchange.buye
r" |
250 ] | 248 ] |
251 } | 249 } |
252 }, | 250 }, |
253 "resources": { | 251 "resources": { |
254 "filteredBids": { | 252 "invitations": { |
255 "methods": { | 253 "methods": { |
256 "list": { | 254 "list": { |
257 "description": "List all reasons for which b
ids were filtered, with the number of bids\nfiltered for each reason.", | 255 "description": "Lists all the client users i
nvitations for a client\nwith a given account ID.", |
258 "httpMethod": "GET", | 256 "httpMethod": "GET", |
259 "id": "adexchangebuyer2.accounts.filterSets.
filteredBids.list", | 257 "id": "adexchangebuyer2.accounts.clients.inv
itations.list", |
260 "parameterOrder": [ | 258 "parameterOrder": [ |
261 "accountId", | 259 "accountId", |
262 "filterSetId" | 260 "clientAccountId" |
263 ], | 261 ], |
264 "parameters": { | 262 "parameters": { |
| 263 "pageToken": { |
| 264 "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.", |
| 265 "location": "query", |
| 266 "type": "string" |
| 267 }, |
| 268 "pageSize": { |
| 269 "description": "Requested page size.
Server may return fewer clients than requested.\nIf unspecified, server will pi
ck an appropriate default.", |
| 270 "format": "int32", |
| 271 "location": "query", |
| 272 "type": "integer" |
| 273 }, |
265 "accountId": { | 274 "accountId": { |
266 "description": "Account ID of the bu
yer.", | 275 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
267 "format": "int64", | 276 "format": "int64", |
268 "location": "path", | 277 "location": "path", |
269 "required": true, | 278 "required": true, |
270 "type": "string" | 279 "type": "string" |
271 }, | 280 }, |
272 "pageSize": { | 281 "clientAccountId": { |
273 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", | 282 "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.", |
274 "format": "int32", | 283 "location": "path", |
275 "location": "query", | 284 "required": true, |
276 "type": "integer" | 285 "type": "string" |
277 }, | 286 } |
278 "filterSetId": { | 287 }, |
279 "description": "The ID of the filter
set to apply.", | 288 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", |
| 289 "response": { |
| 290 "$ref": "ListClientUserInvitationsRespon
se" |
| 291 }, |
| 292 "scopes": [ |
| 293 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 294 ] |
| 295 }, |
| 296 "get": { |
| 297 "description": "Retrieves an existing client
user invitation.", |
| 298 "httpMethod": "GET", |
| 299 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", |
| 300 "parameterOrder": [ |
| 301 "accountId", |
| 302 "clientAccountId", |
| 303 "invitationId" |
| 304 ], |
| 305 "parameters": { |
| 306 "accountId": { |
| 307 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
280 "format": "int64", | 308 "format": "int64", |
281 "location": "path", | 309 "location": "path", |
282 "required": true, | 310 "required": true, |
283 "type": "string" | 311 "type": "string" |
284 }, | 312 }, |
285 "pageToken": { | 313 "clientAccountId": { |
286 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\nac
counts.filterSets.filteredBids.list\nmethod.", | 314 "description": "Numerical account ID
of the client buyer that the user invitation\nto be retrieved is associated wit
h. (required)", |
287 "location": "query", | |
288 "type": "string" | |
289 } | |
290 }, | |
291 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/filteredBids", | |
292 "response": { | |
293 "$ref": "ListFilteredBidsResponse" | |
294 }, | |
295 "scopes": [ | |
296 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
297 ] | |
298 } | |
299 }, | |
300 "resources": { | |
301 "details": { | |
302 "methods": { | |
303 "list": { | |
304 "description": "List all details ass
ociated with a specific reason for which bids were\nfiltered, with the number of
bids filtered for each detail.", | |
305 "httpMethod": "GET", | |
306 "id": "adexchangebuyer2.accounts.fil
terSets.filteredBids.details.list", | |
307 "parameterOrder": [ | |
308 "accountId", | |
309 "filterSetId", | |
310 "creativeStatusId" | |
311 ], | |
312 "parameters": { | |
313 "creativeStatusId": { | |
314 "description": "The ID of th
e creative status for which to retrieve a breakdown by detail.\nSee\n[creative-s
tatus-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-st
atus-codes).", | |
315 "format": "int32", | |
316 "location": "path", | |
317 "required": true, | |
318 "type": "integer" | |
319 }, | |
320 "pageToken": { | |
321 "description": "A token iden
tifying a page of results the server should return.\nTypically, this is the valu
e of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from t
he previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod."
, | |
322 "location": "query", | |
323 "type": "string" | |
324 }, | |
325 "accountId": { | |
326 "description": "Account ID o
f the buyer.", | |
327 "format": "int64", | |
328 "location": "path", | |
329 "required": true, | |
330 "type": "string" | |
331 }, | |
332 "pageSize": { | |
333 "description": "Requested pa
ge size. The server may return fewer results than requested.\nIf unspecified, th
e server will pick an appropriate default.", | |
334 "format": "int32", | |
335 "location": "query", | |
336 "type": "integer" | |
337 }, | |
338 "filterSetId": { | |
339 "description": "The ID of th
e filter set to apply.", | |
340 "format": "int64", | |
341 "location": "path", | |
342 "required": true, | |
343 "type": "string" | |
344 } | |
345 }, | |
346 "path": "v2beta1/accounts/{accountId
}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details", | |
347 "response": { | |
348 "$ref": "ListCreativeStatusBreak
downByDetailResponse" | |
349 }, | |
350 "scopes": [ | |
351 "https://www.googleapis.com/auth
/adexchange.buyer" | |
352 ] | |
353 } | |
354 } | |
355 }, | |
356 "creatives": { | |
357 "methods": { | |
358 "list": { | |
359 "description": "List all creatives a
ssociated with a specific reason for which bids were\nfiltered, with the number
of bids filtered for each creative.", | |
360 "httpMethod": "GET", | |
361 "id": "adexchangebuyer2.accounts.fil
terSets.filteredBids.creatives.list", | |
362 "parameterOrder": [ | |
363 "accountId", | |
364 "filterSetId", | |
365 "creativeStatusId" | |
366 ], | |
367 "parameters": { | |
368 "creativeStatusId": { | |
369 "description": "The ID of th
e creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creativ
e-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative
-status-codes).", | |
370 "format": "int32", | |
371 "location": "path", | |
372 "required": true, | |
373 "type": "integer" | |
374 }, | |
375 "pageToken": { | |
376 "description": "A token iden
tifying a page of results the server should return.\nTypically, this is the valu
e of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from
the previous call to the\naccounts.filterSets.filteredBids.creatives.list\nmeth
od.", | |
377 "location": "query", | |
378 "type": "string" | |
379 }, | |
380 "accountId": { | |
381 "description": "Account ID o
f the buyer.", | |
382 "format": "int64", | |
383 "location": "path", | |
384 "required": true, | |
385 "type": "string" | |
386 }, | |
387 "pageSize": { | |
388 "description": "Requested pa
ge size. The server may return fewer results than requested.\nIf unspecified, th
e server will pick an appropriate default.", | |
389 "format": "int32", | |
390 "location": "query", | |
391 "type": "integer" | |
392 }, | |
393 "filterSetId": { | |
394 "description": "The ID of th
e filter set to apply.", | |
395 "format": "int64", | |
396 "location": "path", | |
397 "required": true, | |
398 "type": "string" | |
399 } | |
400 }, | |
401 "path": "v2beta1/accounts/{accountId
}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives", | |
402 "response": { | |
403 "$ref": "ListCreativeStatusBreak
downByCreativeResponse" | |
404 }, | |
405 "scopes": [ | |
406 "https://www.googleapis.com/auth
/adexchange.buyer" | |
407 ] | |
408 } | |
409 }, | |
410 "resources": { | |
411 "details": { | |
412 "methods": { | |
413 "list": { | |
414 "description": "List all det
ails associated with a specific reason for which bids were\nfiltered and a speci
fic creative that was filtered for that reason, with\nthe number of bids filtere
d for each detail.", | |
415 "httpMethod": "GET", | |
416 "id": "adexchangebuyer2.acco
unts.filterSets.filteredBids.creatives.details.list", | |
417 "parameterOrder": [ | |
418 "accountId", | |
419 "filterSetId", | |
420 "creativeStatusId", | |
421 "creativeId" | |
422 ], | |
423 "parameters": { | |
424 "pageToken": { | |
425 "description": "A to
ken identifying a page of results the server should return.\nTypically, this is
the value of\nListCreativeStatusAndCreativeBreakdownByDetailResponse.nextPageTok
en\nreturned from the previous call to the\naccounts.filterSets.filteredBids.cre
atives.details.list\nmethod.", | |
426 "location": "query", | |
427 "type": "string" | |
428 }, | |
429 "pageSize": { | |
430 "description": "Requ
ested page size. The server may return fewer results than requested.\nIf unspeci
fied, the server will pick an appropriate default.", | |
431 "format": "int32", | |
432 "location": "query", | |
433 "type": "integer" | |
434 }, | |
435 "creativeId": { | |
436 "description": "The
creative ID for which to retrieve a breakdown by detail.", | |
437 "location": "path", | |
438 "required": true, | |
439 "type": "string" | |
440 }, | |
441 "creativeStatusId": { | |
442 "description": "The
ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[cr
eative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/cre
ative-status-codes).", | |
443 "format": "int32", | |
444 "location": "path", | |
445 "required": true, | |
446 "type": "integer" | |
447 }, | |
448 "accountId": { | |
449 "description": "Acco
unt ID of the buyer.", | |
450 "format": "int64", | |
451 "location": "path", | |
452 "required": true, | |
453 "type": "string" | |
454 }, | |
455 "filterSetId": { | |
456 "description": "The
ID of the filter set to apply.", | |
457 "format": "int64", | |
458 "location": "path", | |
459 "required": true, | |
460 "type": "string" | |
461 } | |
462 }, | |
463 "path": "v2beta1/accounts/{a
ccountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives/{cr
eativeId}/details", | |
464 "response": { | |
465 "$ref": "ListCreativeSta
tusAndCreativeBreakdownByDetailResponse" | |
466 }, | |
467 "scopes": [ | |
468 "https://www.googleapis.
com/auth/adexchange.buyer" | |
469 ] | |
470 } | |
471 } | |
472 } | |
473 } | |
474 } | |
475 } | |
476 }, | |
477 "nonBillableWinningBids": { | |
478 "methods": { | |
479 "list": { | |
480 "description": "List all reasons for which w
inning bids were not billable, with the number\nof bids not billed for each reas
on.", | |
481 "httpMethod": "GET", | |
482 "id": "adexchangebuyer2.accounts.filterSets.
nonBillableWinningBids.list", | |
483 "parameterOrder": [ | |
484 "accountId", | |
485 "filterSetId" | |
486 ], | |
487 "parameters": { | |
488 "pageToken": { | |
489 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call
to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.", | |
490 "location": "query", | |
491 "type": "string" | |
492 }, | |
493 "accountId": { | |
494 "description": "Account ID of the bu
yer.", | |
495 "format": "int64", | 315 "format": "int64", |
496 "location": "path", | 316 "location": "path", |
497 "required": true, | 317 "required": true, |
498 "type": "string" | 318 "type": "string" |
499 }, | 319 }, |
500 "pageSize": { | 320 "invitationId": { |
501 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", | 321 "description": "Numerical identifier
of the user invitation to retrieve. (required)", |
502 "format": "int32", | |
503 "location": "query", | |
504 "type": "integer" | |
505 }, | |
506 "filterSetId": { | |
507 "description": "The ID of the filter
set to apply.", | |
508 "format": "int64", | 322 "format": "int64", |
509 "location": "path", | 323 "location": "path", |
510 "required": true, | 324 "required": true, |
511 "type": "string" | 325 "type": "string" |
512 } | 326 } |
513 }, | 327 }, |
514 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/nonBillableWinningBids", | 328 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations/{invitationId}", |
515 "response": { | 329 "response": { |
516 "$ref": "ListNonBillableWinningBidsRespo
nse" | 330 "$ref": "ClientUserInvitation" |
517 }, | 331 }, |
518 "scopes": [ | 332 "scopes": [ |
519 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 333 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
520 ] | 334 ] |
521 } | 335 }, |
522 } | 336 "create": { |
523 }, | 337 "description": "Creates and sends out an ema
il invitation to access\nan Ad Exchange client buyer account.", |
524 "losingBids": { | 338 "httpMethod": "POST", |
525 "methods": { | 339 "id": "adexchangebuyer2.accounts.clients.inv
itations.create", |
526 "list": { | |
527 "description": "List all reasons for which b
ids lost in the auction, with the number of\nbids that lost for each reason.", | |
528 "httpMethod": "GET", | |
529 "id": "adexchangebuyer2.accounts.filterSets.
losingBids.list", | |
530 "parameterOrder": [ | 340 "parameterOrder": [ |
531 "accountId", | 341 "accountId", |
532 "filterSetId" | 342 "clientAccountId" |
533 ], | 343 ], |
534 "parameters": { | 344 "parameters": { |
535 "pageToken": { | |
536 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stLosingBidsResponse.nextPageToken\nreturned from the previous call to the\nacco
unts.filterSets.losingBids.list\nmethod.", | |
537 "location": "query", | |
538 "type": "string" | |
539 }, | |
540 "accountId": { | 345 "accountId": { |
541 "description": "Account ID of the bu
yer.", | 346 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
542 "format": "int64", | 347 "format": "int64", |
543 "location": "path", | 348 "location": "path", |
544 "required": true, | 349 "required": true, |
545 "type": "string" | 350 "type": "string" |
546 }, | 351 }, |
547 "pageSize": { | 352 "clientAccountId": { |
548 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", | 353 "description": "Numerical account ID
of the client buyer that the user\nshould be associated with. (required)", |
549 "format": "int32", | |
550 "location": "query", | |
551 "type": "integer" | |
552 }, | |
553 "filterSetId": { | |
554 "description": "The ID of the filter
set to apply.", | |
555 "format": "int64", | 354 "format": "int64", |
556 "location": "path", | 355 "location": "path", |
557 "required": true, | 356 "required": true, |
558 "type": "string" | 357 "type": "string" |
559 } | 358 } |
560 }, | 359 }, |
561 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/losingBids", | 360 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", |
| 361 "request": { |
| 362 "$ref": "ClientUserInvitation" |
| 363 }, |
562 "response": { | 364 "response": { |
563 "$ref": "ListLosingBidsResponse" | 365 "$ref": "ClientUserInvitation" |
564 }, | 366 }, |
565 "scopes": [ | 367 "scopes": [ |
566 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 368 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
567 ] | 369 ] |
568 } | 370 } |
569 } | 371 } |
570 }, | 372 }, |
571 "impressionMetrics": { | 373 "users": { |
572 "methods": { | 374 "methods": { |
573 "list": { | 375 "get": { |
574 "description": "Lists all metrics that are m
easured in terms of number of impressions.", | 376 "description": "Retrieves an existing client
user.", |
575 "httpMethod": "GET", | 377 "httpMethod": "GET", |
576 "id": "adexchangebuyer2.accounts.filterSets.
impressionMetrics.list", | 378 "id": "adexchangebuyer2.accounts.clients.use
rs.get", |
577 "parameterOrder": [ | 379 "parameterOrder": [ |
578 "accountId", | 380 "accountId", |
579 "filterSetId" | 381 "clientAccountId", |
| 382 "userId" |
580 ], | 383 ], |
581 "parameters": { | 384 "parameters": { |
582 "pageToken": { | 385 "userId": { |
583 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stImpressionMetricsResponse.nextPageToken\nreturned from the previous call to th
e\naccounts.filterSets.impressionMetrics.list\nmethod.", | 386 "description": "Numerical identifier
of the user to retrieve. (required)", |
584 "location": "query", | |
585 "type": "string" | |
586 }, | |
587 "accountId": { | |
588 "description": "Account ID of the bu
yer.", | |
589 "format": "int64", | 387 "format": "int64", |
590 "location": "path", | 388 "location": "path", |
591 "required": true, | 389 "required": true, |
592 "type": "string" | 390 "type": "string" |
593 }, | 391 }, |
594 "pageSize": { | 392 "accountId": { |
595 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", | 393 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
596 "format": "int32", | 394 "format": "int64", |
597 "location": "query", | 395 "location": "path", |
598 "type": "integer" | 396 "required": true, |
| 397 "type": "string" |
599 }, | 398 }, |
600 "filterSetId": { | 399 "clientAccountId": { |
601 "description": "The ID of the filter
set to apply.", | 400 "description": "Numerical account ID
of the client buyer\nthat the user to be retrieved is associated with. (require
d)", |
602 "format": "int64", | 401 "format": "int64", |
603 "location": "path", | 402 "location": "path", |
604 "required": true, | 403 "required": true, |
605 "type": "string" | 404 "type": "string" |
606 } | 405 } |
607 }, | 406 }, |
608 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/impressionMetrics", | 407 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", |
609 "response": { | 408 "response": { |
610 "$ref": "ListImpressionMetricsResponse" | 409 "$ref": "ClientUser" |
611 }, | 410 }, |
612 "scopes": [ | 411 "scopes": [ |
613 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 412 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
614 ] | 413 ] |
615 } | 414 }, |
616 } | |
617 }, | |
618 "bidMetrics": { | |
619 "methods": { | |
620 "list": { | 415 "list": { |
621 "description": "Lists all metrics that are m
easured in terms of number of bids.", | 416 "description": "Lists all the known client u
sers for a specified\nsponsor buyer account ID.", |
622 "httpMethod": "GET", | 417 "httpMethod": "GET", |
623 "id": "adexchangebuyer2.accounts.filterSets.
bidMetrics.list", | 418 "id": "adexchangebuyer2.accounts.clients.use
rs.list", |
624 "parameterOrder": [ | 419 "parameterOrder": [ |
625 "accountId", | 420 "accountId", |
626 "filterSetId" | 421 "clientAccountId" |
627 ], | 422 ], |
628 "parameters": { | 423 "parameters": { |
629 "pageToken": { | 424 "pageToken": { |
630 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stBidMetricsResponse.nextPageToken\nreturned from the previous call to the\nacco
unts.filterSets.bidMetrics.list\nmethod.", | 425 "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.", |
631 "location": "query", | 426 "location": "query", |
632 "type": "string" | 427 "type": "string" |
633 }, | 428 }, |
| 429 "pageSize": { |
| 430 "description": "Requested page size.
The server may return fewer clients than requested.\nIf unspecified, the server
will pick an appropriate default.", |
| 431 "format": "int32", |
| 432 "location": "query", |
| 433 "type": "integer" |
| 434 }, |
634 "accountId": { | 435 "accountId": { |
635 "description": "Account ID of the bu
yer.", | 436 "description": "Numerical account ID
of the sponsor buyer of the client to list users for.\n(required)", |
636 "format": "int64", | 437 "format": "int64", |
637 "location": "path", | 438 "location": "path", |
638 "required": true, | 439 "required": true, |
639 "type": "string" | 440 "type": "string" |
640 }, | 441 }, |
641 "pageSize": { | 442 "clientAccountId": { |
642 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", | 443 "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.", |
643 "format": "int32", | 444 "location": "path", |
644 "location": "query", | 445 "required": true, |
645 "type": "integer" | 446 "type": "string" |
| 447 } |
| 448 }, |
| 449 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users", |
| 450 "response": { |
| 451 "$ref": "ListClientUsersResponse" |
| 452 }, |
| 453 "scopes": [ |
| 454 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 455 ] |
| 456 }, |
| 457 "update": { |
| 458 "description": "Updates an existing client u
ser.\nOnly the user status can be changed on update.", |
| 459 "httpMethod": "PUT", |
| 460 "id": "adexchangebuyer2.accounts.clients.use
rs.update", |
| 461 "parameterOrder": [ |
| 462 "accountId", |
| 463 "clientAccountId", |
| 464 "userId" |
| 465 ], |
| 466 "parameters": { |
| 467 "userId": { |
| 468 "description": "Numerical identifier
of the user to retrieve. (required)", |
| 469 "format": "int64", |
| 470 "location": "path", |
| 471 "required": true, |
| 472 "type": "string" |
646 }, | 473 }, |
647 "filterSetId": { | 474 "accountId": { |
648 "description": "The ID of the filter
set to apply.", | 475 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
| 476 "format": "int64", |
| 477 "location": "path", |
| 478 "required": true, |
| 479 "type": "string" |
| 480 }, |
| 481 "clientAccountId": { |
| 482 "description": "Numerical account ID
of the client buyer that the user to be retrieved\nis associated with. (require
d)", |
649 "format": "int64", | 483 "format": "int64", |
650 "location": "path", | 484 "location": "path", |
651 "required": true, | 485 "required": true, |
652 "type": "string" | 486 "type": "string" |
653 } | 487 } |
654 }, | 488 }, |
655 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidMetrics", | 489 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", |
| 490 "request": { |
| 491 "$ref": "ClientUser" |
| 492 }, |
656 "response": { | 493 "response": { |
657 "$ref": "ListBidMetricsResponse" | 494 "$ref": "ClientUser" |
658 }, | 495 }, |
659 "scopes": [ | 496 "scopes": [ |
660 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 497 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
661 ] | |
662 } | |
663 } | |
664 }, | |
665 "bidResponseErrors": { | |
666 "methods": { | |
667 "list": { | |
668 "description": "List all errors that occurre
d in bid responses, with the number of bid\nresponses affected for each reason."
, | |
669 "httpMethod": "GET", | |
670 "id": "adexchangebuyer2.accounts.filterSets.
bidResponseErrors.list", | |
671 "parameterOrder": [ | |
672 "accountId", | |
673 "filterSetId" | |
674 ], | |
675 "parameters": { | |
676 "filterSetId": { | |
677 "description": "The ID of the filter
set to apply.", | |
678 "format": "int64", | |
679 "location": "path", | |
680 "required": true, | |
681 "type": "string" | |
682 }, | |
683 "pageToken": { | |
684 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to th
e\naccounts.filterSets.bidResponseErrors.list\nmethod.", | |
685 "location": "query", | |
686 "type": "string" | |
687 }, | |
688 "accountId": { | |
689 "description": "Account ID of the bu
yer.", | |
690 "format": "int64", | |
691 "location": "path", | |
692 "required": true, | |
693 "type": "string" | |
694 }, | |
695 "pageSize": { | |
696 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", | |
697 "format": "int32", | |
698 "location": "query", | |
699 "type": "integer" | |
700 } | |
701 }, | |
702 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidResponseErrors", | |
703 "response": { | |
704 "$ref": "ListBidResponseErrorsResponse" | |
705 }, | |
706 "scopes": [ | |
707 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
708 ] | |
709 } | |
710 } | |
711 }, | |
712 "bidResponsesWithoutBids": { | |
713 "methods": { | |
714 "list": { | |
715 "description": "List all reasons for which b
id responses were considered to have no\napplicable bids, with the number of bid
responses affected for each reason.", | |
716 "httpMethod": "GET", | |
717 "id": "adexchangebuyer2.accounts.filterSets.
bidResponsesWithoutBids.list", | |
718 "parameterOrder": [ | |
719 "accountId", | |
720 "filterSetId" | |
721 ], | |
722 "parameters": { | |
723 "filterSetId": { | |
724 "description": "The ID of the filter
set to apply.", | |
725 "format": "int64", | |
726 "location": "path", | |
727 "required": true, | |
728 "type": "string" | |
729 }, | |
730 "pageToken": { | |
731 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call
to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.", | |
732 "location": "query", | |
733 "type": "string" | |
734 }, | |
735 "accountId": { | |
736 "description": "Account ID of the bu
yer.", | |
737 "format": "int64", | |
738 "location": "path", | |
739 "required": true, | |
740 "type": "string" | |
741 }, | |
742 "pageSize": { | |
743 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", | |
744 "format": "int32", | |
745 "location": "query", | |
746 "type": "integer" | |
747 } | |
748 }, | |
749 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidResponsesWithoutBids", | |
750 "response": { | |
751 "$ref": "ListBidResponsesWithoutBidsResp
onse" | |
752 }, | |
753 "scopes": [ | |
754 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
755 ] | |
756 } | |
757 } | |
758 }, | |
759 "filteredBidRequests": { | |
760 "methods": { | |
761 "list": { | |
762 "description": "List all reasons that caused
a bid request not to be sent for an\nimpression, with the number of bid request
s not sent for each reason.", | |
763 "httpMethod": "GET", | |
764 "id": "adexchangebuyer2.accounts.filterSets.
filteredBidRequests.list", | |
765 "parameterOrder": [ | |
766 "accountId", | |
767 "filterSetId" | |
768 ], | |
769 "parameters": { | |
770 "pageToken": { | |
771 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to
the\naccounts.filterSets.filteredBidRequests.list\nmethod.", | |
772 "location": "query", | |
773 "type": "string" | |
774 }, | |
775 "accountId": { | |
776 "description": "Account ID of the bu
yer.", | |
777 "format": "int64", | |
778 "location": "path", | |
779 "required": true, | |
780 "type": "string" | |
781 }, | |
782 "pageSize": { | |
783 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", | |
784 "format": "int32", | |
785 "location": "query", | |
786 "type": "integer" | |
787 }, | |
788 "filterSetId": { | |
789 "description": "The ID of the filter
set to apply.", | |
790 "format": "int64", | |
791 "location": "path", | |
792 "required": true, | |
793 "type": "string" | |
794 } | |
795 }, | |
796 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/filteredBidRequests", | |
797 "response": { | |
798 "$ref": "ListFilteredBidRequestsResponse
" | |
799 }, | |
800 "scopes": [ | |
801 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
802 ] | 498 ] |
803 } | 499 } |
804 } | 500 } |
805 } | 501 } |
806 } | 502 } |
807 }, | 503 }, |
808 "clients": { | 504 "creatives": { |
809 "methods": { | 505 "methods": { |
810 "get": { | 506 "get": { |
811 "description": "Gets a client buyer with a given cli
ent account ID.", | 507 "description": "Gets a creative.", |
812 "httpMethod": "GET", | 508 "httpMethod": "GET", |
813 "id": "adexchangebuyer2.accounts.clients.get", | 509 "id": "adexchangebuyer2.accounts.creatives.get", |
814 "parameterOrder": [ | 510 "parameterOrder": [ |
815 "accountId", | 511 "accountId", |
816 "clientAccountId" | 512 "creativeId" |
817 ], | 513 ], |
818 "parameters": { | 514 "parameters": { |
819 "accountId": { | 515 "accountId": { |
820 "description": "Numerical account ID of the
client's sponsor buyer. (required)", | 516 "description": "The account the creative bel
ongs to.", |
821 "format": "int64", | 517 "location": "path", |
822 "location": "path", | 518 "required": true, |
823 "required": true, | 519 "type": "string" |
824 "type": "string" | 520 }, |
825 }, | 521 "creativeId": { |
826 "clientAccountId": { | 522 "description": "The ID of the creative to re
trieve.", |
827 "description": "Numerical account ID of the
client buyer to retrieve. (required)", | 523 "location": "path", |
828 "format": "int64", | 524 "required": true, |
829 "location": "path", | 525 "type": "string" |
830 "required": true, | 526 } |
831 "type": "string" | 527 }, |
832 } | 528 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}", |
833 }, | 529 "response": { |
834 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", | 530 "$ref": "Creative" |
835 "response": { | 531 }, |
836 "$ref": "Client" | 532 "scopes": [ |
| 533 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 534 ] |
| 535 }, |
| 536 "watch": { |
| 537 "description": "Watches a creative. Will result in p
ush notifications being sent to the\ntopic when the creative changes status.", |
| 538 "httpMethod": "POST", |
| 539 "id": "adexchangebuyer2.accounts.creatives.watch", |
| 540 "parameterOrder": [ |
| 541 "accountId", |
| 542 "creativeId" |
| 543 ], |
| 544 "parameters": { |
| 545 "accountId": { |
| 546 "description": "The account of the creative
to watch.", |
| 547 "location": "path", |
| 548 "required": true, |
| 549 "type": "string" |
| 550 }, |
| 551 "creativeId": { |
| 552 "description": "The creative ID to watch for
status changes.\nSpecify \"-\" to watch all creatives under the above account.\
nIf both creative-level and account-level notifications are\nsent, only a single
notification will be sent to the\ncreative-level notification topic.", |
| 553 "location": "path", |
| 554 "required": true, |
| 555 "type": "string" |
| 556 } |
| 557 }, |
| 558 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}:watch", |
| 559 "request": { |
| 560 "$ref": "WatchCreativeRequest" |
| 561 }, |
| 562 "response": { |
| 563 "$ref": "Empty" |
| 564 }, |
| 565 "scopes": [ |
| 566 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 567 ] |
| 568 }, |
| 569 "update": { |
| 570 "description": "Updates a creative.", |
| 571 "httpMethod": "PUT", |
| 572 "id": "adexchangebuyer2.accounts.creatives.update", |
| 573 "parameterOrder": [ |
| 574 "accountId", |
| 575 "creativeId" |
| 576 ], |
| 577 "parameters": { |
| 578 "accountId": { |
| 579 "description": "The account that this creati
ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho
d.", |
| 580 "location": "path", |
| 581 "required": true, |
| 582 "type": "string" |
| 583 }, |
| 584 "creativeId": { |
| 585 "description": "The buyer-defined creative I
D of this creative.\nCan be used to filter the response of the\ncreatives.list\n
method.", |
| 586 "location": "path", |
| 587 "required": true, |
| 588 "type": "string" |
| 589 } |
| 590 }, |
| 591 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}", |
| 592 "request": { |
| 593 "$ref": "Creative" |
| 594 }, |
| 595 "response": { |
| 596 "$ref": "Creative" |
837 }, | 597 }, |
838 "scopes": [ | 598 "scopes": [ |
839 "https://www.googleapis.com/auth/adexchange.buye
r" | 599 "https://www.googleapis.com/auth/adexchange.buye
r" |
840 ] | 600 ] |
841 }, | 601 }, |
842 "list": { | 602 "list": { |
843 "description": "Lists all the clients for the curren
t sponsor buyer.", | 603 "description": "Lists creatives.", |
844 "httpMethod": "GET", | 604 "httpMethod": "GET", |
845 "id": "adexchangebuyer2.accounts.clients.list", | 605 "id": "adexchangebuyer2.accounts.creatives.list", |
846 "parameterOrder": [ | 606 "parameterOrder": [ |
847 "accountId" | 607 "accountId" |
848 ], | 608 ], |
849 "parameters": { | 609 "parameters": { |
850 "accountId": { | 610 "pageToken": { |
851 "description": "Unique numerical account ID
of the sponsor buyer to list the clients for.", | 611 "description": "A token identifying a page o
f results the server should return.\nTypically, this is the value of\nListCreati
vesResponse.next_page_token\nreturned from the previous call to 'ListCreatives'
method.", |
852 "format": "int64", | 612 "location": "query", |
853 "location": "path", | |
854 "required": true, | |
855 "type": "string" | 613 "type": "string" |
856 }, | 614 }, |
857 "pageSize": { | 615 "pageSize": { |
858 "description": "Requested page size. The ser
ver may return fewer clients than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 616 "description": "Requested page size. The ser
ver may return fewer creatives than requested\n(due to timeout constraint) even
if more are available via another call.\nIf unspecified, server will pick an app
ropriate default.\nAcceptable values are 1 to 1000, inclusive.", |
859 "format": "int32", | 617 "format": "int32", |
860 "location": "query", | 618 "location": "query", |
861 "type": "integer" | 619 "type": "integer" |
862 }, | 620 }, |
863 "pageToken": { | 621 "accountId": { |
864 "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.", | 622 "description": "The account to list the crea
tives from.\nSpecify \"-\" to list all creatives the current user has access to.
", |
| 623 "location": "path", |
| 624 "required": true, |
| 625 "type": "string" |
| 626 }, |
| 627 "query": { |
| 628 "description": "An optional query string to
filter creatives. If no filter is specified,\nall active creatives will be retur
ned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>
creativeId=<i>creative_id_string</i>\n<li>dealsStatus: {approved, conditionally_
approved, disapproved,\n not_checked}\n<li>openAuctionStatus:
{approved, conditionally_approved, disapproved,\n not_c
hecked}\n<li>attribute: {a numeric attribute from the list of attributes}\n<li>d
isapprovalReason: {a reason from DisapprovalReason\n</ul>\nExample: 'accountId=1
2345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR
attribute:47'", |
865 "location": "query", | 629 "location": "query", |
866 "type": "string" | 630 "type": "string" |
867 } | 631 } |
868 }, | 632 }, |
869 "path": "v2beta1/accounts/{accountId}/clients", | 633 "path": "v2beta1/accounts/{accountId}/creatives", |
870 "response": { | 634 "response": { |
871 "$ref": "ListClientsResponse" | 635 "$ref": "ListCreativesResponse" |
872 }, | 636 }, |
873 "scopes": [ | 637 "scopes": [ |
874 "https://www.googleapis.com/auth/adexchange.buye
r" | 638 "https://www.googleapis.com/auth/adexchange.buye
r" |
875 ] | 639 ] |
876 }, | 640 }, |
877 "update": { | 641 "create": { |
878 "description": "Updates an existing client buyer.", | 642 "description": "Creates a creative.", |
879 "httpMethod": "PUT", | 643 "httpMethod": "POST", |
880 "id": "adexchangebuyer2.accounts.clients.update", | 644 "id": "adexchangebuyer2.accounts.creatives.create", |
| 645 "parameterOrder": [ |
| 646 "accountId" |
| 647 ], |
| 648 "parameters": { |
| 649 "duplicateIdMode": { |
| 650 "description": "Indicates if multiple creati
ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).", |
| 651 "enum": [ |
| 652 "NO_DUPLICATES", |
| 653 "FORCE_ENABLE_DUPLICATE_IDS" |
| 654 ], |
| 655 "location": "query", |
| 656 "type": "string" |
| 657 }, |
| 658 "accountId": { |
| 659 "description": "The account that this creati
ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho
d.", |
| 660 "location": "path", |
| 661 "required": true, |
| 662 "type": "string" |
| 663 } |
| 664 }, |
| 665 "path": "v2beta1/accounts/{accountId}/creatives", |
| 666 "request": { |
| 667 "$ref": "Creative" |
| 668 }, |
| 669 "response": { |
| 670 "$ref": "Creative" |
| 671 }, |
| 672 "scopes": [ |
| 673 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 674 ] |
| 675 }, |
| 676 "stopWatching": { |
| 677 "description": "Stops watching a creative. Will stop
push notifications being sent to the\ntopics when the creative changes status."
, |
| 678 "httpMethod": "POST", |
| 679 "id": "adexchangebuyer2.accounts.creatives.stopWatch
ing", |
881 "parameterOrder": [ | 680 "parameterOrder": [ |
882 "accountId", | 681 "accountId", |
883 "clientAccountId" | 682 "creativeId" |
884 ], | 683 ], |
885 "parameters": { | 684 "parameters": { |
886 "accountId": { | 685 "creativeId": { |
887 "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)", | 686 "description": "The creative ID of the creat
ive to stop notifications for.\nSpecify \"-\" to specify stopping account level
notifications.", |
888 "format": "int64", | 687 "location": "path", |
889 "location": "path", | 688 "required": true, |
890 "required": true, | 689 "type": "string" |
891 "type": "string" | 690 }, |
892 }, | 691 "accountId": { |
893 "clientAccountId": { | 692 "description": "The account of the creative
to stop notifications for.", |
894 "description": "Unique numerical account ID
of the client to update. (required)", | 693 "location": "path", |
895 "format": "int64", | 694 "required": true, |
896 "location": "path", | 695 "type": "string" |
897 "required": true, | 696 } |
898 "type": "string" | 697 }, |
899 } | 698 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}:stopWatching", |
900 }, | |
901 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", | |
902 "request": { | 699 "request": { |
903 "$ref": "Client" | 700 "$ref": "StopWatchingCreativeRequest" |
904 }, | 701 }, |
905 "response": { | 702 "response": { |
906 "$ref": "Client" | 703 "$ref": "Empty" |
907 }, | |
908 "scopes": [ | |
909 "https://www.googleapis.com/auth/adexchange.buye
r" | |
910 ] | |
911 }, | |
912 "create": { | |
913 "description": "Creates a new client buyer.", | |
914 "httpMethod": "POST", | |
915 "id": "adexchangebuyer2.accounts.clients.create", | |
916 "parameterOrder": [ | |
917 "accountId" | |
918 ], | |
919 "parameters": { | |
920 "accountId": { | |
921 "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)", | |
922 "format": "int64", | |
923 "location": "path", | |
924 "required": true, | |
925 "type": "string" | |
926 } | |
927 }, | |
928 "path": "v2beta1/accounts/{accountId}/clients", | |
929 "request": { | |
930 "$ref": "Client" | |
931 }, | |
932 "response": { | |
933 "$ref": "Client" | |
934 }, | 704 }, |
935 "scopes": [ | 705 "scopes": [ |
936 "https://www.googleapis.com/auth/adexchange.buye
r" | 706 "https://www.googleapis.com/auth/adexchange.buye
r" |
937 ] | 707 ] |
938 } | 708 } |
939 }, | 709 }, |
940 "resources": { | 710 "resources": { |
941 "invitations": { | 711 "dealAssociations": { |
942 "methods": { | 712 "methods": { |
943 "create": { | 713 "remove": { |
944 "description": "Creates and sends out an ema
il invitation to access\nan Ad Exchange client buyer account.", | 714 "description": "Remove the association betwe
en a deal and a creative.", |
945 "httpMethod": "POST", | 715 "httpMethod": "POST", |
946 "id": "adexchangebuyer2.accounts.clients.inv
itations.create", | 716 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.remove", |
947 "parameterOrder": [ | 717 "parameterOrder": [ |
948 "accountId", | 718 "accountId", |
949 "clientAccountId" | 719 "creativeId" |
950 ], | 720 ], |
951 "parameters": { | 721 "parameters": { |
952 "accountId": { | 722 "accountId": { |
953 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | 723 "description": "The account the crea
tive belongs to.", |
954 "format": "int64", | 724 "location": "path", |
955 "location": "path", | 725 "required": true, |
956 "required": true, | 726 "type": "string" |
957 "type": "string" | 727 }, |
958 }, | 728 "creativeId": { |
959 "clientAccountId": { | 729 "description": "The ID of the creati
ve associated with the deal.", |
960 "description": "Numerical account ID
of the client buyer that the user\nshould be associated with. (required)", | |
961 "format": "int64", | |
962 "location": "path", | 730 "location": "path", |
963 "required": true, | 731 "required": true, |
964 "type": "string" | 732 "type": "string" |
965 } | 733 } |
966 }, | 734 }, |
967 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", | 735 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations:remove", |
968 "request": { | 736 "request": { |
969 "$ref": "ClientUserInvitation" | 737 "$ref": "RemoveDealAssociationRequest" |
970 }, | 738 }, |
971 "response": { | 739 "response": { |
972 "$ref": "ClientUserInvitation" | 740 "$ref": "Empty" |
973 }, | 741 }, |
974 "scopes": [ | 742 "scopes": [ |
975 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 743 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
976 ] | 744 ] |
977 }, | 745 }, |
978 "get": { | 746 "add": { |
979 "description": "Retrieves an existing client
user invitation.", | 747 "description": "Associate an existing deal w
ith a creative.", |
980 "httpMethod": "GET", | 748 "httpMethod": "POST", |
981 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", | 749 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.add", |
982 "parameterOrder": [ | 750 "parameterOrder": [ |
983 "accountId", | 751 "accountId", |
984 "clientAccountId", | 752 "creativeId" |
985 "invitationId" | |
986 ], | 753 ], |
987 "parameters": { | 754 "parameters": { |
988 "invitationId": { | |
989 "description": "Numerical identifier
of the user invitation to retrieve. (required)", | |
990 "format": "int64", | |
991 "location": "path", | |
992 "required": true, | |
993 "type": "string" | |
994 }, | |
995 "accountId": { | 755 "accountId": { |
996 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | 756 "description": "The account the crea
tive belongs to.", |
997 "format": "int64", | 757 "location": "path", |
998 "location": "path", | 758 "required": true, |
999 "required": true, | 759 "type": "string" |
1000 "type": "string" | 760 }, |
1001 }, | 761 "creativeId": { |
1002 "clientAccountId": { | 762 "description": "The ID of the creati
ve associated with the deal.", |
1003 "description": "Numerical account ID
of the client buyer that the user invitation\nto be retrieved is associated wit
h. (required)", | |
1004 "format": "int64", | |
1005 "location": "path", | 763 "location": "path", |
1006 "required": true, | 764 "required": true, |
1007 "type": "string" | 765 "type": "string" |
1008 } | 766 } |
1009 }, | 767 }, |
1010 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations/{invitationId}", | 768 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations:add", |
| 769 "request": { |
| 770 "$ref": "AddDealAssociationRequest" |
| 771 }, |
1011 "response": { | 772 "response": { |
1012 "$ref": "ClientUserInvitation" | 773 "$ref": "Empty" |
1013 }, | 774 }, |
1014 "scopes": [ | 775 "scopes": [ |
1015 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 776 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
1016 ] | 777 ] |
1017 }, | 778 }, |
1018 "list": { | 779 "list": { |
1019 "description": "Lists all the client users i
nvitations for a client\nwith a given account ID.", | 780 "description": "List all creative-deal assoc
iations.", |
1020 "httpMethod": "GET", | 781 "httpMethod": "GET", |
1021 "id": "adexchangebuyer2.accounts.clients.inv
itations.list", | 782 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.list", |
1022 "parameterOrder": [ | 783 "parameterOrder": [ |
1023 "accountId", | 784 "accountId", |
1024 "clientAccountId" | 785 "creativeId" |
1025 ], | 786 ], |
1026 "parameters": { | 787 "parameters": { |
| 788 "creativeId": { |
| 789 "description": "The creative ID to l
ist the associations from.\nSpecify \"-\" to list all creatives under the above
account.", |
| 790 "location": "path", |
| 791 "required": true, |
| 792 "type": "string" |
| 793 }, |
1027 "pageToken": { | 794 "pageToken": { |
1028 "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.", | 795 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stDealAssociationsResponse.next_page_token\nreturned from the previous call to '
ListDealAssociations' method.", |
1029 "location": "query", | 796 "location": "query", |
1030 "type": "string" | 797 "type": "string" |
1031 }, | 798 }, |
1032 "accountId": { | |
1033 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
1034 "format": "int64", | |
1035 "location": "path", | |
1036 "required": true, | |
1037 "type": "string" | |
1038 }, | |
1039 "pageSize": { | 799 "pageSize": { |
1040 "description": "Requested page size.
Server may return fewer clients than requested.\nIf unspecified, server will pi
ck an appropriate default.", | 800 "description": "Requested page size.
Server may return fewer associations than requested.\nIf unspecified, server wi
ll pick an appropriate default.", |
1041 "format": "int32", | 801 "format": "int32", |
1042 "location": "query", | 802 "location": "query", |
1043 "type": "integer" | 803 "type": "integer" |
1044 }, | 804 }, |
1045 "clientAccountId": { | 805 "accountId": { |
1046 "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.", | 806 "description": "The account to list
the associations from.\nSpecify \"-\" to list all creatives the current user has
access to.", |
1047 "location": "path", | 807 "location": "path", |
1048 "required": true, | 808 "required": true, |
| 809 "type": "string" |
| 810 }, |
| 811 "query": { |
| 812 "description": "An optional query st
ring to filter deal associations. If no filter is\nspecified, all associations w
ill be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_stri
ng</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsId=<i>deals_id_string
</i>\n<li>dealsStatus:{approved, conditionally_approved, disapproved,\n
not_checked}\n<li>openAuctionStatus:{approved, conditionally_approved,
disapproved,\n not_checked}\n</ul>\nExample: 'dealsId=12
345 AND dealsStatus:disapproved'", |
| 813 "location": "query", |
1049 "type": "string" | 814 "type": "string" |
1050 } | 815 } |
1051 }, | 816 }, |
1052 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", | 817 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations", |
1053 "response": { | 818 "response": { |
1054 "$ref": "ListClientUserInvitationsRespon
se" | 819 "$ref": "ListDealAssociationsResponse" |
1055 }, | 820 }, |
1056 "scopes": [ | 821 "scopes": [ |
1057 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 822 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
1058 ] | |
1059 } | |
1060 } | |
1061 }, | |
1062 "users": { | |
1063 "methods": { | |
1064 "update": { | |
1065 "description": "Updates an existing client u
ser.\nOnly the user status can be changed on update.", | |
1066 "httpMethod": "PUT", | |
1067 "id": "adexchangebuyer2.accounts.clients.use
rs.update", | |
1068 "parameterOrder": [ | |
1069 "accountId", | |
1070 "clientAccountId", | |
1071 "userId" | |
1072 ], | |
1073 "parameters": { | |
1074 "userId": { | |
1075 "description": "Numerical identifier
of the user to retrieve. (required)", | |
1076 "format": "int64", | |
1077 "location": "path", | |
1078 "required": true, | |
1079 "type": "string" | |
1080 }, | |
1081 "accountId": { | |
1082 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
1083 "format": "int64", | |
1084 "location": "path", | |
1085 "required": true, | |
1086 "type": "string" | |
1087 }, | |
1088 "clientAccountId": { | |
1089 "description": "Numerical account ID
of the client buyer that the user to be retrieved\nis associated with. (require
d)", | |
1090 "format": "int64", | |
1091 "location": "path", | |
1092 "required": true, | |
1093 "type": "string" | |
1094 } | |
1095 }, | |
1096 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", | |
1097 "request": { | |
1098 "$ref": "ClientUser" | |
1099 }, | |
1100 "response": { | |
1101 "$ref": "ClientUser" | |
1102 }, | |
1103 "scopes": [ | |
1104 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
1105 ] | |
1106 }, | |
1107 "list": { | |
1108 "description": "Lists all the known client u
sers for a specified\nsponsor buyer account ID.", | |
1109 "httpMethod": "GET", | |
1110 "id": "adexchangebuyer2.accounts.clients.use
rs.list", | |
1111 "parameterOrder": [ | |
1112 "accountId", | |
1113 "clientAccountId" | |
1114 ], | |
1115 "parameters": { | |
1116 "pageToken": { | |
1117 "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.", | |
1118 "location": "query", | |
1119 "type": "string" | |
1120 }, | |
1121 "accountId": { | |
1122 "description": "Numerical account ID
of the sponsor buyer of the client to list users for.\n(required)", | |
1123 "format": "int64", | |
1124 "location": "path", | |
1125 "required": true, | |
1126 "type": "string" | |
1127 }, | |
1128 "pageSize": { | |
1129 "description": "Requested page size.
The server may return fewer clients than requested.\nIf unspecified, the server
will pick an appropriate default.", | |
1130 "format": "int32", | |
1131 "location": "query", | |
1132 "type": "integer" | |
1133 }, | |
1134 "clientAccountId": { | |
1135 "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.", | |
1136 "location": "path", | |
1137 "required": true, | |
1138 "type": "string" | |
1139 } | |
1140 }, | |
1141 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users", | |
1142 "response": { | |
1143 "$ref": "ListClientUsersResponse" | |
1144 }, | |
1145 "scopes": [ | |
1146 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
1147 ] | |
1148 }, | |
1149 "get": { | |
1150 "description": "Retrieves an existing client
user.", | |
1151 "httpMethod": "GET", | |
1152 "id": "adexchangebuyer2.accounts.clients.use
rs.get", | |
1153 "parameterOrder": [ | |
1154 "accountId", | |
1155 "clientAccountId", | |
1156 "userId" | |
1157 ], | |
1158 "parameters": { | |
1159 "userId": { | |
1160 "description": "Numerical identifier
of the user to retrieve. (required)", | |
1161 "format": "int64", | |
1162 "location": "path", | |
1163 "required": true, | |
1164 "type": "string" | |
1165 }, | |
1166 "accountId": { | |
1167 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
1168 "format": "int64", | |
1169 "location": "path", | |
1170 "required": true, | |
1171 "type": "string" | |
1172 }, | |
1173 "clientAccountId": { | |
1174 "description": "Numerical account ID
of the client buyer\nthat the user to be retrieved is associated with. (require
d)", | |
1175 "format": "int64", | |
1176 "location": "path", | |
1177 "required": true, | |
1178 "type": "string" | |
1179 } | |
1180 }, | |
1181 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", | |
1182 "response": { | |
1183 "$ref": "ClientUser" | |
1184 }, | |
1185 "scopes": [ | |
1186 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
1187 ] | 823 ] |
1188 } | 824 } |
1189 } | 825 } |
1190 } | 826 } |
1191 } | 827 } |
1192 }, | 828 }, |
1193 "creatives": { | 829 "filterSets": { |
1194 "methods": { | 830 "methods": { |
1195 "create": { | 831 "delete": { |
1196 "description": "Creates a creative.", | 832 "description": "Deletes the requested filter set fro
m the account with the given account\nID.", |
1197 "httpMethod": "POST", | 833 "httpMethod": "DELETE", |
1198 "id": "adexchangebuyer2.accounts.creatives.create", | 834 "id": "adexchangebuyer2.accounts.filterSets.delete", |
1199 "parameterOrder": [ | 835 "parameterOrder": [ |
1200 "accountId" | 836 "accountId", |
| 837 "filterSetId" |
1201 ], | 838 ], |
1202 "parameters": { | 839 "parameters": { |
1203 "duplicateIdMode": { | 840 "accountId": { |
1204 "description": "Indicates if multiple creati
ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).", | 841 "description": "Account ID of the buyer.", |
1205 "enum": [ | 842 "format": "int64", |
1206 "NO_DUPLICATES", | 843 "location": "path", |
1207 "FORCE_ENABLE_DUPLICATE_IDS" | 844 "required": true, |
1208 ], | |
1209 "location": "query", | |
1210 "type": "string" | 845 "type": "string" |
1211 }, | 846 }, |
1212 "accountId": { | 847 "filterSetId": { |
1213 "description": "The account that this creati
ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho
d.", | 848 "description": "The ID of the filter set to
delete.", |
| 849 "format": "int64", |
1214 "location": "path", | 850 "location": "path", |
1215 "required": true, | 851 "required": true, |
1216 "type": "string" | 852 "type": "string" |
1217 } | 853 } |
1218 }, | 854 }, |
1219 "path": "v2beta1/accounts/{accountId}/creatives", | 855 "path": "v2beta1/accounts/{accountId}/filterSets/{fi
lterSetId}", |
1220 "request": { | |
1221 "$ref": "Creative" | |
1222 }, | |
1223 "response": { | |
1224 "$ref": "Creative" | |
1225 }, | |
1226 "scopes": [ | |
1227 "https://www.googleapis.com/auth/adexchange.buye
r" | |
1228 ] | |
1229 }, | |
1230 "stopWatching": { | |
1231 "description": "Stops watching a creative. Will stop
push notifications being sent to the\ntopics when the creative changes status."
, | |
1232 "httpMethod": "POST", | |
1233 "id": "adexchangebuyer2.accounts.creatives.stopWatch
ing", | |
1234 "parameterOrder": [ | |
1235 "accountId", | |
1236 "creativeId" | |
1237 ], | |
1238 "parameters": { | |
1239 "accountId": { | |
1240 "description": "The account of the creative
to stop notifications for.", | |
1241 "location": "path", | |
1242 "required": true, | |
1243 "type": "string" | |
1244 }, | |
1245 "creativeId": { | |
1246 "description": "The creative ID of the creat
ive to stop notifications for.\nSpecify \"-\" to specify stopping account level
notifications.", | |
1247 "location": "path", | |
1248 "required": true, | |
1249 "type": "string" | |
1250 } | |
1251 }, | |
1252 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}:stopWatching", | |
1253 "request": { | |
1254 "$ref": "StopWatchingCreativeRequest" | |
1255 }, | |
1256 "response": { | 856 "response": { |
1257 "$ref": "Empty" | 857 "$ref": "Empty" |
1258 }, | 858 }, |
1259 "scopes": [ | 859 "scopes": [ |
1260 "https://www.googleapis.com/auth/adexchange.buye
r" | 860 "https://www.googleapis.com/auth/adexchange.buye
r" |
1261 ] | 861 ] |
1262 }, | 862 }, |
1263 "get": { | 863 "list": { |
1264 "description": "Gets a creative.", | 864 "description": "Lists all filter sets for the accoun
t with the given account ID.", |
1265 "httpMethod": "GET", | 865 "httpMethod": "GET", |
1266 "id": "adexchangebuyer2.accounts.creatives.get", | 866 "id": "adexchangebuyer2.accounts.filterSets.list", |
1267 "parameterOrder": [ | 867 "parameterOrder": [ |
1268 "accountId", | 868 "accountId" |
1269 "creativeId" | |
1270 ], | 869 ], |
1271 "parameters": { | 870 "parameters": { |
1272 "accountId": { | 871 "pageToken": { |
1273 "description": "The account the creative bel
ongs to.", | 872 "description": "A token identifying a page o
f results the server should return.\nTypically, this is the value of\nListFilter
SetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.fil
terSets.list\nmethod.", |
1274 "location": "path", | 873 "location": "query", |
1275 "required": true, | |
1276 "type": "string" | 874 "type": "string" |
1277 }, | 875 }, |
1278 "creativeId": { | 876 "pageSize": { |
1279 "description": "The ID of the creative to re
trieve.", | 877 "description": "Requested page size. The ser
ver may return fewer results than requested.\nIf unspecified, the server will pi
ck an appropriate default.", |
| 878 "format": "int32", |
| 879 "location": "query", |
| 880 "type": "integer" |
| 881 }, |
| 882 "accountId": { |
| 883 "description": "Account ID of the buyer.", |
| 884 "format": "int64", |
1280 "location": "path", | 885 "location": "path", |
1281 "required": true, | 886 "required": true, |
1282 "type": "string" | 887 "type": "string" |
1283 } | 888 } |
1284 }, | 889 }, |
1285 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}", | 890 "path": "v2beta1/accounts/{accountId}/filterSets", |
1286 "response": { | 891 "response": { |
1287 "$ref": "Creative" | 892 "$ref": "ListFilterSetsResponse" |
1288 }, | 893 }, |
1289 "scopes": [ | 894 "scopes": [ |
1290 "https://www.googleapis.com/auth/adexchange.buye
r" | 895 "https://www.googleapis.com/auth/adexchange.buye
r" |
1291 ] | 896 ] |
1292 }, | 897 }, |
1293 "watch": { | 898 "get": { |
1294 "description": "Watches a creative. Will result in p
ush notifications being sent to the\ntopic when the creative changes status.", | 899 "description": "Retrieves the requested filter set f
or the account with the given account\nID.", |
1295 "httpMethod": "POST", | 900 "httpMethod": "GET", |
1296 "id": "adexchangebuyer2.accounts.creatives.watch", | 901 "id": "adexchangebuyer2.accounts.filterSets.get", |
1297 "parameterOrder": [ | 902 "parameterOrder": [ |
1298 "accountId", | 903 "accountId", |
1299 "creativeId" | 904 "filterSetId" |
1300 ], | 905 ], |
1301 "parameters": { | 906 "parameters": { |
1302 "accountId": { | 907 "filterSetId": { |
1303 "description": "The account of the creative
to watch.", | 908 "description": "The ID of the filter set to
get.", |
| 909 "format": "int64", |
1304 "location": "path", | 910 "location": "path", |
1305 "required": true, | 911 "required": true, |
1306 "type": "string" | 912 "type": "string" |
1307 }, | 913 }, |
1308 "creativeId": { | 914 "accountId": { |
1309 "description": "The creative ID to watch for
status changes.\nSpecify \"-\" to watch all creatives under the above account.\
nIf both creative-level and account-level notifications are\nsent, only a single
notification will be sent to the\ncreative-level notification topic.", | 915 "description": "Account ID of the buyer.", |
| 916 "format": "int64", |
1310 "location": "path", | 917 "location": "path", |
1311 "required": true, | 918 "required": true, |
1312 "type": "string" | 919 "type": "string" |
1313 } | 920 } |
1314 }, | 921 }, |
1315 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}:watch", | 922 "path": "v2beta1/accounts/{accountId}/filterSets/{fi
lterSetId}", |
1316 "request": { | |
1317 "$ref": "WatchCreativeRequest" | |
1318 }, | |
1319 "response": { | 923 "response": { |
1320 "$ref": "Empty" | 924 "$ref": "FilterSet" |
1321 }, | 925 }, |
1322 "scopes": [ | 926 "scopes": [ |
1323 "https://www.googleapis.com/auth/adexchange.buye
r" | 927 "https://www.googleapis.com/auth/adexchange.buye
r" |
1324 ] | 928 ] |
1325 }, | 929 }, |
1326 "update": { | 930 "create": { |
1327 "description": "Updates a creative.", | 931 "description": "Creates the specified filter set for
the account with the given account ID.", |
1328 "httpMethod": "PUT", | 932 "httpMethod": "POST", |
1329 "id": "adexchangebuyer2.accounts.creatives.update", | 933 "id": "adexchangebuyer2.accounts.filterSets.create", |
1330 "parameterOrder": [ | 934 "parameterOrder": [ |
1331 "accountId", | 935 "accountId" |
1332 "creativeId" | |
1333 ], | 936 ], |
1334 "parameters": { | 937 "parameters": { |
1335 "creativeId": { | 938 "isTransient": { |
1336 "description": "The buyer-defined creative I
D of this creative.\nCan be used to filter the response of the\ncreatives.list\n
method.", | 939 "description": "Whether the filter set is tr
ansient, or should be persisted indefinitely.\nBy default, filter sets are not t
ransient.\nIf transient, it will be available for at least 1 hour after creation
.", |
1337 "location": "path", | 940 "location": "query", |
1338 "required": true, | 941 "type": "boolean" |
1339 "type": "string" | |
1340 }, | 942 }, |
1341 "accountId": { | 943 "accountId": { |
1342 "description": "The account that this creati
ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho
d.", | 944 "description": "Account ID of the buyer.", |
| 945 "format": "int64", |
1343 "location": "path", | 946 "location": "path", |
1344 "required": true, | 947 "required": true, |
1345 "type": "string" | 948 "type": "string" |
1346 } | 949 } |
1347 }, | 950 }, |
1348 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}", | 951 "path": "v2beta1/accounts/{accountId}/filterSets", |
1349 "request": { | 952 "request": { |
1350 "$ref": "Creative" | 953 "$ref": "FilterSet" |
1351 }, | 954 }, |
1352 "response": { | 955 "response": { |
1353 "$ref": "Creative" | 956 "$ref": "FilterSet" |
1354 }, | 957 }, |
1355 "scopes": [ | 958 "scopes": [ |
1356 "https://www.googleapis.com/auth/adexchange.buye
r" | 959 "https://www.googleapis.com/auth/adexchange.buye
r" |
1357 ] | |
1358 }, | |
1359 "list": { | |
1360 "description": "Lists creatives.", | |
1361 "httpMethod": "GET", | |
1362 "id": "adexchangebuyer2.accounts.creatives.list", | |
1363 "parameterOrder": [ | |
1364 "accountId" | |
1365 ], | |
1366 "parameters": { | |
1367 "pageToken": { | |
1368 "description": "A token identifying a page o
f results the server should return.\nTypically, this is the value of\nListCreati
vesResponse.next_page_token\nreturned from the previous call to 'ListCreatives'
method.", | |
1369 "location": "query", | |
1370 "type": "string" | |
1371 }, | |
1372 "accountId": { | |
1373 "description": "The account to list the crea
tives from.\nSpecify \"-\" to list all creatives the current user has access to.
", | |
1374 "location": "path", | |
1375 "required": true, | |
1376 "type": "string" | |
1377 }, | |
1378 "pageSize": { | |
1379 "description": "Requested page size. The ser
ver may return fewer creatives than requested\n(due to timeout constraint) even
if more are available via another call.\nIf unspecified, server will pick an app
ropriate default.\nAcceptable values are 1 to 1000, inclusive.", | |
1380 "format": "int32", | |
1381 "location": "query", | |
1382 "type": "integer" | |
1383 }, | |
1384 "query": { | |
1385 "description": "An optional query string to
filter creatives. If no filter is specified,\nall active creatives will be retur
ned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li>
creativeId=<i>creative_id_string</i>\n<li>dealsStatus: {approved, conditionally_
approved, disapproved,\n not_checked}\n<li>openAuctionStatus:
{approved, conditionally_approved, disapproved,\n not_c
hecked}\n<li>attribute: {a numeric attribute from the list of attributes}\n<li>d
isapprovalReason: {a reason from DisapprovalReason\n</ul>\nExample: 'accountId=1
2345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR
attribute:47'", | |
1386 "location": "query", | |
1387 "type": "string" | |
1388 } | |
1389 }, | |
1390 "path": "v2beta1/accounts/{accountId}/creatives", | |
1391 "response": { | |
1392 "$ref": "ListCreativesResponse" | |
1393 }, | |
1394 "scopes": [ | |
1395 "https://www.googleapis.com/auth/adexchange.buye
r" | |
1396 ] | 960 ] |
1397 } | 961 } |
1398 }, | 962 }, |
1399 "resources": { | 963 "resources": { |
1400 "dealAssociations": { | 964 "filteredBidRequests": { |
1401 "methods": { | 965 "methods": { |
1402 "add": { | 966 "list": { |
1403 "description": "Associate an existing deal w
ith a creative.", | 967 "description": "List all reasons that caused
a bid request not to be sent for an\nimpression, with the number of bid request
s not sent for each reason.", |
1404 "httpMethod": "POST", | 968 "httpMethod": "GET", |
1405 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.add", | 969 "id": "adexchangebuyer2.accounts.filterSets.
filteredBidRequests.list", |
1406 "parameterOrder": [ | 970 "parameterOrder": [ |
1407 "accountId", | 971 "accountId", |
1408 "creativeId" | 972 "filterSetId" |
1409 ], | 973 ], |
1410 "parameters": { | 974 "parameters": { |
1411 "accountId": { | 975 "filterSetId": { |
1412 "description": "The account the crea
tive belongs to.", | 976 "description": "The ID of the filter
set to apply.", |
1413 "location": "path", | 977 "format": "int64", |
1414 "required": true, | 978 "location": "path", |
1415 "type": "string" | 979 "required": true, |
1416 }, | 980 "type": "string" |
1417 "creativeId": { | 981 }, |
1418 "description": "The ID of the creati
ve associated with the deal.", | 982 "pageToken": { |
1419 "location": "path", | 983 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to
the\naccounts.filterSets.filteredBidRequests.list\nmethod.", |
1420 "required": true, | 984 "location": "query", |
1421 "type": "string" | 985 "type": "string" |
1422 } | 986 }, |
1423 }, | 987 "pageSize": { |
1424 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations:add", | 988 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
1425 "request": { | 989 "format": "int32", |
1426 "$ref": "AddDealAssociationRequest" | 990 "location": "query", |
1427 }, | 991 "type": "integer" |
1428 "response": { | 992 }, |
1429 "$ref": "Empty" | 993 "accountId": { |
1430 }, | 994 "description": "Account ID of the bu
yer.", |
1431 "scopes": [ | 995 "format": "int64", |
1432 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 996 "location": "path", |
1433 ] | 997 "required": true, |
| 998 "type": "string" |
| 999 } |
| 1000 }, |
| 1001 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/filteredBidRequests", |
| 1002 "response": { |
| 1003 "$ref": "ListFilteredBidRequestsResponse
" |
| 1004 }, |
| 1005 "scopes": [ |
| 1006 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 1007 ] |
| 1008 } |
| 1009 } |
| 1010 }, |
| 1011 "nonBillableWinningBids": { |
| 1012 "methods": { |
| 1013 "list": { |
| 1014 "description": "List all reasons for which w
inning bids were not billable, with the number\nof bids not billed for each reas
on.", |
| 1015 "httpMethod": "GET", |
| 1016 "id": "adexchangebuyer2.accounts.filterSets.
nonBillableWinningBids.list", |
| 1017 "parameterOrder": [ |
| 1018 "accountId", |
| 1019 "filterSetId" |
| 1020 ], |
| 1021 "parameters": { |
| 1022 "pageToken": { |
| 1023 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call
to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.", |
| 1024 "location": "query", |
| 1025 "type": "string" |
| 1026 }, |
| 1027 "pageSize": { |
| 1028 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
| 1029 "format": "int32", |
| 1030 "location": "query", |
| 1031 "type": "integer" |
| 1032 }, |
| 1033 "accountId": { |
| 1034 "description": "Account ID of the bu
yer.", |
| 1035 "format": "int64", |
| 1036 "location": "path", |
| 1037 "required": true, |
| 1038 "type": "string" |
| 1039 }, |
| 1040 "filterSetId": { |
| 1041 "description": "The ID of the filter
set to apply.", |
| 1042 "format": "int64", |
| 1043 "location": "path", |
| 1044 "required": true, |
| 1045 "type": "string" |
| 1046 } |
| 1047 }, |
| 1048 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/nonBillableWinningBids", |
| 1049 "response": { |
| 1050 "$ref": "ListNonBillableWinningBidsRespo
nse" |
| 1051 }, |
| 1052 "scopes": [ |
| 1053 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 1054 ] |
| 1055 } |
| 1056 } |
| 1057 }, |
| 1058 "filteredBids": { |
| 1059 "methods": { |
| 1060 "list": { |
| 1061 "description": "List all reasons for which b
ids were filtered, with the number of bids\nfiltered for each reason.", |
| 1062 "httpMethod": "GET", |
| 1063 "id": "adexchangebuyer2.accounts.filterSets.
filteredBids.list", |
| 1064 "parameterOrder": [ |
| 1065 "accountId", |
| 1066 "filterSetId" |
| 1067 ], |
| 1068 "parameters": { |
| 1069 "pageToken": { |
| 1070 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\nac
counts.filterSets.filteredBids.list\nmethod.", |
| 1071 "location": "query", |
| 1072 "type": "string" |
| 1073 }, |
| 1074 "pageSize": { |
| 1075 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
| 1076 "format": "int32", |
| 1077 "location": "query", |
| 1078 "type": "integer" |
| 1079 }, |
| 1080 "accountId": { |
| 1081 "description": "Account ID of the bu
yer.", |
| 1082 "format": "int64", |
| 1083 "location": "path", |
| 1084 "required": true, |
| 1085 "type": "string" |
| 1086 }, |
| 1087 "filterSetId": { |
| 1088 "description": "The ID of the filter
set to apply.", |
| 1089 "format": "int64", |
| 1090 "location": "path", |
| 1091 "required": true, |
| 1092 "type": "string" |
| 1093 } |
| 1094 }, |
| 1095 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/filteredBids", |
| 1096 "response": { |
| 1097 "$ref": "ListFilteredBidsResponse" |
| 1098 }, |
| 1099 "scopes": [ |
| 1100 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 1101 ] |
| 1102 } |
| 1103 }, |
| 1104 "resources": { |
| 1105 "details": { |
| 1106 "methods": { |
| 1107 "list": { |
| 1108 "description": "List all details ass
ociated with a specific reason for which bids were\nfiltered, with the number of
bids filtered for each detail.", |
| 1109 "httpMethod": "GET", |
| 1110 "id": "adexchangebuyer2.accounts.fil
terSets.filteredBids.details.list", |
| 1111 "parameterOrder": [ |
| 1112 "accountId", |
| 1113 "filterSetId", |
| 1114 "creativeStatusId" |
| 1115 ], |
| 1116 "parameters": { |
| 1117 "filterSetId": { |
| 1118 "description": "The ID of th
e filter set to apply.", |
| 1119 "format": "int64", |
| 1120 "location": "path", |
| 1121 "required": true, |
| 1122 "type": "string" |
| 1123 }, |
| 1124 "pageToken": { |
| 1125 "description": "A token iden
tifying a page of results the server should return.\nTypically, this is the valu
e of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from t
he previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod."
, |
| 1126 "location": "query", |
| 1127 "type": "string" |
| 1128 }, |
| 1129 "creativeStatusId": { |
| 1130 "description": "The ID of th
e creative status for which to retrieve a breakdown by detail.\nSee\n[creative-s
tatus-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-st
atus-codes).\nDetails are only available for statuses 14, 15, 17, 18, 19, 86, an
d 87.", |
| 1131 "format": "int32", |
| 1132 "location": "path", |
| 1133 "required": true, |
| 1134 "type": "integer" |
| 1135 }, |
| 1136 "pageSize": { |
| 1137 "description": "Requested pa
ge size. The server may return fewer results than requested.\nIf unspecified, th
e server will pick an appropriate default.", |
| 1138 "format": "int32", |
| 1139 "location": "query", |
| 1140 "type": "integer" |
| 1141 }, |
| 1142 "accountId": { |
| 1143 "description": "Account ID o
f the buyer.", |
| 1144 "format": "int64", |
| 1145 "location": "path", |
| 1146 "required": true, |
| 1147 "type": "string" |
| 1148 } |
| 1149 }, |
| 1150 "path": "v2beta1/accounts/{accountId
}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details", |
| 1151 "response": { |
| 1152 "$ref": "ListCreativeStatusBreak
downByDetailResponse" |
| 1153 }, |
| 1154 "scopes": [ |
| 1155 "https://www.googleapis.com/auth
/adexchange.buyer" |
| 1156 ] |
| 1157 } |
| 1158 } |
1434 }, | 1159 }, |
1435 "remove": { | 1160 "creatives": { |
1436 "description": "Remove the association betwe
en a deal and a creative.", | 1161 "methods": { |
1437 "httpMethod": "POST", | 1162 "list": { |
1438 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.remove", | 1163 "description": "List all creatives a
ssociated with a specific reason for which bids were\nfiltered, with the number
of bids filtered for each creative.", |
1439 "parameterOrder": [ | 1164 "httpMethod": "GET", |
1440 "accountId", | 1165 "id": "adexchangebuyer2.accounts.fil
terSets.filteredBids.creatives.list", |
1441 "creativeId" | 1166 "parameterOrder": [ |
1442 ], | 1167 "accountId", |
1443 "parameters": { | 1168 "filterSetId", |
1444 "accountId": { | 1169 "creativeStatusId" |
1445 "description": "The account the crea
tive belongs to.", | 1170 ], |
1446 "location": "path", | 1171 "parameters": { |
1447 "required": true, | 1172 "filterSetId": { |
1448 "type": "string" | 1173 "description": "The ID of th
e filter set to apply.", |
1449 }, | 1174 "format": "int64", |
1450 "creativeId": { | 1175 "location": "path", |
1451 "description": "The ID of the creati
ve associated with the deal.", | 1176 "required": true, |
1452 "location": "path", | 1177 "type": "string" |
1453 "required": true, | 1178 }, |
1454 "type": "string" | 1179 "pageToken": { |
1455 } | 1180 "description": "A token iden
tifying a page of results the server should return.\nTypically, this is the valu
e of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from
the previous call to the\naccounts.filterSets.filteredBids.creatives.list\nmeth
od.", |
1456 }, | 1181 "location": "query", |
1457 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations:remove", | 1182 "type": "string" |
1458 "request": { | 1183 }, |
1459 "$ref": "RemoveDealAssociationRequest" | 1184 "creativeStatusId": { |
1460 }, | 1185 "description": "The ID of th
e creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creativ
e-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative
-status-codes).", |
1461 "response": { | 1186 "format": "int32", |
1462 "$ref": "Empty" | 1187 "location": "path", |
1463 }, | 1188 "required": true, |
1464 "scopes": [ | 1189 "type": "integer" |
1465 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 1190 }, |
1466 ] | 1191 "pageSize": { |
1467 }, | 1192 "description": "Requested pa
ge size. The server may return fewer results than requested.\nIf unspecified, th
e server will pick an appropriate default.", |
1468 "list": { | 1193 "format": "int32", |
1469 "description": "List all creative-deal assoc
iations.", | 1194 "location": "query", |
1470 "httpMethod": "GET", | 1195 "type": "integer" |
1471 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.list", | 1196 }, |
1472 "parameterOrder": [ | 1197 "accountId": { |
1473 "accountId", | 1198 "description": "Account ID o
f the buyer.", |
1474 "creativeId" | 1199 "format": "int64", |
1475 ], | 1200 "location": "path", |
1476 "parameters": { | 1201 "required": true, |
1477 "query": { | 1202 "type": "string" |
1478 "description": "An optional query st
ring to filter deal associations. If no filter is\nspecified, all associations w
ill be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_stri
ng</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsId=<i>deals_id_string
</i>\n<li>dealsStatus:{approved, conditionally_approved, disapproved,\n
not_checked}\n<li>openAuctionStatus:{approved, conditionally_approved,
disapproved,\n not_checked}\n</ul>\nExample: 'dealsId=12
345 AND dealsStatus:disapproved'", | 1203 } |
1479 "location": "query", | 1204 }, |
1480 "type": "string" | 1205 "path": "v2beta1/accounts/{accountId
}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives", |
1481 }, | 1206 "response": { |
1482 "creativeId": { | 1207 "$ref": "ListCreativeStatusBreak
downByCreativeResponse" |
1483 "description": "The creative ID to l
ist the associations from.\nSpecify \"-\" to list all creatives under the above
account.", | 1208 }, |
1484 "location": "path", | 1209 "scopes": [ |
1485 "required": true, | 1210 "https://www.googleapis.com/auth
/adexchange.buyer" |
1486 "type": "string" | 1211 ] |
1487 }, | 1212 } |
1488 "pageToken": { | 1213 } |
1489 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stDealAssociationsResponse.next_page_token\nreturned from the previous call to '
ListDealAssociations' method.", | 1214 } |
1490 "location": "query", | 1215 } |
1491 "type": "string" | 1216 }, |
1492 }, | 1217 "losingBids": { |
1493 "accountId": { | 1218 "methods": { |
1494 "description": "The account to list
the associations from.\nSpecify \"-\" to list all creatives the current user has
access to.", | 1219 "list": { |
1495 "location": "path", | 1220 "description": "List all reasons for which b
ids lost in the auction, with the number of\nbids that lost for each reason.", |
1496 "required": true, | 1221 "httpMethod": "GET", |
1497 "type": "string" | 1222 "id": "adexchangebuyer2.accounts.filterSets.
losingBids.list", |
1498 }, | 1223 "parameterOrder": [ |
1499 "pageSize": { | 1224 "accountId", |
1500 "description": "Requested page size.
Server may return fewer associations than requested.\nIf unspecified, server wi
ll pick an appropriate default.", | 1225 "filterSetId" |
1501 "format": "int32", | 1226 ], |
1502 "location": "query", | 1227 "parameters": { |
1503 "type": "integer" | 1228 "pageToken": { |
1504 } | 1229 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stLosingBidsResponse.nextPageToken\nreturned from the previous call to the\nacco
unts.filterSets.losingBids.list\nmethod.", |
1505 }, | 1230 "location": "query", |
1506 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations", | 1231 "type": "string" |
1507 "response": { | 1232 }, |
1508 "$ref": "ListDealAssociationsResponse" | 1233 "pageSize": { |
1509 }, | 1234 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
1510 "scopes": [ | 1235 "format": "int32", |
1511 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 1236 "location": "query", |
| 1237 "type": "integer" |
| 1238 }, |
| 1239 "accountId": { |
| 1240 "description": "Account ID of the bu
yer.", |
| 1241 "format": "int64", |
| 1242 "location": "path", |
| 1243 "required": true, |
| 1244 "type": "string" |
| 1245 }, |
| 1246 "filterSetId": { |
| 1247 "description": "The ID of the filter
set to apply.", |
| 1248 "format": "int64", |
| 1249 "location": "path", |
| 1250 "required": true, |
| 1251 "type": "string" |
| 1252 } |
| 1253 }, |
| 1254 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/losingBids", |
| 1255 "response": { |
| 1256 "$ref": "ListLosingBidsResponse" |
| 1257 }, |
| 1258 "scopes": [ |
| 1259 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 1260 ] |
| 1261 } |
| 1262 } |
| 1263 }, |
| 1264 "impressionMetrics": { |
| 1265 "methods": { |
| 1266 "list": { |
| 1267 "description": "Lists all metrics that are m
easured in terms of number of impressions.", |
| 1268 "httpMethod": "GET", |
| 1269 "id": "adexchangebuyer2.accounts.filterSets.
impressionMetrics.list", |
| 1270 "parameterOrder": [ |
| 1271 "accountId", |
| 1272 "filterSetId" |
| 1273 ], |
| 1274 "parameters": { |
| 1275 "pageToken": { |
| 1276 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stImpressionMetricsResponse.nextPageToken\nreturned from the previous call to th
e\naccounts.filterSets.impressionMetrics.list\nmethod.", |
| 1277 "location": "query", |
| 1278 "type": "string" |
| 1279 }, |
| 1280 "pageSize": { |
| 1281 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
| 1282 "format": "int32", |
| 1283 "location": "query", |
| 1284 "type": "integer" |
| 1285 }, |
| 1286 "accountId": { |
| 1287 "description": "Account ID of the bu
yer.", |
| 1288 "format": "int64", |
| 1289 "location": "path", |
| 1290 "required": true, |
| 1291 "type": "string" |
| 1292 }, |
| 1293 "filterSetId": { |
| 1294 "description": "The ID of the filter
set to apply.", |
| 1295 "format": "int64", |
| 1296 "location": "path", |
| 1297 "required": true, |
| 1298 "type": "string" |
| 1299 } |
| 1300 }, |
| 1301 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/impressionMetrics", |
| 1302 "response": { |
| 1303 "$ref": "ListImpressionMetricsResponse" |
| 1304 }, |
| 1305 "scopes": [ |
| 1306 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 1307 ] |
| 1308 } |
| 1309 } |
| 1310 }, |
| 1311 "bidMetrics": { |
| 1312 "methods": { |
| 1313 "list": { |
| 1314 "description": "Lists all metrics that are m
easured in terms of number of bids.", |
| 1315 "httpMethod": "GET", |
| 1316 "id": "adexchangebuyer2.accounts.filterSets.
bidMetrics.list", |
| 1317 "parameterOrder": [ |
| 1318 "accountId", |
| 1319 "filterSetId" |
| 1320 ], |
| 1321 "parameters": { |
| 1322 "pageToken": { |
| 1323 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stBidMetricsResponse.nextPageToken\nreturned from the previous call to the\nacco
unts.filterSets.bidMetrics.list\nmethod.", |
| 1324 "location": "query", |
| 1325 "type": "string" |
| 1326 }, |
| 1327 "pageSize": { |
| 1328 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
| 1329 "format": "int32", |
| 1330 "location": "query", |
| 1331 "type": "integer" |
| 1332 }, |
| 1333 "accountId": { |
| 1334 "description": "Account ID of the bu
yer.", |
| 1335 "format": "int64", |
| 1336 "location": "path", |
| 1337 "required": true, |
| 1338 "type": "string" |
| 1339 }, |
| 1340 "filterSetId": { |
| 1341 "description": "The ID of the filter
set to apply.", |
| 1342 "format": "int64", |
| 1343 "location": "path", |
| 1344 "required": true, |
| 1345 "type": "string" |
| 1346 } |
| 1347 }, |
| 1348 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidMetrics", |
| 1349 "response": { |
| 1350 "$ref": "ListBidMetricsResponse" |
| 1351 }, |
| 1352 "scopes": [ |
| 1353 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 1354 ] |
| 1355 } |
| 1356 } |
| 1357 }, |
| 1358 "bidResponseErrors": { |
| 1359 "methods": { |
| 1360 "list": { |
| 1361 "description": "List all errors that occurre
d in bid responses, with the number of bid\nresponses affected for each reason."
, |
| 1362 "httpMethod": "GET", |
| 1363 "id": "adexchangebuyer2.accounts.filterSets.
bidResponseErrors.list", |
| 1364 "parameterOrder": [ |
| 1365 "accountId", |
| 1366 "filterSetId" |
| 1367 ], |
| 1368 "parameters": { |
| 1369 "filterSetId": { |
| 1370 "description": "The ID of the filter
set to apply.", |
| 1371 "format": "int64", |
| 1372 "location": "path", |
| 1373 "required": true, |
| 1374 "type": "string" |
| 1375 }, |
| 1376 "pageToken": { |
| 1377 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to th
e\naccounts.filterSets.bidResponseErrors.list\nmethod.", |
| 1378 "location": "query", |
| 1379 "type": "string" |
| 1380 }, |
| 1381 "pageSize": { |
| 1382 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
| 1383 "format": "int32", |
| 1384 "location": "query", |
| 1385 "type": "integer" |
| 1386 }, |
| 1387 "accountId": { |
| 1388 "description": "Account ID of the bu
yer.", |
| 1389 "format": "int64", |
| 1390 "location": "path", |
| 1391 "required": true, |
| 1392 "type": "string" |
| 1393 } |
| 1394 }, |
| 1395 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidResponseErrors", |
| 1396 "response": { |
| 1397 "$ref": "ListBidResponseErrorsResponse" |
| 1398 }, |
| 1399 "scopes": [ |
| 1400 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 1401 ] |
| 1402 } |
| 1403 } |
| 1404 }, |
| 1405 "bidResponsesWithoutBids": { |
| 1406 "methods": { |
| 1407 "list": { |
| 1408 "description": "List all reasons for which b
id responses were considered to have no\napplicable bids, with the number of bid
responses affected for each reason.", |
| 1409 "httpMethod": "GET", |
| 1410 "id": "adexchangebuyer2.accounts.filterSets.
bidResponsesWithoutBids.list", |
| 1411 "parameterOrder": [ |
| 1412 "accountId", |
| 1413 "filterSetId" |
| 1414 ], |
| 1415 "parameters": { |
| 1416 "pageToken": { |
| 1417 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call
to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.", |
| 1418 "location": "query", |
| 1419 "type": "string" |
| 1420 }, |
| 1421 "pageSize": { |
| 1422 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
| 1423 "format": "int32", |
| 1424 "location": "query", |
| 1425 "type": "integer" |
| 1426 }, |
| 1427 "accountId": { |
| 1428 "description": "Account ID of the bu
yer.", |
| 1429 "format": "int64", |
| 1430 "location": "path", |
| 1431 "required": true, |
| 1432 "type": "string" |
| 1433 }, |
| 1434 "filterSetId": { |
| 1435 "description": "The ID of the filter
set to apply.", |
| 1436 "format": "int64", |
| 1437 "location": "path", |
| 1438 "required": true, |
| 1439 "type": "string" |
| 1440 } |
| 1441 }, |
| 1442 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidResponsesWithoutBids", |
| 1443 "response": { |
| 1444 "$ref": "ListBidResponsesWithoutBidsResp
onse" |
| 1445 }, |
| 1446 "scopes": [ |
| 1447 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
1512 ] | 1448 ] |
1513 } | 1449 } |
1514 } | 1450 } |
1515 } | 1451 } |
1516 } | 1452 } |
1517 } | 1453 } |
1518 } | 1454 } |
1519 } | 1455 } |
1520 }, | 1456 }, |
1521 "revision": "20170623", | 1457 "revision": "20170720", |
1522 "rootUrl": "https://adexchangebuyer.googleapis.com/", | 1458 "rootUrl": "https://adexchangebuyer.googleapis.com/", |
1523 "schemas": { | 1459 "schemas": { |
| 1460 "AddDealAssociationRequest": { |
| 1461 "description": "A request for associating a deal and a creative.", |
| 1462 "id": "AddDealAssociationRequest", |
| 1463 "properties": { |
| 1464 "association": { |
| 1465 "$ref": "CreativeDealAssociation", |
| 1466 "description": "The association between a creative and a dea
l that should be added." |
| 1467 } |
| 1468 }, |
| 1469 "type": "object" |
| 1470 }, |
1524 "WatchCreativeRequest": { | 1471 "WatchCreativeRequest": { |
1525 "description": "A request for watching changes to creative Status.", | 1472 "description": "A request for watching changes to creative Status.", |
1526 "id": "WatchCreativeRequest", | 1473 "id": "WatchCreativeRequest", |
1527 "properties": { | 1474 "properties": { |
1528 "topic": { | 1475 "topic": { |
1529 "description": "The Pub/Sub topic to publish notifications t
o.\nThis topic must already exist and must give permission to\nad-exchange-buysi
de-reports@google.com to write to the topic.\nThis should be the full resource n
ame in\n\"projects/{project_id}/topics/{topic_id}\" format.", | 1476 "description": "The Pub/Sub topic to publish notifications t
o.\nThis topic must already exist and must give permission to\nad-exchange-buysi
de-reports@google.com to write to the topic.\nThis should be the full resource n
ame in\n\"projects/{project_id}/topics/{topic_id}\" format.", |
1530 "type": "string" | 1477 "type": "string" |
1531 } | 1478 } |
1532 }, | 1479 }, |
1533 "type": "object" | 1480 "type": "object" |
(...skipping 12 matching lines...) Expand all Loading... |
1546 "format": "google-datetime", | 1493 "format": "google-datetime", |
1547 "type": "string" | 1494 "type": "string" |
1548 } | 1495 } |
1549 }, | 1496 }, |
1550 "type": "object" | 1497 "type": "object" |
1551 }, | 1498 }, |
1552 "FilteredBidCreativeRow": { | 1499 "FilteredBidCreativeRow": { |
1553 "description": "The number of filtered bids with the specified dimen
sion values that have the\nspecified creative.", | 1500 "description": "The number of filtered bids with the specified dimen
sion values that have the\nspecified creative.", |
1554 "id": "FilteredBidCreativeRow", | 1501 "id": "FilteredBidCreativeRow", |
1555 "properties": { | 1502 "properties": { |
| 1503 "rowDimensions": { |
| 1504 "$ref": "RowDimensions", |
| 1505 "description": "The values of all dimensions associated with
metric values in this row." |
| 1506 }, |
1556 "bidCount": { | 1507 "bidCount": { |
1557 "$ref": "MetricValue", | 1508 "$ref": "MetricValue", |
1558 "description": "The number of bids with the specified creati
ve." | 1509 "description": "The number of bids with the specified creati
ve." |
1559 }, | 1510 }, |
1560 "creativeId": { | 1511 "creativeId": { |
1561 "description": "The ID of the creative.", | 1512 "description": "The ID of the creative.", |
1562 "type": "string" | 1513 "type": "string" |
1563 }, | |
1564 "rowDimensions": { | |
1565 "$ref": "RowDimensions", | |
1566 "description": "The values of all dimensions associated with
metric values in this row." | |
1567 } | 1514 } |
1568 }, | 1515 }, |
1569 "type": "object" | 1516 "type": "object" |
1570 }, | 1517 }, |
1571 "RelativeDateRange": { | 1518 "RelativeDateRange": { |
1572 "description": "A relative date range, specified by an offset and a
duration.\nThe supported range of dates begins 30 days before today and ends tod
ay.\nI.e. the limits for these values are:\noffset_days >= 0\nduration_days >= 1
\noffset_days + duration_days <= 30", | 1519 "description": "A relative date range, specified by an offset and a
duration.\nThe supported range of dates begins 30 days before today and ends tod
ay.\nI.e. the limits for these values are:\noffset_days >= 0\nduration_days >= 1
\noffset_days + duration_days <= 30", |
1573 "id": "RelativeDateRange", | 1520 "id": "RelativeDateRange", |
1574 "properties": { | 1521 "properties": { |
1575 "durationDays": { | 1522 "durationDays": { |
1576 "description": "The number of days in the requested date ran
ge. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7
.", | 1523 "description": "The number of days in the requested date ran
ge. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7
.", |
1577 "format": "int32", | 1524 "format": "int32", |
1578 "type": "integer" | 1525 "type": "integer" |
1579 }, | 1526 }, |
1580 "offsetDays": { | 1527 "offsetDays": { |
1581 "description": "The end date of the filter set, specified as
the number of days before\ntoday. E.g. for a range where the last date is today
, 0.", | 1528 "description": "The end date of the filter set, specified as
the number of days before\ntoday. E.g. for a range where the last date is today
, 0.", |
1582 "format": "int32", | 1529 "format": "int32", |
1583 "type": "integer" | 1530 "type": "integer" |
1584 } | 1531 } |
1585 }, | 1532 }, |
1586 "type": "object" | 1533 "type": "object" |
1587 }, | 1534 }, |
1588 "NativeContent": { | 1535 "NativeContent": { |
1589 "description": "Native content for a creative.", | 1536 "description": "Native content for a creative.", |
1590 "id": "NativeContent", | 1537 "id": "NativeContent", |
1591 "properties": { | 1538 "properties": { |
| 1539 "headline": { |
| 1540 "description": "A short title for the ad.", |
| 1541 "type": "string" |
| 1542 }, |
| 1543 "appIcon": { |
| 1544 "$ref": "Image", |
| 1545 "description": "The app icon, for app download ads." |
| 1546 }, |
1592 "callToAction": { | 1547 "callToAction": { |
1593 "description": "A label for the button that the user is supp
osed to click.", | 1548 "description": "A label for the button that the user is supp
osed to click.", |
1594 "type": "string" | 1549 "type": "string" |
1595 }, | 1550 }, |
1596 "body": { | 1551 "body": { |
1597 "description": "A long description of the ad.", | 1552 "description": "A long description of the ad.", |
1598 "type": "string" | 1553 "type": "string" |
1599 }, | 1554 }, |
1600 "starRating": { | 1555 "starRating": { |
1601 "description": "The app rating in the app store. Must be in
the range [0-5].", | 1556 "description": "The app rating in the app store. Must be in
the range [0-5].", |
1602 "format": "double", | 1557 "format": "double", |
1603 "type": "number" | 1558 "type": "number" |
1604 }, | 1559 }, |
1605 "videoUrl": { | 1560 "videoUrl": { |
1606 "description": "The URL to fetch a native video ad.", | 1561 "description": "The URL to fetch a native video ad.", |
1607 "type": "string" | 1562 "type": "string" |
1608 }, | 1563 }, |
1609 "clickLinkUrl": { | 1564 "clickLinkUrl": { |
1610 "description": "The URL that the browser/SDK will load when
the user clicks the ad.", | 1565 "description": "The URL that the browser/SDK will load when
the user clicks the ad.", |
1611 "type": "string" | 1566 "type": "string" |
1612 }, | 1567 }, |
1613 "logo": { | 1568 "logo": { |
1614 "$ref": "Image", | 1569 "$ref": "Image", |
1615 "description": "A smaller image, for the advertiser's logo." | 1570 "description": "A smaller image, for the advertiser's logo." |
1616 }, | 1571 }, |
1617 "priceDisplayText": { | 1572 "priceDisplayText": { |
1618 "description": "The price of the promoted app including curr
ency info.", | 1573 "description": "The price of the promoted app including curr
ency info.", |
1619 "type": "string" | 1574 "type": "string" |
1620 }, | 1575 }, |
| 1576 "clickTrackingUrl": { |
| 1577 "description": "The URL to use for click tracking.", |
| 1578 "type": "string" |
| 1579 }, |
1621 "image": { | 1580 "image": { |
1622 "$ref": "Image", | 1581 "$ref": "Image", |
1623 "description": "A large image." | 1582 "description": "A large image." |
1624 }, | 1583 }, |
1625 "clickTrackingUrl": { | |
1626 "description": "The URL to use for click tracking.", | |
1627 "type": "string" | |
1628 }, | |
1629 "advertiserName": { | 1584 "advertiserName": { |
1630 "description": "The name of the advertiser or sponsor, to be
displayed in the ad creative.", | 1585 "description": "The name of the advertiser or sponsor, to be
displayed in the ad creative.", |
1631 "type": "string" | 1586 "type": "string" |
1632 }, | 1587 }, |
1633 "storeUrl": { | 1588 "storeUrl": { |
1634 "description": "The URL to the app store to purchase/downloa
d the promoted app.", | 1589 "description": "The URL to the app store to purchase/downloa
d the promoted app.", |
1635 "type": "string" | 1590 "type": "string" |
1636 }, | |
1637 "headline": { | |
1638 "description": "A short title for the ad.", | |
1639 "type": "string" | |
1640 }, | |
1641 "appIcon": { | |
1642 "$ref": "Image", | |
1643 "description": "The app icon, for app download ads." | |
1644 } | 1591 } |
1645 }, | 1592 }, |
1646 "type": "object" | 1593 "type": "object" |
1647 }, | 1594 }, |
1648 "ListClientsResponse": { | 1595 "ListClientsResponse": { |
1649 "id": "ListClientsResponse", | 1596 "id": "ListClientsResponse", |
1650 "properties": { | 1597 "properties": { |
1651 "nextPageToken": { | 1598 "nextPageToken": { |
1652 "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
.", | 1599 "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
.", |
1653 "type": "string" | 1600 "type": "string" |
1654 }, | 1601 }, |
1655 "clients": { | 1602 "clients": { |
1656 "description": "The returned list of clients.", | 1603 "description": "The returned list of clients.", |
1657 "items": { | 1604 "items": { |
1658 "$ref": "Client" | 1605 "$ref": "Client" |
1659 }, | 1606 }, |
1660 "type": "array" | 1607 "type": "array" |
1661 } | 1608 } |
1662 }, | 1609 }, |
1663 "type": "object" | 1610 "type": "object" |
1664 }, | 1611 }, |
1665 "ListBidResponsesWithoutBidsResponse": { | 1612 "ListBidResponsesWithoutBidsResponse": { |
1666 "description": "Response message for listing all reasons that bid re
sponses were considered\nto have no applicable bids.", | 1613 "description": "Response message for listing all reasons that bid re
sponses were considered\nto have no applicable bids.", |
1667 "id": "ListBidResponsesWithoutBidsResponse", | 1614 "id": "ListBidResponsesWithoutBidsResponse", |
1668 "properties": { | 1615 "properties": { |
| 1616 "nextPageToken": { |
| 1617 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield i
n the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\n
method to retrieve the next page of results.", |
| 1618 "type": "string" |
| 1619 }, |
1669 "bidResponseWithoutBidsStatusRows": { | 1620 "bidResponseWithoutBidsStatusRows": { |
1670 "description": "List of rows, with counts of bid responses w
ithout bids aggregated by\nstatus.", | 1621 "description": "List of rows, with counts of bid responses w
ithout bids aggregated by\nstatus.", |
1671 "items": { | 1622 "items": { |
1672 "$ref": "BidResponseWithoutBidsStatusRow" | 1623 "$ref": "BidResponseWithoutBidsStatusRow" |
1673 }, | 1624 }, |
1674 "type": "array" | 1625 "type": "array" |
1675 }, | |
1676 "nextPageToken": { | |
1677 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield i
n the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\n
method to retrieve the next page of results.", | |
1678 "type": "string" | |
1679 } | 1626 } |
1680 }, | 1627 }, |
1681 "type": "object" | 1628 "type": "object" |
1682 }, | 1629 }, |
1683 "ServingContext": { | 1630 "ServingContext": { |
1684 "description": "The serving context for this restriction.", | 1631 "description": "The serving context for this restriction.", |
1685 "id": "ServingContext", | 1632 "id": "ServingContext", |
1686 "properties": { | 1633 "properties": { |
1687 "appType": { | 1634 "appType": { |
1688 "$ref": "AppContext", | 1635 "$ref": "AppContext", |
(...skipping 25 matching lines...) Expand all Loading... |
1714 ], | 1661 ], |
1715 "type": "string" | 1662 "type": "string" |
1716 } | 1663 } |
1717 }, | 1664 }, |
1718 "type": "object" | 1665 "type": "object" |
1719 }, | 1666 }, |
1720 "Image": { | 1667 "Image": { |
1721 "description": "An image resource. You may provide a larger image th
an was requested,\nso long as the aspect ratio is preserved.", | 1668 "description": "An image resource. You may provide a larger image th
an was requested,\nso long as the aspect ratio is preserved.", |
1722 "id": "Image", | 1669 "id": "Image", |
1723 "properties": { | 1670 "properties": { |
1724 "height": { | |
1725 "description": "Image height in pixels.", | |
1726 "format": "int32", | |
1727 "type": "integer" | |
1728 }, | |
1729 "width": { | 1671 "width": { |
1730 "description": "Image width in pixels.", | 1672 "description": "Image width in pixels.", |
1731 "format": "int32", | 1673 "format": "int32", |
1732 "type": "integer" | 1674 "type": "integer" |
1733 }, | 1675 }, |
1734 "url": { | 1676 "url": { |
1735 "description": "The URL of the image.", | 1677 "description": "The URL of the image.", |
1736 "type": "string" | 1678 "type": "string" |
| 1679 }, |
| 1680 "height": { |
| 1681 "description": "Image height in pixels.", |
| 1682 "format": "int32", |
| 1683 "type": "integer" |
1737 } | 1684 } |
1738 }, | 1685 }, |
1739 "type": "object" | 1686 "type": "object" |
1740 }, | 1687 }, |
1741 "ListFilterSetsResponse": { | 1688 "ListFilterSetsResponse": { |
1742 "description": "Response message for listing filter sets.", | 1689 "description": "Response message for listing filter sets.", |
1743 "id": "ListFilterSetsResponse", | 1690 "id": "ListFilterSetsResponse", |
1744 "properties": { | 1691 "properties": { |
1745 "filterSets": { | 1692 "filterSets": { |
1746 "description": "The filter sets belonging to the buyer.", | 1693 "description": "The filter sets belonging to the buyer.", |
1747 "items": { | 1694 "items": { |
1748 "$ref": "FilterSet" | 1695 "$ref": "FilterSet" |
1749 }, | 1696 }, |
1750 "type": "array" | 1697 "type": "array" |
1751 }, | 1698 }, |
1752 "nextPageToken": { | 1699 "nextPageToken": { |
1753 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequ
ent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of r
esults.", | 1700 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequ
ent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of r
esults.", |
1754 "type": "string" | 1701 "type": "string" |
1755 } | 1702 } |
1756 }, | 1703 }, |
1757 "type": "object" | 1704 "type": "object" |
1758 }, | 1705 }, |
1759 "BidResponseWithoutBidsStatusRow": { | 1706 "BidResponseWithoutBidsStatusRow": { |
1760 "description": "The number of impressions with the specified dimensi
on values that were\nconsidered to have no applicable bids, as described by the
specified status.", | 1707 "description": "The number of impressions with the specified dimensi
on values that were\nconsidered to have no applicable bids, as described by the
specified status.", |
1761 "id": "BidResponseWithoutBidsStatusRow", | 1708 "id": "BidResponseWithoutBidsStatusRow", |
1762 "properties": { | 1709 "properties": { |
| 1710 "rowDimensions": { |
| 1711 "$ref": "RowDimensions", |
| 1712 "description": "The values of all dimensions associated with
metric values in this row." |
| 1713 }, |
1763 "impressionCount": { | 1714 "impressionCount": { |
1764 "$ref": "MetricValue", | 1715 "$ref": "MetricValue", |
1765 "description": "The number of impressions for which there wa
s a bid response with the\nspecified status." | 1716 "description": "The number of impressions for which there wa
s a bid response with the\nspecified status." |
1766 }, | 1717 }, |
1767 "status": { | 1718 "status": { |
1768 "description": "The status specifying why the bid responses
were considered to have no\napplicable bids.", | 1719 "description": "The status specifying why the bid responses
were considered to have no\napplicable bids.", |
1769 "enum": [ | 1720 "enum": [ |
1770 "STATUS_UNSPECIFIED", | 1721 "STATUS_UNSPECIFIED", |
1771 "RESPONSES_WITHOUT_BIDS", | 1722 "RESPONSES_WITHOUT_BIDS", |
1772 "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT", | 1723 "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT", |
1773 "RESPONSES_WITHOUT_BIDS_FOR_DEAL" | 1724 "RESPONSES_WITHOUT_BIDS_FOR_DEAL" |
1774 ], | 1725 ], |
1775 "enumDescriptions": [ | 1726 "enumDescriptions": [ |
1776 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | 1727 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", |
1777 "The response had no bids.", | 1728 "The response had no bids.", |
1778 "The response had no bids for the specified account, tho
ugh it may have\nincluded bids on behalf of other accounts.", | 1729 "The response had no bids for the specified account, tho
ugh it may have\nincluded bids on behalf of other accounts.", |
1779 "The response had no bids for the specified deal, though
it may have\nincluded bids on other deals on behalf of the account to which the
deal\nbelongs." | 1730 "The response had no bids for the specified deal, though
it may have\nincluded bids on other deals on behalf of the account to which the
deal\nbelongs." |
1780 ], | 1731 ], |
1781 "type": "string" | 1732 "type": "string" |
1782 }, | |
1783 "rowDimensions": { | |
1784 "$ref": "RowDimensions", | |
1785 "description": "The values of all dimensions associated with
metric values in this row." | |
1786 } | 1733 } |
1787 }, | 1734 }, |
1788 "type": "object" | 1735 "type": "object" |
1789 }, | 1736 }, |
1790 "ClientUserInvitation": { | 1737 "ClientUserInvitation": { |
1791 "description": "An invitation for a new client user to get access to
the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.
", | 1738 "description": "An invitation for a new client user to get access to
the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.
", |
1792 "id": "ClientUserInvitation", | 1739 "id": "ClientUserInvitation", |
1793 "properties": { | 1740 "properties": { |
1794 "invitationId": { | 1741 "invitationId": { |
1795 "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
.", | 1742 "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
.", |
1796 "format": "int64", | 1743 "format": "int64", |
1797 "type": "string" | 1744 "type": "string" |
1798 }, | 1745 }, |
1799 "email": { | 1746 "email": { |
1800 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", | 1747 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", |
1801 "type": "string" | 1748 "type": "string" |
1802 }, | 1749 }, |
1803 "clientAccountId": { | 1750 "clientAccountId": { |
1804 "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.", | 1751 "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.", |
1805 "format": "int64", | 1752 "format": "int64", |
1806 "type": "string" | 1753 "type": "string" |
1807 } | 1754 } |
1808 }, | 1755 }, |
1809 "type": "object" | 1756 "type": "object" |
1810 }, | 1757 }, |
1811 "ListClientUserInvitationsResponse": { | 1758 "ListCreativeStatusBreakdownByDetailResponse": { |
1812 "id": "ListClientUserInvitationsResponse", | 1759 "description": "Response message for listing all details associated
with a given filtered bid\nreason.", |
| 1760 "id": "ListCreativeStatusBreakdownByDetailResponse", |
1813 "properties": { | 1761 "properties": { |
1814 "nextPageToken": { | 1762 "nextPageToken": { |
1815 "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.", | 1763 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\
nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.l
ist\nmethod to retrieve the next page of results.", |
1816 "type": "string" | 1764 "type": "string" |
1817 }, | 1765 }, |
1818 "invitations": { | 1766 "filteredBidDetailRows": { |
1819 "description": "The returned list of client users.", | 1767 "description": "List of rows, with counts of bids with a giv
en creative status aggregated\nby detail.", |
1820 "items": { | 1768 "items": { |
1821 "$ref": "ClientUserInvitation" | 1769 "$ref": "FilteredBidDetailRow" |
1822 }, | 1770 }, |
1823 "type": "array" | 1771 "type": "array" |
| 1772 }, |
| 1773 "detailType": { |
| 1774 "description": "The type of detail that the detail IDs repre
sent.", |
| 1775 "enum": [ |
| 1776 "DETAIL_TYPE_UNSPECIFIED", |
| 1777 "CREATIVE_ATTRIBUTE", |
| 1778 "VENDOR", |
| 1779 "SENSITIVE_CATEGORY", |
| 1780 "PRODUCT_CATEGORY" |
| 1781 ], |
| 1782 "enumDescriptions": [ |
| 1783 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", |
| 1784 "Indicates that the detail ID refers to a creative attri
bute; see\n[publisher-excludable-creative-attributes](https://developers.google.
com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).", |
| 1785 "Indicates that the detail ID refers to a vendor; see\n[
vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).", |
| 1786 "Indicates that the detail ID refers to a sensitive cate
gory; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/r
tb/downloads/ad-sensitive-categories).", |
| 1787 "Indicates that the detail ID refers to a product catego
ry; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/d
ownloads/ad-product-categories)." |
| 1788 ], |
| 1789 "type": "string" |
1824 } | 1790 } |
1825 }, | 1791 }, |
1826 "type": "object" | 1792 "type": "object" |
1827 }, | 1793 }, |
1828 "ListClientUsersResponse": { | 1794 "ListClientUsersResponse": { |
1829 "id": "ListClientUsersResponse", | 1795 "id": "ListClientUsersResponse", |
1830 "properties": { | 1796 "properties": { |
1831 "nextPageToken": { | 1797 "nextPageToken": { |
1832 "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.", | 1798 "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.", |
1833 "type": "string" | 1799 "type": "string" |
1834 }, | 1800 }, |
1835 "users": { | 1801 "users": { |
1836 "description": "The returned list of client users.", | 1802 "description": "The returned list of client users.", |
1837 "items": { | 1803 "items": { |
1838 "$ref": "ClientUser" | 1804 "$ref": "ClientUser" |
1839 }, | 1805 }, |
1840 "type": "array" | 1806 "type": "array" |
1841 } | 1807 } |
1842 }, | 1808 }, |
1843 "type": "object" | 1809 "type": "object" |
1844 }, | 1810 }, |
1845 "ListCreativeStatusBreakdownByDetailResponse": { | 1811 "ListClientUserInvitationsResponse": { |
1846 "description": "Response message for listing all details associated
with a given filtered bid\nreason.", | 1812 "id": "ListClientUserInvitationsResponse", |
1847 "id": "ListCreativeStatusBreakdownByDetailResponse", | |
1848 "properties": { | 1813 "properties": { |
1849 "filteredBidDetailRows": { | 1814 "nextPageToken": { |
1850 "description": "List of rows, with counts of bids with a giv
en creative status aggregated\nby detail.", | 1815 "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.", |
| 1816 "type": "string" |
| 1817 }, |
| 1818 "invitations": { |
| 1819 "description": "The returned list of client users.", |
1851 "items": { | 1820 "items": { |
1852 "$ref": "FilteredBidDetailRow" | 1821 "$ref": "ClientUserInvitation" |
1853 }, | 1822 }, |
1854 "type": "array" | 1823 "type": "array" |
1855 }, | |
1856 "nextPageToken": { | |
1857 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\
nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.l
ist\nmethod to retrieve the next page of results.", | |
1858 "type": "string" | |
1859 }, | |
1860 "detailType": { | |
1861 "description": "The type of detail that the detail IDs repre
sent.", | |
1862 "enum": [ | |
1863 "TYPE_UNSPECIFIED", | |
1864 "CREATIVE_ATTRIBUTE", | |
1865 "VENDOR", | |
1866 "SENSITIVE_CATEGORY", | |
1867 "PRODUCT_CATEGORY" | |
1868 ], | |
1869 "enumDescriptions": [ | |
1870 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | |
1871 "Indicates that the detail ID refers to a creative attri
bute; see\n[publisher-excludable-creative-attributes](https://developers.google.
com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).", | |
1872 "Indicates that the detail ID refers to a vendor; see\n[
vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).", | |
1873 "Indicates that the detail ID refers to a sensitive cate
gory; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/r
tb/downloads/ad-sensitive-categories).", | |
1874 "Indicates that the detail ID refers to a product catego
ry; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/d
ownloads/ad-product-categories)." | |
1875 ], | |
1876 "type": "string" | |
1877 } | 1824 } |
1878 }, | 1825 }, |
1879 "type": "object" | 1826 "type": "object" |
1880 }, | 1827 }, |
1881 "LocationContext": { | 1828 "LocationContext": { |
1882 "description": "@OutputOnly The Geo criteria the restriction applies
to.", | 1829 "description": "@OutputOnly The Geo criteria the restriction applies
to.", |
1883 "id": "LocationContext", | 1830 "id": "LocationContext", |
1884 "properties": { | 1831 "properties": { |
1885 "geoCriteriaIds": { | 1832 "geoCriteriaIds": { |
1886 "description": "IDs representing the geo location for this c
ontext.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx
-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.", | 1833 "description": "IDs representing the geo location for this c
ontext.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx
-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.", |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1931 "format": "int64", | 1878 "format": "int64", |
1932 "type": "string" | 1879 "type": "string" |
1933 } | 1880 } |
1934 }, | 1881 }, |
1935 "type": "object" | 1882 "type": "object" |
1936 }, | 1883 }, |
1937 "ClientUser": { | 1884 "ClientUser": { |
1938 "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.", | 1885 "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.", |
1939 "id": "ClientUser", | 1886 "id": "ClientUser", |
1940 "properties": { | 1887 "properties": { |
1941 "clientAccountId": { | |
1942 "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.", | |
1943 "format": "int64", | |
1944 "type": "string" | |
1945 }, | |
1946 "status": { | 1888 "status": { |
1947 "description": "The status of the client user.", | 1889 "description": "The status of the client user.", |
1948 "enum": [ | 1890 "enum": [ |
1949 "USER_STATUS_UNSPECIFIED", | 1891 "USER_STATUS_UNSPECIFIED", |
1950 "PENDING", | 1892 "PENDING", |
1951 "ACTIVE", | 1893 "ACTIVE", |
1952 "DISABLED" | 1894 "DISABLED" |
1953 ], | 1895 ], |
1954 "enumDescriptions": [ | 1896 "enumDescriptions": [ |
1955 "A placeholder for an undefined user status.", | 1897 "A placeholder for an undefined user status.", |
1956 "A user who was already created but hasn't accepted the
invitation yet.", | 1898 "A user who was already created but hasn't accepted the
invitation yet.", |
1957 "A user that is currently active.", | 1899 "A user that is currently active.", |
1958 "A user that is currently disabled." | 1900 "A user that is currently disabled." |
1959 ], | 1901 ], |
1960 "type": "string" | 1902 "type": "string" |
1961 }, | 1903 }, |
| 1904 "email": { |
| 1905 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", |
| 1906 "type": "string" |
| 1907 }, |
1962 "userId": { | 1908 "userId": { |
1963 "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.", | 1909 "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.", |
1964 "format": "int64", | 1910 "format": "int64", |
1965 "type": "string" | 1911 "type": "string" |
1966 }, | 1912 }, |
1967 "email": { | 1913 "clientAccountId": { |
1968 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", | 1914 "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.", |
| 1915 "format": "int64", |
1969 "type": "string" | 1916 "type": "string" |
1970 } | 1917 } |
1971 }, | 1918 }, |
1972 "type": "object" | 1919 "type": "object" |
1973 }, | 1920 }, |
1974 "CreativeDealAssociation": { | 1921 "CreativeDealAssociation": { |
1975 "description": "The association between a creative and a deal.", | 1922 "description": "The association between a creative and a deal.", |
1976 "id": "CreativeDealAssociation", | 1923 "id": "CreativeDealAssociation", |
1977 "properties": { | 1924 "properties": { |
1978 "accountId": { | 1925 "accountId": { |
1979 "description": "The account the creative belongs to.", | 1926 "description": "The account the creative belongs to.", |
1980 "type": "string" | 1927 "type": "string" |
1981 }, | 1928 }, |
1982 "creativeId": { | 1929 "creativeId": { |
1983 "description": "The ID of the creative associated with the d
eal.", | 1930 "description": "The ID of the creative associated with the d
eal.", |
1984 "type": "string" | 1931 "type": "string" |
1985 }, | 1932 }, |
1986 "dealsId": { | 1933 "dealsId": { |
1987 "description": "The externalDealId for the deal associated w
ith the creative.", | 1934 "description": "The externalDealId for the deal associated w
ith the creative.", |
1988 "type": "string" | 1935 "type": "string" |
1989 } | 1936 } |
1990 }, | 1937 }, |
1991 "type": "object" | 1938 "type": "object" |
1992 }, | 1939 }, |
1993 "FilteringStats": { | |
1994 "description": "@OutputOnly Filtering reasons for this creative duri
ng a period of a single\nday (from midnight to midnight Pacific).", | |
1995 "id": "FilteringStats", | |
1996 "properties": { | |
1997 "date": { | |
1998 "$ref": "Date", | |
1999 "description": "The day during which the data was collected.
\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST
to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usua
l 24." | |
2000 }, | |
2001 "reasons": { | |
2002 "description": "The set of filtering reasons for this date."
, | |
2003 "items": { | |
2004 "$ref": "Reason" | |
2005 }, | |
2006 "type": "array" | |
2007 } | |
2008 }, | |
2009 "type": "object" | |
2010 }, | |
2011 "Creative": { | 1940 "Creative": { |
2012 "description": "A creative and its classification data.", | 1941 "description": "A creative and its classification data.", |
2013 "id": "Creative", | 1942 "id": "Creative", |
2014 "properties": { | 1943 "properties": { |
2015 "accountId": { | |
2016 "description": "The account that this creative belongs to.\n
Can be used to filter the response of the\ncreatives.list\nmethod.", | |
2017 "type": "string" | |
2018 }, | |
2019 "native": { | 1944 "native": { |
2020 "$ref": "NativeContent", | 1945 "$ref": "NativeContent", |
2021 "description": "A native creative." | 1946 "description": "A native creative." |
2022 }, | 1947 }, |
2023 "video": { | 1948 "video": { |
2024 "$ref": "VideoContent", | 1949 "$ref": "VideoContent", |
2025 "description": "A video creative." | 1950 "description": "A video creative." |
2026 }, | 1951 }, |
2027 "servingRestrictions": { | 1952 "servingRestrictions": { |
2028 "description": "@OutputOnly The granular status of this ad i
n specific contexts.\nA context here relates to where something ultimately serve
s (for example,\na physical location, a platform, an HTTPS vs HTTP request, or t
he type\nof auction).", | 1953 "description": "@OutputOnly The granular status of this ad i
n specific contexts.\nA context here relates to where something ultimately serve
s (for example,\na physical location, a platform, an HTTPS vs HTTP request, or t
he type\nof auction).", |
(...skipping 113 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2142 "The creative has been conditionally approved.\nSee serv
ing_restrictions for details.", | 2067 "The creative has been conditionally approved.\nSee serv
ing_restrictions for details.", |
2143 "The creative has been approved.", | 2068 "The creative has been approved.", |
2144 "The creative has been disapproved." | 2069 "The creative has been disapproved." |
2145 ], | 2070 ], |
2146 "type": "string" | 2071 "type": "string" |
2147 }, | 2072 }, |
2148 "advertiserName": { | 2073 "advertiserName": { |
2149 "description": "The name of the company being advertised in
the creative.", | 2074 "description": "The name of the company being advertised in
the creative.", |
2150 "type": "string" | 2075 "type": "string" |
2151 }, | 2076 }, |
| 2077 "detectedDomains": { |
| 2078 "description": "@OutputOnly\nThe detected domains for this c
reative.", |
| 2079 "items": { |
| 2080 "type": "string" |
| 2081 }, |
| 2082 "type": "array" |
| 2083 }, |
2152 "detectedAdvertiserIds": { | 2084 "detectedAdvertiserIds": { |
2153 "description": "@OutputOnly Detected advertiser IDs, if any.
", | 2085 "description": "@OutputOnly Detected advertiser IDs, if any.
", |
2154 "items": { | 2086 "items": { |
2155 "format": "int64", | 2087 "format": "int64", |
2156 "type": "string" | 2088 "type": "string" |
2157 }, | 2089 }, |
2158 "type": "array" | 2090 "type": "array" |
2159 }, | |
2160 "detectedDomains": { | |
2161 "description": "@OutputOnly\nThe detected domains for this c
reative.", | |
2162 "items": { | |
2163 "type": "string" | |
2164 }, | |
2165 "type": "array" | |
2166 }, | 2091 }, |
2167 "filteringStats": { | 2092 "filteringStats": { |
2168 "$ref": "FilteringStats", | 2093 "$ref": "FilteringStats", |
2169 "description": "@OutputOnly The filtering stats for this cre
ative." | 2094 "description": "@OutputOnly The filtering stats for this cre
ative." |
2170 }, | 2095 }, |
2171 "attributes": { | 2096 "attributes": { |
2172 "description": "All attributes for the ads that may be shown
from this creative.\nCan be used to filter the response of the\ncreatives.list\
nmethod.", | 2097 "description": "All attributes for the ads that may be shown
from this creative.\nCan be used to filter the response of the\ncreatives.list\
nmethod.", |
2173 "enumDescriptions": [ | 2098 "enumDescriptions": [ |
2174 "Do not use. This is a placeholder value only.", | 2099 "Do not use. This is a placeholder value only.", |
2175 "The creative is tagged.", | 2100 "The creative is tagged.", |
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2235 "detectedLanguages": { | 2160 "detectedLanguages": { |
2236 "description": "@OutputOnly\nThe detected languages for this
creative. The order is arbitrary. The codes\nare 2 or 5 characters and are docu
mented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes
.", | 2161 "description": "@OutputOnly\nThe detected languages for this
creative. The order is arbitrary. The codes\nare 2 or 5 characters and are docu
mented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes
.", |
2237 "items": { | 2162 "items": { |
2238 "type": "string" | 2163 "type": "string" |
2239 }, | 2164 }, |
2240 "type": "array" | 2165 "type": "array" |
2241 }, | 2166 }, |
2242 "creativeId": { | 2167 "creativeId": { |
2243 "description": "The buyer-defined creative ID of this creati
ve.\nCan be used to filter the response of the\ncreatives.list\nmethod.", | 2168 "description": "The buyer-defined creative ID of this creati
ve.\nCan be used to filter the response of the\ncreatives.list\nmethod.", |
2244 "type": "string" | 2169 "type": "string" |
| 2170 }, |
| 2171 "accountId": { |
| 2172 "description": "The account that this creative belongs to.\n
Can be used to filter the response of the\ncreatives.list\nmethod.", |
| 2173 "type": "string" |
2245 } | 2174 } |
2246 }, | 2175 }, |
2247 "type": "object" | 2176 "type": "object" |
| 2177 }, |
| 2178 "FilteringStats": { |
| 2179 "description": "@OutputOnly Filtering reasons for this creative duri
ng a period of a single\nday (from midnight to midnight Pacific).", |
| 2180 "id": "FilteringStats", |
| 2181 "properties": { |
| 2182 "reasons": { |
| 2183 "description": "The set of filtering reasons for this date."
, |
| 2184 "items": { |
| 2185 "$ref": "Reason" |
| 2186 }, |
| 2187 "type": "array" |
| 2188 }, |
| 2189 "date": { |
| 2190 "$ref": "Date", |
| 2191 "description": "The day during which the data was collected.
\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST
to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usua
l 24." |
| 2192 } |
| 2193 }, |
| 2194 "type": "object" |
2248 }, | 2195 }, |
2249 "RemoveDealAssociationRequest": { | 2196 "RemoveDealAssociationRequest": { |
2250 "description": "A request for removing the association between a dea
l and a creative.", | 2197 "description": "A request for removing the association between a dea
l and a creative.", |
2251 "id": "RemoveDealAssociationRequest", | 2198 "id": "RemoveDealAssociationRequest", |
2252 "properties": { | 2199 "properties": { |
2253 "association": { | 2200 "association": { |
2254 "$ref": "CreativeDealAssociation", | 2201 "$ref": "CreativeDealAssociation", |
2255 "description": "The association between a creative and a dea
l that should be removed." | 2202 "description": "The association between a creative and a dea
l that should be removed." |
2256 } | 2203 } |
2257 }, | 2204 }, |
2258 "type": "object" | 2205 "type": "object" |
2259 }, | 2206 }, |
2260 "ListCreativeStatusBreakdownByCreativeResponse": { | 2207 "ListCreativeStatusBreakdownByCreativeResponse": { |
2261 "description": "Response message for listing all creatives associate
d with a given filtered\nbid reason.", | 2208 "description": "Response message for listing all creatives associate
d with a given filtered\nbid reason.", |
2262 "id": "ListCreativeStatusBreakdownByCreativeResponse", | 2209 "id": "ListCreativeStatusBreakdownByCreativeResponse", |
2263 "properties": { | 2210 "properties": { |
| 2211 "nextPageToken": { |
| 2212 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToke
n\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creativ
es.list\nmethod to retrieve the next page of results.", |
| 2213 "type": "string" |
| 2214 }, |
2264 "filteredBidCreativeRows": { | 2215 "filteredBidCreativeRows": { |
2265 "description": "List of rows, with counts of bids with a giv
en creative status aggregated\nby creative.", | 2216 "description": "List of rows, with counts of bids with a giv
en creative status aggregated\nby creative.", |
2266 "items": { | 2217 "items": { |
2267 "$ref": "FilteredBidCreativeRow" | 2218 "$ref": "FilteredBidCreativeRow" |
2268 }, | 2219 }, |
2269 "type": "array" | 2220 "type": "array" |
2270 }, | |
2271 "nextPageToken": { | |
2272 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToke
n\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creativ
es.list\nmethod to retrieve the next page of results.", | |
2273 "type": "string" | |
2274 } | 2221 } |
2275 }, | 2222 }, |
2276 "type": "object" | 2223 "type": "object" |
2277 }, | 2224 }, |
2278 "Client": { | 2225 "Client": { |
2279 "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.", | 2226 "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.", |
2280 "id": "Client", | 2227 "id": "Client", |
2281 "properties": { | 2228 "properties": { |
| 2229 "entityType": { |
| 2230 "description": "The type of the client entity: `ADVERTISER`,
`BRAND`, or `AGENCY`.", |
| 2231 "enum": [ |
| 2232 "ENTITY_TYPE_UNSPECIFIED", |
| 2233 "ADVERTISER", |
| 2234 "BRAND", |
| 2235 "AGENCY" |
| 2236 ], |
| 2237 "enumDescriptions": [ |
| 2238 "A placeholder for an undefined client entity type. Shou
ld not be used.", |
| 2239 "An advertiser.", |
| 2240 "A brand.", |
| 2241 "An advertising agency." |
| 2242 ], |
| 2243 "type": "string" |
| 2244 }, |
| 2245 "clientName": { |
| 2246 "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.", |
| 2247 "type": "string" |
| 2248 }, |
2282 "role": { | 2249 "role": { |
2283 "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`.", | 2250 "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`.", |
2284 "enum": [ | 2251 "enum": [ |
2285 "CLIENT_ROLE_UNSPECIFIED", | 2252 "CLIENT_ROLE_UNSPECIFIED", |
2286 "CLIENT_DEAL_VIEWER", | 2253 "CLIENT_DEAL_VIEWER", |
2287 "CLIENT_DEAL_NEGOTIATOR", | 2254 "CLIENT_DEAL_NEGOTIATOR", |
2288 "CLIENT_DEAL_APPROVER" | 2255 "CLIENT_DEAL_APPROVER" |
2289 ], | 2256 ], |
2290 "enumDescriptions": [ | 2257 "enumDescriptions": [ |
2291 "A placeholder for an undefined client role.", | 2258 "A placeholder for an undefined client role.", |
(...skipping 27 matching lines...) Expand all Loading... |
2319 "CLIENT_STATUS_UNSPECIFIED", | 2286 "CLIENT_STATUS_UNSPECIFIED", |
2320 "DISABLED", | 2287 "DISABLED", |
2321 "ACTIVE" | 2288 "ACTIVE" |
2322 ], | 2289 ], |
2323 "enumDescriptions": [ | 2290 "enumDescriptions": [ |
2324 "A placeholder for an undefined client status.", | 2291 "A placeholder for an undefined client status.", |
2325 "A client that is currently disabled.", | 2292 "A client that is currently disabled.", |
2326 "A client that is currently active." | 2293 "A client that is currently active." |
2327 ], | 2294 ], |
2328 "type": "string" | 2295 "type": "string" |
2329 }, | |
2330 "entityType": { | |
2331 "description": "The type of the client entity: `ADVERTISER`,
`BRAND`, or `AGENCY`.", | |
2332 "enum": [ | |
2333 "ENTITY_TYPE_UNSPECIFIED", | |
2334 "ADVERTISER", | |
2335 "BRAND", | |
2336 "AGENCY" | |
2337 ], | |
2338 "enumDescriptions": [ | |
2339 "A placeholder for an undefined client entity type. Shou
ld not be used.", | |
2340 "An advertiser.", | |
2341 "A brand.", | |
2342 "An advertising agency." | |
2343 ], | |
2344 "type": "string" | |
2345 }, | |
2346 "clientName": { | |
2347 "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.", | |
2348 "type": "string" | |
2349 } | 2296 } |
2350 }, | 2297 }, |
2351 "type": "object" | 2298 "type": "object" |
2352 }, | 2299 }, |
2353 "Correction": { | 2300 "Correction": { |
2354 "description": "@OutputOnly Shows any corrections that were applied
to this creative.", | 2301 "description": "@OutputOnly Shows any corrections that were applied
to this creative.", |
2355 "id": "Correction", | 2302 "id": "Correction", |
2356 "properties": { | 2303 "properties": { |
| 2304 "contexts": { |
| 2305 "description": "The contexts for the correction.", |
| 2306 "items": { |
| 2307 "$ref": "ServingContext" |
| 2308 }, |
| 2309 "type": "array" |
| 2310 }, |
2357 "details": { | 2311 "details": { |
2358 "description": "Additional details about what was corrected.
", | 2312 "description": "Additional details about what was corrected.
", |
2359 "items": { | 2313 "items": { |
2360 "type": "string" | 2314 "type": "string" |
2361 }, | 2315 }, |
2362 "type": "array" | 2316 "type": "array" |
2363 }, | 2317 }, |
2364 "type": { | 2318 "type": { |
2365 "description": "The type of correction that was applied to t
he creative.", | 2319 "description": "The type of correction that was applied to t
he creative.", |
2366 "enum": [ | 2320 "enum": [ |
(...skipping 18 matching lines...) Expand all Loading... |
2385 "The ad was not declared as Flash-free but it did not re
ference any flash\ncontent, so the Flash-free attribute was added.", | 2339 "The ad was not declared as Flash-free but it did not re
ference any flash\ncontent, so the Flash-free attribute was added.", |
2386 "The ad did not declare a required creative attribute.\n
The attribute was added.", | 2340 "The ad did not declare a required creative attribute.\n
The attribute was added.", |
2387 "The ad did not declare a required technology vendor.\nT
he technology vendor was added.", | 2341 "The ad did not declare a required technology vendor.\nT
he technology vendor was added.", |
2388 "The ad did not declare the SSL attribute but was SSL-co
mpliant, so the\nSSL attribute was added.", | 2342 "The ad did not declare the SSL attribute but was SSL-co
mpliant, so the\nSSL attribute was added.", |
2389 "Properties consistent with In-banner video were found,
so an\nIn-Banner Video attribute was added.", | 2343 "Properties consistent with In-banner video were found,
so an\nIn-Banner Video attribute was added.", |
2390 "The ad makes calls to the MRAID API so the MRAID attrib
ute was added.", | 2344 "The ad makes calls to the MRAID API so the MRAID attrib
ute was added.", |
2391 "The ad unnecessarily declared the Flash attribute, so t
he Flash attribute\nwas removed.", | 2345 "The ad unnecessarily declared the Flash attribute, so t
he Flash attribute\nwas removed.", |
2392 "The ad contains video content." | 2346 "The ad contains video content." |
2393 ], | 2347 ], |
2394 "type": "string" | 2348 "type": "string" |
2395 }, | |
2396 "contexts": { | |
2397 "description": "The contexts for the correction.", | |
2398 "items": { | |
2399 "$ref": "ServingContext" | |
2400 }, | |
2401 "type": "array" | |
2402 } | 2349 } |
2403 }, | 2350 }, |
2404 "type": "object" | 2351 "type": "object" |
2405 }, | 2352 }, |
2406 "FilterSet": { | 2353 "FilterSet": { |
2407 "description": "A set of filters that is applied to a request for da
ta.\nWithin a filter set, an AND operation is performed across the filters\nrepr
esented by each field. An OR operation is performed across the filters\nrepresen
ted by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id
=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"", | 2354 "description": "A set of filters that is applied to a request for da
ta.\nWithin a filter set, an AND operation is performed across the filters\nrepr
esented by each field. An OR operation is performed across the filters\nrepresen
ted by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id
=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"", |
2408 "id": "FilterSet", | 2355 "id": "FilterSet", |
2409 "properties": { | 2356 "properties": { |
2410 "sellerNetworkIds": { | 2357 "sellerNetworkIds": { |
2411 "description": "The list of IDs of the seller (publisher) ne
tworks on which to filter;\nmay be empty. The filters represented by multiple se
ller network IDs are\nORed together (i.e. if non-empty, results must match any o
ne of the\npublisher networks).\nSee [seller-network-ids](https://developers.goo
gle.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of exist
ing seller network IDs.", | 2358 "description": "The list of IDs of the seller (publisher) ne
tworks on which to filter;\nmay be empty. The filters represented by multiple se
ller network IDs are\nORed together (i.e. if non-empty, results must match any o
ne of the\npublisher networks).\nSee [seller-network-ids](https://developers.goo
gle.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of exist
ing seller network IDs.", |
2412 "items": { | 2359 "items": { |
2413 "format": "int32", | 2360 "format": "int32", |
2414 "type": "integer" | 2361 "type": "integer" |
2415 }, | 2362 }, |
2416 "type": "array" | 2363 "type": "array" |
2417 }, | 2364 }, |
2418 "ownerAccountId": { | 2365 "ownerAccountId": { |
2419 "description": "The account ID of the buyer who owns this fi
lter set.\nThe value of this field is ignored in create operations.", | 2366 "description": "The account ID of the buyer who owns this fi
lter set.\nThe value of this field is ignored in create operations.", |
2420 "format": "int64", | 2367 "format": "int64", |
2421 "type": "string" | 2368 "type": "string" |
2422 }, | 2369 }, |
| 2370 "buyerAccountId": { |
| 2371 "description": "The ID of the buyer account on which to filt
er; optional.", |
| 2372 "format": "int64", |
| 2373 "type": "string" |
| 2374 }, |
2423 "absoluteDateRange": { | 2375 "absoluteDateRange": { |
2424 "$ref": "AbsoluteDateRange", | 2376 "$ref": "AbsoluteDateRange", |
2425 "description": "An absolute date range, defined by a start d
ate and an end date.\nInterpreted relative to Pacific time zone." | 2377 "description": "An absolute date range, defined by a start d
ate and an end date.\nInterpreted relative to Pacific time zone." |
2426 }, | 2378 }, |
2427 "buyerAccountId": { | |
2428 "description": "The ID of the buyer account on which to filt
er; optional.", | |
2429 "format": "int64", | |
2430 "type": "string" | |
2431 }, | |
2432 "environment": { | 2379 "environment": { |
2433 "description": "The environment on which to filter; optional
.", | 2380 "description": "The environment on which to filter; optional
.", |
2434 "enum": [ | 2381 "enum": [ |
2435 "ENVIRONMENT_UNSPECIFIED", | 2382 "ENVIRONMENT_UNSPECIFIED", |
2436 "WEB", | 2383 "WEB", |
2437 "APP" | 2384 "APP" |
2438 ], | 2385 ], |
2439 "enumDescriptions": [ | 2386 "enumDescriptions": [ |
2440 "A placeholder for an undefined environment; indicates t
hat no environment\nfilter will be applied.", | 2387 "A placeholder for an undefined environment; indicates t
hat no environment\nfilter will be applied.", |
2441 "The ad impression appears on the web.", | 2388 "The ad impression appears on the web.", |
2442 "The ad impression appears in an app." | 2389 "The ad impression appears in an app." |
2443 ], | 2390 ], |
2444 "type": "string" | 2391 "type": "string" |
2445 }, | 2392 }, |
2446 "dealId": { | |
2447 "description": "The ID of the deal on which to filter; optio
nal.", | |
2448 "format": "int64", | |
2449 "type": "string" | |
2450 }, | |
2451 "format": { | 2393 "format": { |
2452 "description": "The format on which to filter; optional.", | 2394 "description": "The format on which to filter; optional.", |
2453 "enum": [ | 2395 "enum": [ |
2454 "FORMAT_UNSPECIFIED", | 2396 "FORMAT_UNSPECIFIED", |
2455 "DISPLAY", | 2397 "DISPLAY", |
2456 "VIDEO" | 2398 "VIDEO" |
2457 ], | 2399 ], |
2458 "enumDescriptions": [ | 2400 "enumDescriptions": [ |
2459 "A placeholder for an undefined format; indicates that n
o format filter\nwill be applied.", | 2401 "A placeholder for an undefined format; indicates that n
o format filter\nwill be applied.", |
2460 "The ad impression is display format (i.e. an image).", | 2402 "The ad impression is display format (i.e. an image).", |
2461 "The ad impression is video format." | 2403 "The ad impression is video format." |
2462 ], | 2404 ], |
2463 "type": "string" | 2405 "type": "string" |
2464 }, | 2406 }, |
| 2407 "dealId": { |
| 2408 "description": "The ID of the deal on which to filter; optio
nal.", |
| 2409 "format": "int64", |
| 2410 "type": "string" |
| 2411 }, |
2465 "timeSeriesGranularity": { | 2412 "timeSeriesGranularity": { |
2466 "description": "The granularity of time intervals if a time
series breakdown is desired;\noptional.", | 2413 "description": "The granularity of time intervals if a time
series breakdown is desired;\noptional.", |
2467 "enum": [ | 2414 "enum": [ |
2468 "INTERVAL_UNSPECIFIED", | 2415 "TIME_SERIES_GRANULARITY_UNSPECIFIED", |
2469 "HOURLY", | 2416 "HOURLY", |
2470 "DAILY" | 2417 "DAILY" |
2471 ], | 2418 ], |
2472 "enumDescriptions": [ | 2419 "enumDescriptions": [ |
2473 "A placeholder for an unspecified interval; no time seri
es is applied.\nAll rows in response will contain data for the entire requested
time range.", | 2420 "A placeholder for an unspecified interval; no time seri
es is applied.\nAll rows in response will contain data for the entire requested
time range.", |
2474 "Indicates that data will be broken down by the hour.", | 2421 "Indicates that data will be broken down by the hour.", |
2475 "Indicates that data will be broken down by the day." | 2422 "Indicates that data will be broken down by the day." |
2476 ], | 2423 ], |
2477 "type": "string" | 2424 "type": "string" |
2478 }, | 2425 }, |
2479 "filterSetId": { | 2426 "filterSetId": { |
2480 "description": "The ID of the filter set; unique within the
account of the filter set\nowner.\nThe value of this field is ignored in create
operations.", | 2427 "description": "The ID of the filter set; unique within the
account of the filter set\nowner.\nThe value of this field is ignored in create
operations.", |
2481 "format": "int64", | 2428 "format": "int64", |
2482 "type": "string" | 2429 "type": "string" |
2483 }, | 2430 }, |
2484 "realtimeTimeRange": { | 2431 "realtimeTimeRange": { |
2485 "$ref": "RealtimeTimeRange", | 2432 "$ref": "RealtimeTimeRange", |
2486 "description": "An open-ended realtime time range, defined b
y the aggregation start\ntimestamp." | 2433 "description": "An open-ended realtime time range, defined b
y the aggregation start\ntimestamp." |
2487 }, | 2434 }, |
2488 "creativeId": { | 2435 "creativeId": { |
2489 "description": "The ID of the creative on which to filter; o
ptional.", | 2436 "description": "The ID of the creative on which to filter; o
ptional.", |
2490 "type": "string" | 2437 "type": "string" |
2491 }, | 2438 }, |
2492 "relativeDateRange": { | |
2493 "$ref": "RelativeDateRange", | |
2494 "description": "A relative date range, defined by an offset
from today and a duration.\nInterpreted relative to Pacific time zone." | |
2495 }, | |
2496 "platforms": { | 2439 "platforms": { |
2497 "description": "The list of platforms on which to filter; ma
y be empty. The filters\nrepresented by multiple platforms are ORed together (i.
e. if non-empty,\nresults must match any one of the platforms).", | 2440 "description": "The list of platforms on which to filter; ma
y be empty. The filters\nrepresented by multiple platforms are ORed together (i.
e. if non-empty,\nresults must match any one of the platforms).", |
2498 "enumDescriptions": [ | 2441 "enumDescriptions": [ |
2499 "A placeholder for an undefined platform; indicates that
no platform\nfilter will be applied.", | 2442 "A placeholder for an undefined platform; indicates that
no platform\nfilter will be applied.", |
2500 "The ad impression appears on a desktop.", | 2443 "The ad impression appears on a desktop.", |
2501 "The ad impression appears on a tablet.", | 2444 "The ad impression appears on a tablet.", |
2502 "The ad impression appears on a mobile device." | 2445 "The ad impression appears on a mobile device." |
2503 ], | 2446 ], |
2504 "items": { | 2447 "items": { |
2505 "enum": [ | 2448 "enum": [ |
2506 "PLATFORM_UNSPECIFIED", | 2449 "PLATFORM_UNSPECIFIED", |
2507 "DESKTOP", | 2450 "DESKTOP", |
2508 "TABLET", | 2451 "TABLET", |
2509 "MOBILE" | 2452 "MOBILE" |
2510 ], | 2453 ], |
2511 "type": "string" | 2454 "type": "string" |
2512 }, | 2455 }, |
2513 "type": "array" | 2456 "type": "array" |
| 2457 }, |
| 2458 "relativeDateRange": { |
| 2459 "$ref": "RelativeDateRange", |
| 2460 "description": "A relative date range, defined by an offset
from today and a duration.\nInterpreted relative to Pacific time zone." |
2514 } | 2461 } |
2515 }, | 2462 }, |
2516 "type": "object" | 2463 "type": "object" |
2517 }, | 2464 }, |
2518 "ListDealAssociationsResponse": { | 2465 "ListDealAssociationsResponse": { |
2519 "description": "A response for listing creative and deal association
s", | 2466 "description": "A response for listing creative and deal association
s", |
2520 "id": "ListDealAssociationsResponse", | 2467 "id": "ListDealAssociationsResponse", |
2521 "properties": { | 2468 "properties": { |
2522 "associations": { | 2469 "associations": { |
2523 "description": "The list of associations.", | 2470 "description": "The list of associations.", |
2524 "items": { | 2471 "items": { |
2525 "$ref": "CreativeDealAssociation" | 2472 "$ref": "CreativeDealAssociation" |
2526 }, | 2473 }, |
2527 "type": "array" | 2474 "type": "array" |
2528 }, | 2475 }, |
2529 "nextPageToken": { | 2476 "nextPageToken": { |
2530 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the
subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of re
sults.", | 2477 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the
subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of re
sults.", |
2531 "type": "string" | 2478 "type": "string" |
2532 } | 2479 } |
2533 }, | 2480 }, |
2534 "type": "object" | 2481 "type": "object" |
2535 }, | 2482 }, |
2536 "CalloutStatusRow": { | 2483 "CalloutStatusRow": { |
2537 "description": "The number of impressions with the specified dimensi
on values where the\ncorresponding bid request or bid response was not successfu
l, as described by\nthe specified callout status.", | 2484 "description": "The number of impressions with the specified dimensi
on values where the\ncorresponding bid request or bid response was not successfu
l, as described by\nthe specified callout status.", |
2538 "id": "CalloutStatusRow", | 2485 "id": "CalloutStatusRow", |
2539 "properties": { | 2486 "properties": { |
| 2487 "impressionCount": { |
| 2488 "$ref": "MetricValue", |
| 2489 "description": "The number of impressions for which there wa
s a bid request or bid response\nwith the specified callout status." |
| 2490 }, |
2540 "rowDimensions": { | 2491 "rowDimensions": { |
2541 "$ref": "RowDimensions", | 2492 "$ref": "RowDimensions", |
2542 "description": "The values of all dimensions associated with
metric values in this row." | 2493 "description": "The values of all dimensions associated with
metric values in this row." |
2543 }, | 2494 }, |
2544 "calloutStatusId": { | 2495 "calloutStatusId": { |
2545 "description": "The ID of the callout status.\nSee [callout-
status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-st
atus-codes).", | 2496 "description": "The ID of the callout status.\nSee [callout-
status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-st
atus-codes).", |
2546 "format": "int32", | 2497 "format": "int32", |
2547 "type": "integer" | 2498 "type": "integer" |
2548 }, | |
2549 "impressionCount": { | |
2550 "$ref": "MetricValue", | |
2551 "description": "The number of impressions for which there wa
s a bid request or bid response\nwith the specified callout status." | |
2552 } | 2499 } |
2553 }, | 2500 }, |
2554 "type": "object" | 2501 "type": "object" |
2555 }, | 2502 }, |
2556 "Disapproval": { | 2503 "Disapproval": { |
2557 "description": "@OutputOnly The reason and details for a disapproval
.", | 2504 "description": "@OutputOnly The reason and details for a disapproval
.", |
2558 "id": "Disapproval", | 2505 "id": "Disapproval", |
2559 "properties": { | 2506 "properties": { |
2560 "details": { | 2507 "details": { |
2561 "description": "Additional details about the reason for disa
pproval.", | 2508 "description": "Additional details about the reason for disa
pproval.", |
(...skipping 204 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2766 "StopWatchingCreativeRequest": { | 2713 "StopWatchingCreativeRequest": { |
2767 "description": "A request for stopping notifications for changes to
creative Status.", | 2714 "description": "A request for stopping notifications for changes to
creative Status.", |
2768 "id": "StopWatchingCreativeRequest", | 2715 "id": "StopWatchingCreativeRequest", |
2769 "properties": {}, | 2716 "properties": {}, |
2770 "type": "object" | 2717 "type": "object" |
2771 }, | 2718 }, |
2772 "ServingRestriction": { | 2719 "ServingRestriction": { |
2773 "description": "@OutputOnly A representation of the status of an ad
in a\nspecific context. A context here relates to where something ultimately ser
ves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request
,\nor the type of auction).", | 2720 "description": "@OutputOnly A representation of the status of an ad
in a\nspecific context. A context here relates to where something ultimately ser
ves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request
,\nor the type of auction).", |
2774 "id": "ServingRestriction", | 2721 "id": "ServingRestriction", |
2775 "properties": { | 2722 "properties": { |
| 2723 "contexts": { |
| 2724 "description": "The contexts for the restriction.", |
| 2725 "items": { |
| 2726 "$ref": "ServingContext" |
| 2727 }, |
| 2728 "type": "array" |
| 2729 }, |
2776 "status": { | 2730 "status": { |
2777 "description": "The status of the creative in this context (
for example, it has been\nexplicitly disapproved or is pending review).", | 2731 "description": "The status of the creative in this context (
for example, it has been\nexplicitly disapproved or is pending review).", |
2778 "enum": [ | 2732 "enum": [ |
2779 "STATUS_UNSPECIFIED", | 2733 "STATUS_UNSPECIFIED", |
2780 "DISAPPROVAL", | 2734 "DISAPPROVAL", |
2781 "PENDING_REVIEW" | 2735 "PENDING_REVIEW" |
2782 ], | 2736 ], |
2783 "enumDescriptions": [ | 2737 "enumDescriptions": [ |
2784 "The status is not known.", | 2738 "The status is not known.", |
2785 "The ad was disapproved in this context.", | 2739 "The ad was disapproved in this context.", |
2786 "The ad is pending review in this context." | 2740 "The ad is pending review in this context." |
2787 ], | 2741 ], |
2788 "type": "string" | 2742 "type": "string" |
2789 }, | 2743 }, |
2790 "disapprovalReasons": { | 2744 "disapprovalReasons": { |
2791 "description": "Any disapprovals bound to this restriction.\
nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\
ncreatives.list\nmethod.", | 2745 "description": "Any disapprovals bound to this restriction.\
nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\
ncreatives.list\nmethod.", |
2792 "items": { | 2746 "items": { |
2793 "$ref": "Disapproval" | 2747 "$ref": "Disapproval" |
2794 }, | 2748 }, |
2795 "type": "array" | 2749 "type": "array" |
2796 }, | |
2797 "contexts": { | |
2798 "description": "The contexts for the restriction.", | |
2799 "items": { | |
2800 "$ref": "ServingContext" | |
2801 }, | |
2802 "type": "array" | |
2803 } | 2750 } |
2804 }, | 2751 }, |
2805 "type": "object" | 2752 "type": "object" |
2806 }, | 2753 }, |
2807 "Date": { | 2754 "Date": { |
2808 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and\ntime zone are either specified elsewhere or are not signi
ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b
e 0 to\nrepresent a year and month where the day is not significant, e.g. credit
card\nexpiration date. The year may be 0 to represent a month and day independe
nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand
`google.protobuf.Timestamp`.", | 2755 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and\ntime zone are either specified elsewhere or are not signi
ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b
e 0 to\nrepresent a year and month where the day is not significant, e.g. credit
card\nexpiration date. The year may be 0 to represent a month and day independe
nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand
`google.protobuf.Timestamp`.", |
2809 "id": "Date", | 2756 "id": "Date", |
2810 "properties": { | 2757 "properties": { |
| 2758 "day": { |
| 2759 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", |
| 2760 "format": "int32", |
| 2761 "type": "integer" |
| 2762 }, |
2811 "year": { | 2763 "year": { |
2812 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", | 2764 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
2813 "format": "int32", | 2765 "format": "int32", |
2814 "type": "integer" | 2766 "type": "integer" |
2815 }, | 2767 }, |
2816 "day": { | |
2817 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", | |
2818 "format": "int32", | |
2819 "type": "integer" | |
2820 }, | |
2821 "month": { | 2768 "month": { |
2822 "description": "Month of year. Must be from 1 to 12.", | 2769 "description": "Month of year. Must be from 1 to 12.", |
2823 "format": "int32", | 2770 "format": "int32", |
2824 "type": "integer" | 2771 "type": "integer" |
2825 } | 2772 } |
2826 }, | 2773 }, |
2827 "type": "object" | 2774 "type": "object" |
2828 }, | 2775 }, |
2829 "RowDimensions": { | 2776 "RowDimensions": { |
2830 "description": "A response may include multiple rows, breaking down
along various dimensions.\nEncapsulates the values of all dimensions for a given
row.", | 2777 "description": "A response may include multiple rows, breaking down
along various dimensions.\nEncapsulates the values of all dimensions for a given
row.", |
2831 "id": "RowDimensions", | 2778 "id": "RowDimensions", |
2832 "properties": { | 2779 "properties": { |
2833 "timeInterval": { | 2780 "timeInterval": { |
2834 "$ref": "TimeInterval", | 2781 "$ref": "TimeInterval", |
2835 "description": "The time interval that this row represents." | 2782 "description": "The time interval that this row represents." |
2836 } | 2783 } |
2837 }, | 2784 }, |
2838 "type": "object" | 2785 "type": "object" |
2839 }, | 2786 }, |
2840 "Empty": { | 2787 "Empty": { |
2841 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | 2788 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
2842 "id": "Empty", | 2789 "id": "Empty", |
2843 "properties": {}, | 2790 "properties": {}, |
2844 "type": "object" | 2791 "type": "object" |
2845 }, | 2792 }, |
2846 "ListCreativeStatusAndCreativeBreakdownByDetailResponse": { | |
2847 "description": "Response message for listing all details associated
with a given filtered bid\nreason and a given creative.", | |
2848 "id": "ListCreativeStatusAndCreativeBreakdownByDetailResponse", | |
2849 "properties": { | |
2850 "detailType": { | |
2851 "description": "The type of detail that the detail IDs repre
sent.", | |
2852 "enum": [ | |
2853 "TYPE_UNSPECIFIED", | |
2854 "CREATIVE_ATTRIBUTE", | |
2855 "VENDOR", | |
2856 "SENSITIVE_CATEGORY", | |
2857 "PRODUCT_CATEGORY" | |
2858 ], | |
2859 "enumDescriptions": [ | |
2860 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | |
2861 "Indicates that the detail ID refers to a creative attri
bute; see\n[publisher-excludable-creative-attributes](https://developers.google.
com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).", | |
2862 "Indicates that the detail ID refers to a vendor; see\n[
vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).", | |
2863 "Indicates that the detail ID refers to a sensitive cate
gory; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/r
tb/downloads/ad-sensitive-categories).", | |
2864 "Indicates that the detail ID refers to a product catego
ry; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/d
ownloads/ad-product-categories)." | |
2865 ], | |
2866 "type": "string" | |
2867 }, | |
2868 "filteredBidDetailRows": { | |
2869 "description": "List of rows, with counts of bids with a giv
en creative status and\ncreative, aggregated by detail.", | |
2870 "items": { | |
2871 "$ref": "FilteredBidDetailRow" | |
2872 }, | |
2873 "type": "array" | |
2874 }, | |
2875 "nextPageToken": { | |
2876 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListCreativeStatusAndCreativeBreakdownByDetailRequest
.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBid
s.creatives.details.list\nmethod to retrieve the next page of results.", | |
2877 "type": "string" | |
2878 } | |
2879 }, | |
2880 "type": "object" | |
2881 }, | |
2882 "AppContext": { | 2793 "AppContext": { |
2883 "description": "@OutputOnly The app type the restriction applies to
for mobile device.", | 2794 "description": "@OutputOnly The app type the restriction applies to
for mobile device.", |
2884 "id": "AppContext", | 2795 "id": "AppContext", |
2885 "properties": { | 2796 "properties": { |
2886 "appTypes": { | 2797 "appTypes": { |
2887 "description": "The app types this restriction applies to.", | 2798 "description": "The app types this restriction applies to.", |
2888 "enumDescriptions": [ | 2799 "enumDescriptions": [ |
2889 "Native app context.", | 2800 "Native app context.", |
2890 "Mobile web app context." | 2801 "Mobile web app context." |
2891 ], | 2802 ], |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2934 "INSECURE", | 2845 "INSECURE", |
2935 "SSL" | 2846 "SSL" |
2936 ], | 2847 ], |
2937 "type": "string" | 2848 "type": "string" |
2938 }, | 2849 }, |
2939 "type": "array" | 2850 "type": "array" |
2940 } | 2851 } |
2941 }, | 2852 }, |
2942 "type": "object" | 2853 "type": "object" |
2943 }, | 2854 }, |
2944 "HtmlContent": { | 2855 "ListFilteredBidRequestsResponse": { |
2945 "description": "HTML content for a creative.", | 2856 "description": "Response message for listing all reasons that bid re
quests were filtered and\nnot sent to the buyer.", |
2946 "id": "HtmlContent", | 2857 "id": "ListFilteredBidRequestsResponse", |
2947 "properties": { | 2858 "properties": { |
2948 "height": { | 2859 "calloutStatusRows": { |
2949 "description": "The height of the HTML snippet in pixels.", | 2860 "description": "List of rows, with counts of filtered bid re
quests aggregated by callout\nstatus.", |
2950 "format": "int32", | 2861 "items": { |
2951 "type": "integer" | 2862 "$ref": "CalloutStatusRow" |
| 2863 }, |
| 2864 "type": "array" |
2952 }, | 2865 }, |
2953 "width": { | 2866 "nextPageToken": { |
2954 "description": "The width of the HTML snippet in pixels.", | 2867 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in th
e subsequent call to the\naccounts.filterSets.filteredBidRequests.list\nmethod t
o retrieve the next page of results.", |
2955 "format": "int32", | |
2956 "type": "integer" | |
2957 }, | |
2958 "snippet": { | |
2959 "description": "The HTML snippet that displays the ad when i
nserted in the web page.", | |
2960 "type": "string" | 2868 "type": "string" |
2961 } | 2869 } |
2962 }, | 2870 }, |
2963 "type": "object" | 2871 "type": "object" |
2964 }, | 2872 }, |
2965 "ListCreativesResponse": { | 2873 "ListCreativesResponse": { |
2966 "description": "A response for listing creatives.", | 2874 "description": "A response for listing creatives.", |
2967 "id": "ListCreativesResponse", | 2875 "id": "ListCreativesResponse", |
2968 "properties": { | 2876 "properties": { |
| 2877 "nextPageToken": { |
| 2878 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequ
ent call to `ListCreatives` method to retrieve the next\npage of results.", |
| 2879 "type": "string" |
| 2880 }, |
2969 "creatives": { | 2881 "creatives": { |
2970 "description": "The list of creatives.", | 2882 "description": "The list of creatives.", |
2971 "items": { | 2883 "items": { |
2972 "$ref": "Creative" | 2884 "$ref": "Creative" |
2973 }, | 2885 }, |
2974 "type": "array" | 2886 "type": "array" |
2975 }, | |
2976 "nextPageToken": { | |
2977 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequ
ent call to `ListCreatives` method to retrieve the next\npage of results.", | |
2978 "type": "string" | |
2979 } | 2887 } |
2980 }, | 2888 }, |
2981 "type": "object" | 2889 "type": "object" |
2982 }, | 2890 }, |
2983 "ListFilteredBidRequestsResponse": { | 2891 "HtmlContent": { |
2984 "description": "Response message for listing all reasons that bid re
quests were filtered and\nnot sent to the buyer.", | 2892 "description": "HTML content for a creative.", |
2985 "id": "ListFilteredBidRequestsResponse", | 2893 "id": "HtmlContent", |
2986 "properties": { | 2894 "properties": { |
2987 "calloutStatusRows": { | 2895 "width": { |
2988 "description": "List of rows, with counts of filtered bid re
quests aggregated by callout\nstatus.", | 2896 "description": "The width of the HTML snippet in pixels.", |
2989 "items": { | 2897 "format": "int32", |
2990 "$ref": "CalloutStatusRow" | 2898 "type": "integer" |
2991 }, | |
2992 "type": "array" | |
2993 }, | 2899 }, |
2994 "nextPageToken": { | 2900 "snippet": { |
2995 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in th
e subsequent call to the\naccounts.filterSets.filteredBidRequests.list\nmethod t
o retrieve the next page of results.", | 2901 "description": "The HTML snippet that displays the ad when i
nserted in the web page.", |
2996 "type": "string" | 2902 "type": "string" |
| 2903 }, |
| 2904 "height": { |
| 2905 "description": "The height of the HTML snippet in pixels.", |
| 2906 "format": "int32", |
| 2907 "type": "integer" |
2997 } | 2908 } |
2998 }, | 2909 }, |
2999 "type": "object" | 2910 "type": "object" |
3000 }, | 2911 }, |
3001 "ListBidMetricsResponse": { | 2912 "ListBidMetricsResponse": { |
3002 "description": "Response message for listing the metrics that are me
asured in number of bids.", | 2913 "description": "Response message for listing the metrics that are me
asured in number of bids.", |
3003 "id": "ListBidMetricsResponse", | 2914 "id": "ListBidMetricsResponse", |
3004 "properties": { | 2915 "properties": { |
| 2916 "nextPageToken": { |
| 2917 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequ
ent call to the\naccounts.filterSets.bidMetrics.list\nmethod to retrieve the nex
t page of results.", |
| 2918 "type": "string" |
| 2919 }, |
3005 "bidMetricsRows": { | 2920 "bidMetricsRows": { |
3006 "description": "List of rows, each containing a set of bid m
etrics.", | 2921 "description": "List of rows, each containing a set of bid m
etrics.", |
3007 "items": { | 2922 "items": { |
3008 "$ref": "BidMetricsRow" | 2923 "$ref": "BidMetricsRow" |
3009 }, | 2924 }, |
3010 "type": "array" | 2925 "type": "array" |
3011 }, | |
3012 "nextPageToken": { | |
3013 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequ
ent call to the\naccounts.filterSets.bidMetrics.list\nmethod to retrieve the nex
t page of results.", | |
3014 "type": "string" | |
3015 } | 2926 } |
3016 }, | 2927 }, |
3017 "type": "object" | 2928 "type": "object" |
3018 }, | 2929 }, |
3019 "Reason": { | 2930 "Reason": { |
3020 "description": "A specific filtering status and how many times it oc
curred.", | 2931 "description": "A specific filtering status and how many times it oc
curred.", |
3021 "id": "Reason", | 2932 "id": "Reason", |
3022 "properties": { | 2933 "properties": { |
| 2934 "status": { |
| 2935 "description": "The filtering status code. Please refer to t
he\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionar
ies/creative-status-codes.txt)\nfile for different statuses.", |
| 2936 "format": "int32", |
| 2937 "type": "integer" |
| 2938 }, |
3023 "count": { | 2939 "count": { |
3024 "description": "The number of times the creative was filtere
d for the status. The\ncount is aggregated across all publishers on the exchange
.", | 2940 "description": "The number of times the creative was filtere
d for the status. The\ncount is aggregated across all publishers on the exchange
.", |
3025 "format": "int64", | 2941 "format": "int64", |
3026 "type": "string" | 2942 "type": "string" |
3027 }, | |
3028 "status": { | |
3029 "description": "The filtering status code. Please refer to t
he\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionar
ies/creative-status-codes.txt)\nfile for different statuses.", | |
3030 "format": "int32", | |
3031 "type": "integer" | |
3032 } | 2943 } |
3033 }, | 2944 }, |
3034 "type": "object" | 2945 "type": "object" |
3035 }, | 2946 }, |
3036 "VideoContent": { | 2947 "VideoContent": { |
3037 "description": "Video content for a creative.", | 2948 "description": "Video content for a creative.", |
3038 "id": "VideoContent", | 2949 "id": "VideoContent", |
3039 "properties": { | 2950 "properties": { |
3040 "videoUrl": { | 2951 "videoUrl": { |
3041 "description": "The URL to fetch a video ad.", | 2952 "description": "The URL to fetch a video ad.", |
3042 "type": "string" | 2953 "type": "string" |
3043 } | 2954 } |
3044 }, | 2955 }, |
3045 "type": "object" | 2956 "type": "object" |
3046 }, | 2957 }, |
3047 "ListLosingBidsResponse": { | 2958 "ListLosingBidsResponse": { |
3048 "description": "Response message for listing all reasons that bids l
ost in the auction.", | 2959 "description": "Response message for listing all reasons that bids l
ost in the auction.", |
3049 "id": "ListLosingBidsResponse", | 2960 "id": "ListLosingBidsResponse", |
3050 "properties": { | 2961 "properties": { |
| 2962 "nextPageToken": { |
| 2963 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequ
ent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the nex
t page of results.", |
| 2964 "type": "string" |
| 2965 }, |
3051 "creativeStatusRows": { | 2966 "creativeStatusRows": { |
3052 "description": "List of rows, with counts of losing bids agg
regated by loss reason (i.e.\ncreative status).", | 2967 "description": "List of rows, with counts of losing bids agg
regated by loss reason (i.e.\ncreative status).", |
3053 "items": { | 2968 "items": { |
3054 "$ref": "CreativeStatusRow" | 2969 "$ref": "CreativeStatusRow" |
3055 }, | 2970 }, |
3056 "type": "array" | 2971 "type": "array" |
3057 }, | |
3058 "nextPageToken": { | |
3059 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequ
ent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the nex
t page of results.", | |
3060 "type": "string" | |
3061 } | 2972 } |
3062 }, | 2973 }, |
3063 "type": "object" | 2974 "type": "object" |
3064 }, | 2975 }, |
3065 "ListNonBillableWinningBidsResponse": { | 2976 "ListNonBillableWinningBidsResponse": { |
3066 "description": "Response message for listing all reasons for which a
buyer was not billed for\na winning bid.", | 2977 "description": "Response message for listing all reasons for which a
buyer was not billed for\na winning bid.", |
3067 "id": "ListNonBillableWinningBidsResponse", | 2978 "id": "ListNonBillableWinningBidsResponse", |
3068 "properties": { | 2979 "properties": { |
3069 "nextPageToken": { | 2980 "nextPageToken": { |
3070 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in
the subsequent call to the\naccounts.filterSets.nonBillableWinningBids.list\nme
thod to retrieve the next page of results.", | 2981 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in
the subsequent call to the\naccounts.filterSets.nonBillableWinningBids.list\nme
thod to retrieve the next page of results.", |
(...skipping 14 matching lines...) Expand all Loading... |
3085 "id": "ImpressionMetricsRow", | 2996 "id": "ImpressionMetricsRow", |
3086 "properties": { | 2997 "properties": { |
3087 "rowDimensions": { | 2998 "rowDimensions": { |
3088 "$ref": "RowDimensions", | 2999 "$ref": "RowDimensions", |
3089 "description": "The values of all dimensions associated with
metric values in this row." | 3000 "description": "The values of all dimensions associated with
metric values in this row." |
3090 }, | 3001 }, |
3091 "availableImpressions": { | 3002 "availableImpressions": { |
3092 "$ref": "MetricValue", | 3003 "$ref": "MetricValue", |
3093 "description": "The number of impressions available to the b
uyer on Ad Exchange.\nIn some cases this value may be unavailable." | 3004 "description": "The number of impressions available to the b
uyer on Ad Exchange.\nIn some cases this value may be unavailable." |
3094 }, | 3005 }, |
| 3006 "bidRequests": { |
| 3007 "$ref": "MetricValue", |
| 3008 "description": "The number of impressions for which Ad Excha
nge sent the buyer a bid\nrequest." |
| 3009 }, |
3095 "inventoryMatches": { | 3010 "inventoryMatches": { |
3096 "$ref": "MetricValue", | 3011 "$ref": "MetricValue", |
3097 "description": "The number of impressions that match the buy
er's inventory pretargeting." | 3012 "description": "The number of impressions that match the buy
er's inventory pretargeting." |
3098 }, | 3013 }, |
3099 "bidRequests": { | |
3100 "$ref": "MetricValue", | |
3101 "description": "The number of impressions for which Ad Excha
nge sent the buyer a bid\nrequest." | |
3102 }, | |
3103 "responsesWithBids": { | 3014 "responsesWithBids": { |
3104 "$ref": "MetricValue", | 3015 "$ref": "MetricValue", |
3105 "description": "The number of impressions for which Ad Excha
nge received a response from\nthe buyer that contained at least one applicable b
id." | 3016 "description": "The number of impressions for which Ad Excha
nge received a response from\nthe buyer that contained at least one applicable b
id." |
3106 }, | 3017 }, |
3107 "successfulResponses": { | 3018 "successfulResponses": { |
3108 "$ref": "MetricValue", | 3019 "$ref": "MetricValue", |
3109 "description": "The number of impressions for which the buye
r successfully sent a response\nto Ad Exchange." | 3020 "description": "The number of impressions for which the buye
r successfully sent a response\nto Ad Exchange." |
3110 } | 3021 } |
3111 }, | 3022 }, |
3112 "type": "object" | 3023 "type": "object" |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3148 }, | 3059 }, |
3149 "type": "array" | 3060 "type": "array" |
3150 } | 3061 } |
3151 }, | 3062 }, |
3152 "type": "object" | 3063 "type": "object" |
3153 }, | 3064 }, |
3154 "BidMetricsRow": { | 3065 "BidMetricsRow": { |
3155 "description": "The set of metrics that are measured in numbers of b
ids, representing how\nmany bids with the specified dimension values were consid
ered eligible at\neach stage of the bidding funnel;", | 3066 "description": "The set of metrics that are measured in numbers of b
ids, representing how\nmany bids with the specified dimension values were consid
ered eligible at\neach stage of the bidding funnel;", |
3156 "id": "BidMetricsRow", | 3067 "id": "BidMetricsRow", |
3157 "properties": { | 3068 "properties": { |
| 3069 "measurableImpressions": { |
| 3070 "$ref": "MetricValue", |
| 3071 "description": "The number of bids for which the correspondi
ng impression was measurable\nfor viewability (as defined by Active View)." |
| 3072 }, |
| 3073 "bids": { |
| 3074 "$ref": "MetricValue", |
| 3075 "description": "The number of bids that Ad Exchange received
from the buyer." |
| 3076 }, |
| 3077 "billedImpressions": { |
| 3078 "$ref": "MetricValue", |
| 3079 "description": "The number of bids for which the buyer was b
illed." |
| 3080 }, |
3158 "bidsInAuction": { | 3081 "bidsInAuction": { |
3159 "$ref": "MetricValue", | 3082 "$ref": "MetricValue", |
3160 "description": "The number of bids that were permitted to co
mpete in the auction." | 3083 "description": "The number of bids that were permitted to co
mpete in the auction." |
3161 }, | 3084 }, |
3162 "rowDimensions": { | 3085 "rowDimensions": { |
3163 "$ref": "RowDimensions", | 3086 "$ref": "RowDimensions", |
3164 "description": "The values of all dimensions associated with
metric values in this row." | 3087 "description": "The values of all dimensions associated with
metric values in this row." |
3165 }, | 3088 }, |
3166 "viewableImpressions": { | |
3167 "$ref": "MetricValue", | |
3168 "description": "The number of bids for which the correspondi
ng impression was viewable (as\ndefined by Active View)." | |
3169 }, | |
3170 "impressionsWon": { | 3089 "impressionsWon": { |
3171 "$ref": "MetricValue", | 3090 "$ref": "MetricValue", |
3172 "description": "The number of bids that won an impression." | 3091 "description": "The number of bids that won an impression." |
3173 }, | 3092 }, |
3174 "measurableImpressions": { | 3093 "viewableImpressions": { |
3175 "$ref": "MetricValue", | 3094 "$ref": "MetricValue", |
3176 "description": "The number of bids for which the correspondi
ng impression was measurable\nfor viewability (as defined by Active View)." | 3095 "description": "The number of bids for which the correspondi
ng impression was viewable (as\ndefined by Active View)." |
3177 }, | |
3178 "bids": { | |
3179 "$ref": "MetricValue", | |
3180 "description": "The number of bids that Ad Exchange received
from the buyer." | |
3181 }, | |
3182 "billedImpressions": { | |
3183 "$ref": "MetricValue", | |
3184 "description": "The number of bids for which the buyer was b
illed." | |
3185 } | 3096 } |
3186 }, | 3097 }, |
3187 "type": "object" | 3098 "type": "object" |
3188 }, | 3099 }, |
3189 "ListBidResponseErrorsResponse": { | 3100 "ListBidResponseErrorsResponse": { |
3190 "description": "Response message for listing all reasons that bid re
sponses resulted in an\nerror.", | 3101 "description": "Response message for listing all reasons that bid re
sponses resulted in an\nerror.", |
3191 "id": "ListBidResponseErrorsResponse", | 3102 "id": "ListBidResponseErrorsResponse", |
3192 "properties": { | 3103 "properties": { |
| 3104 "nextPageToken": { |
| 3105 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the
subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to re
trieve the next page of results.", |
| 3106 "type": "string" |
| 3107 }, |
3193 "calloutStatusRows": { | 3108 "calloutStatusRows": { |
3194 "description": "List of rows, with counts of bid responses a
ggregated by callout status.", | 3109 "description": "List of rows, with counts of bid responses a
ggregated by callout status.", |
3195 "items": { | 3110 "items": { |
3196 "$ref": "CalloutStatusRow" | 3111 "$ref": "CalloutStatusRow" |
3197 }, | 3112 }, |
3198 "type": "array" | 3113 "type": "array" |
3199 }, | |
3200 "nextPageToken": { | |
3201 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the
subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to re
trieve the next page of results.", | |
3202 "type": "string" | |
3203 } | 3114 } |
3204 }, | 3115 }, |
3205 "type": "object" | 3116 "type": "object" |
3206 }, | 3117 }, |
3207 "CreativeStatusRow": { | 3118 "CreativeStatusRow": { |
3208 "description": "The number of bids with the specified dimension valu
es that did not win the\nauction (either were filtered pre-auction or lost the a
uction), as described\nby the specified creative status.", | 3119 "description": "The number of bids with the specified dimension valu
es that did not win the\nauction (either were filtered pre-auction or lost the a
uction), as described\nby the specified creative status.", |
3209 "id": "CreativeStatusRow", | 3120 "id": "CreativeStatusRow", |
3210 "properties": { | 3121 "properties": { |
3211 "rowDimensions": { | 3122 "rowDimensions": { |
3212 "$ref": "RowDimensions", | 3123 "$ref": "RowDimensions", |
(...skipping 20 matching lines...) Expand all Loading... |
3233 "format": "google-datetime", | 3144 "format": "google-datetime", |
3234 "type": "string" | 3145 "type": "string" |
3235 } | 3146 } |
3236 }, | 3147 }, |
3237 "type": "object" | 3148 "type": "object" |
3238 }, | 3149 }, |
3239 "NonBillableWinningBidStatusRow": { | 3150 "NonBillableWinningBidStatusRow": { |
3240 "description": "The number of winning bids with the specified dimens
ion values for which the\nbuyer was not billed, as described by the specified st
atus.", | 3151 "description": "The number of winning bids with the specified dimens
ion values for which the\nbuyer was not billed, as described by the specified st
atus.", |
3241 "id": "NonBillableWinningBidStatusRow", | 3152 "id": "NonBillableWinningBidStatusRow", |
3242 "properties": { | 3153 "properties": { |
| 3154 "rowDimensions": { |
| 3155 "$ref": "RowDimensions", |
| 3156 "description": "The values of all dimensions associated with
metric values in this row." |
| 3157 }, |
3243 "bidCount": { | 3158 "bidCount": { |
3244 "$ref": "MetricValue", | 3159 "$ref": "MetricValue", |
3245 "description": "The number of bids with the specified status
." | 3160 "description": "The number of bids with the specified status
." |
3246 }, | 3161 }, |
3247 "status": { | 3162 "status": { |
3248 "description": "The status specifying why the winning bids w
ere not billed.", | 3163 "description": "The status specifying why the winning bids w
ere not billed.", |
3249 "enum": [ | 3164 "enum": [ |
3250 "STATUS_UNSPECIFIED", | 3165 "STATUS_UNSPECIFIED", |
3251 "AD_NOT_RENDERED", | 3166 "AD_NOT_RENDERED", |
3252 "INVALID_IMPRESSION" | 3167 "INVALID_IMPRESSION" |
3253 ], | 3168 ], |
3254 "enumDescriptions": [ | 3169 "enumDescriptions": [ |
3255 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | 3170 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", |
3256 "The buyer was not billed because the ad was not rendere
d by the\npublisher.", | 3171 "The buyer was not billed because the ad was not rendere
d by the\npublisher.", |
3257 "The buyer was not billed because the impression won by
the bid was\ndetermined to be invalid." | 3172 "The buyer was not billed because the impression won by
the bid was\ndetermined to be invalid." |
3258 ], | 3173 ], |
3259 "type": "string" | 3174 "type": "string" |
3260 }, | |
3261 "rowDimensions": { | |
3262 "$ref": "RowDimensions", | |
3263 "description": "The values of all dimensions associated with
metric values in this row." | |
3264 } | 3175 } |
3265 }, | 3176 }, |
3266 "type": "object" | 3177 "type": "object" |
3267 }, | 3178 }, |
3268 "FilteredBidDetailRow": { | 3179 "FilteredBidDetailRow": { |
3269 "description": "The number of filtered bids with the specified dimen
sion values, among those\nfiltered due to the requested filtering reason (i.e. c
reative status), that\nhave the specified detail.", | 3180 "description": "The number of filtered bids with the specified dimen
sion values, among those\nfiltered due to the requested filtering reason (i.e. c
reative status), that\nhave the specified detail.", |
3270 "id": "FilteredBidDetailRow", | 3181 "id": "FilteredBidDetailRow", |
3271 "properties": { | 3182 "properties": { |
3272 "bidCount": { | 3183 "rowDimensions": { |
3273 "$ref": "MetricValue", | 3184 "$ref": "RowDimensions", |
3274 "description": "The number of bids with the specified detail
." | 3185 "description": "The values of all dimensions associated with
metric values in this row." |
3275 }, | 3186 }, |
3276 "detailId": { | 3187 "detailId": { |
3277 "description": "The ID of the detail. The associated value c
an be looked up in the\ndictionary file corresponding to the DetailType in the r
esponse message.", | 3188 "description": "The ID of the detail. The associated value c
an be looked up in the\ndictionary file corresponding to the DetailType in the r
esponse message.", |
3278 "format": "int32", | 3189 "format": "int32", |
3279 "type": "integer" | 3190 "type": "integer" |
3280 }, | 3191 }, |
3281 "rowDimensions": { | 3192 "bidCount": { |
3282 "$ref": "RowDimensions", | 3193 "$ref": "MetricValue", |
3283 "description": "The values of all dimensions associated with
metric values in this row." | 3194 "description": "The number of bids with the specified detail
." |
3284 } | 3195 } |
3285 }, | 3196 }, |
3286 "type": "object" | 3197 "type": "object" |
3287 }, | 3198 }, |
3288 "AbsoluteDateRange": { | 3199 "AbsoluteDateRange": { |
3289 "description": "An absolute date range, specified by its start date
and end date.\nThe supported range of dates begins 30 days before today and ends
today.\nValidity checked upon filter set creation. If a filter set with an abso
lute\ndate range is run at a later date more than 30 days after start_date, it w
ill\nfail.", | 3200 "description": "An absolute date range, specified by its start date
and end date.\nThe supported range of dates begins 30 days before today and ends
today.\nValidity checked upon filter set creation. If a filter set with an abso
lute\ndate range is run at a later date more than 30 days after start_date, it w
ill\nfail.", |
3290 "id": "AbsoluteDateRange", | 3201 "id": "AbsoluteDateRange", |
3291 "properties": { | 3202 "properties": { |
3292 "startDate": { | 3203 "startDate": { |
3293 "$ref": "Date", | 3204 "$ref": "Date", |
3294 "description": "The start date of the range (inclusive).\nMu
st be within the 30 days leading up to current date, and must be equal to\nor be
fore end_date." | 3205 "description": "The start date of the range (inclusive).\nMu
st be within the 30 days leading up to current date, and must be equal to\nor be
fore end_date." |
3295 }, | 3206 }, |
3296 "endDate": { | 3207 "endDate": { |
3297 "$ref": "Date", | 3208 "$ref": "Date", |
3298 "description": "The end date of the range (inclusive).\nMust
be within the 30 days leading up to current date, and must be equal to\nor afte
r start_date." | 3209 "description": "The end date of the range (inclusive).\nMust
be within the 30 days leading up to current date, and must be equal to\nor afte
r start_date." |
3299 } | 3210 } |
3300 }, | 3211 }, |
3301 "type": "object" | 3212 "type": "object" |
3302 }, | |
3303 "AddDealAssociationRequest": { | |
3304 "description": "A request for associating a deal and a creative.", | |
3305 "id": "AddDealAssociationRequest", | |
3306 "properties": { | |
3307 "association": { | |
3308 "$ref": "CreativeDealAssociation", | |
3309 "description": "The association between a creative and a dea
l that should be added." | |
3310 } | |
3311 }, | |
3312 "type": "object" | |
3313 } | 3213 } |
3314 }, | 3214 }, |
3315 "servicePath": "", | 3215 "servicePath": "", |
3316 "title": "Ad Exchange Buyer API II", | 3216 "title": "Ad Exchange Buyer API II", |
3317 "version": "v2beta1" | 3217 "version": "v2beta1" |
3318 } | 3218 } |
OLD | NEW |