AdSense Management API . accounts . reports . saved

Instance Methods

close()

Close httplib2 connections.

generate(name, currencyCode=None, dateRange=None, endDate_day=None, endDate_month=None, endDate_year=None, languageCode=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)

Generates a saved report.

generateCsv(name, currencyCode=None, dateRange=None, endDate_day=None, endDate_month=None, endDate_year=None, languageCode=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)

Generates a csv formatted saved report.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists saved reports.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
generate(name, currencyCode=None, dateRange=None, endDate_day=None, endDate_month=None, endDate_year=None, languageCode=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)
Generates a saved report.

Args:
  name: string, Required. Name of the saved report. Format: accounts/{account}/reports/{report} (required)
  currencyCode: string, The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
  dateRange: string, Date range of the report, if unset the range will be considered CUSTOM.
    Allowed values
      REPORTING_DATE_RANGE_UNSPECIFIED - Unspecified date range.
      CUSTOM - A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.
      TODAY - Current day.
      YESTERDAY - Yesterday.
      MONTH_TO_DATE - From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].
      YEAR_TO_DATE - From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].
      LAST_7_DAYS - Last 7 days, excluding current day.
      LAST_30_DAYS - Last 30 days, excluding current day.
  endDate_day: integer, 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.
  endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  languageCode: string, The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
  reportingTimeZone: string, Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
    Allowed values
      REPORTING_TIME_ZONE_UNSPECIFIED - Unspecified timezone.
      ACCOUNT_TIME_ZONE - Use the account timezone in the report.
      GOOGLE_TIME_ZONE - Use the Google timezone in the report (America/Los_Angeles).
  startDate_day: integer, 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.
  startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  startDate_year: integer, 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:

    { # Result of a generated report.
  "averages": { # Row representation. # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
    "cells": [ # Cells in the row.
      { # Cell representation.
        "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
      },
    ],
  },
  "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 # Required. End date of the range (inclusive).
    "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.
  },
  "headers": [ # The header information; one for each dimension in the request, followed by one for each metric in the request.
    { # The header information of the columns requested in the report.
      "currencyCode": "A String", # The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) of this column. Only present if the header type is METRIC_CURRENCY.
      "name": "A String", # Required. Name of the header.
      "type": "A String", # Required. Type of the header.
    },
  ],
  "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request.
    { # Row representation.
      "cells": [ # Cells in the row.
        { # Cell representation.
          "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
        },
      ],
    },
  ],
  "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 # Required. Start date of the range (inclusive).
    "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.
  },
  "totalMatchedRows": "A String", # The total number of rows matched by the report request.
  "totals": { # Row representation. # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
    "cells": [ # Cells in the row.
      { # Cell representation.
        "value": "A String", # Value in the cell. The dimension cells contain strings, and the metric cells contain numbers.
      },
    ],
  },
  "warnings": [ # Any warnings associated with generation of the report. These warnings are always returned in English.
    "A String",
  ],
}
generateCsv(name, currencyCode=None, dateRange=None, endDate_day=None, endDate_month=None, endDate_year=None, languageCode=None, reportingTimeZone=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)
Generates a csv formatted saved report.

Args:
  name: string, Required. Name of the saved report. Format: accounts/{account}/reports/{report} (required)
  currencyCode: string, The [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) to use when reporting on monetary metrics. Defaults to the account's currency if not set.
  dateRange: string, Date range of the report, if unset the range will be considered CUSTOM.
    Allowed values
      REPORTING_DATE_RANGE_UNSPECIFIED - Unspecified date range.
      CUSTOM - A custom date range specified using the `start_date` and `end_date` fields. This is the default if no ReportingDateRange is provided.
      TODAY - Current day.
      YESTERDAY - Yesterday.
      MONTH_TO_DATE - From the start of the current month to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-03-01, 2020-03-12].
      YEAR_TO_DATE - From the start of the current year to the current day. e.g. if the current date is 2020-03-12 then the range will be [2020-01-01, 2020-03-12].
      LAST_7_DAYS - Last 7 days, excluding current day.
      LAST_30_DAYS - Last 30 days, excluding current day.
  endDate_day: integer, 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.
  endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
  languageCode: string, The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an [IETF BCP-47 language code](https://en.wikipedia.org/wiki/IETF_language_tag).
  reportingTimeZone: string, Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see [changing the time zone of your reports](https://support.google.com/adsense/answer/9830725).
    Allowed values
      REPORTING_TIME_ZONE_UNSPECIFIED - Unspecified timezone.
      ACCOUNT_TIME_ZONE - Use the account timezone in the report.
      GOOGLE_TIME_ZONE - Use the Google timezone in the report (America/Los_Angeles).
  startDate_day: integer, 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.
  startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
  startDate_year: integer, 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:

    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
  "data": "A String", # The HTTP request/response body as raw binary.
  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
    {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  ],
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists saved reports.

Args:
  parent: string, Required. The account which owns the collection of reports. Format: accounts/{account} (required)
  pageSize: integer, The maximum number of reports to include in the response, used for paging. If unspecified, at most 10000 reports will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
  pageToken: string, A page token, received from a previous `ListPayments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPayments` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response definition for the saved reports list rpc.
  "nextPageToken": "A String", # Continuation token used to page through reports. To retrieve the next page of the results, set the next request's "page_token" value to this.
  "savedReports": [ # The reports returned in this list response.
    { # Representation of a saved report.
      "name": "A String", # Output only. Resource name of the report. Format: accounts/{account}/reports/{report}
      "title": "A String", # Report title as specified by publisher.
    },
  ],
}
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.