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 generated by the provided query.
Retrieves the next page of results.
close()
Close httplib2 connections.
get(queryId, reportId, x__xgafv=None)
Retrieves a report.
Args:
queryId: string, Required. The ID of the query that generated the report. (required)
reportId: string, Required. The ID of the 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:
{ # A single report generated by its parent report.
"key": { # Identifying information of a report. # The key information identifying the report.
"queryId": "A String", # Output only. The unique ID of the query that generated the report.
"reportId": "A String", # Output only. The unique ID of the report.
},
"metadata": { # The metadata of a report. # The metadata of the report.
"googleCloudStoragePath": "A String", # Output only. The location of the generated report file in Google Cloud Storage. This field will be absent if status.state is not `DONE`.
"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 end date of the report data date range.
"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 start date of the report data date range.
"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": { # The status of a report. # The status of the report.
"finishTime": "A String", # Output only. The timestamp of when report generation finished successfully or in failure. This field will not be set unless state is `DONE` or `FAILED`.
"format": "A String", # The format of the generated report file.
"state": "A String", # Output only. The state of the report generation.
},
},
"params": { # Parameters of a generated report. # The parameters of the report.
"filters": [ # Filters to limit the scope of reported data.
{ # Represents a single filter rule.
"type": "A String", # The type of value to filter by. Defined by a [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) value.
"value": "A String", # The identifying value to filter by, such as a relevant resource ID.
},
],
"groupBys": [ # Dimensions by which to segment and group the data. Defined by [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) values.
"A String",
],
"metrics": [ # Metrics to define the data populating the report. Defined by [Metric](/bid-manager/reference/rest/v2/filters-metrics#metrics) values.
"A String",
],
"options": { # Report parameter options. # Additional report parameter options.
"includeOnlyTargetedUserLists": True or False, # Whether to include data for audience lists specifically targeted by filtered line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters.
},
"type": "A String", # The type of the report. The type of the report determines the dimesions, filters, and metrics that can be used.
},
}
list(queryId, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists reports generated by the provided query.
Args:
queryId: string, Required. The ID of the query that generated the reports. (required)
orderBy: string, Field to sort the list by. Accepts the following values: * `key.reportId` (default) The default sorting order is ascending. To specify descending order for a field, add the suffix `desc` to the field name. For example, `key.reportId desc`.
pageSize: integer, Maximum number of results per page. Must be between `1` and `100`. Defaults to `100` if unspecified.
pageToken: string, A token identifying which page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to the `queries.reports.list` method. If unspecified, the first page of results is returned.
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 to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `queries.reports.list` method to retrieve the next page of results.
"reports": [ # The list of reports. This field will be absent if empty.
{ # A single report generated by its parent report.
"key": { # Identifying information of a report. # The key information identifying the report.
"queryId": "A String", # Output only. The unique ID of the query that generated the report.
"reportId": "A String", # Output only. The unique ID of the report.
},
"metadata": { # The metadata of a report. # The metadata of the report.
"googleCloudStoragePath": "A String", # Output only. The location of the generated report file in Google Cloud Storage. This field will be absent if status.state is not `DONE`.
"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 end date of the report data date range.
"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 start date of the report data date range.
"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": { # The status of a report. # The status of the report.
"finishTime": "A String", # Output only. The timestamp of when report generation finished successfully or in failure. This field will not be set unless state is `DONE` or `FAILED`.
"format": "A String", # The format of the generated report file.
"state": "A String", # Output only. The state of the report generation.
},
},
"params": { # Parameters of a generated report. # The parameters of the report.
"filters": [ # Filters to limit the scope of reported data.
{ # Represents a single filter rule.
"type": "A String", # The type of value to filter by. Defined by a [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) value.
"value": "A String", # The identifying value to filter by, such as a relevant resource ID.
},
],
"groupBys": [ # Dimensions by which to segment and group the data. Defined by [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) values.
"A String",
],
"metrics": [ # Metrics to define the data populating the report. Defined by [Metric](/bid-manager/reference/rest/v2/filters-metrics#metrics) values.
"A String",
],
"options": { # Report parameter options. # Additional report parameter options.
"includeOnlyTargetedUserLists": True or False, # Whether to include data for audience lists specifically targeted by filtered line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters.
},
"type": "A String", # The type of the report. The type of the report determines the dimesions, filters, and metrics that 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.