Debian Codegraph @

docs/dyn/doubleclickbidmanager_v1.queries.html

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