DoubleClick Bid Manager API . reports

Instance Methods

close()

Close httplib2 connections.

listreports(queryId, pageSize=None, pageToken=None, x__xgafv=None)

Retrieves stored reports.

listreports_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
listreports(queryId, pageSize=None, pageToken=None, x__xgafv=None)
Retrieves stored reports.

Args:
  queryId: string, Query ID with which the reports are associated. (required)
  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 reports response.
    "nextPageToken": "A String", # Next page's pagination token if one exists.
    "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listReportsResponse".
    "reports": [ # Retrieved reports.
      { # Represents a report.
        "params": { # Parameters of a query or report. # Report parameters.
          "groupBys": [ # Data is grouped by the filters listed in this field.
            "A String",
          ],
          "metrics": [ # Metrics to include as columns in your report.
            "A String",
          ],
          "filters": [ # Filters used to match traffic data in your report.
            { # Filter used to match traffic data in your report.
              "value": "A String", # Filter value.
              "type": "A String", # Filter type.
            },
          ],
          "includeInviteData": True or False, # Deprecated. This field is no longer in use.
          "type": "A String", # Report type.
          "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.
                "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.
                              "values": [ # Value to filter on.
                                "A String",
                              ],
                              "filter": "A String", # Dimension the filter is applied to.
                              "match": "A String", # Indicates how the filter should be matched to the value.
                            },
                          },
                        ],
                      },
                    ],
                    "name": "A String", # Rule name.
                  },
                ],
                "name": "A String", # Channel Grouping name.
                "fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping.
              },
              "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.
                        "values": [ # Value to filter on.
                          "A String",
                        ],
                        "filter": "A String", # Dimension the filter is applied to.
                        "match": "A String", # Indicates how the filter should be matched to the value.
                      },
                    },
                  ],
                  "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path).
                },
              ],
            },
          },
        },
        "metadata": { # Report metadata. # Report metadata.
          "status": { # Report status. # Report status.
            "format": "A String", # The file type of the report.
            "state": "A String", # The state of the report.
            "failure": { # An explanation of a report failure. # If the report failed, this records the cause.
              "errorCode": "A String", # Error code that shows why the report was not created.
            },
            "finishTimeMs": "A String", # The time when this report either completed successfully or failed.
          },
          "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report.
          "googleCloudStoragePath": "A String", # The path to the location in Google Cloud Storage where the report is stored.
          "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report.
        },
        "key": { # Key used to identify a report. # Key used to identify a report.
          "reportId": "A String", # Report ID.
          "queryId": "A String", # Query ID.
        },
      },
    ],
  }
listreports_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.