• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="doubleclickbidmanager_v1.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v1.queries.html">queries</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#createquery">createquery(body)</a></code></p>
79<p class="firstline">Creates a query.</p>
80<p class="toc_element">
81  <code><a href="#deletequery">deletequery(queryId)</a></code></p>
82<p class="firstline">Deletes a stored query as well as the associated stored reports.</p>
83<p class="toc_element">
84  <code><a href="#getquery">getquery(queryId)</a></code></p>
85<p class="firstline">Retrieves a stored query.</p>
86<p class="toc_element">
87  <code><a href="#listqueries">listqueries()</a></code></p>
88<p class="firstline">Retrieves stored queries.</p>
89<p class="toc_element">
90  <code><a href="#runquery">runquery(queryId, body)</a></code></p>
91<p class="firstline">Runs a stored query to generate a report.</p>
92<h3>Method Details</h3>
93<div class="method">
94    <code class="details" id="createquery">createquery(body)</code>
95  <pre>Creates a query.
96
97Args:
98  body: object, The request body. (required)
99    The object takes the form of:
100
101{ # Represents a query.
102  "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
103  "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
104    "endTimeMs": "A String", # Datetime to periodically run the query until.
105    "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
106    "frequency": "A String", # How often the query is run.
107    "nextRunMinuteOfDay": 42, # 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.
108  },
109  "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
110  "reportDataEndTimeMs": "A String", # 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.
111  "queryId": "A String", # Query ID.
112  "params": { # Parameters of a query or report. # Query parameters.
113    "metrics": [ # Metrics to include as columns in your report.
114      "A String",
115    ],
116    "includeInviteData": True or False, # Whether to include data from Invite Media.
117    "type": "A String", # Report type.
118    "groupBys": [ # Data is grouped by the filters listed in this field.
119      "A String",
120    ],
121    "filters": [ # Filters used to match traffic data in your report.
122      { # Filter used to match traffic data in your report.
123        "type": "A String", # Filter type.
124        "value": "A String", # Filter value.
125      },
126    ],
127  },
128  "reportDataStartTimeMs": "A String", # 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.
129  "metadata": { # Query metadata. # Query metadata.
130    "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
131    "dataRange": "A String", # Range of report data.
132    "format": "A String", # Format of the generated report.
133    "locale": "A String", # 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
134        #
135        # An locale string not in the list above will generate reports in English.
136    "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
137    "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
138    "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
139      "A String",
140    ],
141    "reportCount": 42, # Number of reports that have been generated for the query.
142    "running": True or False, # Whether the latest report is currently running.
143    "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
144    "title": "A String", # Query title. It is used to name the reports generated from this query.
145  },
146}
147
148
149Returns:
150  An object of the form:
151
152    { # Represents a query.
153    "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
154    "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
155      "endTimeMs": "A String", # Datetime to periodically run the query until.
156      "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
157      "frequency": "A String", # How often the query is run.
158      "nextRunMinuteOfDay": 42, # 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.
159    },
160    "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
161    "reportDataEndTimeMs": "A String", # 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.
162    "queryId": "A String", # Query ID.
163    "params": { # Parameters of a query or report. # Query parameters.
164      "metrics": [ # Metrics to include as columns in your report.
165        "A String",
166      ],
167      "includeInviteData": True or False, # Whether to include data from Invite Media.
168      "type": "A String", # Report type.
169      "groupBys": [ # Data is grouped by the filters listed in this field.
170        "A String",
171      ],
172      "filters": [ # Filters used to match traffic data in your report.
173        { # Filter used to match traffic data in your report.
174          "type": "A String", # Filter type.
175          "value": "A String", # Filter value.
176        },
177      ],
178    },
179    "reportDataStartTimeMs": "A String", # 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.
180    "metadata": { # Query metadata. # Query metadata.
181      "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
182      "dataRange": "A String", # Range of report data.
183      "format": "A String", # Format of the generated report.
184      "locale": "A String", # 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
185          #
186          # An locale string not in the list above will generate reports in English.
187      "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
188      "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
189      "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
190        "A String",
191      ],
192      "reportCount": 42, # Number of reports that have been generated for the query.
193      "running": True or False, # Whether the latest report is currently running.
194      "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
195      "title": "A String", # Query title. It is used to name the reports generated from this query.
196    },
197  }</pre>
198</div>
199
200<div class="method">
201    <code class="details" id="deletequery">deletequery(queryId)</code>
202  <pre>Deletes a stored query as well as the associated stored reports.
203
204Args:
205  queryId: string, Query ID to delete. (required)
206</pre>
207</div>
208
209<div class="method">
210    <code class="details" id="getquery">getquery(queryId)</code>
211  <pre>Retrieves a stored query.
212
213Args:
214  queryId: string, Query ID to retrieve. (required)
215
216Returns:
217  An object of the form:
218
219    { # Represents a query.
220    "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
221    "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
222      "endTimeMs": "A String", # Datetime to periodically run the query until.
223      "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
224      "frequency": "A String", # How often the query is run.
225      "nextRunMinuteOfDay": 42, # 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.
226    },
227    "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
228    "reportDataEndTimeMs": "A String", # 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.
229    "queryId": "A String", # Query ID.
230    "params": { # Parameters of a query or report. # Query parameters.
231      "metrics": [ # Metrics to include as columns in your report.
232        "A String",
233      ],
234      "includeInviteData": True or False, # Whether to include data from Invite Media.
235      "type": "A String", # Report type.
236      "groupBys": [ # Data is grouped by the filters listed in this field.
237        "A String",
238      ],
239      "filters": [ # Filters used to match traffic data in your report.
240        { # Filter used to match traffic data in your report.
241          "type": "A String", # Filter type.
242          "value": "A String", # Filter value.
243        },
244      ],
245    },
246    "reportDataStartTimeMs": "A String", # 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.
247    "metadata": { # Query metadata. # Query metadata.
248      "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
249      "dataRange": "A String", # Range of report data.
250      "format": "A String", # Format of the generated report.
251      "locale": "A String", # 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
252          #
253          # An locale string not in the list above will generate reports in English.
254      "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
255      "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
256      "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
257        "A String",
258      ],
259      "reportCount": 42, # Number of reports that have been generated for the query.
260      "running": True or False, # Whether the latest report is currently running.
261      "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
262      "title": "A String", # Query title. It is used to name the reports generated from this query.
263    },
264  }</pre>
265</div>
266
267<div class="method">
268    <code class="details" id="listqueries">listqueries()</code>
269  <pre>Retrieves stored queries.
270
271Args:
272
273Returns:
274  An object of the form:
275
276    { # List queries response.
277    "kind": "doubleclickbidmanager#listQueriesResponse", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse".
278    "queries": [ # Retrieved queries.
279      { # Represents a query.
280        "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
281        "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
282          "endTimeMs": "A String", # Datetime to periodically run the query until.
283          "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
284          "frequency": "A String", # How often the query is run.
285          "nextRunMinuteOfDay": 42, # 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.
286        },
287        "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
288        "reportDataEndTimeMs": "A String", # 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.
289        "queryId": "A String", # Query ID.
290        "params": { # Parameters of a query or report. # Query parameters.
291          "metrics": [ # Metrics to include as columns in your report.
292            "A String",
293          ],
294          "includeInviteData": True or False, # Whether to include data from Invite Media.
295          "type": "A String", # Report type.
296          "groupBys": [ # Data is grouped by the filters listed in this field.
297            "A String",
298          ],
299          "filters": [ # Filters used to match traffic data in your report.
300            { # Filter used to match traffic data in your report.
301              "type": "A String", # Filter type.
302              "value": "A String", # Filter value.
303            },
304          ],
305        },
306        "reportDataStartTimeMs": "A String", # 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.
307        "metadata": { # Query metadata. # Query metadata.
308          "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
309          "dataRange": "A String", # Range of report data.
310          "format": "A String", # Format of the generated report.
311          "locale": "A String", # 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
312              #
313              # An locale string not in the list above will generate reports in English.
314          "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
315          "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
316          "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
317            "A String",
318          ],
319          "reportCount": 42, # Number of reports that have been generated for the query.
320          "running": True or False, # Whether the latest report is currently running.
321          "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
322          "title": "A String", # Query title. It is used to name the reports generated from this query.
323        },
324      },
325    ],
326  }</pre>
327</div>
328
329<div class="method">
330    <code class="details" id="runquery">runquery(queryId, body)</code>
331  <pre>Runs a stored query to generate a report.
332
333Args:
334  queryId: string, Query ID to run. (required)
335  body: object, The request body. (required)
336    The object takes the form of:
337
338{ # Request to run a stored query to generate a report.
339    "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.
340    "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
341    "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.
342    "dataRange": "A String", # Report data range used to generate the report.
343  }
344
345</pre>
346</div>
347
348</body></html>