| OLD | NEW |
|---|
| (Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/doubleclicksearch": { |
| 6 "description": "View and manage your advertising data in Dou
bleClick Search" |
| 7 } |
| 8 } |
| 9 } |
| 10 }, |
| 11 "basePath": "/doubleclicksearch/v2/", |
| 12 "baseUrl": "https://www.googleapis.com/doubleclicksearch/v2/", |
| 13 "batchPath": "batch", |
| 14 "description": "Report and modify your advertising data in DoubleClick Searc
h (for example, campaigns, ad groups, keywords, and conversions).", |
| 15 "discoveryVersion": "v1", |
| 16 "documentationLink": "https://developers.google.com/doubleclick-search/", |
| 17 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/GOxwndul1frHFhJwbGPiuFL2qqY\"", |
| 18 "icons": { |
| 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 21 }, |
| 22 "id": "doubleclicksearch:v2", |
| 23 "kind": "discovery#restDescription", |
| 24 "name": "doubleclicksearch", |
| 25 "ownerDomain": "google.com", |
| 26 "ownerName": "Google", |
| 27 "parameters": { |
| 28 "alt": { |
| 29 "default": "json", |
| 30 "description": "Data format for the response.", |
| 31 "enum": [ |
| 32 "json" |
| 33 ], |
| 34 "enumDescriptions": [ |
| 35 "Responses with Content-Type of application/json" |
| 36 ], |
| 37 "location": "query", |
| 38 "type": "string" |
| 39 }, |
| 40 "fields": { |
| 41 "description": "Selector specifying which fields to include in a par
tial response.", |
| 42 "location": "query", |
| 43 "type": "string" |
| 44 }, |
| 45 "key": { |
| 46 "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.", |
| 47 "location": "query", |
| 48 "type": "string" |
| 49 }, |
| 50 "oauth_token": { |
| 51 "description": "OAuth 2.0 token for the current user.", |
| 52 "location": "query", |
| 53 "type": "string" |
| 54 }, |
| 55 "prettyPrint": { |
| 56 "default": "true", |
| 57 "description": "Returns response with indentations and line breaks."
, |
| 58 "location": "query", |
| 59 "type": "boolean" |
| 60 }, |
| 61 "quotaUser": { |
| 62 "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.", |
| 63 "location": "query", |
| 64 "type": "string" |
| 65 }, |
| 66 "userIp": { |
| 67 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 68 "location": "query", |
| 69 "type": "string" |
| 70 } |
| 71 }, |
| 72 "protocol": "rest", |
| 73 "resources": { |
| 74 "conversion": { |
| 75 "methods": { |
| 76 "get": { |
| 77 "description": "Retrieves a list of conversions from a Doubl
eClick Search engine account.", |
| 78 "httpMethod": "GET", |
| 79 "id": "doubleclicksearch.conversion.get", |
| 80 "parameterOrder": [ |
| 81 "agencyId", |
| 82 "advertiserId", |
| 83 "engineAccountId", |
| 84 "endDate", |
| 85 "rowCount", |
| 86 "startDate", |
| 87 "startRow" |
| 88 ], |
| 89 "parameters": { |
| 90 "adGroupId": { |
| 91 "description": "Numeric ID of the ad group.", |
| 92 "format": "int64", |
| 93 "location": "query", |
| 94 "type": "string" |
| 95 }, |
| 96 "adId": { |
| 97 "description": "Numeric ID of the ad.", |
| 98 "format": "int64", |
| 99 "location": "query", |
| 100 "type": "string" |
| 101 }, |
| 102 "advertiserId": { |
| 103 "description": "Numeric ID of the advertiser.", |
| 104 "format": "int64", |
| 105 "location": "path", |
| 106 "required": true, |
| 107 "type": "string" |
| 108 }, |
| 109 "agencyId": { |
| 110 "description": "Numeric ID of the agency.", |
| 111 "format": "int64", |
| 112 "location": "path", |
| 113 "required": true, |
| 114 "type": "string" |
| 115 }, |
| 116 "campaignId": { |
| 117 "description": "Numeric ID of the campaign.", |
| 118 "format": "int64", |
| 119 "location": "query", |
| 120 "type": "string" |
| 121 }, |
| 122 "criterionId": { |
| 123 "description": "Numeric ID of the criterion.", |
| 124 "format": "int64", |
| 125 "location": "query", |
| 126 "type": "string" |
| 127 }, |
| 128 "endDate": { |
| 129 "description": "Last date (inclusive) on which to re
trieve conversions. Format is yyyymmdd.", |
| 130 "format": "int32", |
| 131 "location": "query", |
| 132 "maximum": "99991231", |
| 133 "minimum": "20091101", |
| 134 "required": true, |
| 135 "type": "integer" |
| 136 }, |
| 137 "engineAccountId": { |
| 138 "description": "Numeric ID of the engine account.", |
| 139 "format": "int64", |
| 140 "location": "path", |
| 141 "required": true, |
| 142 "type": "string" |
| 143 }, |
| 144 "rowCount": { |
| 145 "description": "The number of conversions to return
per call.", |
| 146 "format": "int32", |
| 147 "location": "query", |
| 148 "maximum": "1000", |
| 149 "minimum": "1", |
| 150 "required": true, |
| 151 "type": "integer" |
| 152 }, |
| 153 "startDate": { |
| 154 "description": "First date (inclusive) on which to r
etrieve conversions. Format is yyyymmdd.", |
| 155 "format": "int32", |
| 156 "location": "query", |
| 157 "maximum": "99991231", |
| 158 "minimum": "20091101", |
| 159 "required": true, |
| 160 "type": "integer" |
| 161 }, |
| 162 "startRow": { |
| 163 "description": "The 0-based starting index for retri
eving conversions results.", |
| 164 "format": "uint32", |
| 165 "location": "query", |
| 166 "required": true, |
| 167 "type": "integer" |
| 168 } |
| 169 }, |
| 170 "path": "agency/{agencyId}/advertiser/{advertiserId}/engine/
{engineAccountId}/conversion", |
| 171 "response": { |
| 172 "$ref": "ConversionList" |
| 173 }, |
| 174 "scopes": [ |
| 175 "https://www.googleapis.com/auth/doubleclicksearch" |
| 176 ] |
| 177 }, |
| 178 "insert": { |
| 179 "description": "Inserts a batch of new conversions into Doub
leClick Search.", |
| 180 "httpMethod": "POST", |
| 181 "id": "doubleclicksearch.conversion.insert", |
| 182 "path": "conversion", |
| 183 "request": { |
| 184 "$ref": "ConversionList" |
| 185 }, |
| 186 "response": { |
| 187 "$ref": "ConversionList" |
| 188 }, |
| 189 "scopes": [ |
| 190 "https://www.googleapis.com/auth/doubleclicksearch" |
| 191 ] |
| 192 }, |
| 193 "patch": { |
| 194 "description": "Updates a batch of conversions in DoubleClic
k Search. This method supports patch semantics.", |
| 195 "httpMethod": "PATCH", |
| 196 "id": "doubleclicksearch.conversion.patch", |
| 197 "parameterOrder": [ |
| 198 "advertiserId", |
| 199 "agencyId", |
| 200 "endDate", |
| 201 "engineAccountId", |
| 202 "rowCount", |
| 203 "startDate", |
| 204 "startRow" |
| 205 ], |
| 206 "parameters": { |
| 207 "advertiserId": { |
| 208 "description": "Numeric ID of the advertiser.", |
| 209 "format": "int64", |
| 210 "location": "query", |
| 211 "required": true, |
| 212 "type": "string" |
| 213 }, |
| 214 "agencyId": { |
| 215 "description": "Numeric ID of the agency.", |
| 216 "format": "int64", |
| 217 "location": "query", |
| 218 "required": true, |
| 219 "type": "string" |
| 220 }, |
| 221 "endDate": { |
| 222 "description": "Last date (inclusive) on which to re
trieve conversions. Format is yyyymmdd.", |
| 223 "format": "int32", |
| 224 "location": "query", |
| 225 "maximum": "99991231", |
| 226 "minimum": "20091101", |
| 227 "required": true, |
| 228 "type": "integer" |
| 229 }, |
| 230 "engineAccountId": { |
| 231 "description": "Numeric ID of the engine account.", |
| 232 "format": "int64", |
| 233 "location": "query", |
| 234 "required": true, |
| 235 "type": "string" |
| 236 }, |
| 237 "rowCount": { |
| 238 "description": "The number of conversions to return
per call.", |
| 239 "format": "int32", |
| 240 "location": "query", |
| 241 "maximum": "1000", |
| 242 "minimum": "1", |
| 243 "required": true, |
| 244 "type": "integer" |
| 245 }, |
| 246 "startDate": { |
| 247 "description": "First date (inclusive) on which to r
etrieve conversions. Format is yyyymmdd.", |
| 248 "format": "int32", |
| 249 "location": "query", |
| 250 "maximum": "99991231", |
| 251 "minimum": "20091101", |
| 252 "required": true, |
| 253 "type": "integer" |
| 254 }, |
| 255 "startRow": { |
| 256 "description": "The 0-based starting index for retri
eving conversions results.", |
| 257 "format": "uint32", |
| 258 "location": "query", |
| 259 "required": true, |
| 260 "type": "integer" |
| 261 } |
| 262 }, |
| 263 "path": "conversion", |
| 264 "request": { |
| 265 "$ref": "ConversionList" |
| 266 }, |
| 267 "response": { |
| 268 "$ref": "ConversionList" |
| 269 }, |
| 270 "scopes": [ |
| 271 "https://www.googleapis.com/auth/doubleclicksearch" |
| 272 ] |
| 273 }, |
| 274 "update": { |
| 275 "description": "Updates a batch of conversions in DoubleClic
k Search.", |
| 276 "httpMethod": "PUT", |
| 277 "id": "doubleclicksearch.conversion.update", |
| 278 "path": "conversion", |
| 279 "request": { |
| 280 "$ref": "ConversionList" |
| 281 }, |
| 282 "response": { |
| 283 "$ref": "ConversionList" |
| 284 }, |
| 285 "scopes": [ |
| 286 "https://www.googleapis.com/auth/doubleclicksearch" |
| 287 ] |
| 288 }, |
| 289 "updateAvailability": { |
| 290 "description": "Updates the availabilities of a batch of flo
odlight activities in DoubleClick Search.", |
| 291 "httpMethod": "POST", |
| 292 "id": "doubleclicksearch.conversion.updateAvailability", |
| 293 "path": "conversion/updateAvailability", |
| 294 "request": { |
| 295 "$ref": "UpdateAvailabilityRequest", |
| 296 "parameterName": "empty" |
| 297 }, |
| 298 "response": { |
| 299 "$ref": "UpdateAvailabilityResponse" |
| 300 }, |
| 301 "scopes": [ |
| 302 "https://www.googleapis.com/auth/doubleclicksearch" |
| 303 ] |
| 304 } |
| 305 } |
| 306 }, |
| 307 "reports": { |
| 308 "methods": { |
| 309 "generate": { |
| 310 "description": "Generates and returns a report immediately."
, |
| 311 "httpMethod": "POST", |
| 312 "id": "doubleclicksearch.reports.generate", |
| 313 "path": "reports/generate", |
| 314 "request": { |
| 315 "$ref": "ReportRequest", |
| 316 "parameterName": "reportRequest" |
| 317 }, |
| 318 "response": { |
| 319 "$ref": "Report" |
| 320 }, |
| 321 "scopes": [ |
| 322 "https://www.googleapis.com/auth/doubleclicksearch" |
| 323 ] |
| 324 }, |
| 325 "get": { |
| 326 "description": "Polls for the status of a report request.", |
| 327 "httpMethod": "GET", |
| 328 "id": "doubleclicksearch.reports.get", |
| 329 "parameterOrder": [ |
| 330 "reportId" |
| 331 ], |
| 332 "parameters": { |
| 333 "reportId": { |
| 334 "description": "ID of the report request being polle
d.", |
| 335 "location": "path", |
| 336 "required": true, |
| 337 "type": "string" |
| 338 } |
| 339 }, |
| 340 "path": "reports/{reportId}", |
| 341 "response": { |
| 342 "$ref": "Report" |
| 343 }, |
| 344 "scopes": [ |
| 345 "https://www.googleapis.com/auth/doubleclicksearch" |
| 346 ] |
| 347 }, |
| 348 "getFile": { |
| 349 "description": "Downloads a report file.", |
| 350 "httpMethod": "GET", |
| 351 "id": "doubleclicksearch.reports.getFile", |
| 352 "parameterOrder": [ |
| 353 "reportId", |
| 354 "reportFragment" |
| 355 ], |
| 356 "parameters": { |
| 357 "reportFragment": { |
| 358 "description": "The index of the report fragment to
download.", |
| 359 "format": "int32", |
| 360 "location": "path", |
| 361 "minimum": "0", |
| 362 "required": true, |
| 363 "type": "integer" |
| 364 }, |
| 365 "reportId": { |
| 366 "description": "ID of the report.", |
| 367 "location": "path", |
| 368 "required": true, |
| 369 "type": "string" |
| 370 } |
| 371 }, |
| 372 "path": "reports/{reportId}/files/{reportFragment}", |
| 373 "scopes": [ |
| 374 "https://www.googleapis.com/auth/doubleclicksearch" |
| 375 ], |
| 376 "supportsMediaDownload": true |
| 377 }, |
| 378 "request": { |
| 379 "description": "Inserts a report request into the reporting
system.", |
| 380 "httpMethod": "POST", |
| 381 "id": "doubleclicksearch.reports.request", |
| 382 "path": "reports", |
| 383 "request": { |
| 384 "$ref": "ReportRequest", |
| 385 "parameterName": "reportRequest" |
| 386 }, |
| 387 "response": { |
| 388 "$ref": "Report" |
| 389 }, |
| 390 "scopes": [ |
| 391 "https://www.googleapis.com/auth/doubleclicksearch" |
| 392 ] |
| 393 } |
| 394 } |
| 395 }, |
| 396 "savedColumns": { |
| 397 "methods": { |
| 398 "list": { |
| 399 "description": "Retrieve the list of saved columns for a spe
cified advertiser.", |
| 400 "httpMethod": "GET", |
| 401 "id": "doubleclicksearch.savedColumns.list", |
| 402 "parameterOrder": [ |
| 403 "agencyId", |
| 404 "advertiserId" |
| 405 ], |
| 406 "parameters": { |
| 407 "advertiserId": { |
| 408 "description": "DS ID of the advertiser.", |
| 409 "format": "int64", |
| 410 "location": "path", |
| 411 "required": true, |
| 412 "type": "string" |
| 413 }, |
| 414 "agencyId": { |
| 415 "description": "DS ID of the agency.", |
| 416 "format": "int64", |
| 417 "location": "path", |
| 418 "required": true, |
| 419 "type": "string" |
| 420 } |
| 421 }, |
| 422 "path": "agency/{agencyId}/advertiser/{advertiserId}/savedco
lumns", |
| 423 "response": { |
| 424 "$ref": "SavedColumnList" |
| 425 }, |
| 426 "scopes": [ |
| 427 "https://www.googleapis.com/auth/doubleclicksearch" |
| 428 ] |
| 429 } |
| 430 } |
| 431 } |
| 432 }, |
| 433 "revision": "20140903", |
| 434 "rootUrl": "https://www.googleapis.com/", |
| 435 "schemas": { |
| 436 "Availability": { |
| 437 "description": "A message containing availability data relevant to D
oubleClick Search.", |
| 438 "id": "Availability", |
| 439 "properties": { |
| 440 "advertiserId": { |
| 441 "annotations": { |
| 442 "required": [ |
| 443 "doubleclicksearch.conversion.updateAvailability" |
| 444 ] |
| 445 }, |
| 446 "description": "DS advertiser ID.", |
| 447 "format": "int64", |
| 448 "type": "string" |
| 449 }, |
| 450 "agencyId": { |
| 451 "annotations": { |
| 452 "required": [ |
| 453 "doubleclicksearch.conversion.updateAvailability" |
| 454 ] |
| 455 }, |
| 456 "description": "DS agency ID.", |
| 457 "format": "int64", |
| 458 "type": "string" |
| 459 }, |
| 460 "availabilityTimestamp": { |
| 461 "annotations": { |
| 462 "required": [ |
| 463 "doubleclicksearch.conversion.updateAvailability" |
| 464 ] |
| 465 }, |
| 466 "description": "The time by which all conversions have been
uploaded, in epoch millis UTC.", |
| 467 "format": "uint64", |
| 468 "type": "string" |
| 469 }, |
| 470 "segmentationId": { |
| 471 "description": "The numeric segmentation identifier (for exa
mple, DoubleClick Search Floodlight activity ID).", |
| 472 "format": "int64", |
| 473 "type": "string" |
| 474 }, |
| 475 "segmentationName": { |
| 476 "description": "The friendly segmentation identifier (for ex
ample, DoubleClick Search Floodlight activity name).", |
| 477 "type": "string" |
| 478 }, |
| 479 "segmentationType": { |
| 480 "annotations": { |
| 481 "required": [ |
| 482 "doubleclicksearch.conversion.updateAvailability" |
| 483 ] |
| 484 }, |
| 485 "description": "The segmentation type that this availability
is for (its default value is FLOODLIGHT).", |
| 486 "type": "string" |
| 487 } |
| 488 }, |
| 489 "type": "object" |
| 490 }, |
| 491 "Conversion": { |
| 492 "description": "A conversion containing data relevant to DoubleClick
Search.", |
| 493 "id": "Conversion", |
| 494 "properties": { |
| 495 "adGroupId": { |
| 496 "description": "DS ad group ID.", |
| 497 "format": "int64", |
| 498 "type": "string" |
| 499 }, |
| 500 "adId": { |
| 501 "description": "DS ad ID.", |
| 502 "format": "int64", |
| 503 "type": "string" |
| 504 }, |
| 505 "advertiserId": { |
| 506 "description": "DS advertiser ID.", |
| 507 "format": "int64", |
| 508 "type": "string" |
| 509 }, |
| 510 "agencyId": { |
| 511 "description": "DS agency ID.", |
| 512 "format": "int64", |
| 513 "type": "string" |
| 514 }, |
| 515 "campaignId": { |
| 516 "description": "DS campaign ID.", |
| 517 "format": "int64", |
| 518 "type": "string" |
| 519 }, |
| 520 "clickId": { |
| 521 "description": "DS click ID for the conversion.", |
| 522 "type": "string" |
| 523 }, |
| 524 "conversionId": { |
| 525 "annotations": { |
| 526 "required": [ |
| 527 "doubleclicksearch.conversion.insert" |
| 528 ] |
| 529 }, |
| 530 "description": "Advertiser-provided ID for the conversion, a
lso known as the order ID.", |
| 531 "type": "string" |
| 532 }, |
| 533 "conversionModifiedTimestamp": { |
| 534 "description": "The time at which the conversion was last mo
dified, in epoch millis UTC.", |
| 535 "format": "uint64", |
| 536 "type": "string" |
| 537 }, |
| 538 "conversionTimestamp": { |
| 539 "annotations": { |
| 540 "required": [ |
| 541 "doubleclicksearch.conversion.insert" |
| 542 ] |
| 543 }, |
| 544 "description": "The time at which the conversion took place,
in epoch millis UTC.", |
| 545 "format": "uint64", |
| 546 "type": "string" |
| 547 }, |
| 548 "criterionId": { |
| 549 "description": "DS criterion (keyword) ID.", |
| 550 "format": "int64", |
| 551 "type": "string" |
| 552 }, |
| 553 "currencyCode": { |
| 554 "description": "The currency code for the conversion's reven
ue. Should be in ISO 4217 alphabetic (3-char) format.", |
| 555 "type": "string" |
| 556 }, |
| 557 "customDimension": { |
| 558 "description": "Custom dimensions for the conversion, which
can be used to filter data in a report.", |
| 559 "items": { |
| 560 "$ref": "CustomDimension" |
| 561 }, |
| 562 "type": "array" |
| 563 }, |
| 564 "customMetric": { |
| 565 "description": "Custom metrics for the conversion.", |
| 566 "items": { |
| 567 "$ref": "CustomMetric" |
| 568 }, |
| 569 "type": "array" |
| 570 }, |
| 571 "dsConversionId": { |
| 572 "description": "DS conversion ID.", |
| 573 "format": "int64", |
| 574 "type": "string" |
| 575 }, |
| 576 "engineAccountId": { |
| 577 "description": "DS engine account ID.", |
| 578 "format": "int64", |
| 579 "type": "string" |
| 580 }, |
| 581 "floodlightOrderId": { |
| 582 "description": "The advertiser-provided order id for the con
version.", |
| 583 "type": "string" |
| 584 }, |
| 585 "quantityMillis": { |
| 586 "description": "The quantity of this conversion, in millis."
, |
| 587 "format": "int64", |
| 588 "type": "string" |
| 589 }, |
| 590 "revenueMicros": { |
| 591 "description": "The revenue amount of this TRANSACTION conve
rsion, in micros.", |
| 592 "format": "int64", |
| 593 "type": "string" |
| 594 }, |
| 595 "segmentationId": { |
| 596 "description": "The numeric segmentation identifier (for exa
mple, DoubleClick Search Floodlight activity ID).", |
| 597 "format": "int64", |
| 598 "type": "string" |
| 599 }, |
| 600 "segmentationName": { |
| 601 "description": "The friendly segmentation identifier (for ex
ample, DoubleClick Search Floodlight activity name).", |
| 602 "type": "string" |
| 603 }, |
| 604 "segmentationType": { |
| 605 "annotations": { |
| 606 "required": [ |
| 607 "doubleclicksearch.conversion.insert" |
| 608 ] |
| 609 }, |
| 610 "description": "The segmentation type of this conversion (fo
r example, FLOODLIGHT).", |
| 611 "type": "string" |
| 612 }, |
| 613 "state": { |
| 614 "description": "The state of the conversion, that is, either
ACTIVE or DELETED.", |
| 615 "type": "string" |
| 616 }, |
| 617 "type": { |
| 618 "description": "The type of the conversion, that is, either
ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no
monetarily quantifiable value, while a TRANSACTION conversion is an action that
does have a monetarily quantifiable value. Examples are email list signups (ACT
ION) versus ecommerce purchases (TRANSACTION).", |
| 619 "type": "string" |
| 620 } |
| 621 }, |
| 622 "type": "object" |
| 623 }, |
| 624 "ConversionList": { |
| 625 "description": "A list of conversions.", |
| 626 "id": "ConversionList", |
| 627 "properties": { |
| 628 "conversion": { |
| 629 "description": "The conversions being requested.", |
| 630 "items": { |
| 631 "$ref": "Conversion" |
| 632 }, |
| 633 "type": "array" |
| 634 }, |
| 635 "kind": { |
| 636 "default": "doubleclicksearch#conversionList", |
| 637 "description": "Identifies this as a ConversionList resource
. Value: the fixed string doubleclicksearch#conversionList.", |
| 638 "type": "string" |
| 639 } |
| 640 }, |
| 641 "type": "object" |
| 642 }, |
| 643 "CustomDimension": { |
| 644 "description": "A message containing the custome dimension.", |
| 645 "id": "CustomDimension", |
| 646 "properties": { |
| 647 "name": { |
| 648 "description": "Custom dimension name.", |
| 649 "type": "string" |
| 650 }, |
| 651 "value": { |
| 652 "description": "Custom dimension value.", |
| 653 "type": "string" |
| 654 } |
| 655 }, |
| 656 "type": "object" |
| 657 }, |
| 658 "CustomMetric": { |
| 659 "description": "A message containing the custome metric.", |
| 660 "id": "CustomMetric", |
| 661 "properties": { |
| 662 "name": { |
| 663 "description": "Custom metric name.", |
| 664 "type": "string" |
| 665 }, |
| 666 "value": { |
| 667 "description": "Custom metric numeric value.", |
| 668 "format": "double", |
| 669 "type": "number" |
| 670 } |
| 671 }, |
| 672 "type": "object" |
| 673 }, |
| 674 "Report": { |
| 675 "description": "A DoubleClick Search report. This object contains th
e report request, some report metadata such as currency code, and the generated
report rows or report files.", |
| 676 "id": "Report", |
| 677 "properties": { |
| 678 "files": { |
| 679 "description": "Asynchronous report only. Contains a list of
generated report files once the report has succesfully completed.", |
| 680 "items": { |
| 681 "properties": { |
| 682 "byteCount": { |
| 683 "description": "The size of this report file in
bytes.", |
| 684 "format": "int64", |
| 685 "type": "string" |
| 686 }, |
| 687 "url": { |
| 688 "description": "Use this url to download the rep
ort file.", |
| 689 "type": "string" |
| 690 } |
| 691 }, |
| 692 "type": "object" |
| 693 }, |
| 694 "type": "array" |
| 695 }, |
| 696 "id": { |
| 697 "description": "Asynchronous report only. Id of the report."
, |
| 698 "type": "string" |
| 699 }, |
| 700 "isReportReady": { |
| 701 "description": "Asynchronous report only. True if and only i
f the report has completed successfully and the report files are ready to be dow
nloaded.", |
| 702 "type": "boolean" |
| 703 }, |
| 704 "kind": { |
| 705 "default": "doubleclicksearch#report", |
| 706 "description": "Identifies this as a Report resource. Value:
the fixed string doubleclicksearch#report.", |
| 707 "type": "string" |
| 708 }, |
| 709 "request": { |
| 710 "$ref": "ReportRequest", |
| 711 "description": "The request that created the report. Optiona
l fields not specified in the original request are filled with default values." |
| 712 }, |
| 713 "rowCount": { |
| 714 "description": "The number of report rows generated by the r
eport, not including headers.", |
| 715 "format": "int32", |
| 716 "type": "integer" |
| 717 }, |
| 718 "rows": { |
| 719 "description": "Synchronous report only. Generated report ro
ws.", |
| 720 "items": { |
| 721 "$ref": "ReportRow" |
| 722 }, |
| 723 "type": "array" |
| 724 }, |
| 725 "statisticsCurrencyCode": { |
| 726 "description": "The currency code of all monetary values pro
duced in the report, including values that are set by users (e.g., keyword bid s
ettings) and metrics (e.g., cost and revenue). The currency code of a report is
determined by the statisticsCurrency field of the report request.", |
| 727 "type": "string" |
| 728 }, |
| 729 "statisticsTimeZone": { |
| 730 "description": "If all statistics of the report are sourced
from the same time zone, this would be it. Otherwise the field is unset.", |
| 731 "type": "string" |
| 732 } |
| 733 }, |
| 734 "type": "object" |
| 735 }, |
| 736 "ReportApiColumnSpec": { |
| 737 "description": "A request object used to create a DoubleClick Search
report.", |
| 738 "id": "ReportApiColumnSpec", |
| 739 "properties": { |
| 740 "columnName": { |
| 741 "description": "Name of a DoubleClick Search column to inclu
de in the report.", |
| 742 "type": "string" |
| 743 }, |
| 744 "customDimensionName": { |
| 745 "description": "Segments a report by a custom dimension. The
report must be scoped to an advertiser or lower, and the custom dimension must
already be set up in DoubleClick Search. The custom dimension name, which appear
s in DoubleClick Search, is case sensitive.", |
| 746 "type": "string" |
| 747 }, |
| 748 "endDate": { |
| 749 "description": "Inclusive day in YYYY-MM-DD format. When pro
vided, this overrides the overall time range of the report for this column only.
Must be provided together with startDate.", |
| 750 "type": "string" |
| 751 }, |
| 752 "groupByColumn": { |
| 753 "default": "false", |
| 754 "description": "Synchronous report only. Set to true to grou
p by this column. Defaults to false.", |
| 755 "type": "boolean" |
| 756 }, |
| 757 "headerText": { |
| 758 "description": "Text used to identify this column in the rep
ort output; defaults to columnName or savedColumnName when not specified. This c
an be used to prevent collisions between DoubleClick Search columns and saved co
lumns with the same name.", |
| 759 "type": "string" |
| 760 }, |
| 761 "platformSource": { |
| 762 "description": "The platform that is used to provide data fo
r the custom dimension. Acceptable values are \"Floodlight\".", |
| 763 "type": "string" |
| 764 }, |
| 765 "savedColumnName": { |
| 766 "description": "Name of a saved column to include in the rep
ort. The report must be scoped at advertiser or lower, and this saved column mus
t already be created in the DoubleClick Search UI.", |
| 767 "type": "string" |
| 768 }, |
| 769 "startDate": { |
| 770 "description": "Inclusive date in YYYY-MM-DD format. When pr
ovided, this overrides the overall time range of the report for this column only
. Must be provided together with endDate.", |
| 771 "type": "string" |
| 772 } |
| 773 }, |
| 774 "type": "object" |
| 775 }, |
| 776 "ReportRequest": { |
| 777 "description": "A request object used to create a DoubleClick Search
report.", |
| 778 "id": "ReportRequest", |
| 779 "properties": { |
| 780 "columns": { |
| 781 "description": "The columns to include in the report. This i
ncludes both DoubleClick Search columns and saved columns. For DoubleClick Searc
h columns, only the columnName parameter is required. For saved columns only the
savedColumnName parameter is required. Both columnName and savedColumnName cann
ot be set in the same stanza.", |
| 782 "items": { |
| 783 "$ref": "ReportApiColumnSpec" |
| 784 }, |
| 785 "type": "array" |
| 786 }, |
| 787 "downloadFormat": { |
| 788 "annotations": { |
| 789 "required": [ |
| 790 "doubleclicksearch.reports.request" |
| 791 ] |
| 792 }, |
| 793 "description": "Format that the report should be returned in
. Currently csv or tsv is supported.", |
| 794 "type": "string" |
| 795 }, |
| 796 "filters": { |
| 797 "description": "A list of filters to be applied to the repor
t.", |
| 798 "items": { |
| 799 "properties": { |
| 800 "column": { |
| 801 "$ref": "ReportApiColumnSpec", |
| 802 "description": "Column to perform the filter on.
This can be a DoubleClick Search column or a saved column." |
| 803 }, |
| 804 "operator": { |
| 805 "description": "Operator to use in the filter. S
ee the filter reference for a list of available operators.", |
| 806 "type": "string" |
| 807 }, |
| 808 "values": { |
| 809 "description": "A list of values to filter the c
olumn value against.", |
| 810 "items": { |
| 811 "type": "any" |
| 812 }, |
| 813 "type": "array" |
| 814 } |
| 815 }, |
| 816 "type": "object" |
| 817 }, |
| 818 "type": "array" |
| 819 }, |
| 820 "includeDeletedEntities": { |
| 821 "default": "false", |
| 822 "description": "Determines if removed entities should be inc
luded in the report. Defaults to false. Deprecated, please use includeRemovedEnt
ities instead.", |
| 823 "type": "boolean" |
| 824 }, |
| 825 "includeRemovedEntities": { |
| 826 "default": "false", |
| 827 "description": "Determines if removed entities should be inc
luded in the report. Defaults to false.", |
| 828 "type": "boolean" |
| 829 }, |
| 830 "maxRowsPerFile": { |
| 831 "annotations": { |
| 832 "required": [ |
| 833 "doubleclicksearch.reports.request" |
| 834 ] |
| 835 }, |
| 836 "description": "Asynchronous report only. The maximum number
of rows per report file. A large report is split into many files based on this
field. Acceptable values are 1000000 to 100000000, inclusive.", |
| 837 "format": "int32", |
| 838 "maximum": "100000000", |
| 839 "minimum": "1000000", |
| 840 "type": "integer" |
| 841 }, |
| 842 "orderBy": { |
| 843 "description": "Synchronous report only. A list of columns a
nd directions defining sorting to be performed on the report rows.", |
| 844 "items": { |
| 845 "properties": { |
| 846 "column": { |
| 847 "$ref": "ReportApiColumnSpec", |
| 848 "description": "Column to perform the sort on. T
his can be a DoubleClick Search-defined column or a saved column." |
| 849 }, |
| 850 "sortOrder": { |
| 851 "description": "The sort direction, which is eit
her ascending or descending.", |
| 852 "type": "string" |
| 853 } |
| 854 }, |
| 855 "type": "object" |
| 856 }, |
| 857 "type": "array" |
| 858 }, |
| 859 "reportScope": { |
| 860 "description": "The reportScope is a set of IDs that are use
d to determine which subset of entities will be returned in the report. The full
lineage of IDs from the lowest scoped level desired up through agency is requir
ed.", |
| 861 "properties": { |
| 862 "adGroupId": { |
| 863 "description": "DS ad group ID.", |
| 864 "format": "int64", |
| 865 "type": "string" |
| 866 }, |
| 867 "adId": { |
| 868 "description": "DS ad ID.", |
| 869 "format": "int64", |
| 870 "type": "string" |
| 871 }, |
| 872 "advertiserId": { |
| 873 "description": "DS advertiser ID.", |
| 874 "format": "int64", |
| 875 "type": "string" |
| 876 }, |
| 877 "agencyId": { |
| 878 "description": "DS agency ID.", |
| 879 "format": "int64", |
| 880 "type": "string" |
| 881 }, |
| 882 "campaignId": { |
| 883 "description": "DS campaign ID.", |
| 884 "format": "int64", |
| 885 "type": "string" |
| 886 }, |
| 887 "engineAccountId": { |
| 888 "description": "DS engine account ID.", |
| 889 "format": "int64", |
| 890 "type": "string" |
| 891 }, |
| 892 "keywordId": { |
| 893 "description": "DS keyword ID.", |
| 894 "format": "int64", |
| 895 "type": "string" |
| 896 } |
| 897 }, |
| 898 "type": "object" |
| 899 }, |
| 900 "reportType": { |
| 901 "annotations": { |
| 902 "required": [ |
| 903 "doubleclicksearch.reports.generate", |
| 904 "doubleclicksearch.reports.request" |
| 905 ] |
| 906 }, |
| 907 "description": "Determines the type of rows that are returne
d in the report. For example, if you specify reportType: keyword, each row in th
e report will contain data about a keyword. See the Types of Reports reference f
or the columns that are available for each type.", |
| 908 "type": "string" |
| 909 }, |
| 910 "rowCount": { |
| 911 "annotations": { |
| 912 "required": [ |
| 913 "doubleclicksearch.reports.generate" |
| 914 ] |
| 915 }, |
| 916 "default": "10000", |
| 917 "description": "Synchronous report only. The maxinum number
of rows to return; additional rows are dropped. Acceptable values are 0 to 10000
, inclusive. Defaults to 10000.", |
| 918 "format": "int32", |
| 919 "maximum": "10000", |
| 920 "minimum": "0", |
| 921 "type": "integer" |
| 922 }, |
| 923 "startRow": { |
| 924 "annotations": { |
| 925 "required": [ |
| 926 "doubleclicksearch.reports.generate" |
| 927 ] |
| 928 }, |
| 929 "default": "0", |
| 930 "description": "Synchronous report only. Zero-based index of
the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults
to 0.", |
| 931 "format": "int32", |
| 932 "maximum": "50000", |
| 933 "minimum": "0", |
| 934 "type": "integer" |
| 935 }, |
| 936 "statisticsCurrency": { |
| 937 "annotations": { |
| 938 "required": [ |
| 939 "doubleclicksearch.reports.generate", |
| 940 "doubleclicksearch.reports.request" |
| 941 ] |
| 942 }, |
| 943 "description": "Specifies the currency in which monetary wil
l be returned. Possible values are: usd, agency (valid if the report is scoped t
o agency or lower), advertiser (valid if the report is scoped to * advertiser or
lower), or account (valid if the report is scoped to engine account or lower)."
, |
| 944 "type": "string" |
| 945 }, |
| 946 "timeRange": { |
| 947 "description": "If metrics are requested in a report, this a
rgument will be used to restrict the metrics to a specific time range.", |
| 948 "properties": { |
| 949 "changedAttributesSinceTimestamp": { |
| 950 "description": "Inclusive UTC timestamp in RFC forma
t, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attr
ibute reports work.", |
| 951 "format": "date-time", |
| 952 "type": "string" |
| 953 }, |
| 954 "changedMetricsSinceTimestamp": { |
| 955 "description": "Inclusive UTC timestamp in RFC forma
t, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metr
ics reports work.", |
| 956 "format": "date-time", |
| 957 "type": "string" |
| 958 }, |
| 959 "endDate": { |
| 960 "description": "Inclusive date in YYYY-MM-DD format.
", |
| 961 "type": "string" |
| 962 }, |
| 963 "startDate": { |
| 964 "description": "Inclusive date in YYYY-MM-DD format.
", |
| 965 "type": "string" |
| 966 } |
| 967 }, |
| 968 "type": "object" |
| 969 }, |
| 970 "verifySingleTimeZone": { |
| 971 "default": "false", |
| 972 "description": "If true, the report would only be created if
all the requested stat data are sourced from a single timezone. Defaults to fal
se.", |
| 973 "type": "boolean" |
| 974 } |
| 975 }, |
| 976 "type": "object" |
| 977 }, |
| 978 "ReportRow": { |
| 979 "additionalProperties": { |
| 980 "description": "Indicates the columns that are represented in th
is row. That is, each key corresponds to a column with a non-empty cell in this
row.", |
| 981 "type": "any" |
| 982 }, |
| 983 "description": "A row in a DoubleClick Search report.", |
| 984 "id": "ReportRow", |
| 985 "type": "object" |
| 986 }, |
| 987 "SavedColumn": { |
| 988 "description": "A saved column", |
| 989 "id": "SavedColumn", |
| 990 "properties": { |
| 991 "kind": { |
| 992 "default": "doubleclicksearch#savedColumn", |
| 993 "description": "Identifies this as a SavedColumn resource. V
alue: the fixed string doubleclicksearch#savedColumn.", |
| 994 "type": "string" |
| 995 }, |
| 996 "savedColumnName": { |
| 997 "description": "The name of the saved column.", |
| 998 "type": "string" |
| 999 }, |
| 1000 "type": { |
| 1001 "description": "The type of data this saved column will prod
uce.", |
| 1002 "type": "string" |
| 1003 } |
| 1004 }, |
| 1005 "type": "object" |
| 1006 }, |
| 1007 "SavedColumnList": { |
| 1008 "description": "A list of saved columns. Advertisers create saved co
lumns to report on Floodlight activities, Google Analytics goals, or custom KPIs
. To request reports with saved columns, you'll need the saved column names that
are available from this list.", |
| 1009 "id": "SavedColumnList", |
| 1010 "properties": { |
| 1011 "items": { |
| 1012 "description": "The saved columns being requested.", |
| 1013 "items": { |
| 1014 "$ref": "SavedColumn" |
| 1015 }, |
| 1016 "type": "array" |
| 1017 }, |
| 1018 "kind": { |
| 1019 "default": "doubleclicksearch#savedColumnList", |
| 1020 "description": "Identifies this as a SavedColumnList resourc
e. Value: the fixed string doubleclicksearch#savedColumnList.", |
| 1021 "type": "string" |
| 1022 } |
| 1023 }, |
| 1024 "type": "object" |
| 1025 }, |
| 1026 "UpdateAvailabilityRequest": { |
| 1027 "description": "The request to update availability.", |
| 1028 "id": "UpdateAvailabilityRequest", |
| 1029 "properties": { |
| 1030 "availabilities": { |
| 1031 "description": "The availabilities being requested.", |
| 1032 "items": { |
| 1033 "$ref": "Availability" |
| 1034 }, |
| 1035 "type": "array" |
| 1036 } |
| 1037 }, |
| 1038 "type": "object" |
| 1039 }, |
| 1040 "UpdateAvailabilityResponse": { |
| 1041 "description": "The response to a update availability request.", |
| 1042 "id": "UpdateAvailabilityResponse", |
| 1043 "properties": { |
| 1044 "availabilities": { |
| 1045 "description": "The availabilities being returned.", |
| 1046 "items": { |
| 1047 "$ref": "Availability" |
| 1048 }, |
| 1049 "type": "array" |
| 1050 } |
| 1051 }, |
| 1052 "type": "object" |
| 1053 } |
| 1054 }, |
| 1055 "servicePath": "doubleclicksearch/v2/", |
| 1056 "title": "DoubleClick Search API", |
| 1057 "version": "v2" |
| 1058 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 559053002:
Generate 0.1.0 version of googleapis/googleapis_beta (Closed)
Base URL: git@github.com:dart-lang/googleapis.git@master