| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="doubleclickbidmanager_v2.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v2.queries.html">queries</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="doubleclickbidmanager_v2.queries.reports.html">reports()</a></code> | |
| </p> | |
| <p class="firstline">Returns the reports Resource.</p> | |
| <p class="toc_element"> | |
| <code><a href="#close">close()</a></code></p> | |
| <p class="firstline">Close httplib2 connections.</p> | |
| <p class="toc_element"> | |
| <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates a query.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(queryId, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes a query as well as the associated reports.</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(queryId, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Retrieves a query.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Lists queries created by the current user.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next()</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#run">run(queryId, body=None, synchronous=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="close">close()</code> | |
| <pre>Close httplib2 connections.</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="create">create(body=None, x__xgafv=None)</code> | |
| <pre>Creates a query. | |
| Args: | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Represents a query. | |
| "metadata": { # Query metadata. # Query metadata. | |
| "dataRange": { # Report data range. # Range of report data. All reports will be based on the same time zone as used by the advertiser. | |
| "customEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "customStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The starting data for the data that is shown in the report. Note, `customStartDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "range": "A String", # Report data range used to generate the report. | |
| }, | |
| "format": "A String", # Format of the generated report. | |
| "sendNotification": True or False, # Whether to send an email notification when a report is ready. Defaults to false. | |
| "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from send_notification. | |
| "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", | |
| ], | |
| "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": [ # DisjunctiveMatchStatements within a Rule. DisjunctiveMatchStatement OR's all contained filters. | |
| { # 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", # Match logic of the filter. | |
| "values": [ # Values 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", # Match logic of the filter. | |
| "values": [ # Values to filter on. | |
| "A String", | |
| ], | |
| }, | |
| }, | |
| ], | |
| "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). | |
| }, | |
| ], | |
| }, | |
| }, | |
| "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. | |
| }, | |
| "queryId": "A String", # Output only. Query ID. | |
| "schedule": { # Information on when and how frequently to run a query. # Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation. | |
| "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date to periodically run the query until. Not applicable to `ONE_TIME` frequency. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "frequency": "A String", # How often the query is run. | |
| "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to `America/New_York`. | |
| "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # When to start running the query. Not applicable to `ONE_TIME` frequency. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| }, | |
| } | |
| 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. | |
| "metadata": { # Query metadata. # Query metadata. | |
| "dataRange": { # Report data range. # Range of report data. All reports will be based on the same time zone as used by the advertiser. | |
| "customEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "customStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The starting data for the data that is shown in the report. Note, `customStartDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "range": "A String", # Report data range used to generate the report. | |
| }, | |
| "format": "A String", # Format of the generated report. | |
| "sendNotification": True or False, # Whether to send an email notification when a report is ready. Defaults to false. | |
| "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from send_notification. | |
| "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", | |
| ], | |
| "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": [ # DisjunctiveMatchStatements within a Rule. DisjunctiveMatchStatement OR's all contained filters. | |
| { # 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", # Match logic of the filter. | |
| "values": [ # Values 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", # Match logic of the filter. | |
| "values": [ # Values to filter on. | |
| "A String", | |
| ], | |
| }, | |
| }, | |
| ], | |
| "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). | |
| }, | |
| ], | |
| }, | |
| }, | |
| "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. | |
| }, | |
| "queryId": "A String", # Output only. Query ID. | |
| "schedule": { # Information on when and how frequently to run a query. # Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation. | |
| "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date to periodically run the query until. Not applicable to `ONE_TIME` frequency. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "frequency": "A String", # How often the query is run. | |
| "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to `America/New_York`. | |
| "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # When to start running the query. Not applicable to `ONE_TIME` frequency. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(queryId, x__xgafv=None)</code> | |
| <pre>Deletes a query as well as the associated reports. | |
| Args: | |
| queryId: string, Required. ID of query 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="get">get(queryId, x__xgafv=None)</code> | |
| <pre>Retrieves a query. | |
| Args: | |
| queryId: string, Required. ID of query 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. | |
| "metadata": { # Query metadata. # Query metadata. | |
| "dataRange": { # Report data range. # Range of report data. All reports will be based on the same time zone as used by the advertiser. | |
| "customEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "customStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The starting data for the data that is shown in the report. Note, `customStartDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "range": "A String", # Report data range used to generate the report. | |
| }, | |
| "format": "A String", # Format of the generated report. | |
| "sendNotification": True or False, # Whether to send an email notification when a report is ready. Defaults to false. | |
| "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from send_notification. | |
| "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", | |
| ], | |
| "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": [ # DisjunctiveMatchStatements within a Rule. DisjunctiveMatchStatement OR's all contained filters. | |
| { # 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", # Match logic of the filter. | |
| "values": [ # Values 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", # Match logic of the filter. | |
| "values": [ # Values to filter on. | |
| "A String", | |
| ], | |
| }, | |
| }, | |
| ], | |
| "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). | |
| }, | |
| ], | |
| }, | |
| }, | |
| "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. | |
| }, | |
| "queryId": "A String", # Output only. Query ID. | |
| "schedule": { # Information on when and how frequently to run a query. # Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation. | |
| "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date to periodically run the query until. Not applicable to `ONE_TIME` frequency. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "frequency": "A String", # How often the query is run. | |
| "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to `America/New_York`. | |
| "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # When to start running the query. Not applicable to `ONE_TIME` frequency. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| }, | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> | |
| <pre>Lists queries created by the current user. | |
| Args: | |
| orderBy: string, Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. For example "metadata.title desc". Sorting is only supported for the following fields: * `queryId` * `metadata.title` | |
| pageSize: integer, Maximum number of results per page. Must be between `1` and `100`. Defaults to `100` if unspecified. | |
| pageToken: string, A page token, received from a previous list call. Provide this to retrieve the subsequent page of queries. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { | |
| "nextPageToken": "A String", # A token, which can be sent as page_token to retrieve the next page of queries. If this field is omitted, there are no subsequent pages. | |
| "queries": [ # The list of queries. | |
| { # Represents a query. | |
| "metadata": { # Query metadata. # Query metadata. | |
| "dataRange": { # Report data range. # Range of report data. All reports will be based on the same time zone as used by the advertiser. | |
| "customEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "customStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The starting data for the data that is shown in the report. Note, `customStartDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "range": "A String", # Report data range used to generate the report. | |
| }, | |
| "format": "A String", # Format of the generated report. | |
| "sendNotification": True or False, # Whether to send an email notification when a report is ready. Defaults to false. | |
| "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from send_notification. | |
| "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", | |
| ], | |
| "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": [ # DisjunctiveMatchStatements within a Rule. DisjunctiveMatchStatement OR's all contained filters. | |
| { # 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", # Match logic of the filter. | |
| "values": [ # Values 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", # Match logic of the filter. | |
| "values": [ # Values to filter on. | |
| "A String", | |
| ], | |
| }, | |
| }, | |
| ], | |
| "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). | |
| }, | |
| ], | |
| }, | |
| }, | |
| "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. | |
| }, | |
| "queryId": "A String", # Output only. Query ID. | |
| "schedule": { # Information on when and how frequently to run a query. # Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation. | |
| "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date to periodically run the query until. Not applicable to `ONE_TIME` frequency. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "frequency": "A String", # How often the query is run. | |
| "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to `America/New_York`. | |
| "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # When to start running the query. Not applicable to `ONE_TIME` frequency. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| }, | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next()</code> | |
| <pre>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. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="run">run(queryId, body=None, synchronous=None, x__xgafv=None)</code> | |
| <pre>Runs a stored query to generate a report. | |
| Args: | |
| queryId: string, Required. ID of query 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": { # Report data range. # Report data range used to generate the report. If unspecified, the original parent query's data range is used. | |
| "customEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "customStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The starting data for the data that is shown in the report. Note, `customStartDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "range": "A String", # Report data range used to generate the report. | |
| }, | |
| } | |
| synchronous: boolean, Whether the query should be run synchronously. When true, this method will not return until the query has finished running. When false or not specified, this method will return immediately. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Represents a report. | |
| "key": { # Key used to identify a report. # Key used to identify a report. | |
| "queryId": "A String", # Output only. Query ID. | |
| "reportId": "A String", # Output only. Report ID. | |
| }, | |
| "metadata": { # Report metadata. # Report metadata. | |
| "googleCloudStoragePath": "A String", # Output only. The path to the location in Google Cloud Storage where the report is stored. | |
| "reportDataEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The ending time for the data that is shown in the report. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "reportDataStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The starting time for the data that is shown in the report. | |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | |
| }, | |
| "status": { # Report status. # Report status. | |
| "finishTime": "A String", # Output only. The time when this report either completed successfully or failed. | |
| "format": "A String", # The file type of the report. | |
| "state": "A String", # Output only. The state of the report. | |
| }, | |
| }, | |
| "params": { # Parameters of a query or report. # Report 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", | |
| ], | |
| "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": [ # DisjunctiveMatchStatements within a Rule. DisjunctiveMatchStatement OR's all contained filters. | |
| { # 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", # Match logic of the filter. | |
| "values": [ # Values 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", # Match logic of the filter. | |
| "values": [ # Values to filter on. | |
| "A String", | |
| ], | |
| }, | |
| }, | |
| ], | |
| "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). | |
| }, | |
| ], | |
| }, | |
| }, | |
| "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |