DoubleClick Bid Manager API . reports

Instance Methods

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

Retrieves stored reports.

listreports_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

listreports(queryId, pageSize=None, pageToken=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.

Returns:
  An object of the form:

    { # List reports response.
    "kind": "doubleclickbidmanager#listReportsResponse", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listReportsResponse".
    "nextPageToken": "A String", # Next page's pagination token if one exists.
    "reports": [ # Retrieved reports.
      { # Represents a report.
        "key": { # Key used to identify a report. # Key used to identify a report.
          "queryId": "A String", # Query ID.
          "reportId": "A String", # Report ID.
        },
        "metadata": { # Report metadata. # Report metadata.
          "googleCloudStoragePath": "A String", # The path to the location in Google Cloud Storage where the report is stored.
          "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report.
          "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report.
          "status": { # Report status. # Report status.
            "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.
            "format": "A String", # The file type of the report.
            "state": "A String", # 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",
          ],
          "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.
          },
          "type": "A String", # Report type.
        },
      },
    ],
  }
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.