docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/doubleclickbidmanager_v1.queries.html b/docs/dyn/doubleclickbidmanager_v1.queries.html
index 7b11e74..619e921 100644
--- a/docs/dyn/doubleclickbidmanager_v1.queries.html
+++ b/docs/dyn/doubleclickbidmanager_v1.queries.html
@@ -75,23 +75,31 @@
<h1><a href="doubleclickbidmanager_v1.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v1.queries.html">queries</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#createquery">createquery(body=None)</a></code></p>
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+ <code><a href="#createquery">createquery(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a query.</p>
<p class="toc_element">
- <code><a href="#deletequery">deletequery(queryId)</a></code></p>
+ <code><a href="#deletequery">deletequery(queryId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a stored query as well as the associated stored reports.</p>
<p class="toc_element">
- <code><a href="#getquery">getquery(queryId)</a></code></p>
+ <code><a href="#getquery">getquery(queryId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a stored query.</p>
<p class="toc_element">
- <code><a href="#listqueries">listqueries()</a></code></p>
+ <code><a href="#listqueries">listqueries(x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves stored queries.</p>
<p class="toc_element">
- <code><a href="#runquery">runquery(queryId, body=None)</a></code></p>
+ <code><a href="#runquery">runquery(queryId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Runs a stored query to generate a report.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="createquery">createquery(body=None)</code>
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="createquery">createquery(body=None, x__xgafv=None)</code>
<pre>Creates a query.
Args:
@@ -99,235 +107,243 @@
The object takes the form of:
{ # Represents a query.
- "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
- "metadata": { # Query metadata. # Query metadata.
- "dataRange": "A String", # Range of report data.
- "format": "A String", # Format of the generated report.
- "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
- "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
- "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
- "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
- #
- # An locale string not in the list above will generate reports in English.
- "reportCount": 42, # Number of reports that have been generated for the query.
- "running": True or False, # Whether the latest report is currently running.
- "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
- "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
- "A String",
- ],
- "title": "A String", # Query title. It is used to name the reports generated from this query.
+ "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.
+ "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
+ "nextRunMinuteOfDay": 42, # Deprecated. This field has no effect.
+ "endTimeMs": "A String", # Datetime to periodically run the query until.
+ "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
+ "frequency": "A String", # How often the query is run.
+ },
+ "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.
+ "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
+ "params": { # Parameters of a query or report. # Query parameters.
+ "type": "A String", # Report type.
+ "filters": [ # Filters used to match traffic data in your report.
+ { # Filter used to match traffic data in your report.
+ "type": "A String", # Filter type.
+ "value": "A String", # Filter value.
+ },
+ ],
+ "metrics": [ # Metrics to include as columns in your report.
+ "A String",
+ ],
+ "includeInviteData": True or False, # Deprecated. This field is no longer in use.
+ "groupBys": [ # Data is grouped by the filters listed in this field.
+ "A String",
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
+ "metadata": { # Query metadata. # Query metadata.
+ "format": "A String", # Format of the generated report.
+ "title": "A String", # Query title. It is used to name the reports generated from this query.
+ "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 An locale string not in the list above will generate reports in English.
+ "running": True or False, # Whether the latest report is currently running.
+ "reportCount": 42, # Number of reports that have been generated for the query.
+ "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
+ "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
+ "A String",
+ ],
+ "dataRange": "A String", # Range of report data.
+ "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
+ "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
+ "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
+ },
+ "queryId": "A String", # Query ID.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a query.
+ "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.
+ "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
+ "nextRunMinuteOfDay": 42, # Deprecated. This field has no effect.
+ "endTimeMs": "A String", # Datetime to periodically run the query until.
+ "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
+ "frequency": "A String", # How often the query is run.
},
+ "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.
+ "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
"params": { # Parameters of a query or report. # Query parameters.
+ "type": "A String", # Report type.
"filters": [ # Filters used to match traffic data in your report.
{ # Filter used to match traffic data in your report.
"type": "A String", # Filter type.
"value": "A String", # Filter value.
},
],
- "groupBys": [ # Data is grouped by the filters listed in this field.
- "A String",
- ],
- "includeInviteData": True or False, # Deprecated. This field is no longer in use.
"metrics": [ # Metrics to include as columns in your report.
"A String",
],
- "type": "A String", # Report type.
+ "includeInviteData": True or False, # Deprecated. This field is no longer in use.
+ "groupBys": [ # Data is grouped by the filters listed in this field.
+ "A String",
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
+ "metadata": { # Query metadata. # Query metadata.
+ "format": "A String", # Format of the generated report.
+ "title": "A String", # Query title. It is used to name the reports generated from this query.
+ "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 An locale string not in the list above will generate reports in English.
+ "running": True or False, # Whether the latest report is currently running.
+ "reportCount": 42, # Number of reports that have been generated for the query.
+ "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
+ "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
+ "A String",
+ ],
+ "dataRange": "A String", # Range of report data.
+ "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
+ "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
+ "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
},
"queryId": "A String", # Query ID.
- "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.
- "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.
- "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
- "endTimeMs": "A String", # Datetime to periodically run the query until.
- "frequency": "A String", # How often the query is run.
- "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.
- "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
- },
- "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a query.
- "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
- "metadata": { # Query metadata. # Query metadata.
- "dataRange": "A String", # Range of report data.
- "format": "A String", # Format of the generated report.
- "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
- "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
- "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
- "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
- #
- # An locale string not in the list above will generate reports in English.
- "reportCount": 42, # Number of reports that have been generated for the query.
- "running": True or False, # Whether the latest report is currently running.
- "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
- "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
- "A String",
- ],
- "title": "A String", # Query title. It is used to name the reports generated from this query.
- },
- "params": { # Parameters of a query or report. # Query parameters.
- "filters": [ # Filters used to match traffic data in your report.
- { # Filter used to match traffic data in your report.
- "type": "A String", # Filter type.
- "value": "A String", # Filter value.
- },
- ],
- "groupBys": [ # Data is grouped by the filters listed in this field.
- "A String",
- ],
- "includeInviteData": True or False, # Deprecated. This field is no longer in use.
- "metrics": [ # Metrics to include as columns in your report.
- "A String",
- ],
- "type": "A String", # Report type.
- },
- "queryId": "A String", # Query ID.
- "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.
- "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.
- "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
- "endTimeMs": "A String", # Datetime to periodically run the query until.
- "frequency": "A String", # How often the query is run.
- "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.
- "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
- },
- "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
- }</pre>
+ }</pre>
</div>
<div class="method">
- <code class="details" id="deletequery">deletequery(queryId)</code>
+ <code class="details" id="deletequery">deletequery(queryId, x__xgafv=None)</code>
<pre>Deletes a stored query as well as the associated stored reports.
Args:
queryId: string, Query ID to delete. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
</pre>
</div>
<div class="method">
- <code class="details" id="getquery">getquery(queryId)</code>
+ <code class="details" id="getquery">getquery(queryId, x__xgafv=None)</code>
<pre>Retrieves a stored query.
Args:
queryId: string, Query ID to retrieve. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Represents a query.
- "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
- "metadata": { # Query metadata. # Query metadata.
- "dataRange": "A String", # Range of report data.
- "format": "A String", # Format of the generated report.
- "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
- "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
- "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
- "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
- #
- # An locale string not in the list above will generate reports in English.
- "reportCount": 42, # Number of reports that have been generated for the query.
- "running": True or False, # Whether the latest report is currently running.
- "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
- "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
- "A String",
- ],
- "title": "A String", # Query title. It is used to name the reports generated from this query.
- },
- "params": { # Parameters of a query or report. # Query parameters.
- "filters": [ # Filters used to match traffic data in your report.
- { # Filter used to match traffic data in your report.
- "type": "A String", # Filter type.
- "value": "A String", # Filter value.
- },
- ],
- "groupBys": [ # Data is grouped by the filters listed in this field.
- "A String",
- ],
- "includeInviteData": True or False, # Deprecated. This field is no longer in use.
- "metrics": [ # Metrics to include as columns in your report.
- "A String",
- ],
- "type": "A String", # Report type.
- },
- "queryId": "A String", # Query ID.
- "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.
- "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.
- "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
- "endTimeMs": "A String", # Datetime to periodically run the query until.
- "frequency": "A String", # How often the query is run.
- "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.
- "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
- },
- "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
- }</pre>
+ "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.
+ "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
+ "nextRunMinuteOfDay": 42, # Deprecated. This field has no effect.
+ "endTimeMs": "A String", # Datetime to periodically run the query until.
+ "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
+ "frequency": "A String", # How often the query is run.
+ },
+ "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.
+ "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
+ "params": { # Parameters of a query or report. # Query parameters.
+ "type": "A String", # Report type.
+ "filters": [ # Filters used to match traffic data in your report.
+ { # Filter used to match traffic data in your report.
+ "type": "A String", # Filter type.
+ "value": "A String", # Filter value.
+ },
+ ],
+ "metrics": [ # Metrics to include as columns in your report.
+ "A String",
+ ],
+ "includeInviteData": True or False, # Deprecated. This field is no longer in use.
+ "groupBys": [ # Data is grouped by the filters listed in this field.
+ "A String",
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
+ "metadata": { # Query metadata. # Query metadata.
+ "format": "A String", # Format of the generated report.
+ "title": "A String", # Query title. It is used to name the reports generated from this query.
+ "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 An locale string not in the list above will generate reports in English.
+ "running": True or False, # Whether the latest report is currently running.
+ "reportCount": 42, # Number of reports that have been generated for the query.
+ "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
+ "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
+ "A String",
+ ],
+ "dataRange": "A String", # Range of report data.
+ "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
+ "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
+ "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
+ },
+ "queryId": "A String", # Query ID.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="listqueries">listqueries()</code>
+ <code class="details" id="listqueries">listqueries(x__xgafv=None)</code>
<pre>Retrieves stored queries.
Args:
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # List queries response.
- "kind": "doubleclickbidmanager#listQueriesResponse", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse".
"queries": [ # Retrieved queries.
{ # Represents a query.
- "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
- "metadata": { # Query metadata. # Query metadata.
- "dataRange": "A String", # Range of report data.
- "format": "A String", # Format of the generated report.
- "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
- "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
- "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
- "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
- #
- # An locale string not in the list above will generate reports in English.
- "reportCount": 42, # Number of reports that have been generated for the query.
- "running": True or False, # Whether the latest report is currently running.
- "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
- "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
- "A String",
- ],
- "title": "A String", # Query title. It is used to name the reports generated from this query.
- },
- "params": { # Parameters of a query or report. # Query parameters.
- "filters": [ # Filters used to match traffic data in your report.
- { # Filter used to match traffic data in your report.
- "type": "A String", # Filter type.
- "value": "A String", # Filter value.
- },
- ],
- "groupBys": [ # Data is grouped by the filters listed in this field.
- "A String",
- ],
- "includeInviteData": True or False, # Deprecated. This field is no longer in use.
- "metrics": [ # Metrics to include as columns in your report.
- "A String",
- ],
- "type": "A String", # Report type.
- },
- "queryId": "A String", # Query ID.
- "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.
- "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.
- "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
- "endTimeMs": "A String", # Datetime to periodically run the query until.
- "frequency": "A String", # How often the query is run.
- "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.
- "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
- },
- "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
+ "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.
+ "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
+ "nextRunMinuteOfDay": 42, # Deprecated. This field has no effect.
+ "endTimeMs": "A String", # Datetime to periodically run the query until.
+ "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
+ "frequency": "A String", # How often the query is run.
},
+ "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.
+ "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
+ "params": { # Parameters of a query or report. # Query parameters.
+ "type": "A String", # Report type.
+ "filters": [ # Filters used to match traffic data in your report.
+ { # Filter used to match traffic data in your report.
+ "type": "A String", # Filter type.
+ "value": "A String", # Filter value.
+ },
+ ],
+ "metrics": [ # Metrics to include as columns in your report.
+ "A String",
+ ],
+ "includeInviteData": True or False, # Deprecated. This field is no longer in use.
+ "groupBys": [ # Data is grouped by the filters listed in this field.
+ "A String",
+ ],
+ },
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
+ "metadata": { # Query metadata. # Query metadata.
+ "format": "A String", # Format of the generated report.
+ "title": "A String", # Query title. It is used to name the reports generated from this query.
+ "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 An locale string not in the list above will generate reports in English.
+ "running": True or False, # Whether the latest report is currently running.
+ "reportCount": 42, # Number of reports that have been generated for the query.
+ "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
+ "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
+ "A String",
+ ],
+ "dataRange": "A String", # Range of report data.
+ "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
+ "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
+ "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
+ },
+ "queryId": "A String", # Query ID.
+ },
],
+ "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse".
}</pre>
</div>
<div class="method">
- <code class="details" id="runquery">runquery(queryId, body=None)</code>
+ <code class="details" id="runquery">runquery(queryId, body=None, x__xgafv=None)</code>
<pre>Runs a stored query to generate a report.
Args:
@@ -336,12 +352,16 @@
The object takes the form of:
{ # Request to run a stored query to generate a report.
- "dataRange": "A String", # Report data range used to generate the report.
- "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.
- "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.
"timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
+ "dataRange": "A String", # Report data range used to generate the report.
+ "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.
+ "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.
}
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
</pre>
</div>