Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0d561ef2b7642e281eb69a81167e45d98d1621a4 / . / docs / dyn / doubleclickbidmanager_v1.queries.html
blob: f4de526099c167844f460f93de47c8709f9ed9a3 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Creates a query.</p>
83<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]84 <code><a href="#deletequery">deletequery(queryId, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Deletes a stored query as well as the associated stored reports.</p>
86<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87 <code><a href="#getquery">getquery(queryId, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Retrieves a stored query.</p>
89<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]90 <code><a href="#listqueries">listqueries(x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91<p class="firstline">Retrieves stored queries.</p>
92<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]93 <code><a href="#runquery">runquery(queryId, body=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]94<p class="firstline">Runs a stored query to generate a report.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103 <pre>Creates a query.
104
105Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]107 The object takes the form of:
108
109{ # Represents a query.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]110 &quot;queryId&quot;: &quot;A String&quot;, # Query ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]111 &quot;params&quot;: { # Parameters of a query or report. # Query parameters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]112 &quot;type&quot;: &quot;A String&quot;, # Report type.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]113 &quot;includeInviteData&quot;: True or False, # Deprecated. This field is no longer in use.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]114 &quot;metrics&quot;: [ # Metrics to include as columns in your report.
115 &quot;A String&quot;,
116 ],
117 &quot;groupBys&quot;: [ # Data is grouped by the filters listed in this field.
118 &quot;A String&quot;,
119 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]120 &quot;filters&quot;: [ # Filters used to match traffic data in your report.
121 { # Filter used to match traffic data in your report.
122 &quot;value&quot;: &quot;A String&quot;, # Filter value.
123 &quot;type&quot;: &quot;A String&quot;, # Filter type.
124 },
125 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]126 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]127 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;doubleclickbidmanager#query&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]128 &quot;metadata&quot;: { # Query metadata. # Query metadata.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]129 &quot;running&quot;: True or False, # Whether the latest report is currently running.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]130 &quot;format&quot;: &quot;A String&quot;, # Format of the generated report.
131 &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.
132 &quot;googleDrivePathForLatestReport&quot;: &quot;A String&quot;, # The path in Google Drive for the latest report.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]133 &quot;sendNotification&quot;: True or False, # Whether to send an email notification when a report is ready. Default to false.
134 &quot;dataRange&quot;: &quot;A String&quot;, # Range of report data.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]135 &quot;title&quot;: &quot;A String&quot;, # Query title. It is used to name the reports generated from this query.
136 &quot;googleCloudStoragePathForLatestReport&quot;: &quot;A String&quot;, # The path to the location in Google Cloud Storage where the latest report is stored.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]137 &quot;shareEmailAddress&quot;: [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
138 &quot;A String&quot;,
139 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]140 &quot;reportCount&quot;: 42, # Number of reports that have been generated for the query.
141 &quot;latestReportRunTimeMs&quot;: &quot;A String&quot;, # The time when the latest report started to run.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]142 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]143 &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.
144 &quot;timezoneCode&quot;: &quot;A String&quot;, # Canonical timezone code for report data time. Defaults to America/New_York.
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;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.
147 &quot;frequency&quot;: &quot;A String&quot;, # How often the query is run.
148 &quot;nextRunTimezoneCode&quot;: &quot;A String&quot;, # Canonical timezone code for report generation time. Defaults to America/New_York.
149 &quot;endTimeMs&quot;: &quot;A String&quot;, # Datetime to periodically run the query until.
150 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]151 &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.
152 }
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]153
154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159Returns:
160 An object of the form:
161
162 { # Represents a query.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]163 &quot;queryId&quot;: &quot;A String&quot;, # Query ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]164 &quot;params&quot;: { # Parameters of a query or report. # Query parameters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]165 &quot;type&quot;: &quot;A String&quot;, # Report type.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]166 &quot;includeInviteData&quot;: True or False, # Deprecated. This field is no longer in use.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]167 &quot;metrics&quot;: [ # Metrics to include as columns in your report.
168 &quot;A String&quot;,
169 ],
170 &quot;groupBys&quot;: [ # Data is grouped by the filters listed in this field.
171 &quot;A String&quot;,
172 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]173 &quot;filters&quot;: [ # Filters used to match traffic data in your report.
174 { # Filter used to match traffic data in your report.
175 &quot;value&quot;: &quot;A String&quot;, # Filter value.
176 &quot;type&quot;: &quot;A String&quot;, # Filter type.
177 },
178 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]179 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]180 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;doubleclickbidmanager#query&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]181 &quot;metadata&quot;: { # Query metadata. # Query metadata.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]182 &quot;running&quot;: True or False, # Whether the latest report is currently running.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]183 &quot;format&quot;: &quot;A String&quot;, # Format of the generated report.
184 &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.
185 &quot;googleDrivePathForLatestReport&quot;: &quot;A String&quot;, # The path in Google Drive for the latest report.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]186 &quot;sendNotification&quot;: True or False, # Whether to send an email notification when a report is ready. Default to false.
187 &quot;dataRange&quot;: &quot;A String&quot;, # Range of report data.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]188 &quot;title&quot;: &quot;A String&quot;, # Query title. It is used to name the reports generated from this query.
189 &quot;googleCloudStoragePathForLatestReport&quot;: &quot;A String&quot;, # The path to the location in Google Cloud Storage where the latest report is stored.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]190 &quot;shareEmailAddress&quot;: [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
191 &quot;A String&quot;,
192 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]193 &quot;reportCount&quot;: 42, # Number of reports that have been generated for the query.
194 &quot;latestReportRunTimeMs&quot;: &quot;A String&quot;, # The time when the latest report started to run.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]195 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]196 &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.
197 &quot;timezoneCode&quot;: &quot;A String&quot;, # Canonical timezone code for report data time. Defaults to America/New_York.
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;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.
200 &quot;frequency&quot;: &quot;A String&quot;, # How often the query is run.
201 &quot;nextRunTimezoneCode&quot;: &quot;A String&quot;, # Canonical timezone code for report generation time. Defaults to America/New_York.
202 &quot;endTimeMs&quot;: &quot;A String&quot;, # Datetime to periodically run the query until.
203 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]204 &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.
205 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]206</div>
207
208<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]209 <code class="details" id="deletequery">deletequery(queryId, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]210 <pre>Deletes a stored query as well as the associated stored reports.
211
212Args:
213 queryId: string, Query ID to delete. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]214 x__xgafv: string, V1 error format.
215 Allowed values
216 1 - v1 error format
217 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]218</pre>
219</div>
220
221<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]222 <code class="details" id="getquery">getquery(queryId, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]223 <pre>Retrieves a stored query.
224
225Args:
226 queryId: string, Query ID to retrieve. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]227 x__xgafv: string, V1 error format.
228 Allowed values
229 1 - v1 error format
230 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231
232Returns:
233 An object of the form:
234
235 { # Represents a query.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]236 &quot;queryId&quot;: &quot;A String&quot;, # Query ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]237 &quot;params&quot;: { # Parameters of a query or report. # Query parameters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]238 &quot;type&quot;: &quot;A String&quot;, # Report type.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]239 &quot;includeInviteData&quot;: True or False, # Deprecated. This field is no longer in use.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]240 &quot;metrics&quot;: [ # Metrics to include as columns in your report.
241 &quot;A String&quot;,
242 ],
243 &quot;groupBys&quot;: [ # Data is grouped by the filters listed in this field.
244 &quot;A String&quot;,
245 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]246 &quot;filters&quot;: [ # Filters used to match traffic data in your report.
247 { # Filter used to match traffic data in your report.
248 &quot;value&quot;: &quot;A String&quot;, # Filter value.
249 &quot;type&quot;: &quot;A String&quot;, # Filter type.
250 },
251 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]252 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]253 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;doubleclickbidmanager#query&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]254 &quot;metadata&quot;: { # Query metadata. # Query metadata.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]255 &quot;running&quot;: True or False, # Whether the latest report is currently running.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]256 &quot;format&quot;: &quot;A String&quot;, # Format of the generated report.
257 &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.
258 &quot;googleDrivePathForLatestReport&quot;: &quot;A String&quot;, # The path in Google Drive for the latest report.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]259 &quot;sendNotification&quot;: True or False, # Whether to send an email notification when a report is ready. Default to false.
260 &quot;dataRange&quot;: &quot;A String&quot;, # Range of report data.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]261 &quot;title&quot;: &quot;A String&quot;, # Query title. It is used to name the reports generated from this query.
262 &quot;googleCloudStoragePathForLatestReport&quot;: &quot;A String&quot;, # The path to the location in Google Cloud Storage where the latest report is stored.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]263 &quot;shareEmailAddress&quot;: [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
264 &quot;A String&quot;,
265 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]266 &quot;reportCount&quot;: 42, # Number of reports that have been generated for the query.
267 &quot;latestReportRunTimeMs&quot;: &quot;A String&quot;, # The time when the latest report started to run.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]268 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]269 &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.
270 &quot;timezoneCode&quot;: &quot;A String&quot;, # Canonical timezone code for report data time. Defaults to America/New_York.
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;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.
273 &quot;frequency&quot;: &quot;A String&quot;, # How often the query is run.
274 &quot;nextRunTimezoneCode&quot;: &quot;A String&quot;, # Canonical timezone code for report generation time. Defaults to America/New_York.
275 &quot;endTimeMs&quot;: &quot;A String&quot;, # Datetime to periodically run the query until.
276 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]277 &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.
278 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]279</div>
280
281<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]282 <code class="details" id="listqueries">listqueries(x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]283 <pre>Retrieves stored queries.
284
285Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]286 x__xgafv: string, V1 error format.
287 Allowed values
288 1 - v1 error format
289 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]290
291Returns:
292 An object of the form:
293
294 { # List queries response.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]295 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;doubleclickbidmanager#listQueriesResponse&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]296 &quot;queries&quot;: [ # Retrieved queries.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]297 { # Represents a query.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]298 &quot;queryId&quot;: &quot;A String&quot;, # Query ID.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]299 &quot;params&quot;: { # Parameters of a query or report. # Query parameters.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]300 &quot;type&quot;: &quot;A String&quot;, # Report type.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]301 &quot;includeInviteData&quot;: True or False, # Deprecated. This field is no longer in use.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]302 &quot;metrics&quot;: [ # Metrics to include as columns in your report.
303 &quot;A String&quot;,
304 ],
305 &quot;groupBys&quot;: [ # Data is grouped by the filters listed in this field.
306 &quot;A String&quot;,
307 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]308 &quot;filters&quot;: [ # Filters used to match traffic data in your report.
309 { # Filter used to match traffic data in your report.
310 &quot;value&quot;: &quot;A String&quot;, # Filter value.
311 &quot;type&quot;: &quot;A String&quot;, # Filter type.
312 },
313 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]314 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]315 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;doubleclickbidmanager#query&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]316 &quot;metadata&quot;: { # Query metadata. # Query metadata.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]317 &quot;running&quot;: True or False, # Whether the latest report is currently running.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]318 &quot;format&quot;: &quot;A String&quot;, # Format of the generated report.
319 &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.
320 &quot;googleDrivePathForLatestReport&quot;: &quot;A String&quot;, # The path in Google Drive for the latest report.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]321 &quot;sendNotification&quot;: True or False, # Whether to send an email notification when a report is ready. Default to false.
322 &quot;dataRange&quot;: &quot;A String&quot;, # Range of report data.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]323 &quot;title&quot;: &quot;A String&quot;, # Query title. It is used to name the reports generated from this query.
324 &quot;googleCloudStoragePathForLatestReport&quot;: &quot;A String&quot;, # The path to the location in Google Cloud Storage where the latest report is stored.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]325 &quot;shareEmailAddress&quot;: [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
326 &quot;A String&quot;,
327 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]328 &quot;reportCount&quot;: 42, # Number of reports that have been generated for the query.
329 &quot;latestReportRunTimeMs&quot;: &quot;A String&quot;, # The time when the latest report started to run.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]330 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]331 &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.
332 &quot;timezoneCode&quot;: &quot;A String&quot;, # Canonical timezone code for report data time. Defaults to America/New_York.
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;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.
335 &quot;frequency&quot;: &quot;A String&quot;, # How often the query is run.
336 &quot;nextRunTimezoneCode&quot;: &quot;A String&quot;, # Canonical timezone code for report generation time. Defaults to America/New_York.
337 &quot;endTimeMs&quot;: &quot;A String&quot;, # Datetime to periodically run the query until.
338 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]339 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]340 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]341 ],
342 }</pre>
343</div>
344
345<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]346 <code class="details" id="runquery">runquery(queryId, body=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]347 <pre>Runs a stored query to generate a report.
348
349Args:
350 queryId: string, Query ID to run. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]351 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]352 The object takes the form of:
353
354{ # Request to run a stored query to generate a report.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]355 &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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]356 &quot;timezoneCode&quot;: &quot;A String&quot;, # Canonical timezone code for report data time. Defaults to America/New_York.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame^]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;dataRange&quot;: &quot;A String&quot;, # Report data range used to generate the report.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]359 }
360
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]361 x__xgafv: string, V1 error format.
362 Allowed values
363 1 - v1 error format
364 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]365</pre>
366</div>
367
368</body></html>