DoubleClick Bid Manager API . queries . reports

Instance Methods

close()

Close httplib2 connections.

get(queryId, reportId, x__xgafv=None)

Retrieves a report.

list(queryId, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists reports associated with a query.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(queryId, reportId, x__xgafv=None)
Retrieves a report.

Args:
  queryId: string, Required. ID of the query the report is associated with. (required)
  reportId: string, Required. ID of the report 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 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.
  },
}
list(queryId, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists reports associated with a query.

Args:
  queryId: string, Required. ID of the query with which the reports are associated. (required)
  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 "key.reportId desc". Sorting is only supported for the following fields: * `key.reportId`
  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 reports.
  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 reports. If this field is omitted, there are no subsequent pages.
  "reports": [ # Retrieved reports.
    { # 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.
      },
    },
  ],
}
list_next()
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.