Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 10f4b6752011a154f041ca69907b4e7ffb5a9050 / . / googleapiclient / discovery_cache / documents / doubleclickbidmanager.v1.json
blob: 47bc9a40f43d96641a6be5ed900431200863f784 [file] [log] [blame]
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1{
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/doubleclickbidmanager": {
6 "description": "View and manage your reports in DoubleClick Bid Manager"
7 }
8 }
9 }
10 },
11 "basePath": "/doubleclickbidmanager/v1/",
12 "baseUrl": "https://doubleclickbidmanager.googleapis.com/doubleclickbidmanager/v1/",
13 "batchPath": "batch",
14 "canonicalName": "DoubleClick Bid Manager",
15 "description": "DoubleClick Bid Manager API allows users to manage and create campaigns and reports.",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://developers.google.com/bid-manager/",
18 "fullyEncodeReservedExpansion": true,
19 "icons": {
20 "x16": "http://www.google.com/images/icons/product/search-16.gif",
21 "x32": "http://www.google.com/images/icons/product/search-32.gif"
22 },
23 "id": "doubleclickbidmanager:v1",
24 "kind": "discovery#restDescription",
25 "mtlsRootUrl": "https://doubleclickbidmanager.mtls.googleapis.com/",
26 "name": "doubleclickbidmanager",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]27 "ownerDomain": "google.com",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]28 "ownerName": "Google",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]29 "parameters": {
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]30 "$.xgafv": {
31 "description": "V1 error format.",
32 "enum": [
33 "1",
34 "2"
35 ],
36 "enumDescriptions": [
37 "v1 error format",
38 "v2 error format"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]48 "alt": {
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]49 "default": "json",
50 "description": "Data format for response.",
51 "enum": [
52 "json",
53 "media",
54 "proto"
55 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]56 "enumDescriptions": [
57 "Responses with Content-Type of application/json",
58 "Media download with context-dependent Content-Type",
59 "Responses with Content-Type of application/x-protobuf"
60 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]61 "location": "query",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]62 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]63 },
64 "callback": {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]65 "description": "JSONP",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]66 "location": "query",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]67 "type": "string"
68 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]69 "fields": {
70 "description": "Selector specifying which fields to include in a partial response.",
71 "location": "query",
72 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]81 "location": "query",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]82 "type": "string"
83 },
84 "prettyPrint": {
85 "default": "true",
86 "description": "Returns response with indentations and line breaks.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "quotaUser": {
91 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
92 "location": "query",
93 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]94 },
95 "uploadType": {
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]96 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]97 "location": "query",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]98 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]99 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]100 "upload_protocol": {
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]102 "location": "query",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]103 "type": "string"
104 }
105 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]106 "protocol": "rest",
107 "resources": {
108 "lineitems": {
109 "methods": {
110 "downloadlineitems": {
111 "description": "Retrieves line items in CSV format. YouTube & partners line items are not supported.",
112 "flatPath": "lineitems/downloadlineitems",
113 "httpMethod": "POST",
114 "id": "doubleclickbidmanager.lineitems.downloadlineitems",
115 "parameterOrder": [],
116 "parameters": {},
117 "path": "lineitems/downloadlineitems",
118 "request": {
119 "$ref": "DownloadLineItemsRequest"
120 },
121 "response": {
122 "$ref": "DownloadLineItemsResponse"
123 },
124 "scopes": [
125 "https://www.googleapis.com/auth/doubleclickbidmanager"
126 ]
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]127 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]128 "uploadlineitems": {
129 "description": "Uploads line items in CSV format. YouTube & partners line items are not supported.",
130 "flatPath": "lineitems/uploadlineitems",
131 "httpMethod": "POST",
132 "id": "doubleclickbidmanager.lineitems.uploadlineitems",
133 "parameterOrder": [],
134 "parameters": {},
135 "path": "lineitems/uploadlineitems",
136 "request": {
137 "$ref": "UploadLineItemsRequest"
138 },
139 "response": {
140 "$ref": "UploadLineItemsResponse"
141 },
142 "scopes": [
143 "https://www.googleapis.com/auth/doubleclickbidmanager"
144 ]
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]145 }
146 }
147 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]148 "queries": {
149 "methods": {
150 "createquery": {
151 "description": "Creates a query.",
152 "flatPath": "query",
153 "httpMethod": "POST",
154 "id": "doubleclickbidmanager.queries.createquery",
155 "parameterOrder": [],
156 "parameters": {},
157 "path": "query",
158 "request": {
159 "$ref": "Query"
160 },
161 "response": {
162 "$ref": "Query"
163 },
164 "scopes": [
165 "https://www.googleapis.com/auth/doubleclickbidmanager"
166 ]
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]167 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]168 "deletequery": {
169 "description": "Deletes a stored query as well as the associated stored reports.",
170 "flatPath": "query/{queryId}",
171 "httpMethod": "DELETE",
172 "id": "doubleclickbidmanager.queries.deletequery",
173 "parameterOrder": [
174 "queryId"
175 ],
176 "parameters": {
177 "queryId": {
178 "description": "Query ID to delete.",
179 "format": "int64",
180 "location": "path",
181 "required": true,
182 "type": "string"
183 }
184 },
185 "path": "query/{queryId}",
186 "scopes": [
187 "https://www.googleapis.com/auth/doubleclickbidmanager"
188 ]
189 },
190 "getquery": {
191 "description": "Retrieves a stored query.",
192 "flatPath": "query/{queryId}",
193 "httpMethod": "GET",
194 "id": "doubleclickbidmanager.queries.getquery",
195 "parameterOrder": [
196 "queryId"
197 ],
198 "parameters": {
199 "queryId": {
200 "description": "Query ID to retrieve.",
201 "format": "int64",
202 "location": "path",
203 "required": true,
204 "type": "string"
205 }
206 },
207 "path": "query/{queryId}",
208 "response": {
209 "$ref": "Query"
210 },
211 "scopes": [
212 "https://www.googleapis.com/auth/doubleclickbidmanager"
213 ]
214 },
215 "listqueries": {
216 "description": "Retrieves stored queries.",
217 "flatPath": "queries",
218 "httpMethod": "GET",
219 "id": "doubleclickbidmanager.queries.listqueries",
220 "parameterOrder": [],
221 "parameters": {},
222 "path": "queries",
223 "response": {
224 "$ref": "ListQueriesResponse"
225 },
226 "scopes": [
227 "https://www.googleapis.com/auth/doubleclickbidmanager"
228 ]
229 },
230 "runquery": {
231 "description": "Runs a stored query to generate a report.",
232 "flatPath": "query/{queryId}",
233 "httpMethod": "POST",
234 "id": "doubleclickbidmanager.queries.runquery",
235 "parameterOrder": [
236 "queryId"
237 ],
238 "parameters": {
239 "queryId": {
240 "description": "Query ID to run.",
241 "format": "int64",
242 "location": "path",
243 "required": true,
244 "type": "string"
245 }
246 },
247 "path": "query/{queryId}",
248 "request": {
249 "$ref": "RunQueryRequest"
250 },
251 "scopes": [
252 "https://www.googleapis.com/auth/doubleclickbidmanager"
253 ]
254 }
255 }
256 },
257 "reports": {
258 "methods": {
259 "listreports": {
260 "description": "Retrieves stored reports.",
261 "flatPath": "queries/{queryId}/reports",
262 "httpMethod": "GET",
263 "id": "doubleclickbidmanager.reports.listreports",
264 "parameterOrder": [
265 "queryId"
266 ],
267 "parameters": {
268 "queryId": {
269 "description": "Query ID with which the reports are associated.",
270 "format": "int64",
271 "location": "path",
272 "required": true,
273 "type": "string"
274 }
275 },
276 "path": "queries/{queryId}/reports",
277 "response": {
278 "$ref": "ListReportsResponse"
279 },
280 "scopes": [
281 "https://www.googleapis.com/auth/doubleclickbidmanager"
282 ]
283 }
284 }
285 },
286 "sdf": {
287 "methods": {
288 "download": {
289 "description": "Retrieves entities in SDF format.",
290 "flatPath": "sdf/download",
291 "httpMethod": "POST",
292 "id": "doubleclickbidmanager.sdf.download",
293 "parameterOrder": [],
294 "parameters": {},
295 "path": "sdf/download",
296 "request": {
297 "$ref": "DownloadRequest"
298 },
299 "response": {
300 "$ref": "DownloadResponse"
301 },
302 "scopes": [
303 "https://www.googleapis.com/auth/doubleclickbidmanager"
304 ]
305 }
306 }
307 }
308 },
309 "revision": "20210331",
310 "rootUrl": "https://doubleclickbidmanager.googleapis.com/",
311 "schemas": {
312 "DownloadLineItemsRequest": {
313 "description": "Request to fetch stored line items.",
314 "id": "DownloadLineItemsRequest",
315 "properties": {
316 "fileSpec": {
317 "description": "File specification (column names, types, order) in which the line items will be returned. Default to EWF.",
318 "enum": [
319 "EWF"
320 ],
321 "enumDescriptions": [
322 ""
323 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]324 "type": "string"
325 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]326 "filterIds": {
327 "description": "Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned.",
328 "items": {
329 "format": "int64",
330 "type": "string"
331 },
332 "type": "array"
333 },
334 "filterType": {
335 "description": "Filter type used to filter line items to fetch.",
336 "enum": [
337 "ADVERTISER_ID",
338 "INSERTION_ORDER_ID",
339 "LINE_ITEM_ID"
340 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]341 "enumDescriptions": [
342 "",
343 "",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]344 ""
345 ],
346 "type": "string"
347 },
348 "format": {
349 "description": "Format in which the line items will be returned. Default to CSV.",
350 "enum": [
351 "CSV"
352 ],
353 "enumDescriptions": [
354 ""
355 ],
356 "type": "string"
357 }
358 },
359 "type": "object"
360 },
361 "DownloadLineItemsResponse": {
362 "description": "Download line items response.",
363 "id": "DownloadLineItemsResponse",
364 "properties": {
365 "lineItems": {
366 "description": "Retrieved line items in CSV format. For more information about file formats, see Entity Write File Format.",
367 "type": "string"
368 }
369 },
370 "type": "object"
371 },
372 "DownloadRequest": {
373 "description": "Request to fetch stored inventory sources, campaigns, insertion orders, line items, YouTube ad groups and ads.",
374 "id": "DownloadRequest",
375 "properties": {
376 "fileTypes": {
377 "description": "File types that will be returned. If INVENTORY_SOURCE is requested, no other file types may be requested. Acceptable values are: - \"AD\" - \"AD_GROUP\" - \"CAMPAIGN\" - \"INSERTION_ORDER\" - \"INVENTORY_SOURCE\" - \"LINE_ITEM\" ",
378 "items": {
379 "enum": [
380 "INSERTION_ORDER",
381 "LINE_ITEM",
382 "AD_GROUP",
383 "AD",
384 "CAMPAIGN",
385 "INVENTORY_SOURCE"
386 ],
387 "enumDescriptions": [
388 "",
389 "",
390 "",
391 "",
392 "",
393 ""
394 ],
395 "type": "string"
396 },
397 "type": "array"
398 },
399 "filterIds": {
400 "description": "The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified.",
401 "items": {
402 "format": "int64",
403 "type": "string"
404 },
405 "type": "array"
406 },
407 "filterType": {
408 "description": "Filter type used to filter entities to fetch. PARTNER_ID and INVENTORY_SOURCE_ID may only be used when downloading inventory sources.",
409 "enum": [
410 "ADVERTISER_ID",
411 "INSERTION_ORDER_ID",
412 "LINE_ITEM_ID",
413 "CAMPAIGN_ID",
414 "INVENTORY_SOURCE_ID",
415 "PARTNER_ID"
416 ],
417 "enumDescriptions": [
418 "",
419 "",
420 "",
421 "",
422 "",
423 ""
424 ],
425 "type": "string"
426 },
427 "version": {
428 "description": "SDF Version (column names, types, order) in which the entities will be returned. Default to 5.",
429 "type": "string"
430 }
431 },
432 "type": "object"
433 },
434 "DownloadResponse": {
435 "description": "Download response.",
436 "id": "DownloadResponse",
437 "properties": {
438 "adGroups": {
439 "description": "Retrieved ad groups in SDF format.",
440 "type": "string"
441 },
442 "ads": {
443 "description": "Retrieved ads in SDF format.",
444 "type": "string"
445 },
446 "campaigns": {
447 "description": "Retrieved campaigns in SDF format.",
448 "type": "string"
449 },
450 "insertionOrders": {
451 "description": "Retrieved insertion orders in SDF format.",
452 "type": "string"
453 },
454 "inventorySources": {
455 "type": "string"
456 },
457 "lineItems": {
458 "description": "Retrieved line items in SDF format.",
459 "type": "string"
460 }
461 },
462 "type": "object"
463 },
464 "FilterPair": {
465 "description": "Filter used to match traffic data in your report.",
466 "id": "FilterPair",
467 "properties": {
468 "type": {
469 "description": "Filter type.",
470 "enum": [
471 "FILTER_UNKNOWN",
472 "FILTER_DATE",
473 "FILTER_DAY_OF_WEEK",
474 "FILTER_WEEK",
475 "FILTER_MONTH",
476 "FILTER_YEAR",
477 "FILTER_TIME_OF_DAY",
478 "FILTER_CONVERSION_DELAY",
479 "FILTER_CREATIVE_ID",
480 "FILTER_CREATIVE_SIZE",
481 "FILTER_CREATIVE_TYPE",
482 "FILTER_EXCHANGE_ID",
483 "FILTER_AD_POSITION",
484 "FILTER_INVENTORY_SOURCE",
485 "FILTER_CITY",
486 "FILTER_REGION",
487 "FILTER_DMA",
488 "FILTER_COUNTRY",
489 "FILTER_SITE_ID",
490 "FILTER_CHANNEL_ID",
491 "FILTER_PARTNER",
492 "FILTER_ADVERTISER",
493 "FILTER_INSERTION_ORDER",
494 "FILTER_LINE_ITEM",
495 "FILTER_PARTNER_CURRENCY",
496 "FILTER_ADVERTISER_CURRENCY",
497 "FILTER_ADVERTISER_TIMEZONE",
498 "FILTER_LINE_ITEM_TYPE",
499 "FILTER_USER_LIST",
500 "FILTER_USER_LIST_FIRST_PARTY",
501 "FILTER_USER_LIST_THIRD_PARTY",
502 "FILTER_TARGETED_USER_LIST",
503 "FILTER_DATA_PROVIDER",
504 "FILTER_ORDER_ID",
505 "FILTER_VIDEO_PLAYER_SIZE",
506 "FILTER_VIDEO_DURATION_SECONDS",
507 "FILTER_KEYWORD",
508 "FILTER_PAGE_CATEGORY",
509 "FILTER_CAMPAIGN_DAILY_FREQUENCY",
510 "FILTER_LINE_ITEM_DAILY_FREQUENCY",
511 "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
512 "FILTER_OS",
513 "FILTER_BROWSER",
514 "FILTER_CARRIER",
515 "FILTER_SITE_LANGUAGE",
516 "FILTER_INVENTORY_FORMAT",
517 "FILTER_ZIP_CODE",
518 "FILTER_VIDEO_RATING_TIER",
519 "FILTER_VIDEO_FORMAT_SUPPORT",
520 "FILTER_VIDEO_SKIPPABLE_SUPPORT",
521 "FILTER_VIDEO_VPAID_SUPPORT",
522 "FILTER_VIDEO_CREATIVE_DURATION",
523 "FILTER_PAGE_LAYOUT",
524 "FILTER_VIDEO_AD_POSITION_IN_STREAM",
525 "FILTER_AGE",
526 "FILTER_GENDER",
527 "FILTER_QUARTER",
528 "FILTER_TRUEVIEW_CONVERSION_TYPE",
529 "FILTER_MOBILE_GEO",
530 "FILTER_MRAID_SUPPORT",
531 "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
532 "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
533 "FILTER_NIELSEN_COUNTRY_CODE",
534 "FILTER_NIELSEN_DEVICE_ID",
535 "FILTER_NIELSEN_GENDER",
536 "FILTER_NIELSEN_AGE",
537 "FILTER_INVENTORY_SOURCE_TYPE",
538 "FILTER_CREATIVE_WIDTH",
539 "FILTER_CREATIVE_HEIGHT",
540 "FILTER_DFP_ORDER_ID",
541 "FILTER_TRUEVIEW_AGE",
542 "FILTER_TRUEVIEW_GENDER",
543 "FILTER_TRUEVIEW_PARENTAL_STATUS",
544 "FILTER_TRUEVIEW_REMARKETING_LIST",
545 "FILTER_TRUEVIEW_INTEREST",
546 "FILTER_TRUEVIEW_AD_GROUP_ID",
547 "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
548 "FILTER_TRUEVIEW_IAR_LANGUAGE",
549 "FILTER_TRUEVIEW_IAR_GENDER",
550 "FILTER_TRUEVIEW_IAR_AGE",
551 "FILTER_TRUEVIEW_IAR_CATEGORY",
552 "FILTER_TRUEVIEW_IAR_COUNTRY",
553 "FILTER_TRUEVIEW_IAR_CITY",
554 "FILTER_TRUEVIEW_IAR_REGION",
555 "FILTER_TRUEVIEW_IAR_ZIPCODE",
556 "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
557 "FILTER_TRUEVIEW_IAR_INTEREST",
558 "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
559 "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
560 "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
561 "FILTER_TRUEVIEW_CATEGORY",
562 "FILTER_TRUEVIEW_KEYWORD",
563 "FILTER_TRUEVIEW_PLACEMENT",
564 "FILTER_TRUEVIEW_URL",
565 "FILTER_TRUEVIEW_COUNTRY",
566 "FILTER_TRUEVIEW_REGION",
567 "FILTER_TRUEVIEW_CITY",
568 "FILTER_TRUEVIEW_DMA",
569 "FILTER_TRUEVIEW_ZIPCODE",
570 "FILTER_NOT_SUPPORTED",
571 "FILTER_MEDIA_PLAN",
572 "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
573 "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
574 "FILTER_SKIPPABLE_SUPPORT",
575 "FILTER_COMPANION_CREATIVE_ID",
576 "FILTER_BUDGET_SEGMENT_DESCRIPTION",
577 "FILTER_FLOODLIGHT_ACTIVITY_ID",
578 "FILTER_DEVICE_MODEL",
579 "FILTER_DEVICE_MAKE",
580 "FILTER_DEVICE_TYPE",
581 "FILTER_CREATIVE_ATTRIBUTE",
582 "FILTER_INVENTORY_COMMITMENT_TYPE",
583 "FILTER_INVENTORY_RATE_TYPE",
584 "FILTER_INVENTORY_DELIVERY_METHOD",
585 "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
586 "FILTER_AUTHORIZED_SELLER_STATE",
587 "FILTER_VIDEO_DURATION_SECONDS_RANGE"
588 ],
589 "enumDescriptions": [
590 "",
591 "",
592 "",
593 "",
594 "",
595 "",
596 "",
597 "",
598 "",
599 "",
600 "",
601 "",
602 "",
603 "",
604 "",
605 "",
606 "",
607 "",
608 "",
609 "",
610 "",
611 "",
612 "",
613 "",
614 "",
615 "",
616 "",
617 "",
618 "",
619 "",
620 "",
621 "",
622 "",
623 "",
624 "",
625 "",
626 "",
627 "",
628 "",
629 "",
630 "",
631 "",
632 "",
633 "",
634 "",
635 "",
636 "",
637 "",
638 "",
639 "",
640 "",
641 "",
642 "",
643 "",
644 "",
645 "",
646 "",
647 "",
648 "",
649 "",
650 "",
651 "",
652 "",
653 "",
654 "",
655 "",
656 "",
657 "",
658 "",
659 "",
660 "",
661 "",
662 "",
663 "",
664 "",
665 "",
666 "",
667 "",
668 "",
669 "",
670 "",
671 "",
672 "",
673 "",
674 "",
675 "",
676 "",
677 "",
678 "",
679 "",
680 "",
681 "",
682 "",
683 "",
684 "",
685 "",
686 "",
687 "",
688 "",
689 "",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]690 "",
691 "",
692 "",
693 "",
694 "",
695 "",
696 "",
697 "",
698 "",
699 "",
700 "",
701 "",
702 "",
703 "",
704 "",
705 "",
706 ""
707 ],
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]708 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]709 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]710 "value": {
711 "description": "Filter value.",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]712 "type": "string"
713 }
714 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]715 "type": "object"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]716 },
717 "ListQueriesResponse": {
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]718 "description": "List queries response.",
719 "id": "ListQueriesResponse",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]720 "properties": {
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]721 "kind": {
722 "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listQueriesResponse\".",
723 "type": "string"
724 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]725 "queries": {
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]726 "description": "Retrieved queries.",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]727 "items": {
728 "$ref": "Query"
729 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]730 "type": "array"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]731 }
732 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]733 "type": "object"
734 },
735 "ListReportsResponse": {
736 "description": "List reports response.",
737 "id": "ListReportsResponse",
738 "properties": {
739 "kind": {
740 "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#listReportsResponse\".",
741 "type": "string"
742 },
743 "reports": {
744 "description": "Retrieved reports.",
745 "items": {
746 "$ref": "Report"
747 },
748 "type": "array"
749 }
750 },
751 "type": "object"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]752 },
753 "Parameters": {
754 "description": "Parameters of a query or report.",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]755 "id": "Parameters",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]756 "properties": {
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]757 "filters": {
758 "description": "Filters used to match traffic data in your report.",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]759 "items": {
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]760 "$ref": "FilterPair"
761 },
762 "type": "array"
763 },
764 "groupBys": {
765 "description": "Data is grouped by the filters listed in this field.",
766 "items": {
767 "enum": [
768 "FILTER_UNKNOWN",
769 "FILTER_DATE",
770 "FILTER_DAY_OF_WEEK",
771 "FILTER_WEEK",
772 "FILTER_MONTH",
773 "FILTER_YEAR",
774 "FILTER_TIME_OF_DAY",
775 "FILTER_CONVERSION_DELAY",
776 "FILTER_CREATIVE_ID",
777 "FILTER_CREATIVE_SIZE",
778 "FILTER_CREATIVE_TYPE",
779 "FILTER_EXCHANGE_ID",
780 "FILTER_AD_POSITION",
781 "FILTER_INVENTORY_SOURCE",
782 "FILTER_CITY",
783 "FILTER_REGION",
784 "FILTER_DMA",
785 "FILTER_COUNTRY",
786 "FILTER_SITE_ID",
787 "FILTER_CHANNEL_ID",
788 "FILTER_PARTNER",
789 "FILTER_ADVERTISER",
790 "FILTER_INSERTION_ORDER",
791 "FILTER_LINE_ITEM",
792 "FILTER_PARTNER_CURRENCY",
793 "FILTER_ADVERTISER_CURRENCY",
794 "FILTER_ADVERTISER_TIMEZONE",
795 "FILTER_LINE_ITEM_TYPE",
796 "FILTER_USER_LIST",
797 "FILTER_USER_LIST_FIRST_PARTY",
798 "FILTER_USER_LIST_THIRD_PARTY",
799 "FILTER_TARGETED_USER_LIST",
800 "FILTER_DATA_PROVIDER",
801 "FILTER_ORDER_ID",
802 "FILTER_VIDEO_PLAYER_SIZE",
803 "FILTER_VIDEO_DURATION_SECONDS",
804 "FILTER_KEYWORD",
805 "FILTER_PAGE_CATEGORY",
806 "FILTER_CAMPAIGN_DAILY_FREQUENCY",
807 "FILTER_LINE_ITEM_DAILY_FREQUENCY",
808 "FILTER_LINE_ITEM_LIFETIME_FREQUENCY",
809 "FILTER_OS",
810 "FILTER_BROWSER",
811 "FILTER_CARRIER",
812 "FILTER_SITE_LANGUAGE",
813 "FILTER_INVENTORY_FORMAT",
814 "FILTER_ZIP_CODE",
815 "FILTER_VIDEO_RATING_TIER",
816 "FILTER_VIDEO_FORMAT_SUPPORT",
817 "FILTER_VIDEO_SKIPPABLE_SUPPORT",
818 "FILTER_VIDEO_VPAID_SUPPORT",
819 "FILTER_VIDEO_CREATIVE_DURATION",
820 "FILTER_PAGE_LAYOUT",
821 "FILTER_VIDEO_AD_POSITION_IN_STREAM",
822 "FILTER_AGE",
823 "FILTER_GENDER",
824 "FILTER_QUARTER",
825 "FILTER_TRUEVIEW_CONVERSION_TYPE",
826 "FILTER_MOBILE_GEO",
827 "FILTER_MRAID_SUPPORT",
828 "FILTER_ACTIVE_VIEW_EXPECTED_VIEWABILITY",
829 "FILTER_VIDEO_CREATIVE_DURATION_SKIPPABLE",
830 "FILTER_NIELSEN_COUNTRY_CODE",
831 "FILTER_NIELSEN_DEVICE_ID",
832 "FILTER_NIELSEN_GENDER",
833 "FILTER_NIELSEN_AGE",
834 "FILTER_INVENTORY_SOURCE_TYPE",
835 "FILTER_CREATIVE_WIDTH",
836 "FILTER_CREATIVE_HEIGHT",
837 "FILTER_DFP_ORDER_ID",
838 "FILTER_TRUEVIEW_AGE",
839 "FILTER_TRUEVIEW_GENDER",
840 "FILTER_TRUEVIEW_PARENTAL_STATUS",
841 "FILTER_TRUEVIEW_REMARKETING_LIST",
842 "FILTER_TRUEVIEW_INTEREST",
843 "FILTER_TRUEVIEW_AD_GROUP_ID",
844 "FILTER_TRUEVIEW_AD_GROUP_AD_ID",
845 "FILTER_TRUEVIEW_IAR_LANGUAGE",
846 "FILTER_TRUEVIEW_IAR_GENDER",
847 "FILTER_TRUEVIEW_IAR_AGE",
848 "FILTER_TRUEVIEW_IAR_CATEGORY",
849 "FILTER_TRUEVIEW_IAR_COUNTRY",
850 "FILTER_TRUEVIEW_IAR_CITY",
851 "FILTER_TRUEVIEW_IAR_REGION",
852 "FILTER_TRUEVIEW_IAR_ZIPCODE",
853 "FILTER_TRUEVIEW_IAR_REMARKETING_LIST",
854 "FILTER_TRUEVIEW_IAR_INTEREST",
855 "FILTER_TRUEVIEW_IAR_PARENTAL_STATUS",
856 "FILTER_TRUEVIEW_IAR_TIME_OF_DAY",
857 "FILTER_TRUEVIEW_CUSTOM_AFFINITY",
858 "FILTER_TRUEVIEW_CATEGORY",
859 "FILTER_TRUEVIEW_KEYWORD",
860 "FILTER_TRUEVIEW_PLACEMENT",
861 "FILTER_TRUEVIEW_URL",
862 "FILTER_TRUEVIEW_COUNTRY",
863 "FILTER_TRUEVIEW_REGION",
864 "FILTER_TRUEVIEW_CITY",
865 "FILTER_TRUEVIEW_DMA",
866 "FILTER_TRUEVIEW_ZIPCODE",
867 "FILTER_NOT_SUPPORTED",
868 "FILTER_MEDIA_PLAN",
869 "FILTER_TRUEVIEW_IAR_YOUTUBE_CHANNEL",
870 "FILTER_TRUEVIEW_IAR_YOUTUBE_VIDEO",
871 "FILTER_SKIPPABLE_SUPPORT",
872 "FILTER_COMPANION_CREATIVE_ID",
873 "FILTER_BUDGET_SEGMENT_DESCRIPTION",
874 "FILTER_FLOODLIGHT_ACTIVITY_ID",
875 "FILTER_DEVICE_MODEL",
876 "FILTER_DEVICE_MAKE",
877 "FILTER_DEVICE_TYPE",
878 "FILTER_CREATIVE_ATTRIBUTE",
879 "FILTER_INVENTORY_COMMITMENT_TYPE",
880 "FILTER_INVENTORY_RATE_TYPE",
881 "FILTER_INVENTORY_DELIVERY_METHOD",
882 "FILTER_INVENTORY_SOURCE_EXTERNAL_ID",
883 "FILTER_AUTHORIZED_SELLER_STATE",
884 "FILTER_VIDEO_DURATION_SECONDS_RANGE"
885 ],
886 "enumDescriptions": [
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 "",
948 "",
949 "",
950 "",
951 "",
952 "",
953 "",
954 "",
955 "",
956 "",
957 "",
958 "",
959 "",
960 "",
961 "",
962 "",
963 "",
964 "",
965 "",
966 "",
967 "",
968 "",
969 "",
970 "",
971 "",
972 "",
973 "",
974 "",
975 "",
976 "",
977 "",
978 "",
979 "",
980 "",
981 "",
982 "",
983 "",
984 "",
985 "",
986 "",
987 "",
988 "",
989 "",
990 "",
991 "",
992 "",
993 "",
994 "",
995 "",
996 "",
997 "",
998 "",
999 "",
1000 "",
1001 "",
1002 "",
1003 ""
1004 ],
1005 "type": "string"
1006 },
1007 "type": "array"
1008 },
1009 "includeInviteData": {
1010 "description": "Deprecated. This field is no longer in use.",
1011 "type": "boolean"
1012 },
1013 "metrics": {
1014 "description": "Metrics to include as columns in your report.",
1015 "items": {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1016 "enum": [
1017 "METRIC_UNKNOWN",
1018 "METRIC_IMPRESSIONS",
1019 "METRIC_CLICKS",
1020 "METRIC_LAST_IMPRESSIONS",
1021 "METRIC_LAST_CLICKS",
1022 "METRIC_TOTAL_CONVERSIONS",
1023 "METRIC_MEDIA_COST_ADVERTISER",
1024 "METRIC_MEDIA_COST_USD",
1025 "METRIC_MEDIA_COST_PARTNER",
1026 "METRIC_DATA_COST_ADVERTISER",
1027 "METRIC_DATA_COST_USD",
1028 "METRIC_DATA_COST_PARTNER",
1029 "METRIC_CPM_FEE1_ADVERTISER",
1030 "METRIC_CPM_FEE1_USD",
1031 "METRIC_CPM_FEE1_PARTNER",
1032 "METRIC_CPM_FEE2_ADVERTISER",
1033 "METRIC_CPM_FEE2_USD",
1034 "METRIC_CPM_FEE2_PARTNER",
1035 "METRIC_MEDIA_FEE1_ADVERTISER",
1036 "METRIC_MEDIA_FEE1_USD",
1037 "METRIC_MEDIA_FEE1_PARTNER",
1038 "METRIC_MEDIA_FEE2_ADVERTISER",
1039 "METRIC_MEDIA_FEE2_USD",
1040 "METRIC_MEDIA_FEE2_PARTNER",
1041 "METRIC_REVENUE_ADVERTISER",
1042 "METRIC_REVENUE_USD",
1043 "METRIC_REVENUE_PARTNER",
1044 "METRIC_PROFIT_ADVERTISER",
1045 "METRIC_PROFIT_USD",
1046 "METRIC_PROFIT_PARTNER",
1047 "METRIC_PROFIT_MARGIN",
1048 "METRIC_TOTAL_MEDIA_COST_USD",
1049 "METRIC_TOTAL_MEDIA_COST_PARTNER",
1050 "METRIC_TOTAL_MEDIA_COST_ADVERTISER",
1051 "METRIC_BILLABLE_COST_USD",
1052 "METRIC_BILLABLE_COST_PARTNER",
1053 "METRIC_BILLABLE_COST_ADVERTISER",
1054 "METRIC_PLATFORM_FEE_USD",
1055 "METRIC_PLATFORM_FEE_PARTNER",
1056 "METRIC_PLATFORM_FEE_ADVERTISER",
1057 "METRIC_VIDEO_COMPLETION_RATE",
1058 "METRIC_PROFIT_ECPM_ADVERTISER",
1059 "METRIC_PROFIT_ECPM_USD",
1060 "METRIC_PROFIT_ECPM_PARTNER",
1061 "METRIC_REVENUE_ECPM_ADVERTISER",
1062 "METRIC_REVENUE_ECPM_USD",
1063 "METRIC_REVENUE_ECPM_PARTNER",
1064 "METRIC_REVENUE_ECPC_ADVERTISER",
1065 "METRIC_REVENUE_ECPC_USD",
1066 "METRIC_REVENUE_ECPC_PARTNER",
1067 "METRIC_REVENUE_ECPA_ADVERTISER",
1068 "METRIC_REVENUE_ECPA_USD",
1069 "METRIC_REVENUE_ECPA_PARTNER",
1070 "METRIC_REVENUE_ECPAPV_ADVERTISER",
1071 "METRIC_REVENUE_ECPAPV_USD",
1072 "METRIC_REVENUE_ECPAPV_PARTNER",
1073 "METRIC_REVENUE_ECPAPC_ADVERTISER",
1074 "METRIC_REVENUE_ECPAPC_USD",
1075 "METRIC_REVENUE_ECPAPC_PARTNER",
1076 "METRIC_MEDIA_COST_ECPM_ADVERTISER",
1077 "METRIC_MEDIA_COST_ECPM_USD",
1078 "METRIC_MEDIA_COST_ECPM_PARTNER",
1079 "METRIC_MEDIA_COST_ECPC_ADVERTISER",
1080 "METRIC_MEDIA_COST_ECPC_USD",
1081 "METRIC_MEDIA_COST_ECPC_PARTNER",
1082 "METRIC_MEDIA_COST_ECPA_ADVERTISER",
1083 "METRIC_MEDIA_COST_ECPA_USD",
1084 "METRIC_MEDIA_COST_ECPA_PARTNER",
1085 "METRIC_MEDIA_COST_ECPAPV_ADVERTISER",
1086 "METRIC_MEDIA_COST_ECPAPV_USD",
1087 "METRIC_MEDIA_COST_ECPAPV_PARTNER",
1088 "METRIC_MEDIA_COST_ECPAPC_ADVERTISER",
1089 "METRIC_MEDIA_COST_ECPAPC_USD",
1090 "METRIC_MEDIA_COST_ECPAPC_PARTNER",
1091 "METRIC_TOTAL_MEDIA_COST_ECPM_ADVERTISER",
1092 "METRIC_TOTAL_MEDIA_COST_ECPM_USD",
1093 "METRIC_TOTAL_MEDIA_COST_ECPM_PARTNER",
1094 "METRIC_TOTAL_MEDIA_COST_ECPC_ADVERTISER",
1095 "METRIC_TOTAL_MEDIA_COST_ECPC_USD",
1096 "METRIC_TOTAL_MEDIA_COST_ECPC_PARTNER",
1097 "METRIC_TOTAL_MEDIA_COST_ECPA_ADVERTISER",
1098 "METRIC_TOTAL_MEDIA_COST_ECPA_USD",
1099 "METRIC_TOTAL_MEDIA_COST_ECPA_PARTNER",
1100 "METRIC_TOTAL_MEDIA_COST_ECPAPV_ADVERTISER",
1101 "METRIC_TOTAL_MEDIA_COST_ECPAPV_USD",
1102 "METRIC_TOTAL_MEDIA_COST_ECPAPV_PARTNER",
1103 "METRIC_TOTAL_MEDIA_COST_ECPAPC_ADVERTISER",
1104 "METRIC_TOTAL_MEDIA_COST_ECPAPC_USD",
1105 "METRIC_TOTAL_MEDIA_COST_ECPAPC_PARTNER",
1106 "METRIC_RICH_MEDIA_VIDEO_PLAYS",
1107 "METRIC_RICH_MEDIA_VIDEO_COMPLETIONS",
1108 "METRIC_RICH_MEDIA_VIDEO_PAUSES",
1109 "METRIC_RICH_MEDIA_VIDEO_MUTES",
1110 "METRIC_RICH_MEDIA_VIDEO_MIDPOINTS",
1111 "METRIC_RICH_MEDIA_VIDEO_FULL_SCREENS",
1112 "METRIC_RICH_MEDIA_VIDEO_FIRST_QUARTILE_COMPLETES",
1113 "METRIC_RICH_MEDIA_VIDEO_THIRD_QUARTILE_COMPLETES",
1114 "METRIC_CLICK_TO_POST_CLICK_CONVERSION_RATE",
1115 "METRIC_IMPRESSIONS_TO_CONVERSION_RATE",
1116 "METRIC_CONVERSIONS_PER_MILLE",
1117 "METRIC_CTR",
1118 "METRIC_BID_REQUESTS",
1119 "METRIC_UNIQUE_VISITORS_COOKIES",
1120 "METRIC_REVENUE_ECPCV_ADVERTISER",
1121 "METRIC_REVENUE_ECPCV_USD",
1122 "METRIC_REVENUE_ECPCV_PARTNER",
1123 "METRIC_MEDIA_COST_ECPCV_ADVERTISER",
1124 "METRIC_MEDIA_COST_ECPCV_USD",
1125 "METRIC_MEDIA_COST_ECPCV_PARTNER",
1126 "METRIC_TOTAL_MEDIA_COST_ECPCV_ADVERTISER",
1127 "METRIC_TOTAL_MEDIA_COST_ECPCV_USD",
1128 "METRIC_TOTAL_MEDIA_COST_ECPCV_PARTNER",
1129 "METRIC_RICH_MEDIA_VIDEO_SKIPS",
1130 "METRIC_FEE2_ADVERTISER",
1131 "METRIC_FEE2_USD",
1132 "METRIC_FEE2_PARTNER",
1133 "METRIC_FEE3_ADVERTISER",
1134 "METRIC_FEE3_USD",
1135 "METRIC_FEE3_PARTNER",
1136 "METRIC_FEE4_ADVERTISER",
1137 "METRIC_FEE4_USD",
1138 "METRIC_FEE4_PARTNER",
1139 "METRIC_FEE5_ADVERTISER",
1140 "METRIC_FEE5_USD",
1141 "METRIC_FEE5_PARTNER",
1142 "METRIC_FEE6_ADVERTISER",
1143 "METRIC_FEE6_USD",
1144 "METRIC_FEE6_PARTNER",
1145 "METRIC_FEE7_ADVERTISER",
1146 "METRIC_FEE7_USD",
1147 "METRIC_FEE7_PARTNER",
1148 "METRIC_FEE8_ADVERTISER",
1149 "METRIC_FEE8_USD",
1150 "METRIC_FEE8_PARTNER",
1151 "METRIC_FEE9_ADVERTISER",
1152 "METRIC_FEE9_USD",
1153 "METRIC_FEE9_PARTNER",
1154 "METRIC_FEE10_ADVERTISER",
1155 "METRIC_FEE10_USD",
1156 "METRIC_FEE10_PARTNER",
1157 "METRIC_FEE11_ADVERTISER",
1158 "METRIC_FEE11_USD",
1159 "METRIC_FEE11_PARTNER",
1160 "METRIC_FEE12_ADVERTISER",
1161 "METRIC_FEE12_USD",
1162 "METRIC_FEE12_PARTNER",
1163 "METRIC_FEE13_ADVERTISER",
1164 "METRIC_FEE13_USD",
1165 "METRIC_FEE13_PARTNER",
1166 "METRIC_FEE14_ADVERTISER",
1167 "METRIC_FEE14_USD",
1168 "METRIC_FEE14_PARTNER",
1169 "METRIC_FEE15_ADVERTISER",
1170 "METRIC_FEE15_USD",
1171 "METRIC_FEE15_PARTNER",
1172 "METRIC_CPM_FEE3_ADVERTISER",
1173 "METRIC_CPM_FEE3_USD",
1174 "METRIC_CPM_FEE3_PARTNER",
1175 "METRIC_CPM_FEE4_ADVERTISER",
1176 "METRIC_CPM_FEE4_USD",
1177 "METRIC_CPM_FEE4_PARTNER",
1178 "METRIC_CPM_FEE5_ADVERTISER",
1179 "METRIC_CPM_FEE5_USD",
1180 "METRIC_CPM_FEE5_PARTNER",
1181 "METRIC_MEDIA_FEE3_ADVERTISER",
1182 "METRIC_MEDIA_FEE3_USD",
1183 "METRIC_MEDIA_FEE3_PARTNER",
1184 "METRIC_MEDIA_FEE4_ADVERTISER",
1185 "METRIC_MEDIA_FEE4_USD",
1186 "METRIC_MEDIA_FEE4_PARTNER",
1187 "METRIC_MEDIA_FEE5_ADVERTISER",
1188 "METRIC_MEDIA_FEE5_USD",
1189 "METRIC_MEDIA_FEE5_PARTNER",
1190 "METRIC_VIDEO_COMPANION_IMPRESSIONS",
1191 "METRIC_VIDEO_COMPANION_CLICKS",
1192 "METRIC_FEE16_ADVERTISER",
1193 "METRIC_FEE16_USD",
1194 "METRIC_FEE16_PARTNER",
1195 "METRIC_FEE17_ADVERTISER",
1196 "METRIC_FEE17_USD",
1197 "METRIC_FEE17_PARTNER",
1198 "METRIC_FEE18_ADVERTISER",
1199 "METRIC_FEE18_USD",
1200 "METRIC_FEE18_PARTNER",
1201 "METRIC_TRUEVIEW_VIEWS",
1202 "METRIC_TRUEVIEW_UNIQUE_VIEWERS",
1203 "METRIC_TRUEVIEW_EARNED_VIEWS",
1204 "METRIC_TRUEVIEW_EARNED_SUBSCRIBERS",
1205 "METRIC_TRUEVIEW_EARNED_PLAYLIST_ADDITIONS",
1206 "METRIC_TRUEVIEW_EARNED_LIKES",
1207 "METRIC_TRUEVIEW_EARNED_SHARES",
1208 "METRIC_TRUEVIEW_IMPRESSION_SHARE",
1209 "METRIC_TRUEVIEW_LOST_IS_BUDGET",
1210 "METRIC_TRUEVIEW_LOST_IS_RANK",
1211 "METRIC_TRUEVIEW_VIEW_THROUGH_CONVERSION",
1212 "METRIC_TRUEVIEW_CONVERSION_MANY_PER_VIEW",
1213 "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUE",
1214 "METRIC_TRUEVIEW_VIEW_RATE",
1215 "METRIC_TRUEVIEW_CONVERSION_RATE_ONE_PER_VIEW",
1216 "METRIC_TRUEVIEW_CPV_ADVERTISER",
1217 "METRIC_TRUEVIEW_CPV_USD",
1218 "METRIC_TRUEVIEW_CPV_PARTNER",
1219 "METRIC_FEE19_ADVERTISER",
1220 "METRIC_FEE19_USD",
1221 "METRIC_FEE19_PARTNER",
1222 "METRIC_TEA_TRUEVIEW_IMPRESSIONS",
1223 "METRIC_TEA_TRUEVIEW_UNIQUE_COOKIES",
1224 "METRIC_FEE20_ADVERTISER",
1225 "METRIC_FEE20_USD",
1226 "METRIC_FEE20_PARTNER",
1227 "METRIC_FEE21_ADVERTISER",
1228 "METRIC_FEE21_USD",
1229 "METRIC_FEE21_PARTNER",
1230 "METRIC_FEE22_ADVERTISER",
1231 "METRIC_FEE22_USD",
1232 "METRIC_FEE22_PARTNER",
1233 "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_ADVERTISER",
1234 "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_USD",
1235 "METRIC_TRUEVIEW_TOTAL_CONVERSION_VALUES_PARTNER",
1236 "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_ADVERTISER",
1237 "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_USD",
1238 "METRIC_TRUEVIEW_CONVERSION_COST_MANY_PER_VIEW_PARTNER",
1239 "METRIC_PROFIT_VIEWABLE_ECPM_ADVERTISER",
1240 "METRIC_PROFIT_VIEWABLE_ECPM_USD",
1241 "METRIC_PROFIT_VIEWABLE_ECPM_PARTNER",
1242 "METRIC_REVENUE_VIEWABLE_ECPM_ADVERTISER",
1243 "METRIC_REVENUE_VIEWABLE_ECPM_USD",
1244 "METRIC_REVENUE_VIEWABLE_ECPM_PARTNER",
1245 "METRIC_MEDIA_COST_VIEWABLE_ECPM_ADVERTISER",
1246 "METRIC_MEDIA_COST_VIEWABLE_ECPM_USD",
1247 "METRIC_MEDIA_COST_VIEWABLE_ECPM_PARTNER",
1248 "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_ADVERTISER",
1249 "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_USD",
1250 "METRIC_TOTAL_MEDIA_COST_VIEWABLE_ECPM_PARTNER",
1251 "METRIC_TRUEVIEW_ENGAGEMENTS",
1252 "METRIC_TRUEVIEW_ENGAGEMENT_RATE",
1253 "METRIC_TRUEVIEW_AVERAGE_CPE_ADVERTISER",
1254 "METRIC_TRUEVIEW_AVERAGE_CPE_USD",
1255 "METRIC_TRUEVIEW_AVERAGE_CPE_PARTNER",
1256 "METRIC_ACTIVE_VIEW_VIEWABLE_IMPRESSIONS",
1257 "METRIC_ACTIVE_VIEW_ELIGIBLE_IMPRESSIONS",
1258 "METRIC_ACTIVE_VIEW_MEASURABLE_IMPRESSIONS",
1259 "METRIC_ACTIVE_VIEW_PCT_MEASURABLE_IMPRESSIONS",
1260 "METRIC_ACTIVE_VIEW_PCT_VIEWABLE_IMPRESSIONS",
1261 "METRIC_ACTIVE_VIEW_AVERAGE_VIEWABLE_TIME",
1262 "METRIC_ACTIVE_VIEW_UNMEASURABLE_IMPRESSIONS",
1263 "METRIC_ACTIVE_VIEW_UNVIEWABLE_IMPRESSIONS",
1264 "METRIC_ACTIVE_VIEW_DISTRIBUTION_UNMEASURABLE",
1265 "METRIC_ACTIVE_VIEW_DISTRIBUTION_UNVIEWABLE",
1266 "METRIC_ACTIVE_VIEW_DISTRIBUTION_VIEWABLE",
1267 "METRIC_ACTIVE_VIEW_PERCENT_VIEWABLE_FOR_TIME_THRESHOLD",
1268 "METRIC_ACTIVE_VIEW_VIEWABLE_FOR_TIME_THRESHOLD",
1269 "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_AT_START",
1270 "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_FIRST_QUAR",
1271 "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_SECOND_QUAR",
1272 "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_THIRD_QUAR",
1273 "METRIC_ACTIVE_VIEW_PERCENT_VISIBLE_ON_COMPLETE",
1274 "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_AT_START",
1275 "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_FIRST_QUAR",
1276 "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_SECOND_QUAR",
1277 "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_THIRD_QUAR",
1278 "METRIC_ACTIVE_VIEW_PERCENT_AUDIBLE_VISIBLE_ON_COMPLETE",
1279 "METRIC_ACTIVE_VIEW_AUDIBLE_VISIBLE_ON_COMPLETE_IMPRESSIONS",
1280 "METRIC_VIEWABLE_BID_REQUESTS",
1281 "METRIC_COOKIE_REACH_IMPRESSION_REACH",
1282 "METRIC_COOKIE_REACH_AVERAGE_IMPRESSION_FREQUENCY",
1283 "METRIC_DBM_ENGAGEMENT_RATE",
1284 "METRIC_RICH_MEDIA_SCROLLS",
1285 "METRIC_CM_POST_VIEW_REVENUE",
1286 "METRIC_CM_POST_CLICK_REVENUE",
1287 "METRIC_FLOODLIGHT_IMPRESSIONS",
1288 "METRIC_BILLABLE_IMPRESSIONS"
1289 ],
1290 "enumDescriptions": [
1291 "",
1292 "",
1293 "",
1294 "",
1295 "",
1296 "",
1297 "",
1298 "",
1299 "",
1300 "",
1301 "",
1302 "",
1303 "",
1304 "",
1305 "",
1306 "",
1307 "",
1308 "",
1309 "",
1310 "",
1311 "",
1312 "",
1313 "",
1314 "",
1315 "",
1316 "",
1317 "",
1318 "",
1319 "",
1320 "",
1321 "",
1322 "",
1323 "",
1324 "",
1325 "",
1326 "",
1327 "",
1328 "",
1329 "",
1330 "",
1331 "",
1332 "",
1333 "",
1334 "",
1335 "",
1336 "",
1337 "",
1338 "",
1339 "",
1340 "",
1341 "",
1342 "",
1343 "",
1344 "",
1345 "",
1346 "",
1347 "",
1348 "",
1349 "",
1350 "",
1351 "",
1352 "",
1353 "",
1354 "",
1355 "",
1356 "",
1357 "",
1358 "",
1359 "",
1360 "",
1361 "",
1362 "",
1363 "",
1364 "",
1365 "",
1366 "",
1367 "",
1368 "",
1369 "",
1370 "",
1371 "",
1372 "",
1373 "",
1374 "",
1375 "",
1376 "",
1377 "",
1378 "",
1379 "",
1380 "",
1381 "",
1382 "",
1383 "",
1384 "",
1385 "",
1386 "",
1387 "",
1388 "",
1389 "",
1390 "",
1391 "",
1392 "",
1393 "",
1394 "",
1395 "",
1396 "",
1397 "",
1398 "",
1399 "",
1400 "",
1401 "",
1402 "",
1403 "",
1404 "",
1405 "",
1406 "",
1407 "",
1408 "",
1409 "",
1410 "",
1411 "",
1412 "",
1413 "",
1414 "",
1415 "",
1416 "",
1417 "",
1418 "",
1419 "",
1420 "",
1421 "",
1422 "",
1423 "",
1424 "",
1425 "",
1426 "",
1427 "",
1428 "",
1429 "",
1430 "",
1431 "",
1432 "",
1433 "",
1434 "",
1435 "",
1436 "",
1437 "",
1438 "",
1439 "",
1440 "",
1441 "",
1442 "",
1443 "",
1444 "",
1445 "",
1446 "",
1447 "",
1448 "",
1449 "",
1450 "",
1451 "",
1452 "",
1453 "",
1454 "",
1455 "",
1456 "",
1457 "",
1458 "",
1459 "",
1460 "",
1461 "",
1462 "",
1463 "",
1464 "",
1465 "",
1466 "",
1467 "",
1468 "",
1469 "",
1470 "",
1471 "",
1472 "",
1473 "",
1474 "",
1475 "",
1476 "",
1477 "",
1478 "",
1479 "",
1480 "",
1481 "",
1482 "",
1483 "",
1484 "",
1485 "",
1486 "",
1487 "",
1488 "",
1489 "",
1490 "",
1491 "",
1492 "",
1493 "",
1494 "",
1495 "",
1496 "",
1497 "",
1498 "",
1499 "",
1500 "",
1501 "",
1502 "",
1503 "",
1504 "",
1505 "",
1506 "",
1507 "",
1508 "",
1509 "",
1510 "",
1511 "",
1512 "",
1513 "",
1514 "",
1515 "",
1516 "",
1517 "",
1518 "",
1519 "",
1520 "",
1521 "",
1522 "",
1523 "",
1524 "",
1525 "",
1526 "",
1527 "",
1528 "",
1529 "",
1530 "",
1531 "",
1532 "",
1533 "",
1534 "",
1535 "",
1536 "",
1537 "",
1538 "",
1539 "",
1540 "",
1541 "",
1542 "",
1543 "",
1544 "",
1545 "",
1546 "",
1547 "",
1548 "",
1549 "",
1550 "",
1551 "",
1552 "",
1553 "",
1554 "",
1555 "",
1556 "",
1557 "",
1558 "",
1559 "",
1560 "",
1561 "",
1562 ""
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1563 ],
1564 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1565 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1566 "type": "array"
1567 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1568 "type": {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1569 "description": "Report type.",
1570 "enum": [
1571 "TYPE_GENERAL",
1572 "TYPE_AUDIENCE_PERFORMANCE",
1573 "TYPE_INVENTORY_AVAILABILITY",
1574 "TYPE_KEYWORD",
1575 "TYPE_PIXEL_LOAD",
1576 "TYPE_AUDIENCE_COMPOSITION",
1577 "TYPE_CROSS_PARTNER",
1578 "TYPE_PAGE_CATEGORY",
1579 "TYPE_THIRD_PARTY_DATA_PROVIDER",
1580 "TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER",
1581 "TYPE_CLIENT_SAFE",
1582 "TYPE_ORDER_ID",
1583 "TYPE_FEE",
1584 "TYPE_CROSS_FEE",
1585 "TYPE_ACTIVE_GRP",
1586 "TYPE_YOUTUBE_VERTICAL",
1587 "TYPE_COMSCORE_VCE",
1588 "TYPE_TRUEVIEW",
1589 "TYPE_NIELSEN_AUDIENCE_PROFILE",
1590 "TYPE_NIELSEN_DAILY_REACH_BUILD",
1591 "TYPE_NIELSEN_SITE",
1592 "TYPE_REACH_AND_FREQUENCY",
1593 "TYPE_ESTIMATED_CONVERSION",
1594 "TYPE_VERIFICATION",
1595 "TYPE_TRUEVIEW_IAR",
1596 "TYPE_NIELSEN_ONLINE_GLOBAL_MARKET",
1597 "TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE",
1598 "TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD",
1599 "TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET",
1600 "TYPE_NOT_SUPPORTED",
1601 "TYPE_REACH_AUDIENCE",
1602 "TYPE_LINEAR_TV_SEARCH_LIFT"
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1603 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1604 "enumDescriptions": [
1605 "",
1606 "",
1607 "",
1608 "",
1609 "",
1610 "",
1611 "",
1612 "",
1613 "",
1614 "",
1615 "",
1616 "",
1617 "",
1618 "",
1619 "",
1620 "",
1621 "",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1622 "",
1623 "",
1624 "",
1625 "",
1626 "",
1627 "",
1628 "",
1629 "",
1630 "",
1631 "",
1632 "",
1633 "",
1634 "",
1635 "",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1636 ""
1637 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1638 "type": "string"
1639 }
1640 },
1641 "type": "object"
1642 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1643 "Query": {
1644 "description": "Represents a query.",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1645 "id": "Query",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1646 "properties": {
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1647 "kind": {
1648 "description": "Identifies what kind of resource this is. Value: the fixed string \"doubleclickbidmanager#query\".",
1649 "type": "string"
1650 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1651 "metadata": {
1652 "$ref": "QueryMetadata",
1653 "description": "Query metadata."
1654 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1655 "params": {
1656 "$ref": "Parameters",
1657 "description": "Query parameters."
1658 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1659 "queryId": {
1660 "description": "Query ID.",
1661 "format": "int64",
1662 "type": "string"
1663 },
1664 "reportDataEndTimeMs": {
1665 "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.",
1666 "format": "int64",
1667 "type": "string"
1668 },
1669 "reportDataStartTimeMs": {
1670 "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.",
1671 "format": "int64",
1672 "type": "string"
1673 },
1674 "schedule": {
1675 "$ref": "QuerySchedule",
1676 "description": "Information on how often and when to run a query."
1677 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1678 "timezoneCode": {
1679 "description": "Canonical timezone code for report data time. Defaults to America/New_York.",
1680 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1681 }
1682 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1683 "type": "object"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1684 },
1685 "QueryMetadata": {
1686 "description": "Query metadata.",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1687 "id": "QueryMetadata",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1688 "properties": {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1689 "dataRange": {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1690 "description": "Range of report data.",
1691 "enum": [
1692 "CUSTOM_DATES",
1693 "CURRENT_DAY",
1694 "PREVIOUS_DAY",
1695 "WEEK_TO_DATE",
1696 "MONTH_TO_DATE",
1697 "QUARTER_TO_DATE",
1698 "YEAR_TO_DATE",
1699 "PREVIOUS_WEEK",
1700 "PREVIOUS_HALF_MONTH",
1701 "PREVIOUS_MONTH",
1702 "PREVIOUS_QUARTER",
1703 "PREVIOUS_YEAR",
1704 "LAST_7_DAYS",
1705 "LAST_30_DAYS",
1706 "LAST_90_DAYS",
1707 "LAST_365_DAYS",
1708 "ALL_TIME",
1709 "LAST_14_DAYS",
1710 "TYPE_NOT_SUPPORTED"
1711 ],
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1712 "enumDescriptions": [
1713 "",
1714 "",
1715 "",
1716 "",
1717 "",
1718 "",
1719 "",
1720 "",
1721 "",
1722 "",
1723 "",
1724 "",
1725 "",
1726 "",
1727 "",
1728 "",
1729 "",
1730 "",
1731 ""
1732 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1733 "type": "string"
1734 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1735 "format": {
1736 "description": "Format of the generated report.",
1737 "enum": [
1738 "CSV",
1739 "EXCEL_CSV",
1740 "XLSX"
1741 ],
1742 "enumDescriptions": [
1743 "",
1744 "",
1745 ""
1746 ],
1747 "type": "string"
1748 },
1749 "googleCloudStoragePathForLatestReport": {
1750 "description": "The path to the location in Google Cloud Storage where the latest report is stored.",
1751 "type": "string"
1752 },
1753 "googleDrivePathForLatestReport": {
1754 "description": "The path in Google Drive for the latest report.",
1755 "type": "string"
1756 },
1757 "latestReportRunTimeMs": {
1758 "description": "The time when the latest report started to run.",
1759 "format": "int64",
1760 "type": "string"
1761 },
1762 "locale": {
1763 "description": "Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh-TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English.",
1764 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1765 },
1766 "reportCount": {
1767 "description": "Number of reports that have been generated for the query.",
1768 "format": "int32",
1769 "type": "integer"
1770 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1771 "running": {
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1772 "description": "Whether the latest report is currently running.",
1773 "type": "boolean"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1774 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1775 "sendNotification": {
1776 "description": "Whether to send an email notification when a report is ready. Default to false.",
1777 "type": "boolean"
1778 },
1779 "shareEmailAddress": {
1780 "description": "List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.",
1781 "items": {
1782 "type": "string"
1783 },
1784 "type": "array"
1785 },
1786 "title": {
1787 "description": "Query title. It is used to name the reports generated from this query.",
1788 "type": "string"
1789 }
1790 },
1791 "type": "object"
1792 },
1793 "QuerySchedule": {
1794 "description": "Information on how frequently and when to run a query.",
1795 "id": "QuerySchedule",
1796 "properties": {
1797 "endTimeMs": {
1798 "description": "Datetime to periodically run the query until.",
1799 "format": "int64",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1800 "type": "string"
1801 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1802 "frequency": {
1803 "description": "How often the query is run.",
1804 "enum": [
1805 "ONE_TIME",
1806 "DAILY",
1807 "WEEKLY",
1808 "SEMI_MONTHLY",
1809 "MONTHLY",
1810 "QUARTERLY"
1811 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1812 "enumDescriptions": [
1813 "",
1814 "",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1815 "",
1816 "",
1817 "",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1818 ""
1819 ],
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1820 "type": "string"
1821 },
1822 "nextRunMinuteOfDay": {
1823 "description": "Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.",
1824 "format": "int32",
1825 "type": "integer"
1826 },
1827 "nextRunTimezoneCode": {
1828 "description": "Canonical timezone code for report generation time. Defaults to America/New_York.",
1829 "type": "string"
1830 }
1831 },
1832 "type": "object"
1833 },
1834 "Report": {
1835 "description": "Represents a report.",
1836 "id": "Report",
1837 "properties": {
1838 "key": {
1839 "$ref": "ReportKey",
1840 "description": "Key used to identify a report."
1841 },
1842 "metadata": {
1843 "$ref": "ReportMetadata",
1844 "description": "Report metadata."
1845 },
1846 "params": {
1847 "$ref": "Parameters",
1848 "description": "Report parameters."
1849 }
1850 },
1851 "type": "object"
1852 },
1853 "ReportFailure": {
1854 "description": "An explanation of a report failure.",
1855 "id": "ReportFailure",
1856 "properties": {
1857 "errorCode": {
1858 "description": "Error code that shows why the report was not created.",
1859 "enum": [
1860 "AUTHENTICATION_ERROR",
1861 "UNAUTHORIZED_API_ACCESS",
1862 "SERVER_ERROR",
1863 "VALIDATION_ERROR",
1864 "REPORTING_FATAL_ERROR",
1865 "REPORTING_TRANSIENT_ERROR",
1866 "REPORTING_IMCOMPATIBLE_METRICS",
1867 "REPORTING_ILLEGAL_FILENAME",
1868 "REPORTING_QUERY_NOT_FOUND",
1869 "REPORTING_BUCKET_NOT_FOUND",
1870 "REPORTING_CREATE_BUCKET_FAILED",
1871 "REPORTING_DELETE_BUCKET_FAILED",
1872 "REPORTING_UPDATE_BUCKET_PERMISSION_FAILED",
1873 "REPORTING_WRITE_BUCKET_OBJECT_FAILED",
1874 "DEPRECATED_REPORTING_INVALID_QUERY",
1875 "REPORTING_INVALID_QUERY_TOO_MANY_UNFILTERED_LARGE_GROUP_BYS",
1876 "REPORTING_INVALID_QUERY_TITLE_MISSING",
1877 "REPORTING_INVALID_QUERY_MISSING_PARTNER_AND_ADVERTISER_FILTERS"
1878 ],
1879 "enumDescriptions": [
1880 "",
1881 "",
1882 "",
1883 "",
1884 "",
1885 "",
1886 "",
1887 "",
1888 "",
1889 "",
1890 "",
1891 "",
1892 "",
1893 "",
1894 "",
1895 "",
1896 "",
1897 ""
1898 ],
1899 "type": "string"
1900 }
1901 },
1902 "type": "object"
1903 },
1904 "ReportKey": {
1905 "description": "Key used to identify a report.",
1906 "id": "ReportKey",
1907 "properties": {
1908 "queryId": {
1909 "description": "Query ID.",
1910 "format": "int64",
1911 "type": "string"
1912 },
1913 "reportId": {
1914 "description": "Report ID.",
1915 "format": "int64",
1916 "type": "string"
1917 }
1918 },
1919 "type": "object"
1920 },
1921 "ReportMetadata": {
1922 "description": "Report metadata.",
1923 "id": "ReportMetadata",
1924 "properties": {
1925 "googleCloudStoragePath": {
1926 "description": "The path to the location in Google Cloud Storage where the report is stored.",
1927 "type": "string"
1928 },
1929 "reportDataEndTimeMs": {
1930 "description": "The ending time for the data that is shown in the report.",
1931 "format": "int64",
1932 "type": "string"
1933 },
1934 "reportDataStartTimeMs": {
1935 "description": "The starting time for the data that is shown in the report.",
1936 "format": "int64",
1937 "type": "string"
1938 },
1939 "status": {
1940 "$ref": "ReportStatus",
1941 "description": "Report status."
1942 }
1943 },
1944 "type": "object"
1945 },
1946 "ReportStatus": {
1947 "description": "Report status.",
1948 "id": "ReportStatus",
1949 "properties": {
1950 "failure": {
1951 "$ref": "ReportFailure",
1952 "description": "If the report failed, this records the cause."
1953 },
1954 "finishTimeMs": {
1955 "description": "The time when this report either completed successfully or failed.",
1956 "format": "int64",
1957 "type": "string"
1958 },
1959 "format": {
1960 "description": "The file type of the report.",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1961 "enum": [
1962 "CSV",
1963 "EXCEL_CSV",
1964 "XLSX"
1965 ],
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1966 "enumDescriptions": [
1967 "",
1968 "",
1969 ""
1970 ],
1971 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1972 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1973 "state": {
1974 "description": "The state of the report.",
1975 "enum": [
1976 "RUNNING",
1977 "DONE",
1978 "FAILED"
1979 ],
1980 "enumDescriptions": [
1981 "",
1982 "",
1983 ""
1984 ],
1985 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1986 }
1987 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1988 "type": "object"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1989 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1990 "RowStatus": {
1991 "description": "Represents the upload status of a row in the request.",
1992 "id": "RowStatus",
1993 "properties": {
1994 "changed": {
1995 "description": "Whether the stored entity is changed as a result of upload.",
1996 "type": "boolean"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]1997 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]1998 "entityId": {
1999 "description": "Entity Id.",
2000 "format": "int64",
2001 "type": "string"
2002 },
2003 "entityName": {
2004 "description": "Entity name.",
2005 "type": "string"
2006 },
2007 "errors": {
2008 "description": "Reasons why the entity can't be uploaded.",
2009 "items": {
2010 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]2011 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]2012 "type": "array"
2013 },
2014 "persisted": {
2015 "description": "Whether the entity is persisted.",
2016 "type": "boolean"
2017 },
2018 "rowNumber": {
2019 "description": "Row number.",
2020 "format": "int32",
2021 "type": "integer"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]2022 }
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]2023 },
2024 "type": "object"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]2025 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]2026 "RunQueryRequest": {
2027 "description": "Request to run a stored query to generate a report.",
2028 "id": "RunQueryRequest",
2029 "properties": {
2030 "dataRange": {
2031 "description": "Report data range used to generate the report.",
2032 "enum": [
2033 "CUSTOM_DATES",
2034 "CURRENT_DAY",
2035 "PREVIOUS_DAY",
2036 "WEEK_TO_DATE",
2037 "MONTH_TO_DATE",
2038 "QUARTER_TO_DATE",
2039 "YEAR_TO_DATE",
2040 "PREVIOUS_WEEK",
2041 "PREVIOUS_HALF_MONTH",
2042 "PREVIOUS_MONTH",
2043 "PREVIOUS_QUARTER",
2044 "PREVIOUS_YEAR",
2045 "LAST_7_DAYS",
2046 "LAST_30_DAYS",
2047 "LAST_90_DAYS",
2048 "LAST_365_DAYS",
2049 "ALL_TIME",
2050 "LAST_14_DAYS",
2051 "TYPE_NOT_SUPPORTED"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]2052 ],
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]2053 "enumDescriptions": [
2054 "",
2055 "",
2056 "",
2057 "",
2058 "",
2059 "",
2060 "",
2061 "",
2062 "",
2063 "",
2064 "",
2065 "",
2066 "",
2067 "",
2068 "",
2069 "",
2070 "",
2071 "",
2072 ""
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]2073 ],
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]2074 "type": "string"
2075 },
2076 "reportDataEndTimeMs": {
2077 "description": "The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
2078 "format": "int64",
2079 "type": "string"
2080 },
2081 "reportDataStartTimeMs": {
2082 "description": "The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.",
2083 "format": "int64",
2084 "type": "string"
2085 },
2086 "timezoneCode": {
2087 "description": "Canonical timezone code for report data time. Defaults to America/New_York.",
2088 "type": "string"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]2089 }
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]2090 },
2091 "type": "object"
2092 },
2093 "UploadLineItemsRequest": {
2094 "description": "Request to upload line items.",
2095 "id": "UploadLineItemsRequest",
2096 "properties": {
2097 "dryRun": {
2098 "description": "Set to true to get upload status without actually persisting the line items.",
2099 "type": "boolean"
2100 },
2101 "format": {
2102 "description": "Format the line items are in. Default to CSV.",
2103 "enum": [
2104 "CSV"
2105 ],
2106 "enumDescriptions": [
2107 ""
2108 ],
2109 "type": "string"
2110 },
2111 "lineItems": {
2112 "description": "Line items in CSV to upload. Refer to Entity Write File Format for more information on file format.",
2113 "type": "string"
2114 }
2115 },
2116 "type": "object"
2117 },
2118 "UploadLineItemsResponse": {
2119 "description": "Upload line items response.",
2120 "id": "UploadLineItemsResponse",
2121 "properties": {
2122 "uploadStatus": {
2123 "$ref": "UploadStatus",
2124 "description": "Status of upload."
2125 }
2126 },
2127 "type": "object"
2128 },
2129 "UploadStatus": {
2130 "description": "Represents the status of upload.",
2131 "id": "UploadStatus",
2132 "properties": {
2133 "errors": {
2134 "description": "Reasons why upload can't be completed.",
2135 "items": {
2136 "type": "string"
2137 },
2138 "type": "array"
2139 },
2140 "rowStatus": {
2141 "description": "Per-row upload status.",
2142 "items": {
2143 "$ref": "RowStatus"
2144 },
2145 "type": "array"
2146 }
2147 },
2148 "type": "object"
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]2149 }
2150 },
2151 "servicePath": "doubleclickbidmanager/v1/",
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]2152 "title": "DoubleClick Bid Manager API",
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame^]2153 "version": "v1"
2154}