| 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 }, |
| (...skipping 98 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 109 "upload_protocol": { | 109 "upload_protocol": { |
| 110 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 110 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 111 "location": "query", | 111 "location": "query", |
| 112 "type": "string" | 112 "type": "string" |
| 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 "getBidMetrics": { | 121 "update": { |
| 122 "description": "Gets all metrics that are measured i
n terms of number of bids.", | 122 "description": "Updates an existing client buyer.", |
| 123 "httpMethod": "GET", | 123 "httpMethod": "PUT", |
| 124 "id": "adexchangebuyer2.accounts.filterSets.getBidMe
trics", | 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 "clientAccountId": { |
| 131 "description": "The ID of the filter set to
apply.", | 131 "description": "Unique numerical account ID
of the client to update. (required)", |
| 132 "format": "int32", | 132 "format": "int64", |
| 133 "location": "path", | 133 "location": "path", |
| 134 "required": true, | 134 "required": true, |
| 135 "type": "integer" | 135 "type": "string" |
| 136 }, | 136 }, |
| 137 "accountId": { | 137 "accountId": { |
| 138 "description": "Account ID of the buyer.", | 138 "description": "Unique numerical account ID
for the buyer of which the client buyer\nis a customer; the sponsor buyer to upd
ate a client for. (required)", |
| 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}/bidMetrics", | 145 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", |
| 146 "request": { |
| 147 "$ref": "Client" |
| 148 }, |
| 146 "response": { | 149 "response": { |
| 147 "$ref": "BidMetrics" | 150 "$ref": "Client" |
| 151 }, |
| 152 "scopes": [ |
| 153 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 154 ] |
| 155 }, |
| 156 "get": { |
| 157 "description": "Gets a client buyer with a given cli
ent account ID.", |
| 158 "httpMethod": "GET", |
| 159 "id": "adexchangebuyer2.accounts.clients.get", |
| 160 "parameterOrder": [ |
| 161 "accountId", |
| 162 "clientAccountId" |
| 163 ], |
| 164 "parameters": { |
| 165 "clientAccountId": { |
| 166 "description": "Numerical account ID of the
client buyer to retrieve. (required)", |
| 167 "format": "int64", |
| 168 "location": "path", |
| 169 "required": true, |
| 170 "type": "string" |
| 171 }, |
| 172 "accountId": { |
| 173 "description": "Numerical account ID of the
client's sponsor buyer. (required)", |
| 174 "format": "int64", |
| 175 "location": "path", |
| 176 "required": true, |
| 177 "type": "string" |
| 178 } |
| 179 }, |
| 180 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", |
| 181 "response": { |
| 182 "$ref": "Client" |
| 183 }, |
| 184 "scopes": [ |
| 185 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 186 ] |
| 187 }, |
| 188 "create": { |
| 189 "description": "Creates a new client buyer.", |
| 190 "httpMethod": "POST", |
| 191 "id": "adexchangebuyer2.accounts.clients.create", |
| 192 "parameterOrder": [ |
| 193 "accountId" |
| 194 ], |
| 195 "parameters": { |
| 196 "accountId": { |
| 197 "description": "Unique numerical account ID
for the buyer of which the client buyer\nis a customer; the sponsor buyer to cre
ate a client for. (required)", |
| 198 "format": "int64", |
| 199 "location": "path", |
| 200 "required": true, |
| 201 "type": "string" |
| 202 } |
| 203 }, |
| 204 "path": "v2beta1/accounts/{accountId}/clients", |
| 205 "request": { |
| 206 "$ref": "Client" |
| 207 }, |
| 208 "response": { |
| 209 "$ref": "Client" |
| 148 }, | 210 }, |
| 149 "scopes": [ | 211 "scopes": [ |
| 150 "https://www.googleapis.com/auth/adexchange.buye
r" | 212 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 151 ] | 213 ] |
| 152 }, | 214 }, |
| 153 "list": { | 215 "list": { |
| 154 "description": "Lists all filter sets for the accoun
t with the given account ID.", | 216 "description": "Lists all the clients for the curren
t sponsor buyer.", |
| 155 "httpMethod": "GET", | 217 "httpMethod": "GET", |
| 156 "id": "adexchangebuyer2.accounts.filterSets.list", | 218 "id": "adexchangebuyer2.accounts.clients.list", |
| 157 "parameterOrder": [ | 219 "parameterOrder": [ |
| 158 "accountId" | 220 "accountId" |
| 159 ], | 221 ], |
| 160 "parameters": { | 222 "parameters": { |
| 161 "pageSize": { | 223 "pageSize": { |
| 162 "description": "Requested page size. The ser
ver may return fewer than requested.\nIf unspecified, the server will pick an ap
propriate default.", | 224 "description": "Requested page size. The ser
ver may return fewer clients than requested.\nIf unspecified, the server will pi
ck an appropriate default.", |
| 163 "format": "int32", | 225 "format": "int32", |
| 164 "location": "query", | 226 "location": "query", |
| 165 "type": "integer" | 227 "type": "integer" |
| 166 }, | 228 }, |
| 167 "accountId": { | 229 "accountId": { |
| 168 "description": "Account ID of the buyer.", | 230 "description": "Unique numerical account ID
of the sponsor buyer to list the clients for.", |
| 169 "format": "int64", | 231 "format": "int64", |
| 170 "location": "path", | 232 "location": "path", |
| 171 "required": true, | 233 "required": true, |
| 172 "type": "string" | 234 "type": "string" |
| 173 }, | 235 }, |
| 174 "pageToken": { | 236 "pageToken": { |
| 175 "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.rtb
Breakout.filterSets.list method.", | 237 "description": "A token identifying a page o
f results the server should return.\nTypically, this is the value of\nListClient
sResponse.nextPageToken\nreturned from the previous call to the\naccounts.client
s.list method.", |
| 176 "location": "query", | 238 "location": "query", |
| 177 "type": "string" | 239 "type": "string" |
| 178 } | 240 } |
| 179 }, | 241 }, |
| 180 "path": "v2beta1/accounts/{accountId}/filterSets", | 242 "path": "v2beta1/accounts/{accountId}/clients", |
| 181 "response": { | 243 "response": { |
| 182 "$ref": "ListFilterSetsResponse" | 244 "$ref": "ListClientsResponse" |
| 183 }, | 245 }, |
| 184 "scopes": [ | 246 "scopes": [ |
| 185 "https://www.googleapis.com/auth/adexchange.buye
r" | 247 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 186 ] | |
| 187 }, | |
| 188 "get": { | |
| 189 "description": "Retrieves the requested filter set f
or the account with the given account\nID.", | |
| 190 "httpMethod": "GET", | |
| 191 "id": "adexchangebuyer2.accounts.filterSets.get", | |
| 192 "parameterOrder": [ | |
| 193 "accountId", | |
| 194 "filterSetId" | |
| 195 ], | |
| 196 "parameters": { | |
| 197 "filterSetId": { | |
| 198 "description": "The ID of the filter set to
get.", | |
| 199 "format": "int32", | |
| 200 "location": "path", | |
| 201 "required": true, | |
| 202 "type": "integer" | |
| 203 }, | |
| 204 "accountId": { | |
| 205 "description": "Account ID of the buyer.", | |
| 206 "format": "int64", | |
| 207 "location": "path", | |
| 208 "required": true, | |
| 209 "type": "string" | |
| 210 } | |
| 211 }, | |
| 212 "path": "v2beta1/accounts/{accountId}/filterSets/{fi
lterSetId}", | |
| 213 "response": { | |
| 214 "$ref": "FilterSet" | |
| 215 }, | |
| 216 "scopes": [ | |
| 217 "https://www.googleapis.com/auth/adexchange.buye
r" | |
| 218 ] | |
| 219 }, | |
| 220 "create": { | |
| 221 "description": "Creates the specified filter set for
the account with the given account ID.", | |
| 222 "httpMethod": "POST", | |
| 223 "id": "adexchangebuyer2.accounts.filterSets.create", | |
| 224 "parameterOrder": [ | |
| 225 "accountId" | |
| 226 ], | |
| 227 "parameters": { | |
| 228 "isTransient": { | |
| 229 "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
.", | |
| 230 "location": "query", | |
| 231 "type": "boolean" | |
| 232 }, | |
| 233 "accountId": { | |
| 234 "description": "Account ID of the buyer.", | |
| 235 "format": "int64", | |
| 236 "location": "path", | |
| 237 "required": true, | |
| 238 "type": "string" | |
| 239 } | |
| 240 }, | |
| 241 "path": "v2beta1/accounts/{accountId}/filterSets", | |
| 242 "request": { | |
| 243 "$ref": "FilterSet" | |
| 244 }, | |
| 245 "response": { | |
| 246 "$ref": "FilterSet" | |
| 247 }, | |
| 248 "scopes": [ | |
| 249 "https://www.googleapis.com/auth/adexchange.buye
r" | |
| 250 ] | |
| 251 }, | |
| 252 "getImpressionMetrics": { | |
| 253 "description": "Gets all metrics that are measured i
n terms of number of impressions.", | |
| 254 "httpMethod": "GET", | |
| 255 "id": "adexchangebuyer2.accounts.filterSets.getImpre
ssionMetrics", | |
| 256 "parameterOrder": [ | |
| 257 "accountId", | |
| 258 "filterSetId" | |
| 259 ], | |
| 260 "parameters": { | |
| 261 "filterSetId": { | |
| 262 "description": "The ID of the filter set to
apply.", | |
| 263 "format": "int32", | |
| 264 "location": "path", | |
| 265 "required": true, | |
| 266 "type": "integer" | |
| 267 }, | |
| 268 "accountId": { | |
| 269 "description": "Account ID of the buyer.", | |
| 270 "format": "int64", | |
| 271 "location": "path", | |
| 272 "required": true, | |
| 273 "type": "string" | |
| 274 } | |
| 275 }, | |
| 276 "path": "v2beta1/accounts/{accountId}/filterSets/{fi
lterSetId}/impressionMetrics", | |
| 277 "response": { | |
| 278 "$ref": "ImpressionMetrics" | |
| 279 }, | |
| 280 "scopes": [ | |
| 281 "https://www.googleapis.com/auth/adexchange.buye
r" | |
| 282 ] | |
| 283 }, | |
| 284 "delete": { | |
| 285 "description": "Deletes the requested filter set fro
m the account with the given account\nID.", | |
| 286 "httpMethod": "DELETE", | |
| 287 "id": "adexchangebuyer2.accounts.filterSets.delete", | |
| 288 "parameterOrder": [ | |
| 289 "accountId", | |
| 290 "filterSetId" | |
| 291 ], | |
| 292 "parameters": { | |
| 293 "filterSetId": { | |
| 294 "description": "The ID of the filter set to
delete.", | |
| 295 "format": "int32", | |
| 296 "location": "path", | |
| 297 "required": true, | |
| 298 "type": "integer" | |
| 299 }, | |
| 300 "accountId": { | |
| 301 "description": "Account ID of the buyer.", | |
| 302 "format": "int64", | |
| 303 "location": "path", | |
| 304 "required": true, | |
| 305 "type": "string" | |
| 306 } | |
| 307 }, | |
| 308 "path": "v2beta1/accounts/{accountId}/filterSets/{fi
lterSetId}", | |
| 309 "response": { | |
| 310 "$ref": "Empty" | |
| 311 }, | |
| 312 "scopes": [ | |
| 313 "https://www.googleapis.com/auth/adexchange.buye
r" | |
| 314 ] | 248 ] |
| 315 } | 249 } |
| 316 }, | 250 }, |
| 317 "resources": { | 251 "resources": { |
| 318 "responsesWithoutBids": { | 252 "users": { |
| 319 "methods": { | 253 "methods": { |
| 320 "list": { | 254 "update": { |
| 321 "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.", | 255 "description": "Updates an existing client u
ser.\nOnly the user status can be changed on update.", |
| 322 "httpMethod": "GET", | 256 "httpMethod": "PUT", |
| 323 "id": "adexchangebuyer2.accounts.filterSets.
responsesWithoutBids.list", | 257 "id": "adexchangebuyer2.accounts.clients.use
rs.update", |
| 324 "parameterOrder": [ | 258 "parameterOrder": [ |
| 325 "accountId", | 259 "accountId", |
| 326 "filterSetId" | 260 "clientAccountId", |
| 261 "userId" |
| 327 ], | 262 ], |
| 328 "parameters": { | 263 "parameters": { |
| 329 "filterSetId": { | 264 "clientAccountId": { |
| 330 "description": "The ID of the filter
set to apply.", | 265 "description": "Numerical account ID
of the client buyer that the user to be retrieved\nis associated with. (require
d)", |
| 331 "format": "int32", | 266 "format": "int64", |
| 332 "location": "path", | 267 "location": "path", |
| 333 "required": true, | 268 "required": true, |
| 334 "type": "integer" | 269 "type": "string" |
| 270 }, |
| 271 "userId": { |
| 272 "description": "Numerical identifier
of the user to retrieve. (required)", |
| 273 "format": "int64", |
| 274 "location": "path", |
| 275 "required": true, |
| 276 "type": "string" |
| 335 }, | 277 }, |
| 336 "accountId": { | 278 "accountId": { |
| 337 "description": "Account ID of the bu
yer.", | 279 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
| 338 "format": "int64", | 280 "format": "int64", |
| 339 "location": "path", | 281 "location": "path", |
| 340 "required": true, | 282 "required": true, |
| 341 "type": "string" | 283 "type": "string" |
| 342 } | 284 } |
| 343 }, | 285 }, |
| 344 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/responsesWithoutBids", | 286 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", |
| 287 "request": { |
| 288 "$ref": "ClientUser" |
| 289 }, |
| 345 "response": { | 290 "response": { |
| 346 "$ref": "ListResponsesWithoutBidsRespons
e" | 291 "$ref": "ClientUser" |
| 347 }, | 292 }, |
| 348 "scopes": [ | 293 "scopes": [ |
| 349 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 294 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 350 ] | 295 ] |
| 351 } | 296 }, |
| 352 } | 297 "get": { |
| 353 }, | 298 "description": "Retrieves an existing client
user.", |
| 354 "responseErrors": { | |
| 355 "methods": { | |
| 356 "list": { | |
| 357 "description": "List all errors that occurre
d in bid responses, with the number of bid\nresponses affected for each reason."
, | |
| 358 "httpMethod": "GET", | 299 "httpMethod": "GET", |
| 359 "id": "adexchangebuyer2.accounts.filterSets.
responseErrors.list", | 300 "id": "adexchangebuyer2.accounts.clients.use
rs.get", |
| 360 "parameterOrder": [ | 301 "parameterOrder": [ |
| 361 "accountId", | 302 "accountId", |
| 362 "filterSetId" | 303 "clientAccountId", |
| 304 "userId" |
| 363 ], | 305 ], |
| 364 "parameters": { | 306 "parameters": { |
| 365 "filterSetId": { | 307 "clientAccountId": { |
| 366 "description": "The ID of the filter
set to apply.", | 308 "description": "Numerical account ID
of the client buyer\nthat the user to be retrieved is associated with. (require
d)", |
| 367 "format": "int32", | 309 "format": "int64", |
| 368 "location": "path", | 310 "location": "path", |
| 369 "required": true, | 311 "required": true, |
| 370 "type": "integer" | 312 "type": "string" |
| 313 }, |
| 314 "userId": { |
| 315 "description": "Numerical identifier
of the user to retrieve. (required)", |
| 316 "format": "int64", |
| 317 "location": "path", |
| 318 "required": true, |
| 319 "type": "string" |
| 371 }, | 320 }, |
| 372 "accountId": { | 321 "accountId": { |
| 373 "description": "Account ID of the bu
yer.", | 322 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
| 374 "format": "int64", | 323 "format": "int64", |
| 375 "location": "path", | 324 "location": "path", |
| 376 "required": true, | 325 "required": true, |
| 377 "type": "string" | 326 "type": "string" |
| 378 } | 327 } |
| 379 }, | 328 }, |
| 380 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/responseErrors", | 329 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", |
| 381 "response": { | 330 "response": { |
| 382 "$ref": "ListResponseErrorsResponse" | 331 "$ref": "ClientUser" |
| 383 }, | 332 }, |
| 384 "scopes": [ | 333 "scopes": [ |
| 385 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 334 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 386 ] | 335 ] |
| 387 } | 336 }, |
| 388 } | |
| 389 }, | |
| 390 "losingBids": { | |
| 391 "methods": { | |
| 392 "list": { | 337 "list": { |
| 393 "description": "List all reasons for which b
ids lost in the auction, with the number of\nbids that lost for each reason.", | 338 "description": "Lists all the known client u
sers for a specified\nsponsor buyer account ID.", |
| 394 "httpMethod": "GET", | 339 "httpMethod": "GET", |
| 395 "id": "adexchangebuyer2.accounts.filterSets.
losingBids.list", | 340 "id": "adexchangebuyer2.accounts.clients.use
rs.list", |
| 396 "parameterOrder": [ | 341 "parameterOrder": [ |
| 397 "accountId", | 342 "accountId", |
| 398 "filterSetId" | 343 "clientAccountId" |
| 399 ], | 344 ], |
| 400 "parameters": { | 345 "parameters": { |
| 401 "filterSetId": { | 346 "clientAccountId": { |
| 402 "description": "The ID of the filter
set to apply.", | 347 "description": "The account ID of th
e client buyer to list users for. (required)\nYou must specify either a string r
epresentation of a\nnumerical account identifier or the `-` character\nto list a
ll the client users for all the clients\nof a given sponsor buyer.", |
| 403 "format": "int32", | |
| 404 "location": "path", | 348 "location": "path", |
| 405 "required": true, | 349 "required": true, |
| 350 "type": "string" |
| 351 }, |
| 352 "pageSize": { |
| 353 "description": "Requested page size.
The server may return fewer clients than requested.\nIf unspecified, the server
will pick an appropriate default.", |
| 354 "format": "int32", |
| 355 "location": "query", |
| 406 "type": "integer" | 356 "type": "integer" |
| 407 }, | 357 }, |
| 408 "accountId": { | 358 "accountId": { |
| 409 "description": "Account ID of the bu
yer.", | 359 "description": "Numerical account ID
of the sponsor buyer of the client to list users for.\n(required)", |
| 410 "format": "int64", | 360 "format": "int64", |
| 411 "location": "path", | 361 "location": "path", |
| 412 "required": true, | 362 "required": true, |
| 413 "type": "string" | 363 "type": "string" |
| 364 }, |
| 365 "pageToken": { |
| 366 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stClientUsersResponse.nextPageToken\nreturned from the previous call to the\nacc
ounts.clients.users.list method.", |
| 367 "location": "query", |
| 368 "type": "string" |
| 414 } | 369 } |
| 415 }, | 370 }, |
| 416 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/losingBids", | 371 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users", |
| 417 "response": { | 372 "response": { |
| 418 "$ref": "ListLosingBidsResponse" | 373 "$ref": "ListClientUsersResponse" |
| 419 }, | 374 }, |
| 420 "scopes": [ | 375 "scopes": [ |
| 421 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 376 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 422 ] | 377 ] |
| 423 } | 378 } |
| 424 } | 379 } |
| 425 }, | 380 }, |
| 426 "filteredBids": { | 381 "invitations": { |
| 427 "methods": { | 382 "methods": { |
| 428 "list": { | 383 "create": { |
| 429 "description": "List all reasons for which b
ids were filtered, with the number of bids\nfiltered for each reason.", | 384 "description": "Creates and sends out an ema
il invitation to access\nan Ad Exchange client buyer account.", |
| 430 "httpMethod": "GET", | 385 "httpMethod": "POST", |
| 431 "id": "adexchangebuyer2.accounts.filterSets.
filteredBids.list", | 386 "id": "adexchangebuyer2.accounts.clients.inv
itations.create", |
| 432 "parameterOrder": [ | 387 "parameterOrder": [ |
| 433 "accountId", | 388 "accountId", |
| 434 "filterSetId" | 389 "clientAccountId" |
| 435 ], | 390 ], |
| 436 "parameters": { | 391 "parameters": { |
| 437 "filterSetId": { | 392 "clientAccountId": { |
| 438 "description": "The ID of the filter
set to apply.", | 393 "description": "Numerical account ID
of the client buyer that the user\nshould be associated with. (required)", |
| 439 "format": "int32", | 394 "format": "int64", |
| 440 "location": "path", | 395 "location": "path", |
| 441 "required": true, | 396 "required": true, |
| 442 "type": "integer" | 397 "type": "string" |
| 443 }, | 398 }, |
| 444 "accountId": { | 399 "accountId": { |
| 445 "description": "Account ID of the bu
yer.", | 400 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
| 446 "format": "int64", | 401 "format": "int64", |
| 447 "location": "path", | 402 "location": "path", |
| 448 "required": true, | 403 "required": true, |
| 449 "type": "string" | 404 "type": "string" |
| 450 } | 405 } |
| 451 }, | 406 }, |
| 452 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/filteredBids", | 407 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", |
| 408 "request": { |
| 409 "$ref": "ClientUserInvitation" |
| 410 }, |
| 453 "response": { | 411 "response": { |
| 454 "$ref": "ListFilteredBidsResponse" | 412 "$ref": "ClientUserInvitation" |
| 455 }, | 413 }, |
| 456 "scopes": [ | 414 "scopes": [ |
| 457 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 415 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 458 ] | 416 ] |
| 459 } | |
| 460 }, | |
| 461 "resources": { | |
| 462 "creatives": { | |
| 463 "methods": { | |
| 464 "list": { | |
| 465 "description": "List all creatives a
ssociated with a specific reason for which bids were\nfiltered, with the number
of bids filtered for each creative.", | |
| 466 "httpMethod": "GET", | |
| 467 "id": "adexchangebuyer2.accounts.fil
terSets.filteredBids.creatives.list", | |
| 468 "parameterOrder": [ | |
| 469 "accountId", | |
| 470 "filterSetId", | |
| 471 "creativeStatusId" | |
| 472 ], | |
| 473 "parameters": { | |
| 474 "filterSetId": { | |
| 475 "description": "The ID of th
e filter set to apply.", | |
| 476 "format": "int32", | |
| 477 "location": "path", | |
| 478 "required": true, | |
| 479 "type": "integer" | |
| 480 }, | |
| 481 "creativeStatusId": { | |
| 482 "description": "The ID of th
e creative status for which to retrieve a breakdown by\ncreative.\nSee creative-
status-codes.", | |
| 483 "format": "int32", | |
| 484 "location": "path", | |
| 485 "required": true, | |
| 486 "type": "integer" | |
| 487 }, | |
| 488 "pageSize": { | |
| 489 "description": "Requested pa
ge size. The server may return fewer than requested.\nIf unspecified, the server
will pick an appropriate default.", | |
| 490 "format": "int32", | |
| 491 "location": "query", | |
| 492 "type": "integer" | |
| 493 }, | |
| 494 "accountId": { | |
| 495 "description": "Account ID o
f the buyer.", | |
| 496 "format": "int64", | |
| 497 "location": "path", | |
| 498 "required": true, | |
| 499 "type": "string" | |
| 500 }, | |
| 501 "pageToken": { | |
| 502 "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 metho
d.", | |
| 503 "location": "query", | |
| 504 "type": "string" | |
| 505 } | |
| 506 }, | |
| 507 "path": "v2beta1/accounts/{accountId
}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives", | |
| 508 "response": { | |
| 509 "$ref": "ListCreativeStatusBreak
downByCreativeResponse" | |
| 510 }, | |
| 511 "scopes": [ | |
| 512 "https://www.googleapis.com/auth
/adexchange.buyer" | |
| 513 ] | |
| 514 } | |
| 515 }, | |
| 516 "resources": { | |
| 517 "details": { | |
| 518 "methods": { | |
| 519 "list": { | |
| 520 "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.", | |
| 521 "httpMethod": "GET", | |
| 522 "id": "adexchangebuyer2.acco
unts.filterSets.filteredBids.creatives.details.list", | |
| 523 "parameterOrder": [ | |
| 524 "accountId", | |
| 525 "filterSetId", | |
| 526 "creativeStatusId", | |
| 527 "creativeId" | |
| 528 ], | |
| 529 "parameters": { | |
| 530 "filterSetId": { | |
| 531 "description": "The
ID of the filter set to apply.", | |
| 532 "format": "int32", | |
| 533 "location": "path", | |
| 534 "required": true, | |
| 535 "type": "integer" | |
| 536 }, | |
| 537 "creativeStatusId": { | |
| 538 "description": "The
ID of the creative status for which to retrieve a breakdown by detail.\nSee crea
tive-status-codes.", | |
| 539 "format": "int32", | |
| 540 "location": "path", | |
| 541 "required": true, | |
| 542 "type": "integer" | |
| 543 }, | |
| 544 "creativeId": { | |
| 545 "description": "The
creative ID for which to retrieve a breakdown by detail.", | |
| 546 "location": "path", | |
| 547 "required": true, | |
| 548 "type": "string" | |
| 549 }, | |
| 550 "accountId": { | |
| 551 "description": "Acco
unt ID of the buyer.", | |
| 552 "format": "int64", | |
| 553 "location": "path", | |
| 554 "required": true, | |
| 555 "type": "string" | |
| 556 } | |
| 557 }, | |
| 558 "path": "v2beta1/accounts/{a
ccountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives/{cr
eativeId}/details", | |
| 559 "response": { | |
| 560 "$ref": "ListCreativeSta
tusAndCreativeBreakdownByDetailResponse" | |
| 561 }, | |
| 562 "scopes": [ | |
| 563 "https://www.googleapis.
com/auth/adexchange.buyer" | |
| 564 ] | |
| 565 } | |
| 566 } | |
| 567 } | |
| 568 } | |
| 569 }, | 417 }, |
| 570 "details": { | 418 "get": { |
| 571 "methods": { | 419 "description": "Retrieves an existing client
user invitation.", |
| 572 "list": { | |
| 573 "description": "List all details ass
ociated with a specific reason for which bids were\nfiltered, with the number of
bids filtered for each detail.", | |
| 574 "httpMethod": "GET", | |
| 575 "id": "adexchangebuyer2.accounts.fil
terSets.filteredBids.details.list", | |
| 576 "parameterOrder": [ | |
| 577 "accountId", | |
| 578 "filterSetId", | |
| 579 "creativeStatusId" | |
| 580 ], | |
| 581 "parameters": { | |
| 582 "filterSetId": { | |
| 583 "description": "The ID of th
e filter set to apply.", | |
| 584 "format": "int32", | |
| 585 "location": "path", | |
| 586 "required": true, | |
| 587 "type": "integer" | |
| 588 }, | |
| 589 "creativeStatusId": { | |
| 590 "description": "The ID of th
e creative status for which to retrieve a breakdown by detail.\nSee creative-sta
tus-codes.", | |
| 591 "format": "int32", | |
| 592 "location": "path", | |
| 593 "required": true, | |
| 594 "type": "integer" | |
| 595 }, | |
| 596 "accountId": { | |
| 597 "description": "Account ID o
f the buyer.", | |
| 598 "format": "int64", | |
| 599 "location": "path", | |
| 600 "required": true, | |
| 601 "type": "string" | |
| 602 } | |
| 603 }, | |
| 604 "path": "v2beta1/accounts/{accountId
}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details", | |
| 605 "response": { | |
| 606 "$ref": "ListCreativeStatusBreak
downByDetailResponse" | |
| 607 }, | |
| 608 "scopes": [ | |
| 609 "https://www.googleapis.com/auth
/adexchange.buyer" | |
| 610 ] | |
| 611 } | |
| 612 } | |
| 613 } | |
| 614 } | |
| 615 }, | |
| 616 "filteredImpressions": { | |
| 617 "methods": { | |
| 618 "list": { | |
| 619 "description": "List all reasons that caused
an impression to be filtered (i.e. not\nconsidered as an inventory match), with
the number of impressions that were\nfiltered for each reason.", | |
| 620 "httpMethod": "GET", | 420 "httpMethod": "GET", |
| 621 "id": "adexchangebuyer2.accounts.filterSets.
filteredImpressions.list", | 421 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", |
| 622 "parameterOrder": [ | 422 "parameterOrder": [ |
| 623 "accountId", | 423 "accountId", |
| 624 "filterSetId" | 424 "clientAccountId", |
| 425 "invitationId" |
| 625 ], | 426 ], |
| 626 "parameters": { | 427 "parameters": { |
| 627 "filterSetId": { | 428 "clientAccountId": { |
| 628 "description": "The ID of the filter
set to apply.", | 429 "description": "Numerical account ID
of the client buyer that the user invitation\nto be retrieved is associated wit
h. (required)", |
| 629 "format": "int32", | 430 "format": "int64", |
| 630 "location": "path", | 431 "location": "path", |
| 631 "required": true, | 432 "required": true, |
| 632 "type": "integer" | 433 "type": "string" |
| 434 }, |
| 435 "invitationId": { |
| 436 "description": "Numerical identifier
of the user invitation to retrieve. (required)", |
| 437 "format": "int64", |
| 438 "location": "path", |
| 439 "required": true, |
| 440 "type": "string" |
| 633 }, | 441 }, |
| 634 "accountId": { | 442 "accountId": { |
| 635 "description": "Account ID of the bu
yer.", | 443 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
| 636 "format": "int64", | 444 "format": "int64", |
| 637 "location": "path", | 445 "location": "path", |
| 638 "required": true, | 446 "required": true, |
| 639 "type": "string" | 447 "type": "string" |
| 640 } | 448 } |
| 641 }, | 449 }, |
| 642 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/filteredImpressions", | 450 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations/{invitationId}", |
| 643 "response": { | 451 "response": { |
| 644 "$ref": "ListFilteredImpressionsResponse
" | 452 "$ref": "ClientUserInvitation" |
| 645 }, | 453 }, |
| 646 "scopes": [ | 454 "scopes": [ |
| 647 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 455 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 648 ] | 456 ] |
| 649 } | 457 }, |
| 650 } | |
| 651 }, | |
| 652 "filteredRequests": { | |
| 653 "methods": { | |
| 654 "list": { | 458 "list": { |
| 655 "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.", | 459 "description": "Lists all the client users i
nvitations for a client\nwith a given account ID.", |
| 656 "httpMethod": "GET", | 460 "httpMethod": "GET", |
| 657 "id": "adexchangebuyer2.accounts.filterSets.
filteredRequests.list", | 461 "id": "adexchangebuyer2.accounts.clients.inv
itations.list", |
| 658 "parameterOrder": [ | 462 "parameterOrder": [ |
| 659 "accountId", | 463 "accountId", |
| 660 "filterSetId" | 464 "clientAccountId" |
| 661 ], | 465 ], |
| 662 "parameters": { | 466 "parameters": { |
| 663 "filterSetId": { | 467 "clientAccountId": { |
| 664 "description": "The ID of the filter
set to apply.", | 468 "description": "Numerical account ID
of the client buyer to list invitations for.\n(required)\nYou must either speci
fy a string representation of a\nnumerical account identifier or the `-` charact
er\nto list all the invitations for all the clients\nof a given sponsor buyer.", |
| 665 "format": "int32", | |
| 666 "location": "path", | 469 "location": "path", |
| 667 "required": true, | 470 "required": true, |
| 471 "type": "string" |
| 472 }, |
| 473 "pageSize": { |
| 474 "description": "Requested page size.
Server may return fewer clients than requested.\nIf unspecified, server will pi
ck an appropriate default.", |
| 475 "format": "int32", |
| 476 "location": "query", |
| 668 "type": "integer" | 477 "type": "integer" |
| 669 }, | 478 }, |
| 670 "accountId": { | 479 "accountId": { |
| 671 "description": "Account ID of the bu
yer.", | 480 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
| 672 "format": "int64", | 481 "format": "int64", |
| 673 "location": "path", | 482 "location": "path", |
| 674 "required": true, | 483 "required": true, |
| 675 "type": "string" | 484 "type": "string" |
| 485 }, |
| 486 "pageToken": { |
| 487 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stClientUserInvitationsResponse.nextPageToken\nreturned from the previous call t
o the\nclients.invitations.list\nmethod.", |
| 488 "location": "query", |
| 489 "type": "string" |
| 676 } | 490 } |
| 677 }, | 491 }, |
| 678 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/filteredRequests", | 492 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", |
| 679 "response": { | 493 "response": { |
| 680 "$ref": "ListFilteredRequestsResponse" | 494 "$ref": "ListClientUserInvitationsRespon
se" |
| 681 }, | 495 }, |
| 682 "scopes": [ | 496 "scopes": [ |
| 683 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 497 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 684 ] | 498 ] |
| 685 } | 499 } |
| 686 } | 500 } |
| 687 } | 501 } |
| 688 } | 502 } |
| 689 }, | |
| 690 "clients": { | |
| 691 "methods": { | |
| 692 "update": { | |
| 693 "description": "Updates an existing client buyer.", | |
| 694 "httpMethod": "PUT", | |
| 695 "id": "adexchangebuyer2.accounts.clients.update", | |
| 696 "parameterOrder": [ | |
| 697 "accountId", | |
| 698 "clientAccountId" | |
| 699 ], | |
| 700 "parameters": { | |
| 701 "clientAccountId": { | |
| 702 "description": "Unique numerical account ID
of the client to update. (required)", | |
| 703 "format": "int64", | |
| 704 "location": "path", | |
| 705 "required": true, | |
| 706 "type": "string" | |
| 707 }, | |
| 708 "accountId": { | |
| 709 "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)", | |
| 710 "format": "int64", | |
| 711 "location": "path", | |
| 712 "required": true, | |
| 713 "type": "string" | |
| 714 } | |
| 715 }, | |
| 716 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", | |
| 717 "request": { | |
| 718 "$ref": "Client" | |
| 719 }, | |
| 720 "response": { | |
| 721 "$ref": "Client" | |
| 722 }, | |
| 723 "scopes": [ | |
| 724 "https://www.googleapis.com/auth/adexchange.buye
r" | |
| 725 ] | |
| 726 }, | |
| 727 "get": { | |
| 728 "description": "Gets a client buyer with a given cli
ent account ID.", | |
| 729 "httpMethod": "GET", | |
| 730 "id": "adexchangebuyer2.accounts.clients.get", | |
| 731 "parameterOrder": [ | |
| 732 "accountId", | |
| 733 "clientAccountId" | |
| 734 ], | |
| 735 "parameters": { | |
| 736 "clientAccountId": { | |
| 737 "description": "Numerical account ID of the
client buyer to retrieve. (required)", | |
| 738 "format": "int64", | |
| 739 "location": "path", | |
| 740 "required": true, | |
| 741 "type": "string" | |
| 742 }, | |
| 743 "accountId": { | |
| 744 "description": "Numerical account ID of the
client's sponsor buyer. (required)", | |
| 745 "format": "int64", | |
| 746 "location": "path", | |
| 747 "required": true, | |
| 748 "type": "string" | |
| 749 } | |
| 750 }, | |
| 751 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", | |
| 752 "response": { | |
| 753 "$ref": "Client" | |
| 754 }, | |
| 755 "scopes": [ | |
| 756 "https://www.googleapis.com/auth/adexchange.buye
r" | |
| 757 ] | |
| 758 }, | |
| 759 "create": { | |
| 760 "description": "Creates a new client buyer.", | |
| 761 "httpMethod": "POST", | |
| 762 "id": "adexchangebuyer2.accounts.clients.create", | |
| 763 "parameterOrder": [ | |
| 764 "accountId" | |
| 765 ], | |
| 766 "parameters": { | |
| 767 "accountId": { | |
| 768 "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)", | |
| 769 "format": "int64", | |
| 770 "location": "path", | |
| 771 "required": true, | |
| 772 "type": "string" | |
| 773 } | |
| 774 }, | |
| 775 "path": "v2beta1/accounts/{accountId}/clients", | |
| 776 "request": { | |
| 777 "$ref": "Client" | |
| 778 }, | |
| 779 "response": { | |
| 780 "$ref": "Client" | |
| 781 }, | |
| 782 "scopes": [ | |
| 783 "https://www.googleapis.com/auth/adexchange.buye
r" | |
| 784 ] | |
| 785 }, | |
| 786 "list": { | |
| 787 "description": "Lists all the clients for the curren
t sponsor buyer.", | |
| 788 "httpMethod": "GET", | |
| 789 "id": "adexchangebuyer2.accounts.clients.list", | |
| 790 "parameterOrder": [ | |
| 791 "accountId" | |
| 792 ], | |
| 793 "parameters": { | |
| 794 "pageSize": { | |
| 795 "description": "Requested page size. The ser
ver may return fewer clients than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | |
| 796 "format": "int32", | |
| 797 "location": "query", | |
| 798 "type": "integer" | |
| 799 }, | |
| 800 "accountId": { | |
| 801 "description": "Unique numerical account ID
of the sponsor buyer to list the clients for.", | |
| 802 "format": "int64", | |
| 803 "location": "path", | |
| 804 "required": true, | |
| 805 "type": "string" | |
| 806 }, | |
| 807 "pageToken": { | |
| 808 "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.", | |
| 809 "location": "query", | |
| 810 "type": "string" | |
| 811 } | |
| 812 }, | |
| 813 "path": "v2beta1/accounts/{accountId}/clients", | |
| 814 "response": { | |
| 815 "$ref": "ListClientsResponse" | |
| 816 }, | |
| 817 "scopes": [ | |
| 818 "https://www.googleapis.com/auth/adexchange.buye
r" | |
| 819 ] | |
| 820 } | |
| 821 }, | |
| 822 "resources": { | |
| 823 "users": { | |
| 824 "methods": { | |
| 825 "update": { | |
| 826 "description": "Updates an existing client u
ser.\nOnly the user status can be changed on update.", | |
| 827 "httpMethod": "PUT", | |
| 828 "id": "adexchangebuyer2.accounts.clients.use
rs.update", | |
| 829 "parameterOrder": [ | |
| 830 "accountId", | |
| 831 "clientAccountId", | |
| 832 "userId" | |
| 833 ], | |
| 834 "parameters": { | |
| 835 "clientAccountId": { | |
| 836 "description": "Numerical account ID
of the client buyer that the user to be retrieved\nis associated with. (require
d)", | |
| 837 "format": "int64", | |
| 838 "location": "path", | |
| 839 "required": true, | |
| 840 "type": "string" | |
| 841 }, | |
| 842 "userId": { | |
| 843 "description": "Numerical identifier
of the user to retrieve. (required)", | |
| 844 "format": "int64", | |
| 845 "location": "path", | |
| 846 "required": true, | |
| 847 "type": "string" | |
| 848 }, | |
| 849 "accountId": { | |
| 850 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
| 851 "format": "int64", | |
| 852 "location": "path", | |
| 853 "required": true, | |
| 854 "type": "string" | |
| 855 } | |
| 856 }, | |
| 857 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", | |
| 858 "request": { | |
| 859 "$ref": "ClientUser" | |
| 860 }, | |
| 861 "response": { | |
| 862 "$ref": "ClientUser" | |
| 863 }, | |
| 864 "scopes": [ | |
| 865 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
| 866 ] | |
| 867 }, | |
| 868 "get": { | |
| 869 "description": "Retrieves an existing client
user.", | |
| 870 "httpMethod": "GET", | |
| 871 "id": "adexchangebuyer2.accounts.clients.use
rs.get", | |
| 872 "parameterOrder": [ | |
| 873 "accountId", | |
| 874 "clientAccountId", | |
| 875 "userId" | |
| 876 ], | |
| 877 "parameters": { | |
| 878 "clientAccountId": { | |
| 879 "description": "Numerical account ID
of the client buyer\nthat the user to be retrieved is associated with. (require
d)", | |
| 880 "format": "int64", | |
| 881 "location": "path", | |
| 882 "required": true, | |
| 883 "type": "string" | |
| 884 }, | |
| 885 "userId": { | |
| 886 "description": "Numerical identifier
of the user to retrieve. (required)", | |
| 887 "format": "int64", | |
| 888 "location": "path", | |
| 889 "required": true, | |
| 890 "type": "string" | |
| 891 }, | |
| 892 "accountId": { | |
| 893 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
| 894 "format": "int64", | |
| 895 "location": "path", | |
| 896 "required": true, | |
| 897 "type": "string" | |
| 898 } | |
| 899 }, | |
| 900 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", | |
| 901 "response": { | |
| 902 "$ref": "ClientUser" | |
| 903 }, | |
| 904 "scopes": [ | |
| 905 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
| 906 ] | |
| 907 }, | |
| 908 "list": { | |
| 909 "description": "Lists all the known client u
sers for a specified\nsponsor buyer account ID.", | |
| 910 "httpMethod": "GET", | |
| 911 "id": "adexchangebuyer2.accounts.clients.use
rs.list", | |
| 912 "parameterOrder": [ | |
| 913 "accountId", | |
| 914 "clientAccountId" | |
| 915 ], | |
| 916 "parameters": { | |
| 917 "clientAccountId": { | |
| 918 "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.", | |
| 919 "location": "path", | |
| 920 "required": true, | |
| 921 "type": "string" | |
| 922 }, | |
| 923 "pageSize": { | |
| 924 "description": "Requested page size.
The server may return fewer clients than requested.\nIf unspecified, the server
will pick an appropriate default.", | |
| 925 "format": "int32", | |
| 926 "location": "query", | |
| 927 "type": "integer" | |
| 928 }, | |
| 929 "accountId": { | |
| 930 "description": "Numerical account ID
of the sponsor buyer of the client to list users for.\n(required)", | |
| 931 "format": "int64", | |
| 932 "location": "path", | |
| 933 "required": true, | |
| 934 "type": "string" | |
| 935 }, | |
| 936 "pageToken": { | |
| 937 "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.", | |
| 938 "location": "query", | |
| 939 "type": "string" | |
| 940 } | |
| 941 }, | |
| 942 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users", | |
| 943 "response": { | |
| 944 "$ref": "ListClientUsersResponse" | |
| 945 }, | |
| 946 "scopes": [ | |
| 947 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
| 948 ] | |
| 949 } | |
| 950 } | |
| 951 }, | |
| 952 "invitations": { | |
| 953 "methods": { | |
| 954 "create": { | |
| 955 "description": "Creates and sends out an ema
il invitation to access\nan Ad Exchange client buyer account.", | |
| 956 "httpMethod": "POST", | |
| 957 "id": "adexchangebuyer2.accounts.clients.inv
itations.create", | |
| 958 "parameterOrder": [ | |
| 959 "accountId", | |
| 960 "clientAccountId" | |
| 961 ], | |
| 962 "parameters": { | |
| 963 "clientAccountId": { | |
| 964 "description": "Numerical account ID
of the client buyer that the user\nshould be associated with. (required)", | |
| 965 "format": "int64", | |
| 966 "location": "path", | |
| 967 "required": true, | |
| 968 "type": "string" | |
| 969 }, | |
| 970 "accountId": { | |
| 971 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
| 972 "format": "int64", | |
| 973 "location": "path", | |
| 974 "required": true, | |
| 975 "type": "string" | |
| 976 } | |
| 977 }, | |
| 978 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", | |
| 979 "request": { | |
| 980 "$ref": "ClientUserInvitation" | |
| 981 }, | |
| 982 "response": { | |
| 983 "$ref": "ClientUserInvitation" | |
| 984 }, | |
| 985 "scopes": [ | |
| 986 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
| 987 ] | |
| 988 }, | |
| 989 "get": { | |
| 990 "description": "Retrieves an existing client
user invitation.", | |
| 991 "httpMethod": "GET", | |
| 992 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", | |
| 993 "parameterOrder": [ | |
| 994 "accountId", | |
| 995 "clientAccountId", | |
| 996 "invitationId" | |
| 997 ], | |
| 998 "parameters": { | |
| 999 "clientAccountId": { | |
| 1000 "description": "Numerical account ID
of the client buyer that the user invitation\nto be retrieved is associated wit
h. (required)", | |
| 1001 "format": "int64", | |
| 1002 "location": "path", | |
| 1003 "required": true, | |
| 1004 "type": "string" | |
| 1005 }, | |
| 1006 "invitationId": { | |
| 1007 "description": "Numerical identifier
of the user invitation to retrieve. (required)", | |
| 1008 "format": "int64", | |
| 1009 "location": "path", | |
| 1010 "required": true, | |
| 1011 "type": "string" | |
| 1012 }, | |
| 1013 "accountId": { | |
| 1014 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
| 1015 "format": "int64", | |
| 1016 "location": "path", | |
| 1017 "required": true, | |
| 1018 "type": "string" | |
| 1019 } | |
| 1020 }, | |
| 1021 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations/{invitationId}", | |
| 1022 "response": { | |
| 1023 "$ref": "ClientUserInvitation" | |
| 1024 }, | |
| 1025 "scopes": [ | |
| 1026 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
| 1027 ] | |
| 1028 }, | |
| 1029 "list": { | |
| 1030 "description": "Lists all the client users i
nvitations for a client\nwith a given account ID.", | |
| 1031 "httpMethod": "GET", | |
| 1032 "id": "adexchangebuyer2.accounts.clients.inv
itations.list", | |
| 1033 "parameterOrder": [ | |
| 1034 "accountId", | |
| 1035 "clientAccountId" | |
| 1036 ], | |
| 1037 "parameters": { | |
| 1038 "clientAccountId": { | |
| 1039 "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.", | |
| 1040 "location": "path", | |
| 1041 "required": true, | |
| 1042 "type": "string" | |
| 1043 }, | |
| 1044 "pageSize": { | |
| 1045 "description": "Requested page size.
Server may return fewer clients than requested.\nIf unspecified, server will pi
ck an appropriate default.", | |
| 1046 "format": "int32", | |
| 1047 "location": "query", | |
| 1048 "type": "integer" | |
| 1049 }, | |
| 1050 "accountId": { | |
| 1051 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
| 1052 "format": "int64", | |
| 1053 "location": "path", | |
| 1054 "required": true, | |
| 1055 "type": "string" | |
| 1056 }, | |
| 1057 "pageToken": { | |
| 1058 "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.", | |
| 1059 "location": "query", | |
| 1060 "type": "string" | |
| 1061 } | |
| 1062 }, | |
| 1063 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", | |
| 1064 "response": { | |
| 1065 "$ref": "ListClientUserInvitationsRespon
se" | |
| 1066 }, | |
| 1067 "scopes": [ | |
| 1068 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
| 1069 ] | |
| 1070 } | |
| 1071 } | |
| 1072 } | |
| 1073 } | |
| 1074 } | 503 } |
| 1075 } | 504 } |
| 1076 } | 505 } |
| 1077 }, | 506 }, |
| 1078 "revision": "20160714", | 507 "revision": "20160803", |
| 1079 "rootUrl": "https://adexchangebuyer.googleapis.com/", | 508 "rootUrl": "https://adexchangebuyer.googleapis.com/", |
| 1080 "schemas": { | 509 "schemas": { |
| 1081 "BidMetrics": { | |
| 1082 "description": "The set of metrics that are measured in numbers of b
ids, representing how\nmany bids were considered eligible at each stage of the b
idding funnel.", | |
| 1083 "id": "BidMetrics", | |
| 1084 "properties": { | |
| 1085 "startTime": { | |
| 1086 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1087 "format": "google-datetime", | |
| 1088 "type": "string" | |
| 1089 }, | |
| 1090 "endTime": { | |
| 1091 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1092 "format": "google-datetime", | |
| 1093 "type": "string" | |
| 1094 }, | |
| 1095 "bids": { | |
| 1096 "description": "The number of bids that Ad Exchange received
from the buyer.", | |
| 1097 "format": "int64", | |
| 1098 "type": "string" | |
| 1099 }, | |
| 1100 "bidsInAuction": { | |
| 1101 "description": "The number of bids that were permitted to co
mpete in the auction.", | |
| 1102 "format": "int64", | |
| 1103 "type": "string" | |
| 1104 }, | |
| 1105 "impressionsWon": { | |
| 1106 "description": "The number of bids that won an impression.", | |
| 1107 "format": "int64", | |
| 1108 "type": "string" | |
| 1109 } | |
| 1110 }, | |
| 1111 "type": "object" | |
| 1112 }, | |
| 1113 "ListResponseErrorsResponse": { | |
| 1114 "description": "Response message for listing all reasons that bid re
sponses resulted in an\nerror.", | |
| 1115 "id": "ListResponseErrorsResponse", | |
| 1116 "properties": { | |
| 1117 "startTime": { | |
| 1118 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1119 "format": "google-datetime", | |
| 1120 "type": "string" | |
| 1121 }, | |
| 1122 "endTime": { | |
| 1123 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1124 "format": "google-datetime", | |
| 1125 "type": "string" | |
| 1126 }, | |
| 1127 "frequencies": { | |
| 1128 "description": "List of all callout status IDs, identifying
the error in the bid responses,\nwith their associated impression counts.\nSee c
allout-status-codes.\nThere is a fixed set of statuses, hence results are not pa
ged.", | |
| 1129 "items": { | |
| 1130 "$ref": "CalloutStatusFrequency" | |
| 1131 }, | |
| 1132 "type": "array" | |
| 1133 } | |
| 1134 }, | |
| 1135 "type": "object" | |
| 1136 }, | |
| 1137 "ClientUser": { | 510 "ClientUser": { |
| 1138 "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.", | 511 "description": "A client user is created under a client buyer and ha
s restricted access to\nthe Ad Exchange Marketplace and certain other sections\n
of the Ad Exchange Buyer UI based on the role\ngranted to the associated client
buyer.\n\nThe only way a new client user can be created is via accepting an\nema
il invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fi
elds are required unless otherwise specified.", |
| 1139 "id": "ClientUser", | 512 "id": "ClientUser", |
| 1140 "properties": { | 513 "properties": { |
| 1141 "email": { | 514 "email": { |
| 1142 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", | 515 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", |
| 1143 "type": "string" | 516 "type": "string" |
| 1144 }, | 517 }, |
| 1145 "clientAccountId": { | 518 "clientAccountId": { |
| 1146 "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.", | 519 "description": "Numerical account ID of the client buyer\nwi
th which the user is associated; the\nbuyer must be a client of the current spon
sor buyer.\nThe value of this field is ignored in an update operation.", |
| (...skipping 15 matching lines...) Expand all Loading... |
| 1162 "A user that is currently disabled." | 535 "A user that is currently disabled." |
| 1163 ], | 536 ], |
| 1164 "type": "string" | 537 "type": "string" |
| 1165 }, | 538 }, |
| 1166 "userId": { | 539 "userId": { |
| 1167 "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.", | 540 "description": "The unique numerical ID of the client user\n
that has accepted an invitation.\nThe value of this field is ignored in an updat
e operation.", |
| 1168 "format": "int64", | 541 "format": "int64", |
| 1169 "type": "string" | 542 "type": "string" |
| 1170 } | 543 } |
| 1171 }, | 544 }, |
| 1172 "type": "object" | |
| 1173 }, | |
| 1174 "CreativeFrequency": { | |
| 1175 "description": "The number of bids for a given creative.", | |
| 1176 "id": "CreativeFrequency", | |
| 1177 "properties": { | |
| 1178 "creativeId": { | |
| 1179 "description": "The ID of the creative.", | |
| 1180 "type": "string" | |
| 1181 }, | |
| 1182 "bidCount": { | |
| 1183 "description": "The number of bids associated with the speci
fied creative.", | |
| 1184 "format": "int64", | |
| 1185 "type": "string" | |
| 1186 } | |
| 1187 }, | |
| 1188 "type": "object" | |
| 1189 }, | |
| 1190 "CreativeStatusFrequency": { | |
| 1191 "description": "The number of bids with the specified creative statu
s.", | |
| 1192 "id": "CreativeStatusFrequency", | |
| 1193 "properties": { | |
| 1194 "creativeStatusId": { | |
| 1195 "description": "The ID of the creative status.\nSee creative
-status-codes.", | |
| 1196 "format": "int32", | |
| 1197 "type": "integer" | |
| 1198 }, | |
| 1199 "bidCount": { | |
| 1200 "description": "The number of bids associated with the speci
fied status.", | |
| 1201 "format": "int64", | |
| 1202 "type": "string" | |
| 1203 } | |
| 1204 }, | |
| 1205 "type": "object" | |
| 1206 }, | |
| 1207 "FilterSet": { | |
| 1208 "description": "A set of filters that is applied to a request for da
ta from the\nRtbTroubleshootingService. Within a filter set, an AND operation is
performed\nacross the filters represented by each field. An OR operation is per
formed\nacross the filters represented by the multiple values of a repeated fiel
d.\nE.g.\n\"format=VIDEO AND deal_id=12 AND (web_property_id=34 OR web_property_
id=56)\"", | |
| 1209 "id": "FilterSet", | |
| 1210 "properties": { | |
| 1211 "format": { | |
| 1212 "description": "The format on which to filter; optional.", | |
| 1213 "enum": [ | |
| 1214 "FORMAT_UNSPECIFIED", | |
| 1215 "DISPLAY", | |
| 1216 "VIDEO" | |
| 1217 ], | |
| 1218 "enumDescriptions": [ | |
| 1219 "A placeholder for an undefined format; indicates that n
o format filter\nwill be applied.", | |
| 1220 "The ad impression is display format (i.e. an image).", | |
| 1221 "The ad impression is video format." | |
| 1222 ], | |
| 1223 "type": "string" | |
| 1224 }, | |
| 1225 "relativeDateRange": { | |
| 1226 "$ref": "RelativeDateRange", | |
| 1227 "description": "A relative date range, defined by an offset
from today and a duration." | |
| 1228 }, | |
| 1229 "creativeId": { | |
| 1230 "description": "The ID of the creative on which to filter; o
ptional.", | |
| 1231 "type": "string" | |
| 1232 }, | |
| 1233 "dealId": { | |
| 1234 "description": "The ID of the deal on which to filter; optio
nal.", | |
| 1235 "format": "int64", | |
| 1236 "type": "string" | |
| 1237 }, | |
| 1238 "buyerAccountId": { | |
| 1239 "description": "The ID of the buyer account on which to filt
er; optional.", | |
| 1240 "format": "int64", | |
| 1241 "type": "string" | |
| 1242 }, | |
| 1243 "filterSetOwnerAccountId": { | |
| 1244 "description": "The account ID of the buyer who owns this fi
lter set.\nThe value of this field is ignored in create operations.", | |
| 1245 "format": "int64", | |
| 1246 "type": "string" | |
| 1247 }, | |
| 1248 "absoluteDateRange": { | |
| 1249 "$ref": "AbsoluteDateRange", | |
| 1250 "description": "An absolute date range, defined by a start d
ate and an end date." | |
| 1251 }, | |
| 1252 "webPropertyIds": { | |
| 1253 "description": "The list of IDs of web properties on which t
o filter; may be empty.\nThe filters represented by multiple web property IDs ar
e ORed together\n(i.e. if non-empty, results must match any one of the web prope
rties).", | |
| 1254 "items": { | |
| 1255 "format": "int64", | |
| 1256 "type": "string" | |
| 1257 }, | |
| 1258 "type": "array" | |
| 1259 }, | |
| 1260 "platform": { | |
| 1261 "description": "The platform on which to filter; optional.", | |
| 1262 "enum": [ | |
| 1263 "PLATFORM_UNSPECIFIED", | |
| 1264 "DESKTOP", | |
| 1265 "TABLET_WEB", | |
| 1266 "TABLET_APP", | |
| 1267 "MOBILE_WEB", | |
| 1268 "MOBILE_APP" | |
| 1269 ], | |
| 1270 "enumDescriptions": [ | |
| 1271 "A placeholder for an undefined platform; indicates that
no platform\nfilter will be applied.", | |
| 1272 "The ad impression appears on a desktop.", | |
| 1273 "The ad impression appears on a tablet, on the web.", | |
| 1274 "The ad impression appears on a tablet, in an app.", | |
| 1275 "The ad impression appears on a mobile device, on the we
b.", | |
| 1276 "The ad impression appears on a mobile device, in an app
." | |
| 1277 ], | |
| 1278 "type": "string" | |
| 1279 }, | |
| 1280 "filterSetId": { | |
| 1281 "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.", | |
| 1282 "format": "int32", | |
| 1283 "type": "integer" | |
| 1284 } | |
| 1285 }, | |
| 1286 "type": "object" | |
| 1287 }, | |
| 1288 "RelativeDateRange": { | |
| 1289 "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", | |
| 1290 "id": "RelativeDateRange", | |
| 1291 "properties": { | |
| 1292 "offsetDays": { | |
| 1293 "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.", | |
| 1294 "format": "int32", | |
| 1295 "type": "integer" | |
| 1296 }, | |
| 1297 "durationDays": { | |
| 1298 "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
.", | |
| 1299 "format": "int32", | |
| 1300 "type": "integer" | |
| 1301 } | |
| 1302 }, | |
| 1303 "type": "object" | |
| 1304 }, | |
| 1305 "ListResponsesWithoutBidsResponse": { | |
| 1306 "description": "Response message for listing all reasons that bid re
sponses were considered\nto have no applicable bids.", | |
| 1307 "id": "ListResponsesWithoutBidsResponse", | |
| 1308 "properties": { | |
| 1309 "startTime": { | |
| 1310 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1311 "format": "google-datetime", | |
| 1312 "type": "string" | |
| 1313 }, | |
| 1314 "endTime": { | |
| 1315 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1316 "format": "google-datetime", | |
| 1317 "type": "string" | |
| 1318 }, | |
| 1319 "frequencies": { | |
| 1320 "description": "List of all statuses with their associated i
mpression counts.\nThere is a fixed set of statuses, hence results are not paged
.", | |
| 1321 "items": { | |
| 1322 "$ref": "ResponsesWithoutBidsStatusFrequency" | |
| 1323 }, | |
| 1324 "type": "array" | |
| 1325 } | |
| 1326 }, | |
| 1327 "type": "object" | |
| 1328 }, | |
| 1329 "ResponsesWithoutBidsStatusFrequency": { | |
| 1330 "description": "The number of impressions for which the correspondin
g response had no\napplicable bids, as described by the specified status.", | |
| 1331 "id": "ResponsesWithoutBidsStatusFrequency", | |
| 1332 "properties": { | |
| 1333 "impressionCount": { | |
| 1334 "description": "The number of impressions associated with th
e specified status.", | |
| 1335 "format": "int64", | |
| 1336 "type": "string" | |
| 1337 }, | |
| 1338 "status": { | |
| 1339 "description": "The status that caused the bid response to b
e considered to have no\napplicable bids.", | |
| 1340 "enum": [ | |
| 1341 "STATUS_UNSPECIFIED", | |
| 1342 "RESPONSES_WITHOUT_BIDS", | |
| 1343 "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT", | |
| 1344 "RESPONSES_WITHOUT_BIDS_FOR_DEAL" | |
| 1345 ], | |
| 1346 "enumDescriptions": [ | |
| 1347 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | |
| 1348 "The response had no bids.", | |
| 1349 "The response had no bids for the specified account, tho
ugh it may have\nincluded bids on behalf of other accounts.", | |
| 1350 "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." | |
| 1351 ], | |
| 1352 "type": "string" | |
| 1353 } | |
| 1354 }, | |
| 1355 "type": "object" | |
| 1356 }, | |
| 1357 "FilteredImpressionStatusFrequency": { | |
| 1358 "description": "The number of impressions filtered due to the specif
ied status.", | |
| 1359 "id": "FilteredImpressionStatusFrequency", | |
| 1360 "properties": { | |
| 1361 "impressionCount": { | |
| 1362 "description": "The number of impressions associated with th
e specified status.", | |
| 1363 "format": "int64", | |
| 1364 "type": "string" | |
| 1365 }, | |
| 1366 "status": { | |
| 1367 "description": "The status for which impressions were filter
ed.", | |
| 1368 "enum": [ | |
| 1369 "STATUS_UNSPECIFIED", | |
| 1370 "PRETARGETING_CONFIGURATIONS" | |
| 1371 ], | |
| 1372 "enumDescriptions": [ | |
| 1373 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | |
| 1374 "The impression was filtered because it did not match th
e buyer's\npretargeting configurations." | |
| 1375 ], | |
| 1376 "type": "string" | |
| 1377 } | |
| 1378 }, | |
| 1379 "type": "object" | 545 "type": "object" |
| 1380 }, | 546 }, |
| 1381 "ClientUserInvitation": { | 547 "ClientUserInvitation": { |
| 1382 "description": "An invitation for a new client user to get access to
the AdExchange Buyer UI.\n\nAll fields are required unless otherwise specified.
", | 548 "description": "An invitation for a new client user to get access to
the AdExchange Buyer UI.\n\nAll fields are required unless otherwise specified.
", |
| 1383 "id": "ClientUserInvitation", | 549 "id": "ClientUserInvitation", |
| 1384 "properties": { | 550 "properties": { |
| 1385 "email": { | 551 "email": { |
| 1386 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", | 552 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", |
| 1387 "type": "string" | 553 "type": "string" |
| 1388 }, | 554 }, |
| 1389 "clientAccountId": { | 555 "clientAccountId": { |
| 1390 "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.", | 556 "description": "Numerical account ID of the client buyer\nth
at the invited user is associated with.\nThe value of this field is ignored in c
reate operations.", |
| 1391 "format": "int64", | 557 "format": "int64", |
| 1392 "type": "string" | 558 "type": "string" |
| 1393 }, | 559 }, |
| 1394 "invitationId": { | 560 "invitationId": { |
| 1395 "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
.", | 561 "description": "The unique numerical ID of the invitation th
at is sent to the user.\nThe value of this field is ignored in create operations
.", |
| 1396 "format": "int64", | 562 "format": "int64", |
| 1397 "type": "string" | 563 "type": "string" |
| 1398 } | 564 } |
| 1399 }, | 565 }, |
| 1400 "type": "object" | 566 "type": "object" |
| 1401 }, | 567 }, |
| 1402 "ListCreativeStatusBreakdownByCreativeResponse": { | |
| 1403 "description": "Response message for listing all creatives associate
d with a given filtered\nbid reason.", | |
| 1404 "id": "ListCreativeStatusBreakdownByCreativeResponse", | |
| 1405 "properties": { | |
| 1406 "startTime": { | |
| 1407 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1408 "format": "google-datetime", | |
| 1409 "type": "string" | |
| 1410 }, | |
| 1411 "endTime": { | |
| 1412 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1413 "format": "google-datetime", | |
| 1414 "type": "string" | |
| 1415 }, | |
| 1416 "creativeStatusId": { | |
| 1417 "description": "The ID of the creative status that identifie
s the reason the bid was\nfiltered before the auction.\nSee creative-status-code
s.", | |
| 1418 "format": "int32", | |
| 1419 "type": "integer" | |
| 1420 }, | |
| 1421 "frequencies": { | |
| 1422 "description": "List of creative IDs with their associated b
id counts.", | |
| 1423 "items": { | |
| 1424 "$ref": "CreativeFrequency" | |
| 1425 }, | |
| 1426 "type": "array" | |
| 1427 }, | |
| 1428 "nextPageToken": { | |
| 1429 "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.", | |
| 1430 "type": "string" | |
| 1431 } | |
| 1432 }, | |
| 1433 "type": "object" | |
| 1434 }, | |
| 1435 "ImpressionMetrics": { | |
| 1436 "description": "The set of metrics that are measured in numbers of i
mpressions, representing\nhow many impressions were considered eligible at each
stage of the bidding\nfunnel.", | |
| 1437 "id": "ImpressionMetrics", | |
| 1438 "properties": { | |
| 1439 "responsesWithBids": { | |
| 1440 "description": "The number of impressions for which Ad Excha
nge received a response from\nthe buyer that contained at least one applicable b
id.", | |
| 1441 "format": "int64", | |
| 1442 "type": "string" | |
| 1443 }, | |
| 1444 "inventoryMatches": { | |
| 1445 "description": "The number of impressions that match the buy
er's inventory pretargeting.", | |
| 1446 "format": "int64", | |
| 1447 "type": "string" | |
| 1448 }, | |
| 1449 "endTime": { | |
| 1450 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1451 "format": "google-datetime", | |
| 1452 "type": "string" | |
| 1453 }, | |
| 1454 "successfulResponses": { | |
| 1455 "description": "The number of impressions for which the buye
r successfully sent a response\nto Ad Exchange.", | |
| 1456 "format": "int64", | |
| 1457 "type": "string" | |
| 1458 }, | |
| 1459 "startTime": { | |
| 1460 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1461 "format": "google-datetime", | |
| 1462 "type": "string" | |
| 1463 }, | |
| 1464 "bidRequests": { | |
| 1465 "description": "The number of impressions for which Ad Excha
nge sent the buyer a bid\nrequest.", | |
| 1466 "format": "int64", | |
| 1467 "type": "string" | |
| 1468 }, | |
| 1469 "availableImpressions": { | |
| 1470 "description": "The number of impressions available to the b
uyer on Ad Exchange.\nIn some cases this value may be unavailable.", | |
| 1471 "format": "int64", | |
| 1472 "type": "string" | |
| 1473 } | |
| 1474 }, | |
| 1475 "type": "object" | |
| 1476 }, | |
| 1477 "ListLosingBidsResponse": { | |
| 1478 "description": "Response message for listing all reasons that bids l
ost in the auction.", | |
| 1479 "id": "ListLosingBidsResponse", | |
| 1480 "properties": { | |
| 1481 "startTime": { | |
| 1482 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1483 "format": "google-datetime", | |
| 1484 "type": "string" | |
| 1485 }, | |
| 1486 "endTime": { | |
| 1487 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1488 "format": "google-datetime", | |
| 1489 "type": "string" | |
| 1490 }, | |
| 1491 "frequencies": { | |
| 1492 "description": "List of all creative status IDs with their a
ssociated bid counts.\nSee creative-status-codes.\nThere is a fixed set of statu
ses, hence results are not paged.", | |
| 1493 "items": { | |
| 1494 "$ref": "CreativeStatusFrequency" | |
| 1495 }, | |
| 1496 "type": "array" | |
| 1497 } | |
| 1498 }, | |
| 1499 "type": "object" | |
| 1500 }, | |
| 1501 "ListFilteredImpressionsResponse": { | |
| 1502 "description": "Response message for listing all reasons that impres
sions were filtered (i.e.\nnot considered as an inventory match) for the buyer."
, | |
| 1503 "id": "ListFilteredImpressionsResponse", | |
| 1504 "properties": { | |
| 1505 "startTime": { | |
| 1506 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1507 "format": "google-datetime", | |
| 1508 "type": "string" | |
| 1509 }, | |
| 1510 "endTime": { | |
| 1511 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1512 "format": "google-datetime", | |
| 1513 "type": "string" | |
| 1514 }, | |
| 1515 "frequencies": { | |
| 1516 "description": "List of all statuses identifying the reason
the bid request was filtered,\nwith their associated impression counts.\nThere i
s a fixed set of statuses, hence results are not paged.", | |
| 1517 "items": { | |
| 1518 "$ref": "FilteredImpressionStatusFrequency" | |
| 1519 }, | |
| 1520 "type": "array" | |
| 1521 } | |
| 1522 }, | |
| 1523 "type": "object" | |
| 1524 }, | |
| 1525 "AbsoluteDateRange": { | |
| 1526 "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.", | |
| 1527 "id": "AbsoluteDateRange", | |
| 1528 "properties": { | |
| 1529 "startDate": { | |
| 1530 "$ref": "Date", | |
| 1531 "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." | |
| 1532 }, | |
| 1533 "endDate": { | |
| 1534 "$ref": "Date", | |
| 1535 "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." | |
| 1536 } | |
| 1537 }, | |
| 1538 "type": "object" | |
| 1539 }, | |
| 1540 "ListFilteredRequestsResponse": { | |
| 1541 "description": "Response message for listing all reasons that bid re
quests were filtered and\nnot sent to the buyer.", | |
| 1542 "id": "ListFilteredRequestsResponse", | |
| 1543 "properties": { | |
| 1544 "startTime": { | |
| 1545 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1546 "format": "google-datetime", | |
| 1547 "type": "string" | |
| 1548 }, | |
| 1549 "endTime": { | |
| 1550 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1551 "format": "google-datetime", | |
| 1552 "type": "string" | |
| 1553 }, | |
| 1554 "frequencies": { | |
| 1555 "description": "List of all callout status IDs, identifying
the reason the bid request was\nfiltered, with their associated impression count
s.\nSee callout-status-codes.\nThere is a fixed set of statuses, hence results a
re not paged.", | |
| 1556 "items": { | |
| 1557 "$ref": "CalloutStatusFrequency" | |
| 1558 }, | |
| 1559 "type": "array" | |
| 1560 } | |
| 1561 }, | |
| 1562 "type": "object" | |
| 1563 }, | |
| 1564 "ListFilterSetsResponse": { | |
| 1565 "description": "Response message for listing filter sets.", | |
| 1566 "id": "ListFilterSetsResponse", | |
| 1567 "properties": { | |
| 1568 "filterSets": { | |
| 1569 "description": "The filter sets belonging to the buyer.", | |
| 1570 "items": { | |
| 1571 "$ref": "FilterSet" | |
| 1572 }, | |
| 1573 "type": "array" | |
| 1574 }, | |
| 1575 "nextPageToken": { | |
| 1576 "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.", | |
| 1577 "type": "string" | |
| 1578 } | |
| 1579 }, | |
| 1580 "type": "object" | |
| 1581 }, | |
| 1582 "ListClientUserInvitationsResponse": { | 568 "ListClientUserInvitationsResponse": { |
| 1583 "id": "ListClientUserInvitationsResponse", | 569 "id": "ListClientUserInvitationsResponse", |
| 1584 "properties": { | 570 "properties": { |
| 1585 "nextPageToken": { | 571 "nextPageToken": { |
| 1586 "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.", | 572 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in
the subsequent call to the\nclients.invitations.list\nmethod to retrieve the nex
t\npage of results.", |
| 1587 "type": "string" | 573 "type": "string" |
| 1588 }, | 574 }, |
| 1589 "invitations": { | 575 "invitations": { |
| 1590 "description": "The returned list of client users.", | 576 "description": "The returned list of client users.", |
| 1591 "items": { | 577 "items": { |
| 1592 "$ref": "ClientUserInvitation" | 578 "$ref": "ClientUserInvitation" |
| 1593 }, | 579 }, |
| 1594 "type": "array" | 580 "type": "array" |
| 1595 } | 581 } |
| 1596 }, | 582 }, |
| 1597 "type": "object" | 583 "type": "object" |
| 1598 }, | 584 }, |
| 1599 "CalloutStatusFrequency": { | |
| 1600 "description": "The number of impressions for which the correspondin
g callouts had the\nspecified status.", | |
| 1601 "id": "CalloutStatusFrequency", | |
| 1602 "properties": { | |
| 1603 "impressionCount": { | |
| 1604 "description": "The number of impressions associated with th
e specified status.", | |
| 1605 "format": "int64", | |
| 1606 "type": "string" | |
| 1607 }, | |
| 1608 "calloutStatusId": { | |
| 1609 "description": "The ID of the callout status.\nSee callout-s
tatus-codes.", | |
| 1610 "format": "int32", | |
| 1611 "type": "integer" | |
| 1612 } | |
| 1613 }, | |
| 1614 "type": "object" | |
| 1615 }, | |
| 1616 "DetailFrequency": { | |
| 1617 "description": "The number of bids, among those with a given creativ
e status, that had the\nspecified detail.", | |
| 1618 "id": "DetailFrequency", | |
| 1619 "properties": { | |
| 1620 "detailId": { | |
| 1621 "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.", | |
| 1622 "format": "int32", | |
| 1623 "type": "integer" | |
| 1624 }, | |
| 1625 "bidCount": { | |
| 1626 "description": "The number of bids associated with the speci
fied detail.", | |
| 1627 "format": "int64", | |
| 1628 "type": "string" | |
| 1629 } | |
| 1630 }, | |
| 1631 "type": "object" | |
| 1632 }, | |
| 1633 "ListCreativeStatusAndCreativeBreakdownByDetailResponse": { | |
| 1634 "description": "Response message for listing all details associated
with a given filtered bid\nreason and a given creative.", | |
| 1635 "id": "ListCreativeStatusAndCreativeBreakdownByDetailResponse", | |
| 1636 "properties": { | |
| 1637 "creativeId": { | |
| 1638 "description": "The ID of the creative associated with a bid
filtered from the auction.", | |
| 1639 "type": "string" | |
| 1640 }, | |
| 1641 "endTime": { | |
| 1642 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1643 "format": "google-datetime", | |
| 1644 "type": "string" | |
| 1645 }, | |
| 1646 "detailType": { | |
| 1647 "description": "The type of detail that the detail IDs repre
sent.", | |
| 1648 "enum": [ | |
| 1649 "TYPE_UNSPECIFIED", | |
| 1650 "CREATIVE_ATTRIBUTE", | |
| 1651 "VENDOR", | |
| 1652 "SENSITIVE_CATEGORY", | |
| 1653 "PRODUCT_CATEGORY" | |
| 1654 ], | |
| 1655 "enumDescriptions": [ | |
| 1656 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | |
| 1657 "Indicates that the detail ID refers to a creative attri
bute; see\npublisher-excludable-creative-attributes.", | |
| 1658 "Indicates that the detail ID refers to a vendor; see\nv
endors.", | |
| 1659 "Indicates that the detail ID refers to a sensitive cate
gory; see\nad-sensitive-categories.", | |
| 1660 "Indicates that the detail ID refers to a product catego
ry; see\nad-product-categories." | |
| 1661 ], | |
| 1662 "type": "string" | |
| 1663 }, | |
| 1664 "frequencies": { | |
| 1665 "description": "List of all detail IDs with their associated
bid counts.\nThere is a fixed set of details, hence results are not paged.", | |
| 1666 "items": { | |
| 1667 "$ref": "DetailFrequency" | |
| 1668 }, | |
| 1669 "type": "array" | |
| 1670 }, | |
| 1671 "startTime": { | |
| 1672 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1673 "format": "google-datetime", | |
| 1674 "type": "string" | |
| 1675 }, | |
| 1676 "creativeStatusId": { | |
| 1677 "description": "The ID of the creative status that identifie
s the reason the bid was\nfiltered before the auction.\nSee creative-status-code
s.", | |
| 1678 "format": "int32", | |
| 1679 "type": "integer" | |
| 1680 } | |
| 1681 }, | |
| 1682 "type": "object" | |
| 1683 }, | |
| 1684 "Empty": { | |
| 1685 "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 `{}`.", | |
| 1686 "id": "Empty", | |
| 1687 "properties": {}, | |
| 1688 "type": "object" | |
| 1689 }, | |
| 1690 "ListClientUsersResponse": { | 585 "ListClientUsersResponse": { |
| 1691 "id": "ListClientUsersResponse", | 586 "id": "ListClientUsersResponse", |
| 1692 "properties": { | 587 "properties": { |
| 1693 "users": { | 588 "users": { |
| 1694 "description": "The returned list of client users.", | 589 "description": "The returned list of client users.", |
| 1695 "items": { | 590 "items": { |
| 1696 "$ref": "ClientUser" | 591 "$ref": "ClientUser" |
| 1697 }, | 592 }, |
| 1698 "type": "array" | 593 "type": "array" |
| 1699 }, | 594 }, |
| 1700 "nextPageToken": { | 595 "nextPageToken": { |
| 1701 "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.", | 596 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subseq
uent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of
results.", |
| 1702 "type": "string" | 597 "type": "string" |
| 1703 } | 598 } |
| 1704 }, | 599 }, |
| 1705 "type": "object" | 600 "type": "object" |
| 1706 }, | 601 }, |
| 1707 "ListCreativeStatusBreakdownByDetailResponse": { | |
| 1708 "description": "Response message for listing all details associated
with a given filtered bid\nreason.", | |
| 1709 "id": "ListCreativeStatusBreakdownByDetailResponse", | |
| 1710 "properties": { | |
| 1711 "startTime": { | |
| 1712 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1713 "format": "google-datetime", | |
| 1714 "type": "string" | |
| 1715 }, | |
| 1716 "endTime": { | |
| 1717 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1718 "format": "google-datetime", | |
| 1719 "type": "string" | |
| 1720 }, | |
| 1721 "creativeStatusId": { | |
| 1722 "description": "The ID of the creative status that identifie
s the reason the bid was\nfiltered before the auction.\nSee creative-status-code
s.", | |
| 1723 "format": "int32", | |
| 1724 "type": "integer" | |
| 1725 }, | |
| 1726 "frequencies": { | |
| 1727 "description": "List of all detail IDs with their associated
bid counts.\nThere is a fixed set of details, hence results are not paged.", | |
| 1728 "items": { | |
| 1729 "$ref": "DetailFrequency" | |
| 1730 }, | |
| 1731 "type": "array" | |
| 1732 }, | |
| 1733 "detailType": { | |
| 1734 "description": "The type of detail that the detail IDs repre
sent.", | |
| 1735 "enum": [ | |
| 1736 "TYPE_UNSPECIFIED", | |
| 1737 "CREATIVE_ATTRIBUTE", | |
| 1738 "VENDOR", | |
| 1739 "SENSITIVE_CATEGORY", | |
| 1740 "PRODUCT_CATEGORY" | |
| 1741 ], | |
| 1742 "enumDescriptions": [ | |
| 1743 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | |
| 1744 "Indicates that the detail ID refers to a creative attri
bute; see\npublisher-excludable-creative-attributes.", | |
| 1745 "Indicates that the detail ID refers to a vendor; see\nv
endors.", | |
| 1746 "Indicates that the detail ID refers to a sensitive cate
gory; see\nad-sensitive-categories.", | |
| 1747 "Indicates that the detail ID refers to a product catego
ry; see\nad-product-categories." | |
| 1748 ], | |
| 1749 "type": "string" | |
| 1750 } | |
| 1751 }, | |
| 1752 "type": "object" | |
| 1753 }, | |
| 1754 "Client": { | 602 "Client": { |
| 1755 "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.", | 603 "description": "A client resource represents a client buyer—an
agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associ
ated with the client buyer have restricted access to\nthe Ad Exchange Marketplac
e and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngra
nted to the client buyer.\nAll fields are required unless otherwise specified.", |
| 1756 "id": "Client", | 604 "id": "Client", |
| 1757 "properties": { | 605 "properties": { |
| 1758 "visibleToSeller": { | 606 "visibleToSeller": { |
| 1759 "description": "Whether the client buyer will be visible to
sellers.", | 607 "description": "Whether the client buyer will be visible to
sellers.", |
| 1760 "type": "boolean" | 608 "type": "boolean" |
| 1761 }, | 609 }, |
| 1762 "status": { | 610 "status": { |
| 1763 "description": "The status of the client buyer.", | 611 "description": "The status of the client buyer.", |
| (...skipping 55 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1819 "format": "int64", | 667 "format": "int64", |
| 1820 "type": "string" | 668 "type": "string" |
| 1821 }, | 669 }, |
| 1822 "entityName": { | 670 "entityName": { |
| 1823 "description": "The name of the entity. This field is automa
tically fetched based on\nthe type and ID.\nThe value of this field is ignored i
n create and update operations.", | 671 "description": "The name of the entity. This field is automa
tically fetched based on\nthe type and ID.\nThe value of this field is ignored i
n create and update operations.", |
| 1824 "type": "string" | 672 "type": "string" |
| 1825 } | 673 } |
| 1826 }, | 674 }, |
| 1827 "type": "object" | 675 "type": "object" |
| 1828 }, | 676 }, |
| 1829 "Date": { | |
| 1830 "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`.", | |
| 1831 "id": "Date", | |
| 1832 "properties": { | |
| 1833 "month": { | |
| 1834 "description": "Month of year. Must be from 1 to 12.", | |
| 1835 "format": "int32", | |
| 1836 "type": "integer" | |
| 1837 }, | |
| 1838 "year": { | |
| 1839 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", | |
| 1840 "format": "int32", | |
| 1841 "type": "integer" | |
| 1842 }, | |
| 1843 "day": { | |
| 1844 "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.", | |
| 1845 "format": "int32", | |
| 1846 "type": "integer" | |
| 1847 } | |
| 1848 }, | |
| 1849 "type": "object" | |
| 1850 }, | |
| 1851 "ListFilteredBidsResponse": { | |
| 1852 "description": "Response message for listing all reasons that bids w
ere filtered from the\nauction.", | |
| 1853 "id": "ListFilteredBidsResponse", | |
| 1854 "properties": { | |
| 1855 "startTime": { | |
| 1856 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
| 1857 "format": "google-datetime", | |
| 1858 "type": "string" | |
| 1859 }, | |
| 1860 "endTime": { | |
| 1861 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
| 1862 "format": "google-datetime", | |
| 1863 "type": "string" | |
| 1864 }, | |
| 1865 "frequencies": { | |
| 1866 "description": "List of all creative status IDs, identifying
the reason the bids were\nfiltered from the auction, with their associated bid
counts.\nSee creative-status-codes.\nThere is a fixed set of statuses, hence res
ults are not paged.", | |
| 1867 "items": { | |
| 1868 "$ref": "CreativeStatusFrequency" | |
| 1869 }, | |
| 1870 "type": "array" | |
| 1871 } | |
| 1872 }, | |
| 1873 "type": "object" | |
| 1874 }, | |
| 1875 "ListClientsResponse": { | 677 "ListClientsResponse": { |
| 1876 "id": "ListClientsResponse", | 678 "id": "ListClientsResponse", |
| 1877 "properties": { | 679 "properties": { |
| 1878 "nextPageToken": { | 680 "nextPageToken": { |
| 1879 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent
call to the\naccounts.clients.list method\nto retrieve the next page of results
.", | 681 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent
call to the\naccounts.clients.list method\nto retrieve the next page of results
.", |
| 1880 "type": "string" | 682 "type": "string" |
| 1881 }, | 683 }, |
| 1882 "clients": { | 684 "clients": { |
| 1883 "description": "The returned list of clients.", | 685 "description": "The returned list of clients.", |
| 1884 "items": { | 686 "items": { |
| 1885 "$ref": "Client" | 687 "$ref": "Client" |
| 1886 }, | 688 }, |
| 1887 "type": "array" | 689 "type": "array" |
| 1888 } | 690 } |
| 1889 }, | 691 }, |
| 1890 "type": "object" | 692 "type": "object" |
| 1891 } | 693 } |
| 1892 }, | 694 }, |
| 1893 "servicePath": "", | 695 "servicePath": "", |
| 1894 "title": "Ad Exchange Buyer API II", | 696 "title": "Ad Exchange Buyer API II", |
| 1895 "version": "v2beta1" | 697 "version": "v2beta1" |
| 1896 } | 698 } |
| OLD | NEW |