OLD | NEW |
(Empty) | |
| 1 { |
| 2 "basePath": "/doubleclickbidmanager/v1/", |
| 3 "baseUrl": "https://www.googleapis.com/doubleclickbidmanager/v1/", |
| 4 "batchPath": "batch", |
| 5 "canonicalName": "DoubleClick Bid Manager", |
| 6 "description": "API for viewing and managing your reports in DoubleClick Bid
Manager.", |
| 7 "discoveryVersion": "v1", |
| 8 "documentationLink": "https://developers.google.com/bid-manager/", |
| 9 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/Xt8yN3tZcmaa98PBixxfMwJ2TF0\"", |
| 10 "icons": { |
| 11 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 12 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 13 }, |
| 14 "id": "doubleclickbidmanager:v1", |
| 15 "kind": "discovery#restDescription", |
| 16 "labels": [ |
| 17 "limited_availability" |
| 18 ], |
| 19 "name": "doubleclickbidmanager", |
| 20 "ownerDomain": "google.com", |
| 21 "ownerName": "Google", |
| 22 "parameters": { |
| 23 "alt": { |
| 24 "default": "json", |
| 25 "description": "Data format for the response.", |
| 26 "enum": [ |
| 27 "json" |
| 28 ], |
| 29 "enumDescriptions": [ |
| 30 "Responses with Content-Type of application/json" |
| 31 ], |
| 32 "location": "query", |
| 33 "type": "string" |
| 34 }, |
| 35 "fields": { |
| 36 "description": "Selector specifying which fields to include in a par
tial response.", |
| 37 "location": "query", |
| 38 "type": "string" |
| 39 }, |
| 40 "key": { |
| 41 "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.", |
| 42 "location": "query", |
| 43 "type": "string" |
| 44 }, |
| 45 "oauth_token": { |
| 46 "description": "OAuth 2.0 token for the current user.", |
| 47 "location": "query", |
| 48 "type": "string" |
| 49 }, |
| 50 "prettyPrint": { |
| 51 "default": "true", |
| 52 "description": "Returns response with indentations and line breaks."
, |
| 53 "location": "query", |
| 54 "type": "boolean" |
| 55 }, |
| 56 "quotaUser": { |
| 57 "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.", |
| 58 "location": "query", |
| 59 "type": "string" |
| 60 }, |
| 61 "userIp": { |
| 62 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 63 "location": "query", |
| 64 "type": "string" |
| 65 } |
| 66 }, |
| 67 "protocol": "rest", |
| 68 "resources": { |
| 69 "lineitems": { |
| 70 "methods": { |
| 71 "downloadlineitems": { |
| 72 "description": "Retrieves line items in CSV format.", |
| 73 "httpMethod": "POST", |
| 74 "id": "doubleclickbidmanager.lineitems.downloadlineitems", |
| 75 "path": "lineitems/downloadlineitems", |
| 76 "request": { |
| 77 "$ref": "DownloadLineItemsRequest" |
| 78 }, |
| 79 "response": { |
| 80 "$ref": "DownloadLineItemsResponse" |
| 81 } |
| 82 }, |
| 83 "uploadlineitems": { |
| 84 "description": "Uploads line items in CSV format.", |
| 85 "httpMethod": "POST", |
| 86 "id": "doubleclickbidmanager.lineitems.uploadlineitems", |
| 87 "path": "lineitems/uploadlineitems", |
| 88 "request": { |
| 89 "$ref": "UploadLineItemsRequest" |
| 90 }, |
| 91 "response": { |
| 92 "$ref": "UploadLineItemsResponse" |
| 93 } |
| 94 } |
| 95 } |
| 96 }, |
| 97 "queries": { |
| 98 "methods": { |
| 99 "createquery": { |
| 100 "description": "Creates a query.", |
| 101 "httpMethod": "POST", |
| 102 "id": "doubleclickbidmanager.queries.createquery", |
| 103 "path": "query", |
| 104 "request": { |
| 105 "$ref": "Query" |
| 106 }, |
| 107 "response": { |
| 108 "$ref": "Query" |
| 109 } |
| 110 }, |
| 111 "deletequery": { |
| 112 "description": "Deletes a stored query as well as the associ
ated stored reports.", |
| 113 "httpMethod": "DELETE", |
| 114 "id": "doubleclickbidmanager.queries.deletequery", |
| 115 "parameterOrder": [ |
| 116 "queryId" |
| 117 ], |
| 118 "parameters": { |
| 119 "queryId": { |
| 120 "description": "Query ID to delete.", |
| 121 "format": "int64", |
| 122 "location": "path", |
| 123 "required": true, |
| 124 "type": "string" |
| 125 } |
| 126 }, |
| 127 "path": "query/{queryId}" |
| 128 }, |
| 129 "getquery": { |
| 130 "description": "Retrieves a stored query.", |
| 131 "httpMethod": "GET", |
| 132 "id": "doubleclickbidmanager.queries.getquery", |
| 133 "parameterOrder": [ |
| 134 "queryId" |
| 135 ], |
| 136 "parameters": { |
| 137 "queryId": { |
| 138 "description": "Query ID to retrieve.", |
| 139 "format": "int64", |
| 140 "location": "path", |
| 141 "required": true, |
| 142 "type": "string" |
| 143 } |
| 144 }, |
| 145 "path": "query/{queryId}", |
| 146 "response": { |
| 147 "$ref": "Query" |
| 148 } |
| 149 }, |
| 150 "listqueries": { |
| 151 "description": "Retrieves stored queries.", |
| 152 "httpMethod": "GET", |
| 153 "id": "doubleclickbidmanager.queries.listqueries", |
| 154 "path": "queries", |
| 155 "response": { |
| 156 "$ref": "ListQueriesResponse" |
| 157 } |
| 158 }, |
| 159 "runquery": { |
| 160 "description": "Runs a stored query to generate a report.", |
| 161 "httpMethod": "POST", |
| 162 "id": "doubleclickbidmanager.queries.runquery", |
| 163 "parameterOrder": [ |
| 164 "queryId" |
| 165 ], |
| 166 "parameters": { |
| 167 "queryId": { |
| 168 "description": "Query ID to run.", |
| 169 "format": "int64", |
| 170 "location": "path", |
| 171 "required": true, |
| 172 "type": "string" |
| 173 } |
| 174 }, |
| 175 "path": "query/{queryId}", |
| 176 "request": { |
| 177 "$ref": "RunQueryRequest" |
| 178 } |
| 179 } |
| 180 } |
| 181 }, |
| 182 "reports": { |
| 183 "methods": { |
| 184 "listreports": { |
| 185 "description": "Retrieves stored reports.", |
| 186 "httpMethod": "GET", |
| 187 "id": "doubleclickbidmanager.reports.listreports", |
| 188 "parameterOrder": [ |
| 189 "queryId" |
| 190 ], |
| 191 "parameters": { |
| 192 "queryId": { |
| 193 "description": "Query ID with which the reports are
associated.", |
| 194 "format": "int64", |
| 195 "location": "path", |
| 196 "required": true, |
| 197 "type": "string" |
| 198 } |
| 199 }, |
| 200 "path": "queries/{queryId}/reports", |
| 201 "response": { |
| 202 "$ref": "ListReportsResponse" |
| 203 } |
| 204 } |
| 205 } |
| 206 } |
| 207 }, |
| 208 "revision": "20140213", |
| 209 "rootUrl": "https://www.googleapis.com/", |
| 210 "schemas": { |
| 211 "DownloadLineItemsRequest": { |
| 212 "description": "Request to fetch stored line items.", |
| 213 "id": "DownloadLineItemsRequest", |
| 214 "properties": { |
| 215 "filterIds": { |
| 216 "description": "Ids of the specified filter type used to fil
ter line items to fetch. If omitted, all the line items will be returned.", |
| 217 "items": { |
| 218 "format": "int64", |
| 219 "type": "string" |
| 220 }, |
| 221 "type": "array" |
| 222 }, |
| 223 "filterType": { |
| 224 "description": "Filter type used to filter line items to fet
ch.", |
| 225 "enum": [ |
| 226 "ADVERTISER_ID", |
| 227 "INSERTION_ORDER_ID", |
| 228 "LINE_ITEM_ID" |
| 229 ], |
| 230 "enumDescriptions": [ |
| 231 "", |
| 232 "", |
| 233 "" |
| 234 ], |
| 235 "type": "string" |
| 236 }, |
| 237 "format": { |
| 238 "description": "Format in which the line items will be retur
ned. Default to CSV.", |
| 239 "enum": [ |
| 240 "CSV" |
| 241 ], |
| 242 "enumDescriptions": [ |
| 243 "" |
| 244 ], |
| 245 "type": "string" |
| 246 } |
| 247 }, |
| 248 "type": "object" |
| 249 }, |
| 250 "DownloadLineItemsResponse": { |
| 251 "description": "Download line items response.", |
| 252 "id": "DownloadLineItemsResponse", |
| 253 "properties": { |
| 254 "lineItems": { |
| 255 "description": "Retrieved line items in CSV format. Refer to
Entity Write File Format for more information on file format.", |
| 256 "type": "string" |
| 257 } |
| 258 }, |
| 259 "type": "object" |
| 260 }, |
| 261 "FilterPair": { |
| 262 "description": "Filter used to match traffic data in your report.", |
| 263 "id": "FilterPair", |
| 264 "properties": { |
| 265 "type": { |
| 266 "description": "Filter type.", |
| 267 "enum": [ |
| 268 "FILTER_ACTIVITY_ID", |
| 269 "FILTER_ADVERTISER", |
| 270 "FILTER_ADVERTISER_CURRENCY", |
| 271 "FILTER_ADVERTISER_TIMEZONE", |
| 272 "FILTER_AD_POSITION", |
| 273 "FILTER_BRANDSAFE_CHANNEL_ID", |
| 274 "FILTER_BROWSER", |
| 275 "FILTER_CAMPAIGN_DAILY_FREQUENCY", |
| 276 "FILTER_CARRIER", |
| 277 "FILTER_CHANNEL_ID", |
| 278 "FILTER_CITY", |
| 279 "FILTER_CONVERSION_DELAY", |
| 280 "FILTER_COUNTRY", |
| 281 "FILTER_CREATIVE_ID", |
| 282 "FILTER_CREATIVE_SIZE", |
| 283 "FILTER_CREATIVE_TYPE", |
| 284 "FILTER_DATA_PROVIDER", |
| 285 "FILTER_DATE", |
| 286 "FILTER_DAY_OF_WEEK", |
| 287 "FILTER_DMA", |
| 288 "FILTER_EXCHANGE_ID", |
| 289 "FILTER_FLOODLIGHT_PIXEL_ID", |
| 290 "FILTER_INSERTION_ORDER", |
| 291 "FILTER_INVENTORY_FORMAT", |
| 292 "FILTER_INVENTORY_SOURCE", |
| 293 "FILTER_KEYWORD", |
| 294 "FILTER_LINE_ITEM", |
| 295 "FILTER_LINE_ITEM_DAILY_FREQUENCY", |
| 296 "FILTER_LINE_ITEM_LIFETIME_FREQUENCY", |
| 297 "FILTER_LINE_ITEM_TYPE", |
| 298 "FILTER_MOBILE_DEVICE_MAKE", |
| 299 "FILTER_MOBILE_DEVICE_MAKE_MODEL", |
| 300 "FILTER_MOBILE_DEVICE_TYPE", |
| 301 "FILTER_MONTH", |
| 302 "FILTER_ORDER_ID", |
| 303 "FILTER_OS", |
| 304 "FILTER_PAGE_CATEGORY", |
| 305 "FILTER_PAGE_LAYOUT", |
| 306 "FILTER_PARTNER", |
| 307 "FILTER_PARTNER_CURRENCY", |
| 308 "FILTER_PUBLIC_INVENTORY", |
| 309 "FILTER_REGION", |
| 310 "FILTER_REGULAR_CHANNEL_ID", |
| 311 "FILTER_SITE_ID", |
| 312 "FILTER_SITE_LANGUAGE", |
| 313 "FILTER_TARGETED_USER_LIST", |
| 314 "FILTER_TIME_OF_DAY", |
| 315 "FILTER_UNKNOWN", |
| 316 "FILTER_USER_LIST", |
| 317 "FILTER_USER_LIST_FIRST_PARTY", |
| 318 "FILTER_USER_LIST_THIRD_PARTY", |
| 319 "FILTER_VIDEO_AD_POSITION_IN_STREAM", |
| 320 "FILTER_VIDEO_CREATIVE_DURATION", |
| 321 "FILTER_VIDEO_DURATION_SECONDS", |
| 322 "FILTER_VIDEO_FORMAT_SUPPORT", |
| 323 "FILTER_VIDEO_INVENTORY_TYPE", |
| 324 "FILTER_VIDEO_PLAYER_SIZE", |
| 325 "FILTER_VIDEO_RATING_TIER", |
| 326 "FILTER_VIDEO_SKIPPABLE_SUPPORT", |
| 327 "FILTER_VIDEO_VPAID_SUPPORT", |
| 328 "FILTER_WEEK", |
| 329 "FILTER_YEAR", |
| 330 "FILTER_YOUTUBE_VERTICAL", |
| 331 "FILTER_ZIP_CODE" |
| 332 ], |
| 333 "enumDescriptions": [ |
| 334 "", |
| 335 "", |
| 336 "", |
| 337 "", |
| 338 "", |
| 339 "", |
| 340 "", |
| 341 "", |
| 342 "", |
| 343 "", |
| 344 "", |
| 345 "", |
| 346 "", |
| 347 "", |
| 348 "", |
| 349 "", |
| 350 "", |
| 351 "", |
| 352 "", |
| 353 "", |
| 354 "", |
| 355 "", |
| 356 "", |
| 357 "", |
| 358 "", |
| 359 "", |
| 360 "", |
| 361 "", |
| 362 "", |
| 363 "", |
| 364 "", |
| 365 "", |
| 366 "", |
| 367 "", |
| 368 "", |
| 369 "", |
| 370 "", |
| 371 "", |
| 372 "", |
| 373 "", |
| 374 "", |
| 375 "", |
| 376 "", |
| 377 "", |
| 378 "", |
| 379 "", |
| 380 "", |
| 381 "", |
| 382 "", |
| 383 "", |
| 384 "", |
| 385 "", |
| 386 "", |
| 387 "", |
| 388 "", |
| 389 "", |
| 390 "", |
| 391 "", |
| 392 "", |
| 393 "", |
| 394 "", |
| 395 "", |
| 396 "", |
| 397 "" |
| 398 ], |
| 399 "type": "string" |
| 400 }, |
| 401 "value": { |
| 402 "description": "Filter value.", |
| 403 "type": "string" |
| 404 } |
| 405 }, |
| 406 "type": "object" |
| 407 }, |
| 408 "ListQueriesResponse": { |
| 409 "description": "List queries response.", |
| 410 "id": "ListQueriesResponse", |
| 411 "properties": { |
| 412 "kind": { |
| 413 "default": "doubleclickbidmanager#listQueriesResponse", |
| 414 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"doubleclickbidmanager#listQueriesResponse\".", |
| 415 "type": "string" |
| 416 }, |
| 417 "queries": { |
| 418 "description": "Retrieved queries.", |
| 419 "items": { |
| 420 "$ref": "Query" |
| 421 }, |
| 422 "type": "array" |
| 423 } |
| 424 }, |
| 425 "type": "object" |
| 426 }, |
| 427 "ListReportsResponse": { |
| 428 "description": "List reports response.", |
| 429 "id": "ListReportsResponse", |
| 430 "properties": { |
| 431 "kind": { |
| 432 "default": "doubleclickbidmanager#listReportsResponse", |
| 433 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"doubleclickbidmanager#listReportsResponse\".", |
| 434 "type": "string" |
| 435 }, |
| 436 "reports": { |
| 437 "description": "Retrieved reports.", |
| 438 "items": { |
| 439 "$ref": "Report" |
| 440 }, |
| 441 "type": "array" |
| 442 } |
| 443 }, |
| 444 "type": "object" |
| 445 }, |
| 446 "Parameters": { |
| 447 "description": "Parameters of a query or report.", |
| 448 "id": "Parameters", |
| 449 "properties": { |
| 450 "filters": { |
| 451 "description": "Filters used to match traffic data in your r
eport.", |
| 452 "items": { |
| 453 "$ref": "FilterPair" |
| 454 }, |
| 455 "type": "array" |
| 456 }, |
| 457 "groupBys": { |
| 458 "description": "Data is grouped by the filters listed in thi
s field.", |
| 459 "items": { |
| 460 "enum": [ |
| 461 "FILTER_ACTIVITY_ID", |
| 462 "FILTER_ADVERTISER", |
| 463 "FILTER_ADVERTISER_CURRENCY", |
| 464 "FILTER_ADVERTISER_TIMEZONE", |
| 465 "FILTER_AD_POSITION", |
| 466 "FILTER_BRANDSAFE_CHANNEL_ID", |
| 467 "FILTER_BROWSER", |
| 468 "FILTER_CAMPAIGN_DAILY_FREQUENCY", |
| 469 "FILTER_CARRIER", |
| 470 "FILTER_CHANNEL_ID", |
| 471 "FILTER_CITY", |
| 472 "FILTER_CONVERSION_DELAY", |
| 473 "FILTER_COUNTRY", |
| 474 "FILTER_CREATIVE_ID", |
| 475 "FILTER_CREATIVE_SIZE", |
| 476 "FILTER_CREATIVE_TYPE", |
| 477 "FILTER_DATA_PROVIDER", |
| 478 "FILTER_DATE", |
| 479 "FILTER_DAY_OF_WEEK", |
| 480 "FILTER_DMA", |
| 481 "FILTER_EXCHANGE_ID", |
| 482 "FILTER_FLOODLIGHT_PIXEL_ID", |
| 483 "FILTER_INSERTION_ORDER", |
| 484 "FILTER_INVENTORY_FORMAT", |
| 485 "FILTER_INVENTORY_SOURCE", |
| 486 "FILTER_KEYWORD", |
| 487 "FILTER_LINE_ITEM", |
| 488 "FILTER_LINE_ITEM_DAILY_FREQUENCY", |
| 489 "FILTER_LINE_ITEM_LIFETIME_FREQUENCY", |
| 490 "FILTER_LINE_ITEM_TYPE", |
| 491 "FILTER_MOBILE_DEVICE_MAKE", |
| 492 "FILTER_MOBILE_DEVICE_MAKE_MODEL", |
| 493 "FILTER_MOBILE_DEVICE_TYPE", |
| 494 "FILTER_MONTH", |
| 495 "FILTER_ORDER_ID", |
| 496 "FILTER_OS", |
| 497 "FILTER_PAGE_CATEGORY", |
| 498 "FILTER_PAGE_LAYOUT", |
| 499 "FILTER_PARTNER", |
| 500 "FILTER_PARTNER_CURRENCY", |
| 501 "FILTER_PUBLIC_INVENTORY", |
| 502 "FILTER_REGION", |
| 503 "FILTER_REGULAR_CHANNEL_ID", |
| 504 "FILTER_SITE_ID", |
| 505 "FILTER_SITE_LANGUAGE", |
| 506 "FILTER_TARGETED_USER_LIST", |
| 507 "FILTER_TIME_OF_DAY", |
| 508 "FILTER_UNKNOWN", |
| 509 "FILTER_USER_LIST", |
| 510 "FILTER_USER_LIST_FIRST_PARTY", |
| 511 "FILTER_USER_LIST_THIRD_PARTY", |
| 512 "FILTER_VIDEO_AD_POSITION_IN_STREAM", |
| 513 "FILTER_VIDEO_CREATIVE_DURATION", |
| 514 "FILTER_VIDEO_DURATION_SECONDS", |
| 515 "FILTER_VIDEO_FORMAT_SUPPORT", |
| 516 "FILTER_VIDEO_INVENTORY_TYPE", |
| 517 "FILTER_VIDEO_PLAYER_SIZE", |
| 518 "FILTER_VIDEO_RATING_TIER", |
| 519 "FILTER_VIDEO_SKIPPABLE_SUPPORT", |
| 520 "FILTER_VIDEO_VPAID_SUPPORT", |
| 521 "FILTER_WEEK", |
| 522 "FILTER_YEAR", |
| 523 "FILTER_YOUTUBE_VERTICAL", |
| 524 "FILTER_ZIP_CODE" |
| 525 ], |
| 526 "enumDescriptions": [ |
| 527 "", |
| 528 "", |
| 529 "", |
| 530 "", |
| 531 "", |
| 532 "", |
| 533 "", |
| 534 "", |
| 535 "", |
| 536 "", |
| 537 "", |
| 538 "", |
| 539 "", |
| 540 "", |
| 541 "", |
| 542 "", |
| 543 "", |
| 544 "", |
| 545 "", |
| 546 "", |
| 547 "", |
| 548 "", |
| 549 "", |
| 550 "", |
| 551 "", |
| 552 "", |
| 553 "", |
| 554 "", |
| 555 "", |
| 556 "", |
| 557 "", |
| 558 "", |
| 559 "", |
| 560 "", |
| 561 "", |
| 562 "", |
| 563 "", |
| 564 "", |
| 565 "", |
| 566 "", |
| 567 "", |
| 568 "", |
| 569 "", |
| 570 "", |
| 571 "", |
| 572 "", |
| 573 "", |
| 574 "", |
| 575 "", |
| 576 "", |
| 577 "", |
| 578 "", |
| 579 "", |
| 580 "", |
| 581 "", |
| 582 "", |
| 583 "", |
| 584 "", |
| 585 "", |
| 586 "", |
| 587 "", |
| 588 "", |
| 589 "", |
| 590 "" |
| 591 ], |
| 592 "type": "string" |
| 593 }, |
| 594 "type": "array" |
| 595 }, |
| 596 "includeInviteData": { |
| 597 "description": "Whether to include data from Invite Media.", |
| 598 "type": "boolean" |
| 599 }, |
| 600 "metrics": { |
| 601 "description": "Metrics to include as columns in your report
.", |
| 602 "items": { |
| 603 "enum": [ |
| 604 "METRIC_BID_REQUESTS", |
| 605 "METRIC_BILLABLE_COST_ADVERTISER", |
| 606 "METRIC_BILLABLE_COST_PARTNER", |
| 607 "METRIC_BILLABLE_COST_USD", |
| 608 "METRIC_CLICKS", |
| 609 "METRIC_CLICK_TO_POST_CLICK_CONVERSION_RATE", |
| 610 "METRIC_CONVERSIONS_PER_MILLE", |
| 611 "METRIC_CPM_FEE1_ADVERTISER", |
| 612 "METRIC_CPM_FEE1_PARTNER", |
| 613 "METRIC_CPM_FEE1_USD", |
| 614 "METRIC_CPM_FEE2_ADVERTISER", |
| 615 "METRIC_CPM_FEE2_PARTNER", |
| 616 "METRIC_CPM_FEE2_USD", |
| 617 "METRIC_CTR", |
| 618 "METRIC_DATA_COST_ADVERTISER", |
| 619 "METRIC_DATA_COST_PARTNER", |
| 620 "METRIC_DATA_COST_USD", |
| 621 "METRIC_FEE10_ADVERTISER", |
| 622 "METRIC_FEE10_PARTNER", |
| 623 "METRIC_FEE10_USD", |
| 624 "METRIC_FEE11_ADVERTISER", |
| 625 "METRIC_FEE11_PARTNER", |
| 626 "METRIC_FEE11_USD", |
| 627 "METRIC_FEE12_ADVERTISER", |
| 628 "METRIC_FEE12_PARTNER", |
| 629 "METRIC_FEE12_USD", |
| 630 "METRIC_FEE13_ADVERTISER", |
| 631 "METRIC_FEE13_PARTNER", |
| 632 "METRIC_FEE13_USD", |
| 633 "METRIC_FEE14_ADVERTISER", |
| 634 "METRIC_FEE14_PARTNER", |
| 635 "METRIC_FEE14_USD", |
| 636 "METRIC_FEE15_ADVERTISER", |
| 637 "METRIC_FEE15_PARTNER", |
| 638 "METRIC_FEE15_USD", |
| 639 "METRIC_FEE2_ADVERTISER", |
| 640 "METRIC_FEE2_PARTNER", |
| 641 "METRIC_FEE2_USD", |
| 642 "METRIC_FEE3_ADVERTISER", |
| 643 "METRIC_FEE3_PARTNER", |
| 644 "METRIC_FEE3_USD", |
| 645 "METRIC_FEE4_ADVERTISER", |
| 646 "METRIC_FEE4_PARTNER", |
| 647 "METRIC_FEE4_USD", |
| 648 "METRIC_FEE5_ADVERTISER", |
| 649 "METRIC_FEE5_PARTNER", |
| 650 "METRIC_FEE5_USD", |
| 651 "METRIC_FEE6_ADVERTISER", |
| 652 "METRIC_FEE6_PARTNER", |
| 653 "METRIC_FEE6_USD", |
| 654 "METRIC_FEE7_ADVERTISER", |
| 655 "METRIC_FEE7_PARTNER", |
| 656 "METRIC_FEE7_USD", |
| 657 "METRIC_FEE8_ADVERTISER", |
| 658 "METRIC_FEE8_PARTNER", |
| 659 "METRIC_FEE8_USD", |
| 660 "METRIC_FEE9_ADVERTISER", |
| 661 "METRIC_FEE9_PARTNER", |
| 662 "METRIC_FEE9_USD", |
| 663 "METRIC_IMPRESSIONS", |
| 664 "METRIC_IMPRESSIONS_TO_CONVERSION_RATE", |
| 665 "METRIC_LAST_CLICKS", |
| 666 "METRIC_LAST_IMPRESSIONS", |
| 667 "METRIC_MEDIA_COST_ADVERTISER", |
| 668 "METRIC_MEDIA_COST_ECPAPC_ADVERTISER", |
| 669 "METRIC_MEDIA_COST_ECPAPC_PARTNER", |
| 670 "METRIC_MEDIA_COST_ECPAPC_USD", |
| 671 "METRIC_MEDIA_COST_ECPAPV_ADVERTISER", |
| 672 "METRIC_MEDIA_COST_ECPAPV_PARTNER", |
| 673 "METRIC_MEDIA_COST_ECPAPV_USD", |
| 674 "METRIC_MEDIA_COST_ECPA_ADVERTISER", |
| 675 "METRIC_MEDIA_COST_ECPA_PARTNER", |
| 676 "METRIC_MEDIA_COST_ECPA_USD", |
| 677 "METRIC_MEDIA_COST_ECPCV_ADVERTISER", |
| 678 "METRIC_MEDIA_COST_ECPCV_PARTNER", |
| 679 "METRIC_MEDIA_COST_ECPCV_USD", |
| 680 "METRIC_MEDIA_COST_ECPC_ADVERTISER", |
| 681 "METRIC_MEDIA_COST_ECPC_PARTNER", |
| 682 "METRIC_MEDIA_COST_ECPC_USD", |
| 683 "METRIC_MEDIA_COST_ECPM_ADVERTISER", |
| 684 "METRIC_MEDIA_COST_ECPM_PARTNER", |
| 685 "METRIC_MEDIA_COST_ECPM_USD", |
| 686 "METRIC_MEDIA_COST_PARTNER", |
| 687 "METRIC_MEDIA_COST_USD", |
| 688 "METRIC_MEDIA_FEE1_ADVERTISER", |
| 689 "METRIC_MEDIA_FEE1_PARTNER", |
| 690 "METRIC_MEDIA_FEE1_USD", |
| 691 "METRIC_MEDIA_FEE2_ADVERTISER", |
| 692 "METRIC_MEDIA_FEE2_PARTNER", |
| 693 "METRIC_MEDIA_FEE2_USD", |
| 694 "METRIC_PIXEL_LOADS", |
| 695 "METRIC_PLATFORM_FEE_ADVERTISER", |
| 696 "METRIC_PLATFORM_FEE_PARTNER", |
| 697 "METRIC_PLATFORM_FEE_USD", |
| 698 "METRIC_POST_CLICK_DFA_REVENUE", |
| 699 "METRIC_POST_VIEW_DFA_REVENUE", |
| 700 "METRIC_PROFIT_ADVERTISER", |
| 701 "METRIC_PROFIT_ECPAPC_ADVERTISER", |
| 702 "METRIC_PROFIT_ECPAPC_PARTNER", |
| 703 "METRIC_PROFIT_ECPAPC_USD", |
| 704 "METRIC_PROFIT_ECPAPV_ADVERTISER", |
| 705 "METRIC_PROFIT_ECPAPV_PARTNER", |
| 706 "METRIC_PROFIT_ECPAPV_USD", |
| 707 "METRIC_PROFIT_ECPA_ADVERTISER", |
| 708 "METRIC_PROFIT_ECPA_PARTNER", |
| 709 "METRIC_PROFIT_ECPA_USD", |
| 710 "METRIC_PROFIT_ECPC_ADVERTISER", |
| 711 "METRIC_PROFIT_ECPC_PARTNER", |
| 712 "METRIC_PROFIT_ECPC_USD", |
| 713 "METRIC_PROFIT_ECPM_ADVERTISER", |
| 714 "METRIC_PROFIT_ECPM_PARTNER", |
| 715 "METRIC_PROFIT_ECPM_USD", |
| 716 "METRIC_PROFIT_MARGIN", |
| 717 "METRIC_PROFIT_PARTNER", |
| 718 "METRIC_PROFIT_USD", |
| 719 "METRIC_REVENUE_ADVERTISER", |
| 720 "METRIC_REVENUE_ECPAPC_ADVERTISER", |
| 721 "METRIC_REVENUE_ECPAPC_PARTNER", |
| 722 "METRIC_REVENUE_ECPAPC_USD", |
| 723 "METRIC_REVENUE_ECPAPV_ADVERTISER", |
| 724 "METRIC_REVENUE_ECPAPV_PARTNER", |
| 725 "METRIC_REVENUE_ECPAPV_USD", |
| 726 "METRIC_REVENUE_ECPA_ADVERTISER", |
| 727 "METRIC_REVENUE_ECPA_PARTNER", |
| 728 "METRIC_REVENUE_ECPA_USD", |
| 729 "METRIC_REVENUE_ECPCV_ADVERTISER", |
| 730 "METRIC_REVENUE_ECPCV_PARTNER", |
| 731 "METRIC_REVENUE_ECPCV_USD", |
| 732 "METRIC_REVENUE_ECPC_ADVERTISER", |
| 733 "METRIC_REVENUE_ECPC_PARTNER", |
| 734 "METRIC_REVENUE_ECPC_USD", |
| 735 "METRIC_REVENUE_ECPM_ADVERTISER", |
| 736 "METRIC_REVENUE_ECPM_PARTNER", |
| 737 "METRIC_REVENUE_ECPM_USD", |
| 738 "METRIC_REVENUE_PARTNER", |
| 739 "METRIC_REVENUE_USD", |
| 740 "METRIC_RICH_MEDIA_VIDEO_COMPLETIONS", |
| 741 "METRIC_RICH_MEDIA_VIDEO_FIRST_QUARTILE_COMPLETES", |
| 742 "METRIC_RICH_MEDIA_VIDEO_FULL_SCREENS", |
| 743 "METRIC_RICH_MEDIA_VIDEO_MIDPOINTS", |
| 744 "METRIC_RICH_MEDIA_VIDEO_MUTES", |
| 745 "METRIC_RICH_MEDIA_VIDEO_PAUSES", |
| 746 "METRIC_RICH_MEDIA_VIDEO_PLAYS", |
| 747 "METRIC_RICH_MEDIA_VIDEO_SKIPS", |
| 748 "METRIC_RICH_MEDIA_VIDEO_THIRD_QUARTILE_COMPLETES", |
| 749 "METRIC_TOTAL_CONVERSIONS", |
| 750 "METRIC_TOTAL_MEDIA_COST_ADVERTISER", |
| 751 "METRIC_TOTAL_MEDIA_COST_ECPAPC_ADVERTISER", |
| 752 "METRIC_TOTAL_MEDIA_COST_ECPAPC_PARTNER", |
| 753 "METRIC_TOTAL_MEDIA_COST_ECPAPC_USD", |
| 754 "METRIC_TOTAL_MEDIA_COST_ECPAPV_ADVERTISER", |
| 755 "METRIC_TOTAL_MEDIA_COST_ECPAPV_PARTNER", |
| 756 "METRIC_TOTAL_MEDIA_COST_ECPAPV_USD", |
| 757 "METRIC_TOTAL_MEDIA_COST_ECPA_ADVERTISER", |
| 758 "METRIC_TOTAL_MEDIA_COST_ECPA_PARTNER", |
| 759 "METRIC_TOTAL_MEDIA_COST_ECPA_USD", |
| 760 "METRIC_TOTAL_MEDIA_COST_ECPCV_ADVERTISER", |
| 761 "METRIC_TOTAL_MEDIA_COST_ECPCV_PARTNER", |
| 762 "METRIC_TOTAL_MEDIA_COST_ECPCV_USD", |
| 763 "METRIC_TOTAL_MEDIA_COST_ECPC_ADVERTISER", |
| 764 "METRIC_TOTAL_MEDIA_COST_ECPC_PARTNER", |
| 765 "METRIC_TOTAL_MEDIA_COST_ECPC_USD", |
| 766 "METRIC_TOTAL_MEDIA_COST_ECPM_ADVERTISER", |
| 767 "METRIC_TOTAL_MEDIA_COST_ECPM_PARTNER", |
| 768 "METRIC_TOTAL_MEDIA_COST_ECPM_USD", |
| 769 "METRIC_TOTAL_MEDIA_COST_PARTNER", |
| 770 "METRIC_TOTAL_MEDIA_COST_USD", |
| 771 "METRIC_UNIQUE_VISITORS_COOKIES", |
| 772 "METRIC_UNKNOWN", |
| 773 "METRIC_VIDEO_COMPLETION_RATE" |
| 774 ], |
| 775 "enumDescriptions": [ |
| 776 "", |
| 777 "", |
| 778 "", |
| 779 "", |
| 780 "", |
| 781 "", |
| 782 "", |
| 783 "", |
| 784 "", |
| 785 "", |
| 786 "", |
| 787 "", |
| 788 "", |
| 789 "", |
| 790 "", |
| 791 "", |
| 792 "", |
| 793 "", |
| 794 "", |
| 795 "", |
| 796 "", |
| 797 "", |
| 798 "", |
| 799 "", |
| 800 "", |
| 801 "", |
| 802 "", |
| 803 "", |
| 804 "", |
| 805 "", |
| 806 "", |
| 807 "", |
| 808 "", |
| 809 "", |
| 810 "", |
| 811 "", |
| 812 "", |
| 813 "", |
| 814 "", |
| 815 "", |
| 816 "", |
| 817 "", |
| 818 "", |
| 819 "", |
| 820 "", |
| 821 "", |
| 822 "", |
| 823 "", |
| 824 "", |
| 825 "", |
| 826 "", |
| 827 "", |
| 828 "", |
| 829 "", |
| 830 "", |
| 831 "", |
| 832 "", |
| 833 "", |
| 834 "", |
| 835 "", |
| 836 "", |
| 837 "", |
| 838 "", |
| 839 "", |
| 840 "", |
| 841 "", |
| 842 "", |
| 843 "", |
| 844 "", |
| 845 "", |
| 846 "", |
| 847 "", |
| 848 "", |
| 849 "", |
| 850 "", |
| 851 "", |
| 852 "", |
| 853 "", |
| 854 "", |
| 855 "", |
| 856 "", |
| 857 "", |
| 858 "", |
| 859 "", |
| 860 "", |
| 861 "", |
| 862 "", |
| 863 "", |
| 864 "", |
| 865 "", |
| 866 "", |
| 867 "", |
| 868 "", |
| 869 "", |
| 870 "", |
| 871 "", |
| 872 "", |
| 873 "", |
| 874 "", |
| 875 "", |
| 876 "", |
| 877 "", |
| 878 "", |
| 879 "", |
| 880 "", |
| 881 "", |
| 882 "", |
| 883 "", |
| 884 "", |
| 885 "", |
| 886 "", |
| 887 "", |
| 888 "", |
| 889 "", |
| 890 "", |
| 891 "", |
| 892 "", |
| 893 "", |
| 894 "", |
| 895 "", |
| 896 "", |
| 897 "", |
| 898 "", |
| 899 "", |
| 900 "", |
| 901 "", |
| 902 "", |
| 903 "", |
| 904 "", |
| 905 "", |
| 906 "", |
| 907 "", |
| 908 "", |
| 909 "", |
| 910 "", |
| 911 "", |
| 912 "", |
| 913 "", |
| 914 "", |
| 915 "", |
| 916 "", |
| 917 "", |
| 918 "", |
| 919 "", |
| 920 "", |
| 921 "", |
| 922 "", |
| 923 "", |
| 924 "", |
| 925 "", |
| 926 "", |
| 927 "", |
| 928 "", |
| 929 "", |
| 930 "", |
| 931 "", |
| 932 "", |
| 933 "", |
| 934 "", |
| 935 "", |
| 936 "", |
| 937 "", |
| 938 "", |
| 939 "", |
| 940 "", |
| 941 "", |
| 942 "", |
| 943 "", |
| 944 "", |
| 945 "" |
| 946 ], |
| 947 "type": "string" |
| 948 }, |
| 949 "type": "array" |
| 950 }, |
| 951 "type": { |
| 952 "description": "Report type.", |
| 953 "enum": [ |
| 954 "TYPE_ACTIVE_GRP", |
| 955 "TYPE_AUDIENCE_COMPOSITION", |
| 956 "TYPE_AUDIENCE_PERFORMANCE", |
| 957 "TYPE_CLIENT_SAFE", |
| 958 "TYPE_CROSS_FEE", |
| 959 "TYPE_CROSS_PARTNER", |
| 960 "TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER", |
| 961 "TYPE_FEE", |
| 962 "TYPE_GENERAL", |
| 963 "TYPE_INVENTORY_AVAILABILITY", |
| 964 "TYPE_KEYWORD", |
| 965 "TYPE_ORDER_ID", |
| 966 "TYPE_PAGE_CATEGORY", |
| 967 "TYPE_PIXEL_LOAD", |
| 968 "TYPE_THIRD_PARTY_DATA_PROVIDER", |
| 969 "TYPE_YOUTUBE_VERTICAL" |
| 970 ], |
| 971 "enumDescriptions": [ |
| 972 "", |
| 973 "", |
| 974 "", |
| 975 "", |
| 976 "", |
| 977 "", |
| 978 "", |
| 979 "", |
| 980 "", |
| 981 "", |
| 982 "", |
| 983 "", |
| 984 "", |
| 985 "", |
| 986 "", |
| 987 "" |
| 988 ], |
| 989 "type": "string" |
| 990 } |
| 991 }, |
| 992 "type": "object" |
| 993 }, |
| 994 "Query": { |
| 995 "description": "Represents a query.", |
| 996 "id": "Query", |
| 997 "properties": { |
| 998 "kind": { |
| 999 "default": "doubleclickbidmanager#query", |
| 1000 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"doubleclickbidmanager#query\".", |
| 1001 "type": "string" |
| 1002 }, |
| 1003 "metadata": { |
| 1004 "$ref": "QueryMetadata", |
| 1005 "description": "Query metadata." |
| 1006 }, |
| 1007 "params": { |
| 1008 "$ref": "Parameters", |
| 1009 "description": "Query parameters." |
| 1010 }, |
| 1011 "queryId": { |
| 1012 "description": "Query ID.", |
| 1013 "format": "int64", |
| 1014 "type": "string" |
| 1015 }, |
| 1016 "reportDataEndTimeMs": { |
| 1017 "description": "The ending time for the data that is shown i
n the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUS
TOM_DATES and ignored otherwise.", |
| 1018 "format": "int64", |
| 1019 "type": "string" |
| 1020 }, |
| 1021 "reportDataStartTimeMs": { |
| 1022 "description": "The starting time for the data that is shown
in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is
CUSTOM_DATES and ignored otherwise.", |
| 1023 "format": "int64", |
| 1024 "type": "string" |
| 1025 }, |
| 1026 "schedule": { |
| 1027 "$ref": "QuerySchedule", |
| 1028 "description": "Information on how often and when to run a q
uery." |
| 1029 }, |
| 1030 "timezoneCode": { |
| 1031 "description": "Canonical timezone code for report data time
. Defaults to America/New_York.", |
| 1032 "type": "string" |
| 1033 } |
| 1034 }, |
| 1035 "type": "object" |
| 1036 }, |
| 1037 "QueryMetadata": { |
| 1038 "description": "Query metadata.", |
| 1039 "id": "QueryMetadata", |
| 1040 "properties": { |
| 1041 "dataRange": { |
| 1042 "description": "Range of report data.", |
| 1043 "enum": [ |
| 1044 "ALL_TIME", |
| 1045 "CURRENT_DAY", |
| 1046 "CUSTOM_DATES", |
| 1047 "LAST_14_DAYS", |
| 1048 "LAST_30_DAYS", |
| 1049 "LAST_365_DAYS", |
| 1050 "LAST_7_DAYS", |
| 1051 "LAST_90_DAYS", |
| 1052 "MONTH_TO_DATE", |
| 1053 "PREVIOUS_DAY", |
| 1054 "PREVIOUS_HALF_MONTH", |
| 1055 "PREVIOUS_MONTH", |
| 1056 "PREVIOUS_QUARTER", |
| 1057 "PREVIOUS_WEEK", |
| 1058 "PREVIOUS_YEAR", |
| 1059 "QUARTER_TO_DATE", |
| 1060 "WEEK_TO_DATE", |
| 1061 "YEAR_TO_DATE" |
| 1062 ], |
| 1063 "enumDescriptions": [ |
| 1064 "", |
| 1065 "", |
| 1066 "", |
| 1067 "", |
| 1068 "", |
| 1069 "", |
| 1070 "", |
| 1071 "", |
| 1072 "", |
| 1073 "", |
| 1074 "", |
| 1075 "", |
| 1076 "", |
| 1077 "", |
| 1078 "", |
| 1079 "", |
| 1080 "", |
| 1081 "" |
| 1082 ], |
| 1083 "type": "string" |
| 1084 }, |
| 1085 "format": { |
| 1086 "description": "Format of the generated report.", |
| 1087 "enum": [ |
| 1088 "CSV", |
| 1089 "EXCEL_CSV", |
| 1090 "XLSX" |
| 1091 ], |
| 1092 "enumDescriptions": [ |
| 1093 "", |
| 1094 "", |
| 1095 "" |
| 1096 ], |
| 1097 "type": "string" |
| 1098 }, |
| 1099 "googleCloudStoragePathForLatestReport": { |
| 1100 "description": "The path to the location in Google Cloud Sto
rage where the latest report is stored.", |
| 1101 "type": "string" |
| 1102 }, |
| 1103 "googleDrivePathForLatestReport": { |
| 1104 "description": "The path in Google Drive for the latest repo
rt.", |
| 1105 "type": "string" |
| 1106 }, |
| 1107 "latestReportRunTimeMs": { |
| 1108 "description": "The time when the latest report started to r
un.", |
| 1109 "format": "int64", |
| 1110 "type": "string" |
| 1111 }, |
| 1112 "reportCount": { |
| 1113 "description": "Number of reports that have been generated f
or the query.", |
| 1114 "format": "int32", |
| 1115 "type": "integer" |
| 1116 }, |
| 1117 "running": { |
| 1118 "description": "Whether the latest report is currently runni
ng.", |
| 1119 "type": "boolean" |
| 1120 }, |
| 1121 "sendNotification": { |
| 1122 "description": "Whether to send an email notification when a
report is ready. Default to false.", |
| 1123 "type": "boolean" |
| 1124 }, |
| 1125 "shareEmailAddress": { |
| 1126 "description": "List of email addresses which are sent email
notifications when the report is finished. Separate from sendNotification.", |
| 1127 "items": { |
| 1128 "type": "string" |
| 1129 }, |
| 1130 "type": "array" |
| 1131 }, |
| 1132 "title": { |
| 1133 "description": "Query title. It is used to name the reports
generated from this query.", |
| 1134 "type": "string" |
| 1135 } |
| 1136 }, |
| 1137 "type": "object" |
| 1138 }, |
| 1139 "QuerySchedule": { |
| 1140 "description": "Information on how frequently and when to run a quer
y.", |
| 1141 "id": "QuerySchedule", |
| 1142 "properties": { |
| 1143 "endTimeMs": { |
| 1144 "description": "Datetime to periodically run the query until
.", |
| 1145 "format": "int64", |
| 1146 "type": "string" |
| 1147 }, |
| 1148 "frequency": { |
| 1149 "description": "How often the query is run.", |
| 1150 "enum": [ |
| 1151 "DAILY", |
| 1152 "MONTHLY", |
| 1153 "ONE_TIME", |
| 1154 "QUARTERLY", |
| 1155 "SEMI_MONTHLY", |
| 1156 "WEEKLY" |
| 1157 ], |
| 1158 "enumDescriptions": [ |
| 1159 "", |
| 1160 "", |
| 1161 "", |
| 1162 "", |
| 1163 "", |
| 1164 "" |
| 1165 ], |
| 1166 "type": "string" |
| 1167 }, |
| 1168 "nextRunMinuteOfDay": { |
| 1169 "description": "Time of day at which a new report will be ge
nerated, represented as minutes past midnight Range is 0 to 1439. Only applies t
o scheduled reports.", |
| 1170 "format": "int32", |
| 1171 "type": "integer" |
| 1172 }, |
| 1173 "nextRunTimezoneCode": { |
| 1174 "description": "Canonical timezone code for report generatio
n time. Defaults to America/New_York.", |
| 1175 "type": "string" |
| 1176 } |
| 1177 }, |
| 1178 "type": "object" |
| 1179 }, |
| 1180 "Report": { |
| 1181 "description": "Represents a report.", |
| 1182 "id": "Report", |
| 1183 "properties": { |
| 1184 "key": { |
| 1185 "$ref": "ReportKey", |
| 1186 "description": "Key used to identify a report." |
| 1187 }, |
| 1188 "metadata": { |
| 1189 "$ref": "ReportMetadata", |
| 1190 "description": "Report metadata." |
| 1191 }, |
| 1192 "params": { |
| 1193 "$ref": "Parameters", |
| 1194 "description": "Report parameters." |
| 1195 } |
| 1196 }, |
| 1197 "type": "object" |
| 1198 }, |
| 1199 "ReportFailure": { |
| 1200 "description": "An explanation of a report failure.", |
| 1201 "id": "ReportFailure", |
| 1202 "properties": { |
| 1203 "errorCode": { |
| 1204 "description": "Error code that shows why the report was not
created.", |
| 1205 "enum": [ |
| 1206 "AUTHENTICATION_ERROR", |
| 1207 "DEPRECATED_REPORTING_INVALID_QUERY", |
| 1208 "REPORTING_BUCKET_NOT_FOUND", |
| 1209 "REPORTING_CREATE_BUCKET_FAILED", |
| 1210 "REPORTING_DELETE_BUCKET_FAILED", |
| 1211 "REPORTING_FATAL_ERROR", |
| 1212 "REPORTING_ILLEGAL_FILENAME", |
| 1213 "REPORTING_IMCOMPATIBLE_METRICS", |
| 1214 "REPORTING_INVALID_QUERY_MISSING_PARTNER_AND_ADVERTISER_
FILTERS", |
| 1215 "REPORTING_INVALID_QUERY_TITLE_MISSING", |
| 1216 "REPORTING_INVALID_QUERY_TOO_MANY_UNFILTERED_LARGE_GROUP
_BYS", |
| 1217 "REPORTING_QUERY_NOT_FOUND", |
| 1218 "REPORTING_TRANSIENT_ERROR", |
| 1219 "REPORTING_UPDATE_BUCKET_PERMISSION_FAILED", |
| 1220 "REPORTING_WRITE_BUCKET_OBJECT_FAILED", |
| 1221 "SERVER_ERROR", |
| 1222 "UNAUTHORIZED_API_ACCESS", |
| 1223 "VALIDATION_ERROR" |
| 1224 ], |
| 1225 "enumDescriptions": [ |
| 1226 "", |
| 1227 "", |
| 1228 "", |
| 1229 "", |
| 1230 "", |
| 1231 "", |
| 1232 "", |
| 1233 "", |
| 1234 "", |
| 1235 "", |
| 1236 "", |
| 1237 "", |
| 1238 "", |
| 1239 "", |
| 1240 "", |
| 1241 "", |
| 1242 "", |
| 1243 "" |
| 1244 ], |
| 1245 "type": "string" |
| 1246 } |
| 1247 }, |
| 1248 "type": "object" |
| 1249 }, |
| 1250 "ReportKey": { |
| 1251 "description": "Key used to identify a report.", |
| 1252 "id": "ReportKey", |
| 1253 "properties": { |
| 1254 "queryId": { |
| 1255 "description": "Query ID.", |
| 1256 "format": "int64", |
| 1257 "type": "string" |
| 1258 }, |
| 1259 "reportId": { |
| 1260 "description": "Report ID.", |
| 1261 "format": "int64", |
| 1262 "type": "string" |
| 1263 } |
| 1264 }, |
| 1265 "type": "object" |
| 1266 }, |
| 1267 "ReportMetadata": { |
| 1268 "description": "Report metadata.", |
| 1269 "id": "ReportMetadata", |
| 1270 "properties": { |
| 1271 "googleCloudStoragePath": { |
| 1272 "description": "The path to the location in Google Cloud Sto
rage where the report is stored.", |
| 1273 "type": "string" |
| 1274 }, |
| 1275 "reportDataEndTimeMs": { |
| 1276 "description": "The ending time for the data that is shown i
n the report.", |
| 1277 "format": "int64", |
| 1278 "type": "string" |
| 1279 }, |
| 1280 "reportDataStartTimeMs": { |
| 1281 "description": "The starting time for the data that is shown
in the report.", |
| 1282 "format": "int64", |
| 1283 "type": "string" |
| 1284 }, |
| 1285 "status": { |
| 1286 "$ref": "ReportStatus", |
| 1287 "description": "Report status." |
| 1288 } |
| 1289 }, |
| 1290 "type": "object" |
| 1291 }, |
| 1292 "ReportStatus": { |
| 1293 "description": "Report status.", |
| 1294 "id": "ReportStatus", |
| 1295 "properties": { |
| 1296 "failure": { |
| 1297 "$ref": "ReportFailure", |
| 1298 "description": "If the report failed, this records the cause
." |
| 1299 }, |
| 1300 "finishTimeMs": { |
| 1301 "description": "The time when this report either completed s
uccessfully or failed.", |
| 1302 "format": "int64", |
| 1303 "type": "string" |
| 1304 }, |
| 1305 "format": { |
| 1306 "description": "The file type of the report.", |
| 1307 "enum": [ |
| 1308 "CSV", |
| 1309 "EXCEL_CSV", |
| 1310 "XLSX" |
| 1311 ], |
| 1312 "enumDescriptions": [ |
| 1313 "", |
| 1314 "", |
| 1315 "" |
| 1316 ], |
| 1317 "type": "string" |
| 1318 }, |
| 1319 "state": { |
| 1320 "description": "The state of the report.", |
| 1321 "enum": [ |
| 1322 "DONE", |
| 1323 "FAILED", |
| 1324 "RUNNING" |
| 1325 ], |
| 1326 "enumDescriptions": [ |
| 1327 "", |
| 1328 "", |
| 1329 "" |
| 1330 ], |
| 1331 "type": "string" |
| 1332 } |
| 1333 }, |
| 1334 "type": "object" |
| 1335 }, |
| 1336 "RowStatus": { |
| 1337 "description": "Represents the upload status of a row in the request
.", |
| 1338 "id": "RowStatus", |
| 1339 "properties": { |
| 1340 "changed": { |
| 1341 "description": "Whether the stored entity is changed as a re
sult of upload.", |
| 1342 "type": "boolean" |
| 1343 }, |
| 1344 "entityId": { |
| 1345 "description": "Entity Id.", |
| 1346 "format": "int64", |
| 1347 "type": "string" |
| 1348 }, |
| 1349 "entityName": { |
| 1350 "description": "Entity name.", |
| 1351 "type": "string" |
| 1352 }, |
| 1353 "errors": { |
| 1354 "description": "Reasons why the entity can't be uploaded.", |
| 1355 "items": { |
| 1356 "type": "string" |
| 1357 }, |
| 1358 "type": "array" |
| 1359 }, |
| 1360 "persisted": { |
| 1361 "description": "Whether the entity is persisted.", |
| 1362 "type": "boolean" |
| 1363 }, |
| 1364 "rowNumber": { |
| 1365 "description": "Row number.", |
| 1366 "format": "int32", |
| 1367 "type": "integer" |
| 1368 } |
| 1369 }, |
| 1370 "type": "object" |
| 1371 }, |
| 1372 "RunQueryRequest": { |
| 1373 "description": "Request to run a stored query to generate a report."
, |
| 1374 "id": "RunQueryRequest", |
| 1375 "properties": { |
| 1376 "dataRange": { |
| 1377 "description": "Report data range used to generate the repor
t.", |
| 1378 "enum": [ |
| 1379 "ALL_TIME", |
| 1380 "CURRENT_DAY", |
| 1381 "CUSTOM_DATES", |
| 1382 "LAST_14_DAYS", |
| 1383 "LAST_30_DAYS", |
| 1384 "LAST_365_DAYS", |
| 1385 "LAST_7_DAYS", |
| 1386 "LAST_90_DAYS", |
| 1387 "MONTH_TO_DATE", |
| 1388 "PREVIOUS_DAY", |
| 1389 "PREVIOUS_HALF_MONTH", |
| 1390 "PREVIOUS_MONTH", |
| 1391 "PREVIOUS_QUARTER", |
| 1392 "PREVIOUS_WEEK", |
| 1393 "PREVIOUS_YEAR", |
| 1394 "QUARTER_TO_DATE", |
| 1395 "WEEK_TO_DATE", |
| 1396 "YEAR_TO_DATE" |
| 1397 ], |
| 1398 "enumDescriptions": [ |
| 1399 "", |
| 1400 "", |
| 1401 "", |
| 1402 "", |
| 1403 "", |
| 1404 "", |
| 1405 "", |
| 1406 "", |
| 1407 "", |
| 1408 "", |
| 1409 "", |
| 1410 "", |
| 1411 "", |
| 1412 "", |
| 1413 "", |
| 1414 "", |
| 1415 "", |
| 1416 "" |
| 1417 ], |
| 1418 "type": "string" |
| 1419 }, |
| 1420 "reportDataEndTimeMs": { |
| 1421 "description": "The ending time for the data that is shown i
n the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES
and ignored otherwise.", |
| 1422 "format": "int64", |
| 1423 "type": "string" |
| 1424 }, |
| 1425 "reportDataStartTimeMs": { |
| 1426 "description": "The starting time for the data that is shown
in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_D
ATES and ignored otherwise.", |
| 1427 "format": "int64", |
| 1428 "type": "string" |
| 1429 }, |
| 1430 "timezoneCode": { |
| 1431 "description": "Canonical timezone code for report data time
. Defaults to America/New_York.", |
| 1432 "type": "string" |
| 1433 } |
| 1434 }, |
| 1435 "type": "object" |
| 1436 }, |
| 1437 "UploadLineItemsRequest": { |
| 1438 "description": "Request to upload line items.", |
| 1439 "id": "UploadLineItemsRequest", |
| 1440 "properties": { |
| 1441 "dryRun": { |
| 1442 "description": "Set to true to get upload status without act
ually persisting the line items.", |
| 1443 "type": "boolean" |
| 1444 }, |
| 1445 "format": { |
| 1446 "description": "Format the line items are in. Default to CSV
.", |
| 1447 "enum": [ |
| 1448 "CSV" |
| 1449 ], |
| 1450 "enumDescriptions": [ |
| 1451 "" |
| 1452 ], |
| 1453 "type": "string" |
| 1454 }, |
| 1455 "lineItems": { |
| 1456 "description": "Line items in CSV to upload. Refer to Entit
y Write File Format for more information on file format.", |
| 1457 "type": "string" |
| 1458 } |
| 1459 }, |
| 1460 "type": "object" |
| 1461 }, |
| 1462 "UploadLineItemsResponse": { |
| 1463 "description": "Upload line items response.", |
| 1464 "id": "UploadLineItemsResponse", |
| 1465 "properties": { |
| 1466 "uploadStatus": { |
| 1467 "$ref": "UploadStatus", |
| 1468 "description": "Status of upload." |
| 1469 } |
| 1470 }, |
| 1471 "type": "object" |
| 1472 }, |
| 1473 "UploadStatus": { |
| 1474 "description": "Represents the status of upload.", |
| 1475 "id": "UploadStatus", |
| 1476 "properties": { |
| 1477 "errors": { |
| 1478 "description": "Reasons why upload can't be completed.", |
| 1479 "items": { |
| 1480 "type": "string" |
| 1481 }, |
| 1482 "type": "array" |
| 1483 }, |
| 1484 "rowStatus": { |
| 1485 "description": "Per-row upload status.", |
| 1486 "items": { |
| 1487 "$ref": "RowStatus" |
| 1488 }, |
| 1489 "type": "array" |
| 1490 } |
| 1491 }, |
| 1492 "type": "object" |
| 1493 } |
| 1494 }, |
| 1495 "servicePath": "doubleclickbidmanager/v1/", |
| 1496 "title": "DoubleClick Bid Manager API", |
| 1497 "version": "v1" |
| 1498 } |
OLD | NEW |