OLD | NEW |
(Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/adsense": { |
| 6 "description": "View and manage your AdSense data" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/adsense.readonly": { |
| 9 "description": "View your AdSense data" |
| 10 } |
| 11 } |
| 12 } |
| 13 }, |
| 14 "basePath": "/adsense/v1.4/", |
| 15 "baseUrl": "https://www.googleapis.com/adsense/v1.4/", |
| 16 "batchPath": "batch", |
| 17 "canonicalName": "AdSense", |
| 18 "description": "Gives AdSense publishers access to their inventory and the a
bility to generate reports", |
| 19 "discoveryVersion": "v1", |
| 20 "documentationLink": "https://developers.google.com/adsense/management/", |
| 21 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/w5NCsqdDReX8O9yjFmrFBeYpEhQ\"", |
| 22 "icons": { |
| 23 "x16": "https://www.google.com/images/icons/product/adsense-16.png", |
| 24 "x32": "https://www.google.com/images/icons/product/adsense-32.png" |
| 25 }, |
| 26 "id": "adsense:v1.4", |
| 27 "kind": "discovery#restDescription", |
| 28 "name": "adsense", |
| 29 "ownerDomain": "google.com", |
| 30 "ownerName": "Google", |
| 31 "parameters": { |
| 32 "alt": { |
| 33 "default": "json", |
| 34 "description": "Data format for the response.", |
| 35 "enum": [ |
| 36 "csv", |
| 37 "json" |
| 38 ], |
| 39 "enumDescriptions": [ |
| 40 "Responses with Content-Type of text/csv", |
| 41 "Responses with Content-Type of application/json" |
| 42 ], |
| 43 "location": "query", |
| 44 "type": "string" |
| 45 }, |
| 46 "fields": { |
| 47 "description": "Selector specifying which fields to include in a par
tial response.", |
| 48 "location": "query", |
| 49 "type": "string" |
| 50 }, |
| 51 "key": { |
| 52 "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.", |
| 53 "location": "query", |
| 54 "type": "string" |
| 55 }, |
| 56 "oauth_token": { |
| 57 "description": "OAuth 2.0 token for the current user.", |
| 58 "location": "query", |
| 59 "type": "string" |
| 60 }, |
| 61 "prettyPrint": { |
| 62 "default": "true", |
| 63 "description": "Returns response with indentations and line breaks."
, |
| 64 "location": "query", |
| 65 "type": "boolean" |
| 66 }, |
| 67 "quotaUser": { |
| 68 "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. Overrides userIp if both are provided.", |
| 69 "location": "query", |
| 70 "type": "string" |
| 71 }, |
| 72 "userIp": { |
| 73 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 74 "location": "query", |
| 75 "type": "string" |
| 76 } |
| 77 }, |
| 78 "protocol": "rest", |
| 79 "resources": { |
| 80 "accounts": { |
| 81 "methods": { |
| 82 "get": { |
| 83 "description": "Get information about the selected AdSense a
ccount.", |
| 84 "httpMethod": "GET", |
| 85 "id": "adsense.accounts.get", |
| 86 "parameterOrder": [ |
| 87 "accountId" |
| 88 ], |
| 89 "parameters": { |
| 90 "accountId": { |
| 91 "description": "Account to get information about.", |
| 92 "location": "path", |
| 93 "required": true, |
| 94 "type": "string" |
| 95 }, |
| 96 "tree": { |
| 97 "description": "Whether the tree of sub accounts sho
uld be returned.", |
| 98 "location": "query", |
| 99 "type": "boolean" |
| 100 } |
| 101 }, |
| 102 "path": "accounts/{accountId}", |
| 103 "response": { |
| 104 "$ref": "Account" |
| 105 }, |
| 106 "scopes": [ |
| 107 "https://www.googleapis.com/auth/adsense", |
| 108 "https://www.googleapis.com/auth/adsense.readonly" |
| 109 ] |
| 110 }, |
| 111 "list": { |
| 112 "description": "List all accounts available to this AdSense
account.", |
| 113 "httpMethod": "GET", |
| 114 "id": "adsense.accounts.list", |
| 115 "parameters": { |
| 116 "maxResults": { |
| 117 "description": "The maximum number of accounts to in
clude in the response, used for paging.", |
| 118 "format": "int32", |
| 119 "location": "query", |
| 120 "maximum": "10000", |
| 121 "minimum": "0", |
| 122 "type": "integer" |
| 123 }, |
| 124 "pageToken": { |
| 125 "description": "A continuation token, used to page t
hrough accounts. To retrieve the next page, set this parameter to the value of \
"nextPageToken\" from the previous response.", |
| 126 "location": "query", |
| 127 "type": "string" |
| 128 } |
| 129 }, |
| 130 "path": "accounts", |
| 131 "response": { |
| 132 "$ref": "Accounts" |
| 133 }, |
| 134 "scopes": [ |
| 135 "https://www.googleapis.com/auth/adsense", |
| 136 "https://www.googleapis.com/auth/adsense.readonly" |
| 137 ] |
| 138 } |
| 139 }, |
| 140 "resources": { |
| 141 "adclients": { |
| 142 "methods": { |
| 143 "list": { |
| 144 "description": "List all ad clients in the specified
account.", |
| 145 "httpMethod": "GET", |
| 146 "id": "adsense.accounts.adclients.list", |
| 147 "parameterOrder": [ |
| 148 "accountId" |
| 149 ], |
| 150 "parameters": { |
| 151 "accountId": { |
| 152 "description": "Account for which to list ad
clients.", |
| 153 "location": "path", |
| 154 "required": true, |
| 155 "type": "string" |
| 156 }, |
| 157 "maxResults": { |
| 158 "description": "The maximum number of ad cli
ents to include in the response, used for paging.", |
| 159 "format": "int32", |
| 160 "location": "query", |
| 161 "maximum": "10000", |
| 162 "minimum": "0", |
| 163 "type": "integer" |
| 164 }, |
| 165 "pageToken": { |
| 166 "description": "A continuation token, used t
o page through ad clients. To retrieve the next page, set this parameter to the
value of \"nextPageToken\" from the previous response.", |
| 167 "location": "query", |
| 168 "type": "string" |
| 169 } |
| 170 }, |
| 171 "path": "accounts/{accountId}/adclients", |
| 172 "response": { |
| 173 "$ref": "AdClients" |
| 174 }, |
| 175 "scopes": [ |
| 176 "https://www.googleapis.com/auth/adsense", |
| 177 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 178 ] |
| 179 } |
| 180 } |
| 181 }, |
| 182 "adunits": { |
| 183 "methods": { |
| 184 "get": { |
| 185 "description": "Gets the specified ad unit in the sp
ecified ad client for the specified account.", |
| 186 "httpMethod": "GET", |
| 187 "id": "adsense.accounts.adunits.get", |
| 188 "parameterOrder": [ |
| 189 "accountId", |
| 190 "adClientId", |
| 191 "adUnitId" |
| 192 ], |
| 193 "parameters": { |
| 194 "accountId": { |
| 195 "description": "Account to which the ad clie
nt belongs.", |
| 196 "location": "path", |
| 197 "required": true, |
| 198 "type": "string" |
| 199 }, |
| 200 "adClientId": { |
| 201 "description": "Ad client for which to get t
he ad unit.", |
| 202 "location": "path", |
| 203 "required": true, |
| 204 "type": "string" |
| 205 }, |
| 206 "adUnitId": { |
| 207 "description": "Ad unit to retrieve.", |
| 208 "location": "path", |
| 209 "required": true, |
| 210 "type": "string" |
| 211 } |
| 212 }, |
| 213 "path": "accounts/{accountId}/adclients/{adClientId}
/adunits/{adUnitId}", |
| 214 "response": { |
| 215 "$ref": "AdUnit" |
| 216 }, |
| 217 "scopes": [ |
| 218 "https://www.googleapis.com/auth/adsense", |
| 219 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 220 ] |
| 221 }, |
| 222 "getAdCode": { |
| 223 "description": "Get ad code for the specified ad uni
t.", |
| 224 "httpMethod": "GET", |
| 225 "id": "adsense.accounts.adunits.getAdCode", |
| 226 "parameterOrder": [ |
| 227 "accountId", |
| 228 "adClientId", |
| 229 "adUnitId" |
| 230 ], |
| 231 "parameters": { |
| 232 "accountId": { |
| 233 "description": "Account which contains the a
d client.", |
| 234 "location": "path", |
| 235 "required": true, |
| 236 "type": "string" |
| 237 }, |
| 238 "adClientId": { |
| 239 "description": "Ad client with contains the
ad unit.", |
| 240 "location": "path", |
| 241 "required": true, |
| 242 "type": "string" |
| 243 }, |
| 244 "adUnitId": { |
| 245 "description": "Ad unit to get the code for.
", |
| 246 "location": "path", |
| 247 "required": true, |
| 248 "type": "string" |
| 249 } |
| 250 }, |
| 251 "path": "accounts/{accountId}/adclients/{adClientId}
/adunits/{adUnitId}/adcode", |
| 252 "response": { |
| 253 "$ref": "AdCode" |
| 254 }, |
| 255 "scopes": [ |
| 256 "https://www.googleapis.com/auth/adsense", |
| 257 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 258 ] |
| 259 }, |
| 260 "list": { |
| 261 "description": "List all ad units in the specified a
d client for the specified account.", |
| 262 "httpMethod": "GET", |
| 263 "id": "adsense.accounts.adunits.list", |
| 264 "parameterOrder": [ |
| 265 "accountId", |
| 266 "adClientId" |
| 267 ], |
| 268 "parameters": { |
| 269 "accountId": { |
| 270 "description": "Account to which the ad clie
nt belongs.", |
| 271 "location": "path", |
| 272 "required": true, |
| 273 "type": "string" |
| 274 }, |
| 275 "adClientId": { |
| 276 "description": "Ad client for which to list
ad units.", |
| 277 "location": "path", |
| 278 "required": true, |
| 279 "type": "string" |
| 280 }, |
| 281 "includeInactive": { |
| 282 "description": "Whether to include inactive
ad units. Default: true.", |
| 283 "location": "query", |
| 284 "type": "boolean" |
| 285 }, |
| 286 "maxResults": { |
| 287 "description": "The maximum number of ad uni
ts to include in the response, used for paging.", |
| 288 "format": "int32", |
| 289 "location": "query", |
| 290 "maximum": "10000", |
| 291 "minimum": "0", |
| 292 "type": "integer" |
| 293 }, |
| 294 "pageToken": { |
| 295 "description": "A continuation token, used t
o page through ad units. To retrieve the next page, set this parameter to the va
lue of \"nextPageToken\" from the previous response.", |
| 296 "location": "query", |
| 297 "type": "string" |
| 298 } |
| 299 }, |
| 300 "path": "accounts/{accountId}/adclients/{adClientId}
/adunits", |
| 301 "response": { |
| 302 "$ref": "AdUnits" |
| 303 }, |
| 304 "scopes": [ |
| 305 "https://www.googleapis.com/auth/adsense", |
| 306 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 307 ] |
| 308 } |
| 309 }, |
| 310 "resources": { |
| 311 "customchannels": { |
| 312 "methods": { |
| 313 "list": { |
| 314 "description": "List all custom channels whi
ch the specified ad unit belongs to.", |
| 315 "httpMethod": "GET", |
| 316 "id": "adsense.accounts.adunits.customchanne
ls.list", |
| 317 "parameterOrder": [ |
| 318 "accountId", |
| 319 "adClientId", |
| 320 "adUnitId" |
| 321 ], |
| 322 "parameters": { |
| 323 "accountId": { |
| 324 "description": "Account to which the
ad client belongs.", |
| 325 "location": "path", |
| 326 "required": true, |
| 327 "type": "string" |
| 328 }, |
| 329 "adClientId": { |
| 330 "description": "Ad client which cont
ains the ad unit.", |
| 331 "location": "path", |
| 332 "required": true, |
| 333 "type": "string" |
| 334 }, |
| 335 "adUnitId": { |
| 336 "description": "Ad unit for which to
list custom channels.", |
| 337 "location": "path", |
| 338 "required": true, |
| 339 "type": "string" |
| 340 }, |
| 341 "maxResults": { |
| 342 "description": "The maximum number o
f custom channels to include in the response, used for paging.", |
| 343 "format": "int32", |
| 344 "location": "query", |
| 345 "maximum": "10000", |
| 346 "minimum": "0", |
| 347 "type": "integer" |
| 348 }, |
| 349 "pageToken": { |
| 350 "description": "A continuation token
, used to page through custom channels. To retrieve the next page, set this para
meter to the value of \"nextPageToken\" from the previous response.", |
| 351 "location": "query", |
| 352 "type": "string" |
| 353 } |
| 354 }, |
| 355 "path": "accounts/{accountId}/adclients/{adC
lientId}/adunits/{adUnitId}/customchannels", |
| 356 "response": { |
| 357 "$ref": "CustomChannels" |
| 358 }, |
| 359 "scopes": [ |
| 360 "https://www.googleapis.com/auth/adsense
", |
| 361 "https://www.googleapis.com/auth/adsense
.readonly" |
| 362 ] |
| 363 } |
| 364 } |
| 365 } |
| 366 } |
| 367 }, |
| 368 "alerts": { |
| 369 "methods": { |
| 370 "delete": { |
| 371 "description": "Dismiss (delete) the specified alert
from the specified publisher AdSense account.", |
| 372 "httpMethod": "DELETE", |
| 373 "id": "adsense.accounts.alerts.delete", |
| 374 "parameterOrder": [ |
| 375 "accountId", |
| 376 "alertId" |
| 377 ], |
| 378 "parameters": { |
| 379 "accountId": { |
| 380 "description": "Account which contains the a
d unit.", |
| 381 "location": "path", |
| 382 "required": true, |
| 383 "type": "string" |
| 384 }, |
| 385 "alertId": { |
| 386 "description": "Alert to delete.", |
| 387 "location": "path", |
| 388 "required": true, |
| 389 "type": "string" |
| 390 } |
| 391 }, |
| 392 "path": "accounts/{accountId}/alerts/{alertId}", |
| 393 "scopes": [ |
| 394 "https://www.googleapis.com/auth/adsense" |
| 395 ] |
| 396 }, |
| 397 "list": { |
| 398 "description": "List the alerts for the specified Ad
Sense account.", |
| 399 "httpMethod": "GET", |
| 400 "id": "adsense.accounts.alerts.list", |
| 401 "parameterOrder": [ |
| 402 "accountId" |
| 403 ], |
| 404 "parameters": { |
| 405 "accountId": { |
| 406 "description": "Account for which to retriev
e the alerts.", |
| 407 "location": "path", |
| 408 "required": true, |
| 409 "type": "string" |
| 410 }, |
| 411 "locale": { |
| 412 "description": "The locale to use for transl
ating alert messages. The account locale will be used if this is not supplied. T
he AdSense default (English) will be used if the supplied locale is invalid or u
nsupported.", |
| 413 "location": "query", |
| 414 "type": "string" |
| 415 } |
| 416 }, |
| 417 "path": "accounts/{accountId}/alerts", |
| 418 "response": { |
| 419 "$ref": "Alerts" |
| 420 }, |
| 421 "scopes": [ |
| 422 "https://www.googleapis.com/auth/adsense", |
| 423 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 424 ] |
| 425 } |
| 426 } |
| 427 }, |
| 428 "customchannels": { |
| 429 "methods": { |
| 430 "get": { |
| 431 "description": "Get the specified custom channel fro
m the specified ad client for the specified account.", |
| 432 "httpMethod": "GET", |
| 433 "id": "adsense.accounts.customchannels.get", |
| 434 "parameterOrder": [ |
| 435 "accountId", |
| 436 "adClientId", |
| 437 "customChannelId" |
| 438 ], |
| 439 "parameters": { |
| 440 "accountId": { |
| 441 "description": "Account to which the ad clie
nt belongs.", |
| 442 "location": "path", |
| 443 "required": true, |
| 444 "type": "string" |
| 445 }, |
| 446 "adClientId": { |
| 447 "description": "Ad client which contains the
custom channel.", |
| 448 "location": "path", |
| 449 "required": true, |
| 450 "type": "string" |
| 451 }, |
| 452 "customChannelId": { |
| 453 "description": "Custom channel to retrieve."
, |
| 454 "location": "path", |
| 455 "required": true, |
| 456 "type": "string" |
| 457 } |
| 458 }, |
| 459 "path": "accounts/{accountId}/adclients/{adClientId}
/customchannels/{customChannelId}", |
| 460 "response": { |
| 461 "$ref": "CustomChannel" |
| 462 }, |
| 463 "scopes": [ |
| 464 "https://www.googleapis.com/auth/adsense", |
| 465 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 466 ] |
| 467 }, |
| 468 "list": { |
| 469 "description": "List all custom channels in the spec
ified ad client for the specified account.", |
| 470 "httpMethod": "GET", |
| 471 "id": "adsense.accounts.customchannels.list", |
| 472 "parameterOrder": [ |
| 473 "accountId", |
| 474 "adClientId" |
| 475 ], |
| 476 "parameters": { |
| 477 "accountId": { |
| 478 "description": "Account to which the ad clie
nt belongs.", |
| 479 "location": "path", |
| 480 "required": true, |
| 481 "type": "string" |
| 482 }, |
| 483 "adClientId": { |
| 484 "description": "Ad client for which to list
custom channels.", |
| 485 "location": "path", |
| 486 "required": true, |
| 487 "type": "string" |
| 488 }, |
| 489 "maxResults": { |
| 490 "description": "The maximum number of custom
channels to include in the response, used for paging.", |
| 491 "format": "int32", |
| 492 "location": "query", |
| 493 "maximum": "10000", |
| 494 "minimum": "0", |
| 495 "type": "integer" |
| 496 }, |
| 497 "pageToken": { |
| 498 "description": "A continuation token, used t
o page through custom channels. To retrieve the next page, set this parameter to
the value of \"nextPageToken\" from the previous response.", |
| 499 "location": "query", |
| 500 "type": "string" |
| 501 } |
| 502 }, |
| 503 "path": "accounts/{accountId}/adclients/{adClientId}
/customchannels", |
| 504 "response": { |
| 505 "$ref": "CustomChannels" |
| 506 }, |
| 507 "scopes": [ |
| 508 "https://www.googleapis.com/auth/adsense", |
| 509 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 510 ] |
| 511 } |
| 512 }, |
| 513 "resources": { |
| 514 "adunits": { |
| 515 "methods": { |
| 516 "list": { |
| 517 "description": "List all ad units in the spe
cified custom channel.", |
| 518 "httpMethod": "GET", |
| 519 "id": "adsense.accounts.customchannels.aduni
ts.list", |
| 520 "parameterOrder": [ |
| 521 "accountId", |
| 522 "adClientId", |
| 523 "customChannelId" |
| 524 ], |
| 525 "parameters": { |
| 526 "accountId": { |
| 527 "description": "Account to which the
ad client belongs.", |
| 528 "location": "path", |
| 529 "required": true, |
| 530 "type": "string" |
| 531 }, |
| 532 "adClientId": { |
| 533 "description": "Ad client which cont
ains the custom channel.", |
| 534 "location": "path", |
| 535 "required": true, |
| 536 "type": "string" |
| 537 }, |
| 538 "customChannelId": { |
| 539 "description": "Custom channel for w
hich to list ad units.", |
| 540 "location": "path", |
| 541 "required": true, |
| 542 "type": "string" |
| 543 }, |
| 544 "includeInactive": { |
| 545 "description": "Whether to include i
nactive ad units. Default: true.", |
| 546 "location": "query", |
| 547 "type": "boolean" |
| 548 }, |
| 549 "maxResults": { |
| 550 "description": "The maximum number o
f ad units to include in the response, used for paging.", |
| 551 "format": "int32", |
| 552 "location": "query", |
| 553 "maximum": "10000", |
| 554 "minimum": "0", |
| 555 "type": "integer" |
| 556 }, |
| 557 "pageToken": { |
| 558 "description": "A continuation token
, used to page through ad units. To retrieve the next page, set this parameter t
o the value of \"nextPageToken\" from the previous response.", |
| 559 "location": "query", |
| 560 "type": "string" |
| 561 } |
| 562 }, |
| 563 "path": "accounts/{accountId}/adclients/{adC
lientId}/customchannels/{customChannelId}/adunits", |
| 564 "response": { |
| 565 "$ref": "AdUnits" |
| 566 }, |
| 567 "scopes": [ |
| 568 "https://www.googleapis.com/auth/adsense
", |
| 569 "https://www.googleapis.com/auth/adsense
.readonly" |
| 570 ] |
| 571 } |
| 572 } |
| 573 } |
| 574 } |
| 575 }, |
| 576 "payments": { |
| 577 "methods": { |
| 578 "list": { |
| 579 "description": "List the payments for the specified
AdSense account.", |
| 580 "httpMethod": "GET", |
| 581 "id": "adsense.accounts.payments.list", |
| 582 "parameterOrder": [ |
| 583 "accountId" |
| 584 ], |
| 585 "parameters": { |
| 586 "accountId": { |
| 587 "description": "Account for which to retriev
e the payments.", |
| 588 "location": "path", |
| 589 "required": true, |
| 590 "type": "string" |
| 591 } |
| 592 }, |
| 593 "path": "accounts/{accountId}/payments", |
| 594 "response": { |
| 595 "$ref": "Payments" |
| 596 }, |
| 597 "scopes": [ |
| 598 "https://www.googleapis.com/auth/adsense", |
| 599 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 600 ] |
| 601 } |
| 602 } |
| 603 }, |
| 604 "reports": { |
| 605 "methods": { |
| 606 "generate": { |
| 607 "description": "Generate an AdSense report based on
the report request sent in the query parameters. Returns the result as JSON; to
retrieve output in CSV format specify \"alt=csv\" as a query parameter.", |
| 608 "httpMethod": "GET", |
| 609 "id": "adsense.accounts.reports.generate", |
| 610 "parameterOrder": [ |
| 611 "accountId", |
| 612 "startDate", |
| 613 "endDate" |
| 614 ], |
| 615 "parameters": { |
| 616 "accountId": { |
| 617 "description": "Account upon which to report
.", |
| 618 "location": "path", |
| 619 "required": true, |
| 620 "type": "string" |
| 621 }, |
| 622 "currency": { |
| 623 "description": "Optional currency to use whe
n reporting on monetary metrics. Defaults to the account's currency if not set."
, |
| 624 "location": "query", |
| 625 "pattern": "[a-zA-Z]+", |
| 626 "type": "string" |
| 627 }, |
| 628 "dimension": { |
| 629 "description": "Dimensions to base the repor
t on.", |
| 630 "location": "query", |
| 631 "pattern": "[a-zA-Z_]+", |
| 632 "repeated": true, |
| 633 "type": "string" |
| 634 }, |
| 635 "endDate": { |
| 636 "description": "End of the date range to rep
ort on in \"YYYY-MM-DD\" format, inclusive.", |
| 637 "location": "query", |
| 638 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|star
tOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d
+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)", |
| 639 "required": true, |
| 640 "type": "string" |
| 641 }, |
| 642 "filter": { |
| 643 "description": "Filters to be run on the rep
ort.", |
| 644 "location": "query", |
| 645 "pattern": "[a-zA-Z_]+(==|=@).+", |
| 646 "repeated": true, |
| 647 "type": "string" |
| 648 }, |
| 649 "locale": { |
| 650 "description": "Optional locale to use for t
ranslating report output to a local language. Defaults to \"en_US\" if not speci
fied.", |
| 651 "location": "query", |
| 652 "pattern": "[a-zA-Z_]+", |
| 653 "type": "string" |
| 654 }, |
| 655 "maxResults": { |
| 656 "description": "The maximum number of rows o
f report data to return.", |
| 657 "format": "int32", |
| 658 "location": "query", |
| 659 "maximum": "50000", |
| 660 "minimum": "0", |
| 661 "type": "integer" |
| 662 }, |
| 663 "metric": { |
| 664 "description": "Numeric columns to include i
n the report.", |
| 665 "location": "query", |
| 666 "pattern": "[a-zA-Z_]+", |
| 667 "repeated": true, |
| 668 "type": "string" |
| 669 }, |
| 670 "sort": { |
| 671 "description": "The name of a dimension or m
etric to sort the resulting report on, optionally prefixed with \"+\" to sort as
cending or \"-\" to sort descending. If no prefix is specified, the column is so
rted ascending.", |
| 672 "location": "query", |
| 673 "pattern": "(\\+|-)?[a-zA-Z_]+", |
| 674 "repeated": true, |
| 675 "type": "string" |
| 676 }, |
| 677 "startDate": { |
| 678 "description": "Start of the date range to r
eport on in \"YYYY-MM-DD\" format, inclusive.", |
| 679 "location": "query", |
| 680 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|star
tOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d
+y)?)|(latest-latest-(\\d{2})(-\\d+m)?)", |
| 681 "required": true, |
| 682 "type": "string" |
| 683 }, |
| 684 "startIndex": { |
| 685 "description": "Index of the first row of re
port data to return.", |
| 686 "format": "int32", |
| 687 "location": "query", |
| 688 "maximum": "5000", |
| 689 "minimum": "0", |
| 690 "type": "integer" |
| 691 }, |
| 692 "useTimezoneReporting": { |
| 693 "description": "Whether the report should be
generated in the AdSense account's local timezone. If false default PST/PDT tim
ezone will be used.", |
| 694 "location": "query", |
| 695 "type": "boolean" |
| 696 } |
| 697 }, |
| 698 "path": "accounts/{accountId}/reports", |
| 699 "response": { |
| 700 "$ref": "AdsenseReportsGenerateResponse" |
| 701 }, |
| 702 "scopes": [ |
| 703 "https://www.googleapis.com/auth/adsense", |
| 704 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 705 ], |
| 706 "supportsMediaDownload": true |
| 707 } |
| 708 }, |
| 709 "resources": { |
| 710 "saved": { |
| 711 "methods": { |
| 712 "generate": { |
| 713 "description": "Generate an AdSense report b
ased on the saved report ID sent in the query parameters.", |
| 714 "httpMethod": "GET", |
| 715 "id": "adsense.accounts.reports.saved.genera
te", |
| 716 "parameterOrder": [ |
| 717 "accountId", |
| 718 "savedReportId" |
| 719 ], |
| 720 "parameters": { |
| 721 "accountId": { |
| 722 "description": "Account to which the
saved reports belong.", |
| 723 "location": "path", |
| 724 "required": true, |
| 725 "type": "string" |
| 726 }, |
| 727 "locale": { |
| 728 "description": "Optional locale to u
se for translating report output to a local language. Defaults to \"en_US\" if n
ot specified.", |
| 729 "location": "query", |
| 730 "pattern": "[a-zA-Z_]+", |
| 731 "type": "string" |
| 732 }, |
| 733 "maxResults": { |
| 734 "description": "The maximum number o
f rows of report data to return.", |
| 735 "format": "int32", |
| 736 "location": "query", |
| 737 "maximum": "50000", |
| 738 "minimum": "0", |
| 739 "type": "integer" |
| 740 }, |
| 741 "savedReportId": { |
| 742 "description": "The saved report to
retrieve.", |
| 743 "location": "path", |
| 744 "required": true, |
| 745 "type": "string" |
| 746 }, |
| 747 "startIndex": { |
| 748 "description": "Index of the first r
ow of report data to return.", |
| 749 "format": "int32", |
| 750 "location": "query", |
| 751 "maximum": "5000", |
| 752 "minimum": "0", |
| 753 "type": "integer" |
| 754 } |
| 755 }, |
| 756 "path": "accounts/{accountId}/reports/{saved
ReportId}", |
| 757 "response": { |
| 758 "$ref": "AdsenseReportsGenerateResponse" |
| 759 }, |
| 760 "scopes": [ |
| 761 "https://www.googleapis.com/auth/adsense
", |
| 762 "https://www.googleapis.com/auth/adsense
.readonly" |
| 763 ] |
| 764 }, |
| 765 "list": { |
| 766 "description": "List all saved reports in th
e specified AdSense account.", |
| 767 "httpMethod": "GET", |
| 768 "id": "adsense.accounts.reports.saved.list", |
| 769 "parameterOrder": [ |
| 770 "accountId" |
| 771 ], |
| 772 "parameters": { |
| 773 "accountId": { |
| 774 "description": "Account to which the
saved reports belong.", |
| 775 "location": "path", |
| 776 "required": true, |
| 777 "type": "string" |
| 778 }, |
| 779 "maxResults": { |
| 780 "description": "The maximum number o
f saved reports to include in the response, used for paging.", |
| 781 "format": "int32", |
| 782 "location": "query", |
| 783 "maximum": "100", |
| 784 "minimum": "0", |
| 785 "type": "integer" |
| 786 }, |
| 787 "pageToken": { |
| 788 "description": "A continuation token
, used to page through saved reports. To retrieve the next page, set this parame
ter to the value of \"nextPageToken\" from the previous response.", |
| 789 "location": "query", |
| 790 "type": "string" |
| 791 } |
| 792 }, |
| 793 "path": "accounts/{accountId}/reports/saved"
, |
| 794 "response": { |
| 795 "$ref": "SavedReports" |
| 796 }, |
| 797 "scopes": [ |
| 798 "https://www.googleapis.com/auth/adsense
", |
| 799 "https://www.googleapis.com/auth/adsense
.readonly" |
| 800 ] |
| 801 } |
| 802 } |
| 803 } |
| 804 } |
| 805 }, |
| 806 "savedadstyles": { |
| 807 "methods": { |
| 808 "get": { |
| 809 "description": "List a specific saved ad style for t
he specified account.", |
| 810 "httpMethod": "GET", |
| 811 "id": "adsense.accounts.savedadstyles.get", |
| 812 "parameterOrder": [ |
| 813 "accountId", |
| 814 "savedAdStyleId" |
| 815 ], |
| 816 "parameters": { |
| 817 "accountId": { |
| 818 "description": "Account for which to get the
saved ad style.", |
| 819 "location": "path", |
| 820 "required": true, |
| 821 "type": "string" |
| 822 }, |
| 823 "savedAdStyleId": { |
| 824 "description": "Saved ad style to retrieve."
, |
| 825 "location": "path", |
| 826 "required": true, |
| 827 "type": "string" |
| 828 } |
| 829 }, |
| 830 "path": "accounts/{accountId}/savedadstyles/{savedAd
StyleId}", |
| 831 "response": { |
| 832 "$ref": "SavedAdStyle" |
| 833 }, |
| 834 "scopes": [ |
| 835 "https://www.googleapis.com/auth/adsense", |
| 836 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 837 ] |
| 838 }, |
| 839 "list": { |
| 840 "description": "List all saved ad styles in the spec
ified account.", |
| 841 "httpMethod": "GET", |
| 842 "id": "adsense.accounts.savedadstyles.list", |
| 843 "parameterOrder": [ |
| 844 "accountId" |
| 845 ], |
| 846 "parameters": { |
| 847 "accountId": { |
| 848 "description": "Account for which to list sa
ved ad styles.", |
| 849 "location": "path", |
| 850 "required": true, |
| 851 "type": "string" |
| 852 }, |
| 853 "maxResults": { |
| 854 "description": "The maximum number of saved
ad styles to include in the response, used for paging.", |
| 855 "format": "int32", |
| 856 "location": "query", |
| 857 "maximum": "10000", |
| 858 "minimum": "0", |
| 859 "type": "integer" |
| 860 }, |
| 861 "pageToken": { |
| 862 "description": "A continuation token, used t
o page through saved ad styles. To retrieve the next page, set this parameter to
the value of \"nextPageToken\" from the previous response.", |
| 863 "location": "query", |
| 864 "type": "string" |
| 865 } |
| 866 }, |
| 867 "path": "accounts/{accountId}/savedadstyles", |
| 868 "response": { |
| 869 "$ref": "SavedAdStyles" |
| 870 }, |
| 871 "scopes": [ |
| 872 "https://www.googleapis.com/auth/adsense", |
| 873 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 874 ] |
| 875 } |
| 876 } |
| 877 }, |
| 878 "urlchannels": { |
| 879 "methods": { |
| 880 "list": { |
| 881 "description": "List all URL channels in the specifi
ed ad client for the specified account.", |
| 882 "httpMethod": "GET", |
| 883 "id": "adsense.accounts.urlchannels.list", |
| 884 "parameterOrder": [ |
| 885 "accountId", |
| 886 "adClientId" |
| 887 ], |
| 888 "parameters": { |
| 889 "accountId": { |
| 890 "description": "Account to which the ad clie
nt belongs.", |
| 891 "location": "path", |
| 892 "required": true, |
| 893 "type": "string" |
| 894 }, |
| 895 "adClientId": { |
| 896 "description": "Ad client for which to list
URL channels.", |
| 897 "location": "path", |
| 898 "required": true, |
| 899 "type": "string" |
| 900 }, |
| 901 "maxResults": { |
| 902 "description": "The maximum number of URL ch
annels to include in the response, used for paging.", |
| 903 "format": "int32", |
| 904 "location": "query", |
| 905 "maximum": "10000", |
| 906 "minimum": "0", |
| 907 "type": "integer" |
| 908 }, |
| 909 "pageToken": { |
| 910 "description": "A continuation token, used t
o page through URL channels. To retrieve the next page, set this parameter to th
e value of \"nextPageToken\" from the previous response.", |
| 911 "location": "query", |
| 912 "type": "string" |
| 913 } |
| 914 }, |
| 915 "path": "accounts/{accountId}/adclients/{adClientId}
/urlchannels", |
| 916 "response": { |
| 917 "$ref": "UrlChannels" |
| 918 }, |
| 919 "scopes": [ |
| 920 "https://www.googleapis.com/auth/adsense", |
| 921 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 922 ] |
| 923 } |
| 924 } |
| 925 } |
| 926 } |
| 927 }, |
| 928 "adclients": { |
| 929 "methods": { |
| 930 "list": { |
| 931 "description": "List all ad clients in this AdSense account.
", |
| 932 "httpMethod": "GET", |
| 933 "id": "adsense.adclients.list", |
| 934 "parameters": { |
| 935 "maxResults": { |
| 936 "description": "The maximum number of ad clients to
include in the response, used for paging.", |
| 937 "format": "int32", |
| 938 "location": "query", |
| 939 "maximum": "10000", |
| 940 "minimum": "0", |
| 941 "type": "integer" |
| 942 }, |
| 943 "pageToken": { |
| 944 "description": "A continuation token, used to page t
hrough ad clients. To retrieve the next page, set this parameter to the value of
\"nextPageToken\" from the previous response.", |
| 945 "location": "query", |
| 946 "type": "string" |
| 947 } |
| 948 }, |
| 949 "path": "adclients", |
| 950 "response": { |
| 951 "$ref": "AdClients" |
| 952 }, |
| 953 "scopes": [ |
| 954 "https://www.googleapis.com/auth/adsense", |
| 955 "https://www.googleapis.com/auth/adsense.readonly" |
| 956 ] |
| 957 } |
| 958 } |
| 959 }, |
| 960 "adunits": { |
| 961 "methods": { |
| 962 "get": { |
| 963 "description": "Gets the specified ad unit in the specified
ad client.", |
| 964 "httpMethod": "GET", |
| 965 "id": "adsense.adunits.get", |
| 966 "parameterOrder": [ |
| 967 "adClientId", |
| 968 "adUnitId" |
| 969 ], |
| 970 "parameters": { |
| 971 "adClientId": { |
| 972 "description": "Ad client for which to get the ad un
it.", |
| 973 "location": "path", |
| 974 "required": true, |
| 975 "type": "string" |
| 976 }, |
| 977 "adUnitId": { |
| 978 "description": "Ad unit to retrieve.", |
| 979 "location": "path", |
| 980 "required": true, |
| 981 "type": "string" |
| 982 } |
| 983 }, |
| 984 "path": "adclients/{adClientId}/adunits/{adUnitId}", |
| 985 "response": { |
| 986 "$ref": "AdUnit" |
| 987 }, |
| 988 "scopes": [ |
| 989 "https://www.googleapis.com/auth/adsense", |
| 990 "https://www.googleapis.com/auth/adsense.readonly" |
| 991 ] |
| 992 }, |
| 993 "getAdCode": { |
| 994 "description": "Get ad code for the specified ad unit.", |
| 995 "httpMethod": "GET", |
| 996 "id": "adsense.adunits.getAdCode", |
| 997 "parameterOrder": [ |
| 998 "adClientId", |
| 999 "adUnitId" |
| 1000 ], |
| 1001 "parameters": { |
| 1002 "adClientId": { |
| 1003 "description": "Ad client with contains the ad unit.
", |
| 1004 "location": "path", |
| 1005 "required": true, |
| 1006 "type": "string" |
| 1007 }, |
| 1008 "adUnitId": { |
| 1009 "description": "Ad unit to get the code for.", |
| 1010 "location": "path", |
| 1011 "required": true, |
| 1012 "type": "string" |
| 1013 } |
| 1014 }, |
| 1015 "path": "adclients/{adClientId}/adunits/{adUnitId}/adcode", |
| 1016 "response": { |
| 1017 "$ref": "AdCode" |
| 1018 }, |
| 1019 "scopes": [ |
| 1020 "https://www.googleapis.com/auth/adsense", |
| 1021 "https://www.googleapis.com/auth/adsense.readonly" |
| 1022 ] |
| 1023 }, |
| 1024 "list": { |
| 1025 "description": "List all ad units in the specified ad client
for this AdSense account.", |
| 1026 "httpMethod": "GET", |
| 1027 "id": "adsense.adunits.list", |
| 1028 "parameterOrder": [ |
| 1029 "adClientId" |
| 1030 ], |
| 1031 "parameters": { |
| 1032 "adClientId": { |
| 1033 "description": "Ad client for which to list ad units
.", |
| 1034 "location": "path", |
| 1035 "required": true, |
| 1036 "type": "string" |
| 1037 }, |
| 1038 "includeInactive": { |
| 1039 "description": "Whether to include inactive ad units
. Default: true.", |
| 1040 "location": "query", |
| 1041 "type": "boolean" |
| 1042 }, |
| 1043 "maxResults": { |
| 1044 "description": "The maximum number of ad units to in
clude in the response, used for paging.", |
| 1045 "format": "int32", |
| 1046 "location": "query", |
| 1047 "maximum": "10000", |
| 1048 "minimum": "0", |
| 1049 "type": "integer" |
| 1050 }, |
| 1051 "pageToken": { |
| 1052 "description": "A continuation token, used to page t
hrough ad units. To retrieve the next page, set this parameter to the value of \
"nextPageToken\" from the previous response.", |
| 1053 "location": "query", |
| 1054 "type": "string" |
| 1055 } |
| 1056 }, |
| 1057 "path": "adclients/{adClientId}/adunits", |
| 1058 "response": { |
| 1059 "$ref": "AdUnits" |
| 1060 }, |
| 1061 "scopes": [ |
| 1062 "https://www.googleapis.com/auth/adsense", |
| 1063 "https://www.googleapis.com/auth/adsense.readonly" |
| 1064 ] |
| 1065 } |
| 1066 }, |
| 1067 "resources": { |
| 1068 "customchannels": { |
| 1069 "methods": { |
| 1070 "list": { |
| 1071 "description": "List all custom channels which the s
pecified ad unit belongs to.", |
| 1072 "httpMethod": "GET", |
| 1073 "id": "adsense.adunits.customchannels.list", |
| 1074 "parameterOrder": [ |
| 1075 "adClientId", |
| 1076 "adUnitId" |
| 1077 ], |
| 1078 "parameters": { |
| 1079 "adClientId": { |
| 1080 "description": "Ad client which contains the
ad unit.", |
| 1081 "location": "path", |
| 1082 "required": true, |
| 1083 "type": "string" |
| 1084 }, |
| 1085 "adUnitId": { |
| 1086 "description": "Ad unit for which to list cu
stom channels.", |
| 1087 "location": "path", |
| 1088 "required": true, |
| 1089 "type": "string" |
| 1090 }, |
| 1091 "maxResults": { |
| 1092 "description": "The maximum number of custom
channels to include in the response, used for paging.", |
| 1093 "format": "int32", |
| 1094 "location": "query", |
| 1095 "maximum": "10000", |
| 1096 "minimum": "0", |
| 1097 "type": "integer" |
| 1098 }, |
| 1099 "pageToken": { |
| 1100 "description": "A continuation token, used t
o page through custom channels. To retrieve the next page, set this parameter to
the value of \"nextPageToken\" from the previous response.", |
| 1101 "location": "query", |
| 1102 "type": "string" |
| 1103 } |
| 1104 }, |
| 1105 "path": "adclients/{adClientId}/adunits/{adUnitId}/c
ustomchannels", |
| 1106 "response": { |
| 1107 "$ref": "CustomChannels" |
| 1108 }, |
| 1109 "scopes": [ |
| 1110 "https://www.googleapis.com/auth/adsense", |
| 1111 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 1112 ] |
| 1113 } |
| 1114 } |
| 1115 } |
| 1116 } |
| 1117 }, |
| 1118 "alerts": { |
| 1119 "methods": { |
| 1120 "delete": { |
| 1121 "description": "Dismiss (delete) the specified alert from th
e publisher's AdSense account.", |
| 1122 "httpMethod": "DELETE", |
| 1123 "id": "adsense.alerts.delete", |
| 1124 "parameterOrder": [ |
| 1125 "alertId" |
| 1126 ], |
| 1127 "parameters": { |
| 1128 "alertId": { |
| 1129 "description": "Alert to delete.", |
| 1130 "location": "path", |
| 1131 "required": true, |
| 1132 "type": "string" |
| 1133 } |
| 1134 }, |
| 1135 "path": "alerts/{alertId}", |
| 1136 "scopes": [ |
| 1137 "https://www.googleapis.com/auth/adsense" |
| 1138 ] |
| 1139 }, |
| 1140 "list": { |
| 1141 "description": "List the alerts for this AdSense account.", |
| 1142 "httpMethod": "GET", |
| 1143 "id": "adsense.alerts.list", |
| 1144 "parameters": { |
| 1145 "locale": { |
| 1146 "description": "The locale to use for translating al
ert messages. The account locale will be used if this is not supplied. The AdSen
se default (English) will be used if the supplied locale is invalid or unsupport
ed.", |
| 1147 "location": "query", |
| 1148 "type": "string" |
| 1149 } |
| 1150 }, |
| 1151 "path": "alerts", |
| 1152 "response": { |
| 1153 "$ref": "Alerts" |
| 1154 }, |
| 1155 "scopes": [ |
| 1156 "https://www.googleapis.com/auth/adsense", |
| 1157 "https://www.googleapis.com/auth/adsense.readonly" |
| 1158 ] |
| 1159 } |
| 1160 } |
| 1161 }, |
| 1162 "customchannels": { |
| 1163 "methods": { |
| 1164 "get": { |
| 1165 "description": "Get the specified custom channel from the sp
ecified ad client.", |
| 1166 "httpMethod": "GET", |
| 1167 "id": "adsense.customchannels.get", |
| 1168 "parameterOrder": [ |
| 1169 "adClientId", |
| 1170 "customChannelId" |
| 1171 ], |
| 1172 "parameters": { |
| 1173 "adClientId": { |
| 1174 "description": "Ad client which contains the custom
channel.", |
| 1175 "location": "path", |
| 1176 "required": true, |
| 1177 "type": "string" |
| 1178 }, |
| 1179 "customChannelId": { |
| 1180 "description": "Custom channel to retrieve.", |
| 1181 "location": "path", |
| 1182 "required": true, |
| 1183 "type": "string" |
| 1184 } |
| 1185 }, |
| 1186 "path": "adclients/{adClientId}/customchannels/{customChanne
lId}", |
| 1187 "response": { |
| 1188 "$ref": "CustomChannel" |
| 1189 }, |
| 1190 "scopes": [ |
| 1191 "https://www.googleapis.com/auth/adsense", |
| 1192 "https://www.googleapis.com/auth/adsense.readonly" |
| 1193 ] |
| 1194 }, |
| 1195 "list": { |
| 1196 "description": "List all custom channels in the specified ad
client for this AdSense account.", |
| 1197 "httpMethod": "GET", |
| 1198 "id": "adsense.customchannels.list", |
| 1199 "parameterOrder": [ |
| 1200 "adClientId" |
| 1201 ], |
| 1202 "parameters": { |
| 1203 "adClientId": { |
| 1204 "description": "Ad client for which to list custom c
hannels.", |
| 1205 "location": "path", |
| 1206 "required": true, |
| 1207 "type": "string" |
| 1208 }, |
| 1209 "maxResults": { |
| 1210 "description": "The maximum number of custom channel
s to include in the response, used for paging.", |
| 1211 "format": "int32", |
| 1212 "location": "query", |
| 1213 "maximum": "10000", |
| 1214 "minimum": "0", |
| 1215 "type": "integer" |
| 1216 }, |
| 1217 "pageToken": { |
| 1218 "description": "A continuation token, used to page t
hrough custom channels. To retrieve the next page, set this parameter to the val
ue of \"nextPageToken\" from the previous response.", |
| 1219 "location": "query", |
| 1220 "type": "string" |
| 1221 } |
| 1222 }, |
| 1223 "path": "adclients/{adClientId}/customchannels", |
| 1224 "response": { |
| 1225 "$ref": "CustomChannels" |
| 1226 }, |
| 1227 "scopes": [ |
| 1228 "https://www.googleapis.com/auth/adsense", |
| 1229 "https://www.googleapis.com/auth/adsense.readonly" |
| 1230 ] |
| 1231 } |
| 1232 }, |
| 1233 "resources": { |
| 1234 "adunits": { |
| 1235 "methods": { |
| 1236 "list": { |
| 1237 "description": "List all ad units in the specified c
ustom channel.", |
| 1238 "httpMethod": "GET", |
| 1239 "id": "adsense.customchannels.adunits.list", |
| 1240 "parameterOrder": [ |
| 1241 "adClientId", |
| 1242 "customChannelId" |
| 1243 ], |
| 1244 "parameters": { |
| 1245 "adClientId": { |
| 1246 "description": "Ad client which contains the
custom channel.", |
| 1247 "location": "path", |
| 1248 "required": true, |
| 1249 "type": "string" |
| 1250 }, |
| 1251 "customChannelId": { |
| 1252 "description": "Custom channel for which to
list ad units.", |
| 1253 "location": "path", |
| 1254 "required": true, |
| 1255 "type": "string" |
| 1256 }, |
| 1257 "includeInactive": { |
| 1258 "description": "Whether to include inactive
ad units. Default: true.", |
| 1259 "location": "query", |
| 1260 "type": "boolean" |
| 1261 }, |
| 1262 "maxResults": { |
| 1263 "description": "The maximum number of ad uni
ts to include in the response, used for paging.", |
| 1264 "format": "int32", |
| 1265 "location": "query", |
| 1266 "maximum": "10000", |
| 1267 "minimum": "0", |
| 1268 "type": "integer" |
| 1269 }, |
| 1270 "pageToken": { |
| 1271 "description": "A continuation token, used t
o page through ad units. To retrieve the next page, set this parameter to the va
lue of \"nextPageToken\" from the previous response.", |
| 1272 "location": "query", |
| 1273 "type": "string" |
| 1274 } |
| 1275 }, |
| 1276 "path": "adclients/{adClientId}/customchannels/{cust
omChannelId}/adunits", |
| 1277 "response": { |
| 1278 "$ref": "AdUnits" |
| 1279 }, |
| 1280 "scopes": [ |
| 1281 "https://www.googleapis.com/auth/adsense", |
| 1282 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 1283 ] |
| 1284 } |
| 1285 } |
| 1286 } |
| 1287 } |
| 1288 }, |
| 1289 "metadata": { |
| 1290 "resources": { |
| 1291 "dimensions": { |
| 1292 "methods": { |
| 1293 "list": { |
| 1294 "description": "List the metadata for the dimensions
available to this AdSense account.", |
| 1295 "httpMethod": "GET", |
| 1296 "id": "adsense.metadata.dimensions.list", |
| 1297 "path": "metadata/dimensions", |
| 1298 "response": { |
| 1299 "$ref": "Metadata" |
| 1300 }, |
| 1301 "scopes": [ |
| 1302 "https://www.googleapis.com/auth/adsense", |
| 1303 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 1304 ] |
| 1305 } |
| 1306 } |
| 1307 }, |
| 1308 "metrics": { |
| 1309 "methods": { |
| 1310 "list": { |
| 1311 "description": "List the metadata for the metrics av
ailable to this AdSense account.", |
| 1312 "httpMethod": "GET", |
| 1313 "id": "adsense.metadata.metrics.list", |
| 1314 "path": "metadata/metrics", |
| 1315 "response": { |
| 1316 "$ref": "Metadata" |
| 1317 }, |
| 1318 "scopes": [ |
| 1319 "https://www.googleapis.com/auth/adsense", |
| 1320 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 1321 ] |
| 1322 } |
| 1323 } |
| 1324 } |
| 1325 } |
| 1326 }, |
| 1327 "payments": { |
| 1328 "methods": { |
| 1329 "list": { |
| 1330 "description": "List the payments for this AdSense account."
, |
| 1331 "httpMethod": "GET", |
| 1332 "id": "adsense.payments.list", |
| 1333 "path": "payments", |
| 1334 "response": { |
| 1335 "$ref": "Payments" |
| 1336 }, |
| 1337 "scopes": [ |
| 1338 "https://www.googleapis.com/auth/adsense", |
| 1339 "https://www.googleapis.com/auth/adsense.readonly" |
| 1340 ] |
| 1341 } |
| 1342 } |
| 1343 }, |
| 1344 "reports": { |
| 1345 "methods": { |
| 1346 "generate": { |
| 1347 "description": "Generate an AdSense report based on the repo
rt request sent in the query parameters. Returns the result as JSON; to retrieve
output in CSV format specify \"alt=csv\" as a query parameter.", |
| 1348 "httpMethod": "GET", |
| 1349 "id": "adsense.reports.generate", |
| 1350 "parameterOrder": [ |
| 1351 "startDate", |
| 1352 "endDate" |
| 1353 ], |
| 1354 "parameters": { |
| 1355 "accountId": { |
| 1356 "description": "Accounts upon which to report.", |
| 1357 "location": "query", |
| 1358 "repeated": true, |
| 1359 "type": "string" |
| 1360 }, |
| 1361 "currency": { |
| 1362 "description": "Optional currency to use when report
ing on monetary metrics. Defaults to the account's currency if not set.", |
| 1363 "location": "query", |
| 1364 "pattern": "[a-zA-Z]+", |
| 1365 "type": "string" |
| 1366 }, |
| 1367 "dimension": { |
| 1368 "description": "Dimensions to base the report on.", |
| 1369 "location": "query", |
| 1370 "pattern": "[a-zA-Z_]+", |
| 1371 "repeated": true, |
| 1372 "type": "string" |
| 1373 }, |
| 1374 "endDate": { |
| 1375 "description": "End of the date range to report on i
n \"YYYY-MM-DD\" format, inclusive.", |
| 1376 "location": "query", |
| 1377 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth
|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(l
atest-latest-(\\d{2})(-\\d+m)?)", |
| 1378 "required": true, |
| 1379 "type": "string" |
| 1380 }, |
| 1381 "filter": { |
| 1382 "description": "Filters to be run on the report.", |
| 1383 "location": "query", |
| 1384 "pattern": "[a-zA-Z_]+(==|=@).+", |
| 1385 "repeated": true, |
| 1386 "type": "string" |
| 1387 }, |
| 1388 "locale": { |
| 1389 "description": "Optional locale to use for translati
ng report output to a local language. Defaults to \"en_US\" if not specified.", |
| 1390 "location": "query", |
| 1391 "pattern": "[a-zA-Z_]+", |
| 1392 "type": "string" |
| 1393 }, |
| 1394 "maxResults": { |
| 1395 "description": "The maximum number of rows of report
data to return.", |
| 1396 "format": "int32", |
| 1397 "location": "query", |
| 1398 "maximum": "50000", |
| 1399 "minimum": "0", |
| 1400 "type": "integer" |
| 1401 }, |
| 1402 "metric": { |
| 1403 "description": "Numeric columns to include in the re
port.", |
| 1404 "location": "query", |
| 1405 "pattern": "[a-zA-Z_]+", |
| 1406 "repeated": true, |
| 1407 "type": "string" |
| 1408 }, |
| 1409 "sort": { |
| 1410 "description": "The name of a dimension or metric to
sort the resulting report on, optionally prefixed with \"+\" to sort ascending
or \"-\" to sort descending. If no prefix is specified, the column is sorted asc
ending.", |
| 1411 "location": "query", |
| 1412 "pattern": "(\\+|-)?[a-zA-Z_]+", |
| 1413 "repeated": true, |
| 1414 "type": "string" |
| 1415 }, |
| 1416 "startDate": { |
| 1417 "description": "Start of the date range to report on
in \"YYYY-MM-DD\" format, inclusive.", |
| 1418 "location": "query", |
| 1419 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth
|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)|(latest-(\\d{2})-(\\d{2})(-\\d+y)?)|(l
atest-latest-(\\d{2})(-\\d+m)?)", |
| 1420 "required": true, |
| 1421 "type": "string" |
| 1422 }, |
| 1423 "startIndex": { |
| 1424 "description": "Index of the first row of report dat
a to return.", |
| 1425 "format": "int32", |
| 1426 "location": "query", |
| 1427 "maximum": "5000", |
| 1428 "minimum": "0", |
| 1429 "type": "integer" |
| 1430 }, |
| 1431 "useTimezoneReporting": { |
| 1432 "description": "Whether the report should be generat
ed in the AdSense account's local timezone. If false default PST/PDT timezone wi
ll be used.", |
| 1433 "location": "query", |
| 1434 "type": "boolean" |
| 1435 } |
| 1436 }, |
| 1437 "path": "reports", |
| 1438 "response": { |
| 1439 "$ref": "AdsenseReportsGenerateResponse" |
| 1440 }, |
| 1441 "scopes": [ |
| 1442 "https://www.googleapis.com/auth/adsense", |
| 1443 "https://www.googleapis.com/auth/adsense.readonly" |
| 1444 ], |
| 1445 "supportsMediaDownload": true |
| 1446 } |
| 1447 }, |
| 1448 "resources": { |
| 1449 "saved": { |
| 1450 "methods": { |
| 1451 "generate": { |
| 1452 "description": "Generate an AdSense report based on
the saved report ID sent in the query parameters.", |
| 1453 "httpMethod": "GET", |
| 1454 "id": "adsense.reports.saved.generate", |
| 1455 "parameterOrder": [ |
| 1456 "savedReportId" |
| 1457 ], |
| 1458 "parameters": { |
| 1459 "locale": { |
| 1460 "description": "Optional locale to use for t
ranslating report output to a local language. Defaults to \"en_US\" if not speci
fied.", |
| 1461 "location": "query", |
| 1462 "pattern": "[a-zA-Z_]+", |
| 1463 "type": "string" |
| 1464 }, |
| 1465 "maxResults": { |
| 1466 "description": "The maximum number of rows o
f report data to return.", |
| 1467 "format": "int32", |
| 1468 "location": "query", |
| 1469 "maximum": "50000", |
| 1470 "minimum": "0", |
| 1471 "type": "integer" |
| 1472 }, |
| 1473 "savedReportId": { |
| 1474 "description": "The saved report to retrieve
.", |
| 1475 "location": "path", |
| 1476 "required": true, |
| 1477 "type": "string" |
| 1478 }, |
| 1479 "startIndex": { |
| 1480 "description": "Index of the first row of re
port data to return.", |
| 1481 "format": "int32", |
| 1482 "location": "query", |
| 1483 "maximum": "5000", |
| 1484 "minimum": "0", |
| 1485 "type": "integer" |
| 1486 } |
| 1487 }, |
| 1488 "path": "reports/{savedReportId}", |
| 1489 "response": { |
| 1490 "$ref": "AdsenseReportsGenerateResponse" |
| 1491 }, |
| 1492 "scopes": [ |
| 1493 "https://www.googleapis.com/auth/adsense", |
| 1494 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 1495 ] |
| 1496 }, |
| 1497 "list": { |
| 1498 "description": "List all saved reports in this AdSen
se account.", |
| 1499 "httpMethod": "GET", |
| 1500 "id": "adsense.reports.saved.list", |
| 1501 "parameters": { |
| 1502 "maxResults": { |
| 1503 "description": "The maximum number of saved
reports to include in the response, used for paging.", |
| 1504 "format": "int32", |
| 1505 "location": "query", |
| 1506 "maximum": "100", |
| 1507 "minimum": "0", |
| 1508 "type": "integer" |
| 1509 }, |
| 1510 "pageToken": { |
| 1511 "description": "A continuation token, used t
o page through saved reports. To retrieve the next page, set this parameter to t
he value of \"nextPageToken\" from the previous response.", |
| 1512 "location": "query", |
| 1513 "type": "string" |
| 1514 } |
| 1515 }, |
| 1516 "path": "reports/saved", |
| 1517 "response": { |
| 1518 "$ref": "SavedReports" |
| 1519 }, |
| 1520 "scopes": [ |
| 1521 "https://www.googleapis.com/auth/adsense", |
| 1522 "https://www.googleapis.com/auth/adsense.readonl
y" |
| 1523 ] |
| 1524 } |
| 1525 } |
| 1526 } |
| 1527 } |
| 1528 }, |
| 1529 "savedadstyles": { |
| 1530 "methods": { |
| 1531 "get": { |
| 1532 "description": "Get a specific saved ad style from the user'
s account.", |
| 1533 "httpMethod": "GET", |
| 1534 "id": "adsense.savedadstyles.get", |
| 1535 "parameterOrder": [ |
| 1536 "savedAdStyleId" |
| 1537 ], |
| 1538 "parameters": { |
| 1539 "savedAdStyleId": { |
| 1540 "description": "Saved ad style to retrieve.", |
| 1541 "location": "path", |
| 1542 "required": true, |
| 1543 "type": "string" |
| 1544 } |
| 1545 }, |
| 1546 "path": "savedadstyles/{savedAdStyleId}", |
| 1547 "response": { |
| 1548 "$ref": "SavedAdStyle" |
| 1549 }, |
| 1550 "scopes": [ |
| 1551 "https://www.googleapis.com/auth/adsense", |
| 1552 "https://www.googleapis.com/auth/adsense.readonly" |
| 1553 ] |
| 1554 }, |
| 1555 "list": { |
| 1556 "description": "List all saved ad styles in the user's accou
nt.", |
| 1557 "httpMethod": "GET", |
| 1558 "id": "adsense.savedadstyles.list", |
| 1559 "parameters": { |
| 1560 "maxResults": { |
| 1561 "description": "The maximum number of saved ad style
s to include in the response, used for paging.", |
| 1562 "format": "int32", |
| 1563 "location": "query", |
| 1564 "maximum": "10000", |
| 1565 "minimum": "0", |
| 1566 "type": "integer" |
| 1567 }, |
| 1568 "pageToken": { |
| 1569 "description": "A continuation token, used to page t
hrough saved ad styles. To retrieve the next page, set this parameter to the val
ue of \"nextPageToken\" from the previous response.", |
| 1570 "location": "query", |
| 1571 "type": "string" |
| 1572 } |
| 1573 }, |
| 1574 "path": "savedadstyles", |
| 1575 "response": { |
| 1576 "$ref": "SavedAdStyles" |
| 1577 }, |
| 1578 "scopes": [ |
| 1579 "https://www.googleapis.com/auth/adsense", |
| 1580 "https://www.googleapis.com/auth/adsense.readonly" |
| 1581 ] |
| 1582 } |
| 1583 } |
| 1584 }, |
| 1585 "urlchannels": { |
| 1586 "methods": { |
| 1587 "list": { |
| 1588 "description": "List all URL channels in the specified ad cl
ient for this AdSense account.", |
| 1589 "httpMethod": "GET", |
| 1590 "id": "adsense.urlchannels.list", |
| 1591 "parameterOrder": [ |
| 1592 "adClientId" |
| 1593 ], |
| 1594 "parameters": { |
| 1595 "adClientId": { |
| 1596 "description": "Ad client for which to list URL chan
nels.", |
| 1597 "location": "path", |
| 1598 "required": true, |
| 1599 "type": "string" |
| 1600 }, |
| 1601 "maxResults": { |
| 1602 "description": "The maximum number of URL channels t
o include in the response, used for paging.", |
| 1603 "format": "int32", |
| 1604 "location": "query", |
| 1605 "maximum": "10000", |
| 1606 "minimum": "0", |
| 1607 "type": "integer" |
| 1608 }, |
| 1609 "pageToken": { |
| 1610 "description": "A continuation token, used to page t
hrough URL channels. To retrieve the next page, set this parameter to the value
of \"nextPageToken\" from the previous response.", |
| 1611 "location": "query", |
| 1612 "type": "string" |
| 1613 } |
| 1614 }, |
| 1615 "path": "adclients/{adClientId}/urlchannels", |
| 1616 "response": { |
| 1617 "$ref": "UrlChannels" |
| 1618 }, |
| 1619 "scopes": [ |
| 1620 "https://www.googleapis.com/auth/adsense", |
| 1621 "https://www.googleapis.com/auth/adsense.readonly" |
| 1622 ] |
| 1623 } |
| 1624 } |
| 1625 } |
| 1626 }, |
| 1627 "revision": "20140908", |
| 1628 "rootUrl": "https://www.googleapis.com/", |
| 1629 "schemas": { |
| 1630 "Account": { |
| 1631 "id": "Account", |
| 1632 "properties": { |
| 1633 "id": { |
| 1634 "description": "Unique identifier of this account.", |
| 1635 "type": "string" |
| 1636 }, |
| 1637 "kind": { |
| 1638 "default": "adsense#account", |
| 1639 "description": "Kind of resource this is, in this case adsen
se#account.", |
| 1640 "type": "string" |
| 1641 }, |
| 1642 "name": { |
| 1643 "description": "Name of this account.", |
| 1644 "type": "string" |
| 1645 }, |
| 1646 "premium": { |
| 1647 "description": "Whether this account is premium.", |
| 1648 "type": "boolean" |
| 1649 }, |
| 1650 "subAccounts": { |
| 1651 "description": "Sub accounts of the this account.", |
| 1652 "items": { |
| 1653 "$ref": "Account" |
| 1654 }, |
| 1655 "type": "array" |
| 1656 }, |
| 1657 "timezone": { |
| 1658 "description": "AdSense timezone of this account.", |
| 1659 "type": "string" |
| 1660 } |
| 1661 }, |
| 1662 "type": "object" |
| 1663 }, |
| 1664 "Accounts": { |
| 1665 "id": "Accounts", |
| 1666 "properties": { |
| 1667 "etag": { |
| 1668 "description": "ETag of this response for caching purposes."
, |
| 1669 "type": "string" |
| 1670 }, |
| 1671 "items": { |
| 1672 "description": "The accounts returned in this list response.
", |
| 1673 "items": { |
| 1674 "$ref": "Account" |
| 1675 }, |
| 1676 "type": "array" |
| 1677 }, |
| 1678 "kind": { |
| 1679 "default": "adsense#accounts", |
| 1680 "description": "Kind of list this is, in this case adsense#a
ccounts.", |
| 1681 "type": "string" |
| 1682 }, |
| 1683 "nextPageToken": { |
| 1684 "description": "Continuation token used to page through acco
unts. To retrieve the next page of results, set the next request's \"pageToken\"
value to this.", |
| 1685 "type": "string" |
| 1686 } |
| 1687 }, |
| 1688 "type": "object" |
| 1689 }, |
| 1690 "AdClient": { |
| 1691 "id": "AdClient", |
| 1692 "properties": { |
| 1693 "arcOptIn": { |
| 1694 "description": "Whether this ad client is opted in to ARC.", |
| 1695 "type": "boolean" |
| 1696 }, |
| 1697 "arcReviewMode": { |
| 1698 "description": "ARC review mode this ad client is in. Empty
if the client is not opted in to ARC. Possible values: POST_REVIEW, AUTOMATIC_PR
E_REVIEW.", |
| 1699 "type": "string" |
| 1700 }, |
| 1701 "id": { |
| 1702 "description": "Unique identifier of this ad client.", |
| 1703 "type": "string" |
| 1704 }, |
| 1705 "kind": { |
| 1706 "default": "adsense#adClient", |
| 1707 "description": "Kind of resource this is, in this case adsen
se#adClient.", |
| 1708 "type": "string" |
| 1709 }, |
| 1710 "productCode": { |
| 1711 "description": "This ad client's product code, which corresp
onds to the PRODUCT_CODE report dimension.", |
| 1712 "type": "string" |
| 1713 }, |
| 1714 "supportsReporting": { |
| 1715 "description": "Whether this ad client supports being report
ed on.", |
| 1716 "type": "boolean" |
| 1717 } |
| 1718 }, |
| 1719 "type": "object" |
| 1720 }, |
| 1721 "AdClients": { |
| 1722 "id": "AdClients", |
| 1723 "properties": { |
| 1724 "etag": { |
| 1725 "description": "ETag of this response for caching purposes."
, |
| 1726 "type": "string" |
| 1727 }, |
| 1728 "items": { |
| 1729 "description": "The ad clients returned in this list respons
e.", |
| 1730 "items": { |
| 1731 "$ref": "AdClient" |
| 1732 }, |
| 1733 "type": "array" |
| 1734 }, |
| 1735 "kind": { |
| 1736 "default": "adsense#adClients", |
| 1737 "description": "Kind of list this is, in this case adsense#a
dClients.", |
| 1738 "type": "string" |
| 1739 }, |
| 1740 "nextPageToken": { |
| 1741 "description": "Continuation token used to page through ad c
lients. To retrieve the next page of results, set the next request's \"pageToken
\" value to this.", |
| 1742 "type": "string" |
| 1743 } |
| 1744 }, |
| 1745 "type": "object" |
| 1746 }, |
| 1747 "AdCode": { |
| 1748 "id": "AdCode", |
| 1749 "properties": { |
| 1750 "adCode": { |
| 1751 "description": "The ad code snippet.", |
| 1752 "type": "string" |
| 1753 }, |
| 1754 "kind": { |
| 1755 "default": "adsense#adCode", |
| 1756 "description": "Kind this is, in this case adsense#adCode.", |
| 1757 "type": "string" |
| 1758 } |
| 1759 }, |
| 1760 "type": "object" |
| 1761 }, |
| 1762 "AdStyle": { |
| 1763 "id": "AdStyle", |
| 1764 "properties": { |
| 1765 "colors": { |
| 1766 "description": "The colors which are included in the style.
These are represented as six hexadecimal characters, similar to HTML color codes
, but without the leading hash.", |
| 1767 "properties": { |
| 1768 "background": { |
| 1769 "description": "The color of the ad background.", |
| 1770 "type": "string" |
| 1771 }, |
| 1772 "border": { |
| 1773 "description": "The color of the ad border.", |
| 1774 "type": "string" |
| 1775 }, |
| 1776 "text": { |
| 1777 "description": "The color of the ad text.", |
| 1778 "type": "string" |
| 1779 }, |
| 1780 "title": { |
| 1781 "description": "The color of the ad title.", |
| 1782 "type": "string" |
| 1783 }, |
| 1784 "url": { |
| 1785 "description": "The color of the ad url.", |
| 1786 "type": "string" |
| 1787 } |
| 1788 }, |
| 1789 "type": "object" |
| 1790 }, |
| 1791 "corners": { |
| 1792 "description": "The style of the corners in the ad.", |
| 1793 "type": "string" |
| 1794 }, |
| 1795 "font": { |
| 1796 "description": "The font which is included in the style.", |
| 1797 "properties": { |
| 1798 "family": { |
| 1799 "description": "The family of the font.", |
| 1800 "type": "string" |
| 1801 }, |
| 1802 "size": { |
| 1803 "description": "The size of the font.", |
| 1804 "type": "string" |
| 1805 } |
| 1806 }, |
| 1807 "type": "object" |
| 1808 }, |
| 1809 "kind": { |
| 1810 "default": "adsense#adStyle", |
| 1811 "description": "Kind this is, in this case adsense#adStyle."
, |
| 1812 "type": "string" |
| 1813 } |
| 1814 }, |
| 1815 "type": "object" |
| 1816 }, |
| 1817 "AdUnit": { |
| 1818 "id": "AdUnit", |
| 1819 "properties": { |
| 1820 "code": { |
| 1821 "description": "Identity code of this ad unit, not necessari
ly unique across ad clients.", |
| 1822 "type": "string" |
| 1823 }, |
| 1824 "contentAdsSettings": { |
| 1825 "description": "Settings specific to content ads (AFC) and h
ighend mobile content ads (AFMC).", |
| 1826 "properties": { |
| 1827 "backupOption": { |
| 1828 "description": "The backup option to be used in inst
ances where no ad is available.", |
| 1829 "properties": { |
| 1830 "color": { |
| 1831 "description": "Color to use when type is se
t to COLOR.", |
| 1832 "type": "string" |
| 1833 }, |
| 1834 "type": { |
| 1835 "description": "Type of the backup option. P
ossible values are BLANK, COLOR and URL.", |
| 1836 "type": "string" |
| 1837 }, |
| 1838 "url": { |
| 1839 "description": "URL to use when type is set
to URL.", |
| 1840 "type": "string" |
| 1841 } |
| 1842 }, |
| 1843 "type": "object" |
| 1844 }, |
| 1845 "size": { |
| 1846 "description": "Size of this ad unit.", |
| 1847 "type": "string" |
| 1848 }, |
| 1849 "type": { |
| 1850 "description": "Type of this ad unit.", |
| 1851 "type": "string" |
| 1852 } |
| 1853 }, |
| 1854 "type": "object" |
| 1855 }, |
| 1856 "customStyle": { |
| 1857 "$ref": "AdStyle", |
| 1858 "description": "Custom style information specific to this ad
unit." |
| 1859 }, |
| 1860 "feedAdsSettings": { |
| 1861 "description": "Settings specific to feed ads (AFF).", |
| 1862 "properties": { |
| 1863 "adPosition": { |
| 1864 "description": "The position of the ads relative to
the feed entries.", |
| 1865 "type": "string" |
| 1866 }, |
| 1867 "frequency": { |
| 1868 "description": "The frequency at which ads should ap
pear in the feed (i.e. every N entries).", |
| 1869 "format": "int32", |
| 1870 "type": "integer" |
| 1871 }, |
| 1872 "minimumWordCount": { |
| 1873 "description": "The minimum length an entry should b
e in order to have attached ads.", |
| 1874 "format": "int32", |
| 1875 "type": "integer" |
| 1876 }, |
| 1877 "type": { |
| 1878 "description": "The type of ads which should appear.
", |
| 1879 "type": "string" |
| 1880 } |
| 1881 }, |
| 1882 "type": "object" |
| 1883 }, |
| 1884 "id": { |
| 1885 "description": "Unique identifier of this ad unit. This shou
ld be considered an opaque identifier; it is not safe to rely on it being in any
particular format.", |
| 1886 "type": "string" |
| 1887 }, |
| 1888 "kind": { |
| 1889 "default": "adsense#adUnit", |
| 1890 "description": "Kind of resource this is, in this case adsen
se#adUnit.", |
| 1891 "type": "string" |
| 1892 }, |
| 1893 "mobileContentAdsSettings": { |
| 1894 "description": "Settings specific to WAP mobile content ads
(AFMC).", |
| 1895 "properties": { |
| 1896 "markupLanguage": { |
| 1897 "description": "The markup language to use for this
ad unit.", |
| 1898 "type": "string" |
| 1899 }, |
| 1900 "scriptingLanguage": { |
| 1901 "description": "The scripting language to use for th
is ad unit.", |
| 1902 "type": "string" |
| 1903 }, |
| 1904 "size": { |
| 1905 "description": "Size of this ad unit.", |
| 1906 "type": "string" |
| 1907 }, |
| 1908 "type": { |
| 1909 "description": "Type of this ad unit.", |
| 1910 "type": "string" |
| 1911 } |
| 1912 }, |
| 1913 "type": "object" |
| 1914 }, |
| 1915 "name": { |
| 1916 "description": "Name of this ad unit.", |
| 1917 "type": "string" |
| 1918 }, |
| 1919 "savedStyleId": { |
| 1920 "description": "ID of the saved ad style which holds this ad
unit's style information.", |
| 1921 "type": "string" |
| 1922 }, |
| 1923 "status": { |
| 1924 "description": "Status of this ad unit. Possible values are:
\nNEW: Indicates that the ad unit was created within the last seven days and doe
s not yet have any activity associated with it.\n\nACTIVE: Indicates that there
has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates
that there has been no activity on this ad unit in the last seven days.", |
| 1925 "type": "string" |
| 1926 } |
| 1927 }, |
| 1928 "type": "object" |
| 1929 }, |
| 1930 "AdUnits": { |
| 1931 "id": "AdUnits", |
| 1932 "properties": { |
| 1933 "etag": { |
| 1934 "description": "ETag of this response for caching purposes."
, |
| 1935 "type": "string" |
| 1936 }, |
| 1937 "items": { |
| 1938 "description": "The ad units returned in this list response.
", |
| 1939 "items": { |
| 1940 "$ref": "AdUnit" |
| 1941 }, |
| 1942 "type": "array" |
| 1943 }, |
| 1944 "kind": { |
| 1945 "default": "adsense#adUnits", |
| 1946 "description": "Kind of list this is, in this case adsense#a
dUnits.", |
| 1947 "type": "string" |
| 1948 }, |
| 1949 "nextPageToken": { |
| 1950 "description": "Continuation token used to page through ad u
nits. To retrieve the next page of results, set the next request's \"pageToken\"
value to this.", |
| 1951 "type": "string" |
| 1952 } |
| 1953 }, |
| 1954 "type": "object" |
| 1955 }, |
| 1956 "AdsenseReportsGenerateResponse": { |
| 1957 "id": "AdsenseReportsGenerateResponse", |
| 1958 "properties": { |
| 1959 "averages": { |
| 1960 "description": "The averages of the report. This is the same
length as any other row in the report; cells corresponding to dimension columns
are empty.", |
| 1961 "items": { |
| 1962 "type": "string" |
| 1963 }, |
| 1964 "type": "array" |
| 1965 }, |
| 1966 "endDate": { |
| 1967 "description": "The requested end date in yyyy-mm-dd format.
", |
| 1968 "type": "string" |
| 1969 }, |
| 1970 "headers": { |
| 1971 "description": "The header information of the columns reques
ted in the report. This is a list of headers; one for each dimension in the requ
est, followed by one for each metric in the request.", |
| 1972 "items": { |
| 1973 "properties": { |
| 1974 "currency": { |
| 1975 "description": "The currency of this column. Onl
y present if the header type is METRIC_CURRENCY.", |
| 1976 "type": "string" |
| 1977 }, |
| 1978 "name": { |
| 1979 "description": "The name of the header.", |
| 1980 "type": "string" |
| 1981 }, |
| 1982 "type": { |
| 1983 "description": "The type of the header; one of D
IMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.", |
| 1984 "type": "string" |
| 1985 } |
| 1986 }, |
| 1987 "type": "object" |
| 1988 }, |
| 1989 "type": "array" |
| 1990 }, |
| 1991 "kind": { |
| 1992 "default": "adsense#report", |
| 1993 "description": "Kind this is, in this case adsense#report.", |
| 1994 "type": "string" |
| 1995 }, |
| 1996 "rows": { |
| 1997 "description": "The output rows of the report. Each row is a
list of cells; one for each dimension in the request, followed by one for each
metric in the request. The dimension cells contain strings, and the metric cells
contain numbers.", |
| 1998 "items": { |
| 1999 "items": { |
| 2000 "type": "string" |
| 2001 }, |
| 2002 "type": "array" |
| 2003 }, |
| 2004 "type": "array" |
| 2005 }, |
| 2006 "startDate": { |
| 2007 "description": "The requested start date in yyyy-mm-dd forma
t.", |
| 2008 "type": "string" |
| 2009 }, |
| 2010 "totalMatchedRows": { |
| 2011 "description": "The total number of rows matched by the repo
rt request. Fewer rows may be returned in the response due to being limited by t
he row count requested or the report row limit.", |
| 2012 "format": "int64", |
| 2013 "type": "string" |
| 2014 }, |
| 2015 "totals": { |
| 2016 "description": "The totals of the report. This is the same l
ength as any other row in the report; cells corresponding to dimension columns a
re empty.", |
| 2017 "items": { |
| 2018 "type": "string" |
| 2019 }, |
| 2020 "type": "array" |
| 2021 }, |
| 2022 "warnings": { |
| 2023 "description": "Any warnings associated with generation of t
he report.", |
| 2024 "items": { |
| 2025 "type": "string" |
| 2026 }, |
| 2027 "type": "array" |
| 2028 } |
| 2029 }, |
| 2030 "type": "object" |
| 2031 }, |
| 2032 "Alert": { |
| 2033 "id": "Alert", |
| 2034 "properties": { |
| 2035 "id": { |
| 2036 "description": "Unique identifier of this alert. This should
be considered an opaque identifier; it is not safe to rely on it being in any p
articular format.", |
| 2037 "type": "string" |
| 2038 }, |
| 2039 "isDismissible": { |
| 2040 "description": "Whether this alert can be dismissed.", |
| 2041 "type": "boolean" |
| 2042 }, |
| 2043 "kind": { |
| 2044 "default": "adsense#alert", |
| 2045 "description": "Kind of resource this is, in this case adsen
se#alert.", |
| 2046 "type": "string" |
| 2047 }, |
| 2048 "message": { |
| 2049 "description": "The localized alert message.", |
| 2050 "type": "string" |
| 2051 }, |
| 2052 "severity": { |
| 2053 "description": "Severity of this alert. Possible values: INF
O, WARNING, SEVERE.", |
| 2054 "type": "string" |
| 2055 }, |
| 2056 "type": { |
| 2057 "description": "Type of this alert. Possible values: SELF_HO
LD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORP
ORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.", |
| 2058 "type": "string" |
| 2059 } |
| 2060 }, |
| 2061 "type": "object" |
| 2062 }, |
| 2063 "Alerts": { |
| 2064 "id": "Alerts", |
| 2065 "properties": { |
| 2066 "items": { |
| 2067 "description": "The alerts returned in this list response.", |
| 2068 "items": { |
| 2069 "$ref": "Alert" |
| 2070 }, |
| 2071 "type": "array" |
| 2072 }, |
| 2073 "kind": { |
| 2074 "default": "adsense#alerts", |
| 2075 "description": "Kind of list this is, in this case adsense#a
lerts.", |
| 2076 "type": "string" |
| 2077 } |
| 2078 }, |
| 2079 "type": "object" |
| 2080 }, |
| 2081 "CustomChannel": { |
| 2082 "id": "CustomChannel", |
| 2083 "properties": { |
| 2084 "code": { |
| 2085 "description": "Code of this custom channel, not necessarily
unique across ad clients.", |
| 2086 "type": "string" |
| 2087 }, |
| 2088 "id": { |
| 2089 "description": "Unique identifier of this custom channel. Th
is should be considered an opaque identifier; it is not safe to rely on it being
in any particular format.", |
| 2090 "type": "string" |
| 2091 }, |
| 2092 "kind": { |
| 2093 "default": "adsense#customChannel", |
| 2094 "description": "Kind of resource this is, in this case adsen
se#customChannel.", |
| 2095 "type": "string" |
| 2096 }, |
| 2097 "name": { |
| 2098 "description": "Name of this custom channel.", |
| 2099 "type": "string" |
| 2100 }, |
| 2101 "targetingInfo": { |
| 2102 "description": "The targeting information of this custom cha
nnel, if activated.", |
| 2103 "properties": { |
| 2104 "adsAppearOn": { |
| 2105 "description": "The name used to describe this chann
el externally.", |
| 2106 "type": "string" |
| 2107 }, |
| 2108 "description": { |
| 2109 "description": "The external description of the chan
nel.", |
| 2110 "type": "string" |
| 2111 }, |
| 2112 "location": { |
| 2113 "description": "The locations in which ads appear. (
Only valid for content and mobile content ads). Acceptable values for content ad
s are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT
, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable value
s for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.", |
| 2114 "type": "string" |
| 2115 }, |
| 2116 "siteLanguage": { |
| 2117 "description": "The language of the sites ads will b
e displayed on.", |
| 2118 "type": "string" |
| 2119 } |
| 2120 }, |
| 2121 "type": "object" |
| 2122 } |
| 2123 }, |
| 2124 "type": "object" |
| 2125 }, |
| 2126 "CustomChannels": { |
| 2127 "id": "CustomChannels", |
| 2128 "properties": { |
| 2129 "etag": { |
| 2130 "description": "ETag of this response for caching purposes."
, |
| 2131 "type": "string" |
| 2132 }, |
| 2133 "items": { |
| 2134 "description": "The custom channels returned in this list re
sponse.", |
| 2135 "items": { |
| 2136 "$ref": "CustomChannel" |
| 2137 }, |
| 2138 "type": "array" |
| 2139 }, |
| 2140 "kind": { |
| 2141 "default": "adsense#customChannels", |
| 2142 "description": "Kind of list this is, in this case adsense#c
ustomChannels.", |
| 2143 "type": "string" |
| 2144 }, |
| 2145 "nextPageToken": { |
| 2146 "description": "Continuation token used to page through cust
om channels. To retrieve the next page of results, set the next request's \"page
Token\" value to this.", |
| 2147 "type": "string" |
| 2148 } |
| 2149 }, |
| 2150 "type": "object" |
| 2151 }, |
| 2152 "Metadata": { |
| 2153 "id": "Metadata", |
| 2154 "properties": { |
| 2155 "items": { |
| 2156 "items": { |
| 2157 "$ref": "ReportingMetadataEntry" |
| 2158 }, |
| 2159 "type": "array" |
| 2160 }, |
| 2161 "kind": { |
| 2162 "default": "adsense#metadata", |
| 2163 "description": "Kind of list this is, in this case adsense#m
etadata.", |
| 2164 "type": "string" |
| 2165 } |
| 2166 }, |
| 2167 "type": "object" |
| 2168 }, |
| 2169 "Payment": { |
| 2170 "id": "Payment", |
| 2171 "properties": { |
| 2172 "id": { |
| 2173 "description": "Unique identifier of this Payment.", |
| 2174 "type": "string" |
| 2175 }, |
| 2176 "kind": { |
| 2177 "default": "adsense#payment", |
| 2178 "description": "Kind of resource this is, in this case adsen
se#payment.", |
| 2179 "type": "string" |
| 2180 }, |
| 2181 "paymentAmount": { |
| 2182 "description": "The amount to be paid.", |
| 2183 "type": "string" |
| 2184 }, |
| 2185 "paymentAmountCurrencyCode": { |
| 2186 "description": "The currency code for the amount to be paid.
", |
| 2187 "type": "string" |
| 2188 }, |
| 2189 "paymentDate": { |
| 2190 "description": "The date this payment was/will be credited t
o the user, or none if the payment threshold has not been met.", |
| 2191 "type": "string" |
| 2192 } |
| 2193 }, |
| 2194 "type": "object" |
| 2195 }, |
| 2196 "Payments": { |
| 2197 "id": "Payments", |
| 2198 "properties": { |
| 2199 "items": { |
| 2200 "description": "The list of Payments for the account. One or
both of a) the account's most recent payment; and b) the account's upcoming pay
ment.", |
| 2201 "items": { |
| 2202 "$ref": "Payment" |
| 2203 }, |
| 2204 "type": "array" |
| 2205 }, |
| 2206 "kind": { |
| 2207 "default": "adsense#payments", |
| 2208 "description": "Kind of list this is, in this case adsense#p
ayments.", |
| 2209 "type": "string" |
| 2210 } |
| 2211 }, |
| 2212 "type": "object" |
| 2213 }, |
| 2214 "ReportingMetadataEntry": { |
| 2215 "id": "ReportingMetadataEntry", |
| 2216 "properties": { |
| 2217 "compatibleDimensions": { |
| 2218 "description": "For metrics this is a list of dimension IDs
which the metric is compatible with, for dimensions it is a list of compatibilit
y groups the dimension belongs to.", |
| 2219 "items": { |
| 2220 "type": "string" |
| 2221 }, |
| 2222 "type": "array" |
| 2223 }, |
| 2224 "compatibleMetrics": { |
| 2225 "description": "The names of the metrics the dimension or me
tric this reporting metadata entry describes is compatible with.", |
| 2226 "items": { |
| 2227 "type": "string" |
| 2228 }, |
| 2229 "type": "array" |
| 2230 }, |
| 2231 "id": { |
| 2232 "description": "Unique identifier of this reporting metadata
entry, corresponding to the name of the appropriate dimension or metric.", |
| 2233 "type": "string" |
| 2234 }, |
| 2235 "kind": { |
| 2236 "default": "adsense#reportingMetadataEntry", |
| 2237 "description": "Kind of resource this is, in this case adsen
se#reportingMetadataEntry.", |
| 2238 "type": "string" |
| 2239 }, |
| 2240 "requiredDimensions": { |
| 2241 "description": "The names of the dimensions which the dimens
ion or metric this reporting metadata entry describes requires to also be presen
t in order for the report to be valid. Omitting these will not cause an error or
warning, but may result in data which cannot be correctly interpreted.", |
| 2242 "items": { |
| 2243 "type": "string" |
| 2244 }, |
| 2245 "type": "array" |
| 2246 }, |
| 2247 "requiredMetrics": { |
| 2248 "description": "The names of the metrics which the dimension
or metric this reporting metadata entry describes requires to also be present i
n order for the report to be valid. Omitting these will not cause an error or wa
rning, but may result in data which cannot be correctly interpreted.", |
| 2249 "items": { |
| 2250 "type": "string" |
| 2251 }, |
| 2252 "type": "array" |
| 2253 }, |
| 2254 "supportedProducts": { |
| 2255 "description": "The codes of the projects supported by the d
imension or metric this reporting metadata entry describes.", |
| 2256 "items": { |
| 2257 "type": "string" |
| 2258 }, |
| 2259 "type": "array" |
| 2260 } |
| 2261 }, |
| 2262 "type": "object" |
| 2263 }, |
| 2264 "SavedAdStyle": { |
| 2265 "id": "SavedAdStyle", |
| 2266 "properties": { |
| 2267 "adStyle": { |
| 2268 "$ref": "AdStyle", |
| 2269 "description": "The AdStyle itself." |
| 2270 }, |
| 2271 "id": { |
| 2272 "description": "Unique identifier of this saved ad style. Th
is should be considered an opaque identifier; it is not safe to rely on it being
in any particular format.", |
| 2273 "type": "string" |
| 2274 }, |
| 2275 "kind": { |
| 2276 "default": "adsense#savedAdStyle", |
| 2277 "description": "Kind of resource this is, in this case adsen
se#savedAdStyle.", |
| 2278 "type": "string" |
| 2279 }, |
| 2280 "name": { |
| 2281 "description": "The user selected name of this SavedAdStyle.
", |
| 2282 "type": "string" |
| 2283 } |
| 2284 }, |
| 2285 "type": "object" |
| 2286 }, |
| 2287 "SavedAdStyles": { |
| 2288 "id": "SavedAdStyles", |
| 2289 "properties": { |
| 2290 "etag": { |
| 2291 "description": "ETag of this response for caching purposes."
, |
| 2292 "type": "string" |
| 2293 }, |
| 2294 "items": { |
| 2295 "description": "The saved ad styles returned in this list re
sponse.", |
| 2296 "items": { |
| 2297 "$ref": "SavedAdStyle" |
| 2298 }, |
| 2299 "type": "array" |
| 2300 }, |
| 2301 "kind": { |
| 2302 "default": "adsense#savedAdStyles", |
| 2303 "description": "Kind of list this is, in this case adsense#s
avedAdStyles.", |
| 2304 "type": "string" |
| 2305 }, |
| 2306 "nextPageToken": { |
| 2307 "description": "Continuation token used to page through ad u
nits. To retrieve the next page of results, set the next request's \"pageToken\"
value to this.", |
| 2308 "type": "string" |
| 2309 } |
| 2310 }, |
| 2311 "type": "object" |
| 2312 }, |
| 2313 "SavedReport": { |
| 2314 "id": "SavedReport", |
| 2315 "properties": { |
| 2316 "id": { |
| 2317 "description": "Unique identifier of this saved report.", |
| 2318 "type": "string" |
| 2319 }, |
| 2320 "kind": { |
| 2321 "default": "adsense#savedReport", |
| 2322 "description": "Kind of resource this is, in this case adsen
se#savedReport.", |
| 2323 "type": "string" |
| 2324 }, |
| 2325 "name": { |
| 2326 "description": "This saved report's name.", |
| 2327 "type": "string" |
| 2328 } |
| 2329 }, |
| 2330 "type": "object" |
| 2331 }, |
| 2332 "SavedReports": { |
| 2333 "id": "SavedReports", |
| 2334 "properties": { |
| 2335 "etag": { |
| 2336 "description": "ETag of this response for caching purposes."
, |
| 2337 "type": "string" |
| 2338 }, |
| 2339 "items": { |
| 2340 "description": "The saved reports returned in this list resp
onse.", |
| 2341 "items": { |
| 2342 "$ref": "SavedReport" |
| 2343 }, |
| 2344 "type": "array" |
| 2345 }, |
| 2346 "kind": { |
| 2347 "default": "adsense#savedReports", |
| 2348 "description": "Kind of list this is, in this case adsense#s
avedReports.", |
| 2349 "type": "string" |
| 2350 }, |
| 2351 "nextPageToken": { |
| 2352 "description": "Continuation token used to page through save
d reports. To retrieve the next page of results, set the next request's \"pageTo
ken\" value to this.", |
| 2353 "type": "string" |
| 2354 } |
| 2355 }, |
| 2356 "type": "object" |
| 2357 }, |
| 2358 "UrlChannel": { |
| 2359 "id": "UrlChannel", |
| 2360 "properties": { |
| 2361 "id": { |
| 2362 "description": "Unique identifier of this URL channel. This
should be considered an opaque identifier; it is not safe to rely on it being in
any particular format.", |
| 2363 "type": "string" |
| 2364 }, |
| 2365 "kind": { |
| 2366 "default": "adsense#urlChannel", |
| 2367 "description": "Kind of resource this is, in this case adsen
se#urlChannel.", |
| 2368 "type": "string" |
| 2369 }, |
| 2370 "urlPattern": { |
| 2371 "description": "URL Pattern of this URL channel. Does not in
clude \"http://\" or \"https://\". Example: www.example.com/home", |
| 2372 "type": "string" |
| 2373 } |
| 2374 }, |
| 2375 "type": "object" |
| 2376 }, |
| 2377 "UrlChannels": { |
| 2378 "id": "UrlChannels", |
| 2379 "properties": { |
| 2380 "etag": { |
| 2381 "description": "ETag of this response for caching purposes."
, |
| 2382 "type": "string" |
| 2383 }, |
| 2384 "items": { |
| 2385 "description": "The URL channels returned in this list respo
nse.", |
| 2386 "items": { |
| 2387 "$ref": "UrlChannel" |
| 2388 }, |
| 2389 "type": "array" |
| 2390 }, |
| 2391 "kind": { |
| 2392 "default": "adsense#urlChannels", |
| 2393 "description": "Kind of list this is, in this case adsense#u
rlChannels.", |
| 2394 "type": "string" |
| 2395 }, |
| 2396 "nextPageToken": { |
| 2397 "description": "Continuation token used to page through URL
channels. To retrieve the next page of results, set the next request's \"pageTok
en\" value to this.", |
| 2398 "type": "string" |
| 2399 } |
| 2400 }, |
| 2401 "type": "object" |
| 2402 } |
| 2403 }, |
| 2404 "servicePath": "adsense/v1.4/", |
| 2405 "title": "AdSense Management API", |
| 2406 "version": "v1.4" |
| 2407 } |
OLD | NEW |