Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / doubleclickbidmanager_v1.queries.html
blob: b37081e50f73374731b75b8d3a640165cbd04b30 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame^]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 "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
134 "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
135 "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
136 "A String",
137 ],
138 "reportCount": 42, # Number of reports that have been generated for the query.
139 "running": True or False, # Whether the latest report is currently running.
140 "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
141 "title": "A String", # Query title. It is used to name the reports generated from this query.
142 },
143}
144
145
146Returns:
147 An object of the form:
148
149 { # Represents a query.
150 "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
151 "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
152 "endTimeMs": "A String", # Datetime to periodically run the query until.
153 "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
154 "frequency": "A String", # How often the query is run.
155 "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.
156 },
157 "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
158 "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.
159 "queryId": "A String", # Query ID.
160 "params": { # Parameters of a query or report. # Query parameters.
161 "metrics": [ # Metrics to include as columns in your report.
162 "A String",
163 ],
164 "includeInviteData": True or False, # Whether to include data from Invite Media.
165 "type": "A String", # Report type.
166 "groupBys": [ # Data is grouped by the filters listed in this field.
167 "A String",
168 ],
169 "filters": [ # Filters used to match traffic data in your report.
170 { # Filter used to match traffic data in your report.
171 "type": "A String", # Filter type.
172 "value": "A String", # Filter value.
173 },
174 ],
175 },
176 "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.
177 "metadata": { # Query metadata. # Query metadata.
178 "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
179 "dataRange": "A String", # Range of report data.
180 "format": "A String", # Format of the generated report.
181 "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
182 "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
183 "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
184 "A String",
185 ],
186 "reportCount": 42, # Number of reports that have been generated for the query.
187 "running": True or False, # Whether the latest report is currently running.
188 "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
189 "title": "A String", # Query title. It is used to name the reports generated from this query.
190 },
191 }</pre>
192</div>
193
194<div class="method">
195 <code class="details" id="deletequery">deletequery(queryId)</code>
196 <pre>Deletes a stored query as well as the associated stored reports.
197
198Args:
199 queryId: string, Query ID to delete. (required)
200</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="getquery">getquery(queryId)</code>
205 <pre>Retrieves a stored query.
206
207Args:
208 queryId: string, Query ID to retrieve. (required)
209
210Returns:
211 An object of the form:
212
213 { # Represents a query.
214 "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
215 "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
216 "endTimeMs": "A String", # Datetime to periodically run the query until.
217 "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
218 "frequency": "A String", # How often the query is run.
219 "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.
220 },
221 "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
222 "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.
223 "queryId": "A String", # Query ID.
224 "params": { # Parameters of a query or report. # Query parameters.
225 "metrics": [ # Metrics to include as columns in your report.
226 "A String",
227 ],
228 "includeInviteData": True or False, # Whether to include data from Invite Media.
229 "type": "A String", # Report type.
230 "groupBys": [ # Data is grouped by the filters listed in this field.
231 "A String",
232 ],
233 "filters": [ # Filters used to match traffic data in your report.
234 { # Filter used to match traffic data in your report.
235 "type": "A String", # Filter type.
236 "value": "A String", # Filter value.
237 },
238 ],
239 },
240 "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.
241 "metadata": { # Query metadata. # Query metadata.
242 "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
243 "dataRange": "A String", # Range of report data.
244 "format": "A String", # Format of the generated report.
245 "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
246 "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
247 "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
248 "A String",
249 ],
250 "reportCount": 42, # Number of reports that have been generated for the query.
251 "running": True or False, # Whether the latest report is currently running.
252 "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
253 "title": "A String", # Query title. It is used to name the reports generated from this query.
254 },
255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="listqueries">listqueries()</code>
260 <pre>Retrieves stored queries.
261
262Args:
263
264Returns:
265 An object of the form:
266
267 { # List queries response.
268 "kind": "doubleclickbidmanager#listQueriesResponse", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse".
269 "queries": [ # Retrieved queries.
270 { # Represents a query.
271 "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
272 "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
273 "endTimeMs": "A String", # Datetime to periodically run the query until.
274 "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
275 "frequency": "A String", # How often the query is run.
276 "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.
277 },
278 "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
279 "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.
280 "queryId": "A String", # Query ID.
281 "params": { # Parameters of a query or report. # Query parameters.
282 "metrics": [ # Metrics to include as columns in your report.
283 "A String",
284 ],
285 "includeInviteData": True or False, # Whether to include data from Invite Media.
286 "type": "A String", # Report type.
287 "groupBys": [ # Data is grouped by the filters listed in this field.
288 "A String",
289 ],
290 "filters": [ # Filters used to match traffic data in your report.
291 { # Filter used to match traffic data in your report.
292 "type": "A String", # Filter type.
293 "value": "A String", # Filter value.
294 },
295 ],
296 },
297 "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.
298 "metadata": { # Query metadata. # Query metadata.
299 "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
300 "dataRange": "A String", # Range of report data.
301 "format": "A String", # Format of the generated report.
302 "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
303 "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
304 "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
305 "A String",
306 ],
307 "reportCount": 42, # Number of reports that have been generated for the query.
308 "running": True or False, # Whether the latest report is currently running.
309 "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
310 "title": "A String", # Query title. It is used to name the reports generated from this query.
311 },
312 },
313 ],
314 }</pre>
315</div>
316
317<div class="method">
318 <code class="details" id="runquery">runquery(queryId, body)</code>
319 <pre>Runs a stored query to generate a report.
320
321Args:
322 queryId: string, Query ID to run. (required)
323 body: object, The request body. (required)
324 The object takes the form of:
325
326{ # Request to run a stored query to generate a report.
327 "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.
328 "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
329 "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.
330 "dataRange": "A String", # Report data range used to generate the report.
331 }
332
333</pre>
334</div>
335
336</body></html>