Close httplib2 connections.
createquery(asynchronous=None, body=None, x__xgafv=None)
Creates a query.
deletequery(queryId, x__xgafv=None)
Deletes a stored query as well as the associated stored reports.
getquery(queryId, x__xgafv=None)
Retrieves a stored query.
listqueries(pageSize=None, pageToken=None, x__xgafv=None)
Retrieves stored queries.
listqueries_next(previous_request, previous_response)
Retrieves the next page of results.
runquery(queryId, asynchronous=None, body=None, x__xgafv=None)
Runs a stored query to generate a report.
close()
Close httplib2 connections.
createquery(asynchronous=None, body=None, x__xgafv=None)
Creates a query.
Args:
body: object, The request body.
The object takes the form of:
{ # Represents a query.
"kind": "A String", # 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",
],
"options": { # Additional query options. # Additional query options.
"includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.
"pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings.
"channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings.
"fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping.
"name": "A String", # Channel Grouping name.
"rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
{ # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied.
"disjunctiveMatchStatements": [
{ # DisjunctiveMatchStatement that OR's all contained filters.
"eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
},
],
"name": "A String", # Rule name.
},
],
},
"pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report.
{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.
"eventFilters": [ # Filter on an event to be applied to some part of the path.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
"pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path).
},
],
},
},
"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.
"startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency.
},
"timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
}
asynchronous: boolean, If true, tries to run the query asynchronously. Only applicable when the frequency is ONE_TIME.
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": "A String", # 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",
],
"options": { # Additional query options. # Additional query options.
"includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.
"pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings.
"channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings.
"fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping.
"name": "A String", # Channel Grouping name.
"rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
{ # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied.
"disjunctiveMatchStatements": [
{ # DisjunctiveMatchStatement that OR's all contained filters.
"eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
},
],
"name": "A String", # Rule name.
},
],
},
"pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report.
{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.
"eventFilters": [ # Filter on an event to be applied to some part of the path.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
"pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path).
},
],
},
},
"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.
"startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency.
},
"timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
}
deletequery(queryId, x__xgafv=None)
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
getquery(queryId, x__xgafv=None)
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": "A String", # 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",
],
"options": { # Additional query options. # Additional query options.
"includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.
"pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings.
"channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings.
"fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping.
"name": "A String", # Channel Grouping name.
"rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
{ # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied.
"disjunctiveMatchStatements": [
{ # DisjunctiveMatchStatement that OR's all contained filters.
"eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
},
],
"name": "A String", # Rule name.
},
],
},
"pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report.
{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.
"eventFilters": [ # Filter on an event to be applied to some part of the path.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
"pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path).
},
],
},
},
"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.
"startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency.
},
"timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
}
listqueries(pageSize=None, pageToken=None, x__xgafv=None)
Retrieves stored queries.
Args:
pageSize: integer, Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
pageToken: string, Optional pagination token.
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": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse".
"nextPageToken": "A String", # Next page's pagination token if one exists.
"queries": [ # Retrieved queries.
{ # Represents a query.
"kind": "A String", # 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",
],
"options": { # Additional query options. # Additional query options.
"includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.
"pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings.
"channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings.
"fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping.
"name": "A String", # Channel Grouping name.
"rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
{ # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied.
"disjunctiveMatchStatements": [
{ # DisjunctiveMatchStatement that OR's all contained filters.
"eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
},
],
"name": "A String", # Rule name.
},
],
},
"pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report.
{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded.
"eventFilters": [ # Filter on an event to be applied to some part of the path.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
"pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path).
},
],
},
},
"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.
"startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency.
},
"timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
},
],
}
listqueries_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
runquery(queryId, asynchronous=None, body=None, x__xgafv=None)
Runs a stored query to generate a report.
Args:
queryId: string, Query ID to run. (required)
body: object, The request body.
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.
}
asynchronous: boolean, If true, tries to run the query asynchronously.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format