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