1{
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": "/v2/",
12 "baseUrl": "https://doubleclickbidmanager.googleapis.com/v2/",
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 "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": "doubleclickbidmanager:v2",
23 "kind": "discovery#restDescription",
24 "mtlsRootUrl": "https://doubleclickbidmanager.mtls.googleapis.com/",
25 "name": "doubleclickbidmanager",
26 "ownerDomain": "google.com",
27 "ownerName": "Google",
28 "parameters": {
29 "$.xgafv": {
30 "description": "V1 error format.",
31 "enum": [
32 "1",
33 "2"
34 ],
35 "enumDescriptions": [
36 "v1 error format",
37 "v2 error format"
38 ],
39 "location": "query",
40 "type": "string"
41 },
42 "access_token": {
43 "description": "OAuth access token.",
44 "location": "query",
45 "type": "string"
46 },
47 "alt": {
48 "default": "json",
49 "description": "Data format for response.",
50 "enum": [
51 "json",
52 "media",
53 "proto"
54 ],
55 "enumDescriptions": [
56 "Responses with Content-Type of application/json",
57 "Media download with context-dependent Content-Type",
58 "Responses with Content-Type of application/x-protobuf"
59 ],
60 "location": "query",
61 "type": "string"
62 },
63 "callback": {
64 "description": "JSONP",
65 "location": "query",
66 "type": "string"
67 },
68 "fields": {
69 "description": "Selector specifying which fields to include in a partial response.",
70 "location": "query",
71 "type": "string"
72 },
73 "key": {
74 "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.",
75 "location": "query",
76 "type": "string"
77 },
78 "oauth_token": {
79 "description": "OAuth 2.0 token for the current user.",
80 "location": "query",
81 "type": "string"
82 },
83 "prettyPrint": {
84 "default": "true",
85 "description": "Returns response with indentations and line breaks.",
86 "location": "query",
87 "type": "boolean"
88 },
89 "quotaUser": {
90 "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.",
91 "location": "query",
92 "type": "string"
93 },
94 "uploadType": {
95 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
96 "location": "query",
97 "type": "string"
98 },
99 "upload_protocol": {
100 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
101 "location": "query",
102 "type": "string"
103 }
104 },
105 "protocol": "rest",
106 "resources": {
107 "queries": {
108 "methods": {
109 "create": {
110 "description": "Creates a query.",
111 "flatPath": "queries",
112 "httpMethod": "POST",
113 "id": "doubleclickbidmanager.queries.create",
114 "parameterOrder": [],
115 "parameters": {},
116 "path": "queries",
117 "request": {
118 "$ref": "Query"
119 },
120 "response": {
121 "$ref": "Query"
122 },
123 "scopes": [
124 "https://www.googleapis.com/auth/doubleclickbidmanager"
125 ]
126 },
127 "delete": {
128 "description": "Deletes a query as well as the associated reports.",
129 "flatPath": "queries/{queryId}",
130 "httpMethod": "DELETE",
131 "id": "doubleclickbidmanager.queries.delete",
132 "parameterOrder": [
133 "queryId"
134 ],
135 "parameters": {
136 "queryId": {
137 "description": "Required. ID of query to delete.",
138 "format": "int64",
139 "location": "path",
140 "required": true,
141 "type": "string"
142 }
143 },
144 "path": "queries/{queryId}",
145 "scopes": [
146 "https://www.googleapis.com/auth/doubleclickbidmanager"
147 ]
148 },
149 "get": {
150 "description": "Retrieves a query.",
151 "flatPath": "queries/{queryId}",
152 "httpMethod": "GET",
153 "id": "doubleclickbidmanager.queries.get",
154 "parameterOrder": [
155 "queryId"
156 ],
157 "parameters": {
158 "queryId": {
159 "description": "Required. ID of query to retrieve.",
160 "format": "int64",
161 "location": "path",
162 "required": true,
163 "type": "string"
164 }
165 },
166 "path": "queries/{queryId}",
167 "response": {
168 "$ref": "Query"
169 },
170 "scopes": [
171 "https://www.googleapis.com/auth/doubleclickbidmanager"
172 ]
173 },
174 "list": {
175 "description": "Lists queries created by the current user.",
176 "flatPath": "queries",
177 "httpMethod": "GET",
178 "id": "doubleclickbidmanager.queries.list",
179 "parameterOrder": [],
180 "parameters": {
181 "orderBy": {
182 "description": "Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. For example \"metadata.title desc\". Sorting is only supported for the following fields: * `queryId` * `metadata.title`",
183 "location": "query",
184 "type": "string"
185 },
186 "pageSize": {
187 "description": "Maximum number of results per page. Must be between `1` and `100`. Defaults to `100` if unspecified.",
188 "format": "int32",
189 "location": "query",
190 "type": "integer"
191 },
192 "pageToken": {
193 "description": "A page token, received from a previous list call. Provide this to retrieve the subsequent page of queries.",
194 "location": "query",
195 "type": "string"
196 }
197 },
198 "path": "queries",
199 "response": {
200 "$ref": "ListQueriesResponse"
201 },
202 "scopes": [
203 "https://www.googleapis.com/auth/doubleclickbidmanager"
204 ]
205 },
206 "run": {
207 "description": "Runs a stored query to generate a report.",
208 "flatPath": "queries/{queryId}:run",
209 "httpMethod": "POST",
210 "id": "doubleclickbidmanager.queries.run",
211 "parameterOrder": [
212 "queryId"
213 ],
214 "parameters": {
215 "queryId": {
216 "description": "Required. ID of query to run.",
217 "format": "int64",
218 "location": "path",
219 "required": true,
220 "type": "string"
221 },
222 "synchronous": {
223 "description": "Whether the query should be run synchronously. When true, this method will not return until the query has finished running. When false or not specified, this method will return immediately.",
224 "location": "query",
225 "type": "boolean"
226 }
227 },
228 "path": "queries/{queryId}:run",
229 "request": {
230 "$ref": "RunQueryRequest"
231 },
232 "response": {
233 "$ref": "Report"
234 },
235 "scopes": [
236 "https://www.googleapis.com/auth/doubleclickbidmanager"
237 ]
238 }
239 },
240 "resources": {
241 "reports": {
242 "methods": {
243 "get": {
244 "description": "Retrieves a report.",
245 "flatPath": "queries/{queryId}/reports/{reportId}",
246 "httpMethod": "GET",
247 "id": "doubleclickbidmanager.queries.reports.get",
248 "parameterOrder": [
249 "queryId",
250 "reportId"
251 ],
252 "parameters": {
253 "queryId": {
254 "description": "Required. ID of the query the report is associated with.",
255 "format": "int64",
256 "location": "path",
257 "required": true,
258 "type": "string"
259 },
260 "reportId": {
261 "description": "Required. ID of the report to retrieve.",
262 "format": "int64",
263 "location": "path",
264 "required": true,
265 "type": "string"
266 }
267 },
268 "path": "queries/{queryId}/reports/{reportId}",
269 "response": {
270 "$ref": "Report"
271 },
272 "scopes": [
273 "https://www.googleapis.com/auth/doubleclickbidmanager"
274 ]
275 },
276 "list": {
277 "description": "Lists reports associated with a query.",
278 "flatPath": "queries/{queryId}/reports",
279 "httpMethod": "GET",
280 "id": "doubleclickbidmanager.queries.reports.list",
281 "parameterOrder": [
282 "queryId"
283 ],
284 "parameters": {
285 "orderBy": {
286 "description": "Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. For example \"key.reportId desc\". Sorting is only supported for the following fields: * `key.reportId`",
287 "location": "query",
288 "type": "string"
289 },
290 "pageSize": {
291 "description": "Maximum number of results per page. Must be between `1` and `100`. Defaults to `100` if unspecified.",
292 "format": "int32",
293 "location": "query",
294 "type": "integer"
295 },
296 "pageToken": {
297 "description": "A page token, received from a previous list call. Provide this to retrieve the subsequent page of reports.",
298 "location": "query",
299 "type": "string"
300 },
301 "queryId": {
302 "description": "Required. ID of the query with which the reports are associated.",
303 "format": "int64",
304 "location": "path",
305 "required": true,
306 "type": "string"
307 }
308 },
309 "path": "queries/{queryId}/reports",
310 "response": {
311 "$ref": "ListReportsResponse"
312 },
313 "scopes": [
314 "https://www.googleapis.com/auth/doubleclickbidmanager"
315 ]
316 }
317 }
318 }
319 }
320 }
321 },
322 "revision": "20240424",
323 "rootUrl": "https://doubleclickbidmanager.googleapis.com/",
324 "schemas": {
325 "DataRange": {
326 "description": "Report data range.",
327 "id": "DataRange",
328 "properties": {
329 "customEndDate": {
330 "$ref": "Date",
331 "description": "The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise."
332 },
333 "customStartDate": {
334 "$ref": "Date",
335 "description": "The starting data for the data that is shown in the report. Note, `customStartDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise."
336 },
337 "range": {
338 "description": "Report data range used to generate the report.",
339 "enum": [
340 "RANGE_UNSPECIFIED",
341 "CUSTOM_DATES",
342 "CURRENT_DAY",
343 "PREVIOUS_DAY",
344 "WEEK_TO_DATE",
345 "MONTH_TO_DATE",
346 "QUARTER_TO_DATE",
347 "YEAR_TO_DATE",
348 "PREVIOUS_WEEK",
349 "PREVIOUS_MONTH",
350 "PREVIOUS_QUARTER",
351 "PREVIOUS_YEAR",
352 "LAST_7_DAYS",
353 "LAST_30_DAYS",
354 "LAST_90_DAYS",
355 "LAST_365_DAYS",
356 "ALL_TIME",
357 "LAST_14_DAYS",
358 "LAST_60_DAYS"
359 ],
360 "enumDescriptions": [
361 "Default value when range is not specified or is unknown in this version.",
362 "Custom range specified by custom_start_date and custom_end_date fields.",
363 "Current day.",
364 "Previous day.",
365 "All days, including the current day, since the most recent Sunday.",
366 "All days, including the current day, since the start of the current month.",
367 "All days, including the current day, since the start of the current quarter.",
368 "All days, including the current day, since the start of the current calendar year.",
369 "The previous completed week, beginning from Sunday.",
370 "The previous completed calendar month.",
371 "The previous completed quarter.",
372 "The previous completed calendar year.",
373 "The previous 7 days, excluding the current day.",
374 "The previous 30 days, excluding the current day.",
375 "The previous 90 days, excluding the current day.",
376 "The previous 365 days, excluding the current day.",
377 "All time for which data is available, excluding the current day.",
378 "The previous 14 days, excluding the current day.",
379 "The previous 60 days, excluding the current day."
380 ],
381 "type": "string"
382 }
383 },
384 "type": "object"
385 },
386 "Date": {
387 "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
388 "id": "Date",
389 "properties": {
390 "day": {
391 "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
392 "format": "int32",
393 "type": "integer"
394 },
395 "month": {
396 "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
397 "format": "int32",
398 "type": "integer"
399 },
400 "year": {
401 "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
402 "format": "int32",
403 "type": "integer"
404 }
405 },
406 "type": "object"
407 },
408 "FilterPair": {
409 "description": "Filter used to match traffic data in your report.",
410 "id": "FilterPair",
411 "properties": {
412 "type": {
413 "description": "Filter type.",
414 "type": "string"
415 },
416 "value": {
417 "description": "Filter value.",
418 "type": "string"
419 }
420 },
421 "type": "object"
422 },
423 "ListQueriesResponse": {
424 "id": "ListQueriesResponse",
425 "properties": {
426 "nextPageToken": {
427 "description": "A token, which can be sent as page_token to retrieve the next page of queries. If this field is omitted, there are no subsequent pages.",
428 "type": "string"
429 },
430 "queries": {
431 "description": "The list of queries.",
432 "items": {
433 "$ref": "Query"
434 },
435 "type": "array"
436 }
437 },
438 "type": "object"
439 },
440 "ListReportsResponse": {
441 "id": "ListReportsResponse",
442 "properties": {
443 "nextPageToken": {
444 "description": "A token, which can be sent as page_token to retrieve the next page of reports. If this field is omitted, there are no subsequent pages.",
445 "type": "string"
446 },
447 "reports": {
448 "description": "Retrieved reports.",
449 "items": {
450 "$ref": "Report"
451 },
452 "type": "array"
453 }
454 },
455 "type": "object"
456 },
457 "Options": {
458 "description": "Additional query options.",
459 "id": "Options",
460 "properties": {
461 "includeOnlyTargetedUserLists": {
462 "description": "Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.",
463 "type": "boolean"
464 }
465 },
466 "type": "object"
467 },
468 "Parameters": {
469 "description": "Parameters of a query or report.",
470 "id": "Parameters",
471 "properties": {
472 "filters": {
473 "description": "Filters used to match traffic data in your report.",
474 "items": {
475 "$ref": "FilterPair"
476 },
477 "type": "array"
478 },
479 "groupBys": {
480 "description": "Data is grouped by the filters listed in this field.",
481 "items": {
482 "type": "string"
483 },
484 "type": "array"
485 },
486 "metrics": {
487 "description": "Metrics to include as columns in your report.",
488 "items": {
489 "type": "string"
490 },
491 "type": "array"
492 },
493 "options": {
494 "$ref": "Options",
495 "description": "Additional query options."
496 },
497 "type": {
498 "description": "The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used.",
499 "enum": [
500 "REPORT_TYPE_UNSPECIFIED",
501 "STANDARD",
502 "INVENTORY_AVAILABILITY",
503 "AUDIENCE_COMPOSITION",
504 "FLOODLIGHT",
505 "YOUTUBE",
506 "GRP",
507 "YOUTUBE_PROGRAMMATIC_GUARANTEED",
508 "REACH",
509 "UNIQUE_REACH_AUDIENCE"
510 ],
511 "enumDeprecated": [
512 false,
513 false,
514 false,
515 true,
516 false,
517 false,
518 false,
519 false,
520 false,
521 false
522 ],
523 "enumDescriptions": [
524 "Default value when report type is not specified or is unknown in this version.",
525 "Standard report.",
526 "Inventory Availability report.",
527 "Audience Composition report.",
528 "Floodlight report.",
529 "YouTube report.",
530 "GRP report.",
531 "YouTube Programmatic Guaranteed report.",
532 "Reach report.",
533 "Unique Reach Audience report."
534 ],
535 "type": "string"
536 }
537 },
538 "type": "object"
539 },
540 "Query": {
541 "description": "Represents a query.",
542 "id": "Query",
543 "properties": {
544 "metadata": {
545 "$ref": "QueryMetadata",
546 "description": "Query metadata."
547 },
548 "params": {
549 "$ref": "Parameters",
550 "description": "Query parameters."
551 },
552 "queryId": {
553 "description": "Output only. Query ID.",
554 "format": "int64",
555 "readOnly": true,
556 "type": "string"
557 },
558 "schedule": {
559 "$ref": "QuerySchedule",
560 "description": "Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation."
561 }
562 },
563 "type": "object"
564 },
565 "QueryMetadata": {
566 "description": "Query metadata.",
567 "id": "QueryMetadata",
568 "properties": {
569 "dataRange": {
570 "$ref": "DataRange",
571 "description": "Range of report data. All reports will be based on the same time zone as used by the advertiser."
572 },
573 "format": {
574 "description": "Format of the generated report.",
575 "enum": [
576 "FORMAT_UNSPECIFIED",
577 "CSV",
578 "XLSX"
579 ],
580 "enumDescriptions": [
581 "Default value when format is not specified or is unknown in this version.",
582 "CSV.",
583 "Excel."
584 ],
585 "type": "string"
586 },
587 "sendNotification": {
588 "description": "Whether to send an email notification when a report is ready. Defaults to false.",
589 "type": "boolean"
590 },
591 "shareEmailAddress": {
592 "description": "List of email addresses which are sent email notifications when the report is finished. Separate from send_notification.",
593 "items": {
594 "type": "string"
595 },
596 "type": "array"
597 },
598 "title": {
599 "description": "Query title. It is used to name the reports generated from this query.",
600 "type": "string"
601 }
602 },
603 "type": "object"
604 },
605 "QuerySchedule": {
606 "description": "Information on when and how frequently to run a query.",
607 "id": "QuerySchedule",
608 "properties": {
609 "endDate": {
610 "$ref": "Date",
611 "description": "Date to periodically run the query until. Not applicable to `ONE_TIME` frequency."
612 },
613 "frequency": {
614 "description": "How often the query is run.",
615 "enum": [
616 "FREQUENCY_UNSPECIFIED",
617 "ONE_TIME",
618 "DAILY",
619 "WEEKLY",
620 "SEMI_MONTHLY",
621 "MONTHLY",
622 "QUARTERLY",
623 "YEARLY"
624 ],
625 "enumDescriptions": [
626 "Default value when frequency is not specified or is unknown in this version.",
627 "Only once.",
628 "Once a day.",
629 "Once a week.",
630 "Twice a month.",
631 "Once a month.",
632 "Once a quarter",
633 "Once a year."
634 ],
635 "type": "string"
636 },
637 "nextRunTimezoneCode": {
638 "description": "Canonical timezone code for report generation time. Defaults to `America/New_York`.",
639 "type": "string"
640 },
641 "startDate": {
642 "$ref": "Date",
643 "description": "When to start running the query. Not applicable to `ONE_TIME` frequency."
644 }
645 },
646 "type": "object"
647 },
648 "Report": {
649 "description": "Represents a report.",
650 "id": "Report",
651 "properties": {
652 "key": {
653 "$ref": "ReportKey",
654 "description": "Key used to identify a report."
655 },
656 "metadata": {
657 "$ref": "ReportMetadata",
658 "description": "Report metadata."
659 },
660 "params": {
661 "$ref": "Parameters",
662 "description": "Report parameters."
663 }
664 },
665 "type": "object"
666 },
667 "ReportKey": {
668 "description": "Key used to identify a report.",
669 "id": "ReportKey",
670 "properties": {
671 "queryId": {
672 "description": "Output only. Query ID.",
673 "format": "int64",
674 "readOnly": true,
675 "type": "string"
676 },
677 "reportId": {
678 "description": "Output only. Report ID.",
679 "format": "int64",
680 "readOnly": true,
681 "type": "string"
682 }
683 },
684 "type": "object"
685 },
686 "ReportMetadata": {
687 "description": "Report metadata.",
688 "id": "ReportMetadata",
689 "properties": {
690 "googleCloudStoragePath": {
691 "description": "Output only. The path to the location in Google Cloud Storage where the report is stored.",
692 "readOnly": true,
693 "type": "string"
694 },
695 "reportDataEndDate": {
696 "$ref": "Date",
697 "description": "The ending time for the data that is shown in the report."
698 },
699 "reportDataStartDate": {
700 "$ref": "Date",
701 "description": "The starting time for the data that is shown in the report."
702 },
703 "status": {
704 "$ref": "ReportStatus",
705 "description": "Report status."
706 }
707 },
708 "type": "object"
709 },
710 "ReportStatus": {
711 "description": "Report status.",
712 "id": "ReportStatus",
713 "properties": {
714 "finishTime": {
715 "description": "Output only. The time when this report either completed successfully or failed.",
716 "format": "google-datetime",
717 "readOnly": true,
718 "type": "string"
719 },
720 "format": {
721 "description": "The file type of the report.",
722 "enum": [
723 "FORMAT_UNSPECIFIED",
724 "CSV",
725 "XLSX"
726 ],
727 "enumDescriptions": [
728 "Default value when format is not specified or is unknown in this version.",
729 "CSV.",
730 "Excel."
731 ],
732 "type": "string"
733 },
734 "state": {
735 "description": "Output only. The state of the report.",
736 "enum": [
737 "STATE_UNSPECIFIED",
738 "QUEUED",
739 "RUNNING",
740 "DONE",
741 "FAILED"
742 ],
743 "enumDescriptions": [
744 "Default value when state is not specified or is unknown in this version.",
745 "The report is queued to run.",
746 "The report is currently running.",
747 "The report has finished running successfully.",
748 "The report has finished running in failure."
749 ],
750 "readOnly": true,
751 "type": "string"
752 }
753 },
754 "type": "object"
755 },
756 "RunQueryRequest": {
757 "description": "Request to run a stored query to generate a report.",
758 "id": "RunQueryRequest",
759 "properties": {
760 "dataRange": {
761 "$ref": "DataRange",
762 "description": "Report data range used to generate the report. If unspecified, the original parent query's data range is used."
763 }
764 },
765 "type": "object"
766 }
767 },
768 "servicePath": "v2/",
769 "title": "DoubleClick Bid Manager API",
770 "version": "v2"
771}View as plain text