AdSense Management API (adsense:v1.4)

2021-12-02

39 removed methods | Removed API

Deletions

    Methods
  • adsense.accounts.list

      HTTP Method: GET

      Description: List all accounts available to this AdSense account.

      Parameters:

        maxResults

          Format: int32

          Location: query

          Type: integer

          Description: The maximum number of accounts to include in the response, used for paging.

          Minimum: 0

          Maximum: 10000

        pageToken

          Description: A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Type: string

          Location: query

      Path: accounts

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
  • adsense.accounts.get

      HTTP Method: GET

      Parameter Order: accountId

      Parameters:

        accountId

          Required: Yes

          Description: Account to get information about.

          Type: string

          Location: path

        tree

          Description: Whether the tree of sub accounts should be returned.

          Location: query

          Type: boolean

      Description: Get information about the selected AdSense account.

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Path: accounts/{accountId}

  • adsense.accounts.reports.saved.list

      HTTP Method: GET

      Description: List all saved reports in the specified AdSense account.

      Parameter Order: accountId

      Parameters:

        maxResults

          Description: The maximum number of saved reports to include in the response, used for paging.

          Minimum: 0

          Format: int32

          Type: integer

          Maximum: 100

          Location: query

        accountId

          Type: string

          Location: path

          Required: Yes

          Description: Account to which the saved reports belong.

        pageToken

          Type: string

          Location: query

          Description: A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

      Path: accounts/{accountId}/reports/saved

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
  • adsense.accounts.reports.saved.generate

      Path: accounts/{accountId}/reports/{savedReportId}

      Parameter Order:

    • accountId
    • savedReportId
    • Parameters:

        maxResults

          Description: The maximum number of rows of report data to return.

          Type: integer

          Minimum: 0

          Format: int32

          Location: query

          Maximum: 50000

        accountId

          Type: string

          Description: Account to which the saved reports belong.

          Required: Yes

          Location: path

        savedReportId

          Description: The saved report to retrieve.

          Required: Yes

          Location: path

          Type: string

        startIndex

          Maximum: 5000

          Minimum: 0

          Description: Index of the first row of report data to return.

          Type: integer

          Format: int32

          Location: query

        locale

          Description: Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

          Type: string

          Pattern: [a-zA-Z_]+

          Location: query

      HTTP Method: GET

      Description: Generate an AdSense report based on the saved report ID sent in the query parameters.

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
  • adsense.accounts.reports.generate

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • HTTP Method: GET

      Path: accounts/{accountId}/reports

      Description: Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

      Parameters:

        maxResults

          Maximum: 50000

          Description: The maximum number of rows of report data to return.

          Location: query

          Format: int32

          Minimum: 0

          Type: integer

        endDate

          Location: query

          Description: End of the date range to report on in "YYYY-MM-DD" format, inclusive.

          Pattern: \d{4}-\d{2}-\d{2}|(today|startOfMonth|startOfYear)(([\-\+]\d+[dwmy]){0,3}?)|(latest-(\d{2})-(\d{2})(-\d+y)?)|(latest-latest-(\d{2})(-\d+m)?)

          Type: string

          Required: Yes

        startIndex

          Minimum: 0

          Description: Index of the first row of report data to return.

          Type: integer

          Maximum: 5000

          Location: query

          Format: int32

        filter

          Pattern: [a-zA-Z_]+(==|=@).+

          Description: Filters to be run on the report.

          Repeated: Yes

          Type: string

          Location: query

        metric

          Pattern: [a-zA-Z_]+

          Repeated: Yes

          Location: query

          Description: Numeric columns to include in the report.

          Type: string

        locale

          Location: query

          Description: Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

          Type: string

          Pattern: [a-zA-Z_]+

        accountId

          Location: path

          Type: string

          Description: Account upon which to report.

          Required: Yes

        sort

          Repeated: Yes

          Location: query

          Description: The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.

          Pattern: (\+|-)?[a-zA-Z_]+

          Type: string

        currency

          Description: Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.

          Location: query

          Type: string

          Pattern: [a-zA-Z]+

        startDate

          Location: query

          Pattern: \d{4}-\d{2}-\d{2}|(today|startOfMonth|startOfYear)(([\-\+]\d+[dwmy]){0,3}?)|(latest-(\d{2})-(\d{2})(-\d+y)?)|(latest-latest-(\d{2})(-\d+m)?)

          Description: Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

          Required: Yes

          Type: string

        useTimezoneReporting

          Description: Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.

          Location: query

          Type: boolean

        dimension

          Location: query

          Repeated: Yes

          Description: Dimensions to base the report on.

          Type: string

          Pattern: [a-zA-Z_]+

      Supportsmediadownload: Yes

      Parameter Order:

    • accountId
    • startDate
    • endDate
  • adsense.accounts.adclients.list

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • HTTP Method: GET

      Parameters:

        accountId

          Location: path

          Type: string

          Description: Account for which to list ad clients.

          Required: Yes

        pageToken

          Description: A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Location: query

          Type: string

        maxResults

          Format: int32

          Description: The maximum number of ad clients to include in the response, used for paging.

          Minimum: 0

          Location: query

          Maximum: 10000

          Type: integer

      Parameter Order: accountId

      Description: List all ad clients in the specified account.

      Path: accounts/{accountId}/adclients

  • adsense.accounts.adclients.getAdCode

      HTTP Method: GET

      Parameter Order:

    • accountId
    • adClientId
    • Parameters:

        accountId

          Type: string

          Location: path

          Description: Account which contains the ad client.

          Required: Yes

        tagPartner

          Description: Tag partner to include in the ad code snippet.

          Type: string

          Location: query

        adClientId

          Type: string

          Description: Ad client to get the code for.

          Location: path

          Required: Yes

      Description: Get Auto ad code for a given ad client.

      Path: accounts/{accountId}/adclients/{adClientId}/adcode

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
  • adsense.accounts.adunits.getAdCode

      Path: accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/adcode

      HTTP Method: GET

      Parameters:

        adClientId

          Required: Yes

          Description: Ad client with contains the ad unit.

          Location: path

          Type: string

        accountId

          Location: path

          Required: Yes

          Type: string

          Description: Account which contains the ad client.

        adUnitId

          Type: string

          Required: Yes

          Location: path

          Description: Ad unit to get the code for.

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Parameter Order:

    • accountId
    • adClientId
    • adUnitId
    • Description: Get ad code for the specified ad unit.

  • adsense.accounts.adunits.get

      Path: accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}

      Parameters:

        accountId

          Location: path

          Type: string

          Required: Yes

          Description: Account to which the ad client belongs.

        adUnitId

          Location: path

          Type: string

          Description: Ad unit to retrieve.

          Required: Yes

        adClientId

          Description: Ad client for which to get the ad unit.

          Type: string

          Required: Yes

          Location: path

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Parameter Order:

    • accountId
    • adClientId
    • adUnitId
    • HTTP Method: GET

      Description: Gets the specified ad unit in the specified ad client for the specified account.

  • adsense.accounts.adunits.list

      HTTP Method: GET

      Description: List all ad units in the specified ad client for the specified account.

      Parameter Order:

    • accountId
    • adClientId
    • Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Path: accounts/{accountId}/adclients/{adClientId}/adunits

      Parameters:

        includeInactive

          Description: Whether to include inactive ad units. Default: true.

          Type: boolean

          Location: query

        accountId

          Description: Account to which the ad client belongs.

          Location: path

          Type: string

          Required: Yes

        adClientId

          Type: string

          Location: path

          Required: Yes

          Description: Ad client for which to list ad units.

        maxResults

          Location: query

          Maximum: 10000

          Minimum: 0

          Description: The maximum number of ad units to include in the response, used for paging.

          Format: int32

          Type: integer

        pageToken

          Description: A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Type: string

          Location: query

  • adsense.accounts.adunits.customchannels.list

      HTTP Method: GET

      Path: accounts/{accountId}/adclients/{adClientId}/adunits/{adUnitId}/customchannels

      Parameters:

        pageToken

          Location: query

          Description: A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Type: string

        accountId

          Description: Account to which the ad client belongs.

          Location: path

          Required: Yes

          Type: string

        adUnitId

          Location: path

          Type: string

          Required: Yes

          Description: Ad unit for which to list custom channels.

        maxResults

          Location: query

          Description: The maximum number of custom channels to include in the response, used for paging.

          Type: integer

          Minimum: 0

          Format: int32

          Maximum: 10000

        adClientId

          Type: string

          Required: Yes

          Description: Ad client which contains the ad unit.

          Location: path

      Description: List all custom channels which the specified ad unit belongs to.

      Parameter Order:

    • accountId
    • adClientId
    • adUnitId
    • Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
  • adsense.accounts.customchannels.get

      Description: Get the specified custom channel from the specified ad client for the specified account.

      Parameters:

        accountId

          Location: path

          Required: Yes

          Type: string

          Description: Account to which the ad client belongs.

        customChannelId

          Type: string

          Description: Custom channel to retrieve.

          Required: Yes

          Location: path

        adClientId

          Type: string

          Location: path

          Required: Yes

          Description: Ad client which contains the custom channel.

      Parameter Order:

    • accountId
    • adClientId
    • customChannelId
    • Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Path: accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}

      HTTP Method: GET

  • adsense.accounts.customchannels.list

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Path: accounts/{accountId}/adclients/{adClientId}/customchannels

      Parameter Order:

    • accountId
    • adClientId
    • Parameters:

        accountId

          Required: Yes

          Type: string

          Location: path

          Description: Account to which the ad client belongs.

        adClientId

          Type: string

          Location: path

          Required: Yes

          Description: Ad client for which to list custom channels.

        maxResults

          Type: integer

          Location: query

          Format: int32

          Minimum: 0

          Maximum: 10000

          Description: The maximum number of custom channels to include in the response, used for paging.

        pageToken

          Location: query

          Type: string

          Description: A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

      HTTP Method: GET

      Description: List all custom channels in the specified ad client for the specified account.

  • adsense.accounts.customchannels.adunits.list

      Parameter Order:

    • accountId
    • adClientId
    • customChannelId
    • Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • HTTP Method: GET

      Path: accounts/{accountId}/adclients/{adClientId}/customchannels/{customChannelId}/adunits

      Parameters:

        adClientId

          Type: string

          Required: Yes

          Location: path

          Description: Ad client which contains the custom channel.

        maxResults

          Type: integer

          Description: The maximum number of ad units to include in the response, used for paging.

          Location: query

          Minimum: 0

          Maximum: 10000

          Format: int32

        accountId

          Required: Yes

          Type: string

          Description: Account to which the ad client belongs.

          Location: path

        pageToken

          Type: string

          Description: A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Location: query

        customChannelId

          Location: path

          Type: string

          Required: Yes

          Description: Custom channel for which to list ad units.

        includeInactive

          Location: query

          Type: boolean

          Description: Whether to include inactive ad units. Default: true.

      Description: List all ad units in the specified custom channel.

  • adsense.accounts.savedadstyles.get

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Parameters:

        savedAdStyleId

          Type: string

          Location: path

          Required: Yes

          Description: Saved ad style to retrieve.

        accountId

          Required: Yes

          Location: path

          Type: string

          Description: Account for which to get the saved ad style.

      HTTP Method: GET

      Parameter Order:

    • accountId
    • savedAdStyleId
    • Description: List a specific saved ad style for the specified account.

      Path: accounts/{accountId}/savedadstyles/{savedAdStyleId}

  • adsense.accounts.savedadstyles.list

      Parameter Order: accountId

      Description: List all saved ad styles in the specified account.

      HTTP Method: GET

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

        maxResults

          Type: integer

          Location: query

          Maximum: 10000

          Format: int32

          Minimum: 0

          Description: The maximum number of saved ad styles to include in the response, used for paging.

        accountId

          Description: Account for which to list saved ad styles.

          Location: path

          Type: string

          Required: Yes

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Path: accounts/{accountId}/savedadstyles

  • adsense.accounts.alerts.delete

      Parameters:

        accountId

          Description: Account which contains the ad unit.

          Location: path

          Type: string

          Required: Yes

        alertId

          Description: Alert to delete.

          Type: string

          Required: Yes

          Location: path

      HTTP Method: DELETE

      Description: Dismiss (delete) the specified alert from the specified publisher AdSense account.

      Scopes: https://www.googleapis.com/auth/adsense

      Parameter Order:

    • accountId
    • alertId
    • Path: accounts/{accountId}/alerts/{alertId}

  • adsense.accounts.alerts.list

      Parameters:

        accountId

          Description: Account for which to retrieve the alerts.

          Location: path

          Type: string

          Required: Yes

        locale

          Description: The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.

          Location: query

          Type: string

      Description: List the alerts for the specified AdSense account.

      Parameter Order: accountId

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • HTTP Method: GET

      Path: accounts/{accountId}/alerts

  • adsense.accounts.payments.list

  • adsense.accounts.urlchannels.list

      Parameters:

        maxResults

          Format: int32

          Location: query

          Description: The maximum number of URL channels to include in the response, used for paging.

          Type: integer

          Maximum: 10000

          Minimum: 0

        accountId

          Location: path

          Required: Yes

          Description: Account to which the ad client belongs.

          Type: string

        pageToken

          Type: string

          Location: query

          Description: A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

        adClientId

          Location: path

          Required: Yes

          Type: string

          Description: Ad client for which to list URL channels.

      Description: List all URL channels in the specified ad client for the specified account.

      Path: accounts/{accountId}/adclients/{adClientId}/urlchannels

      HTTP Method: GET

      Parameter Order:

    • accountId
    • adClientId
    • Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
  • adsense.payments.list

  • adsense.adclients.list

      Parameters:

        maxResults

          Minimum: 0

          Description: The maximum number of ad clients to include in the response, used for paging.

          Type: integer

          Maximum: 10000

          Format: int32

          Location: query

        pageToken

          Type: string

          Location: query

          Description: A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Path: adclients

      HTTP Method: GET

      Description: List all ad clients in this AdSense account.

  • adsense.adunits.list

      Description: List all ad units in the specified ad client for this AdSense account.

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Parameter Order: adClientId

      Parameters:

        maxResults

          Type: integer

          Description: The maximum number of ad units to include in the response, used for paging.

          Format: int32

          Minimum: 0

          Maximum: 10000

          Location: query

        pageToken

          Description: A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Location: query

          Type: string

        includeInactive

          Location: query

          Description: Whether to include inactive ad units. Default: true.

          Type: boolean

        adClientId

          Description: Ad client for which to list ad units.

          Location: path

          Type: string

          Required: Yes

      Path: adclients/{adClientId}/adunits

      HTTP Method: GET

  • adsense.adunits.getAdCode

      Path: adclients/{adClientId}/adunits/{adUnitId}/adcode

      Parameters:

        adUnitId

          Description: Ad unit to get the code for.

          Required: Yes

          Location: path

          Type: string

        adClientId

          Type: string

          Location: path

          Description: Ad client with contains the ad unit.

          Required: Yes

      HTTP Method: GET

      Description: Get ad code for the specified ad unit.

      Parameter Order:

    • adClientId
    • adUnitId
    • Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
  • adsense.adunits.get

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Parameter Order:

    • adClientId
    • adUnitId
    • Parameters:

        adClientId

          Type: string

          Description: Ad client for which to get the ad unit.

          Location: path

          Required: Yes

        adUnitId

          Type: string

          Required: Yes

          Description: Ad unit to retrieve.

          Location: path

      Description: Gets the specified ad unit in the specified ad client.

      HTTP Method: GET

      Path: adclients/{adClientId}/adunits/{adUnitId}

  • adsense.adunits.customchannels.list

      Parameters:

        adUnitId

          Location: path

          Description: Ad unit for which to list custom channels.

          Required: Yes

          Type: string

        adClientId

          Required: Yes

          Description: Ad client which contains the ad unit.

          Type: string

          Location: path

        pageToken

          Location: query

          Description: A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Type: string

        maxResults

          Maximum: 10000

          Minimum: 0

          Description: The maximum number of custom channels to include in the response, used for paging.

          Location: query

          Type: integer

          Format: int32

      Parameter Order:

    • adClientId
    • adUnitId
    • Path: adclients/{adClientId}/adunits/{adUnitId}/customchannels

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Description: List all custom channels which the specified ad unit belongs to.

      HTTP Method: GET

  • adsense.metadata.metrics.list

  • adsense.metadata.dimensions.list

  • adsense.savedadstyles.get

  • adsense.savedadstyles.list

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • HTTP Method: GET

      Description: List all saved ad styles in the user's account.

      Parameters:

        maxResults

          Maximum: 10000

          Format: int32

          Type: integer

          Location: query

          Description: The maximum number of saved ad styles to include in the response, used for paging.

          Minimum: 0

        pageToken

          Description: A continuation token, used to page through saved ad styles. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Type: string

          Location: query

      Path: savedadstyles

  • adsense.customchannels.list

      Parameters:

        pageToken

          Description: A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Location: query

          Type: string

        adClientId

          Description: Ad client for which to list custom channels.

          Location: path

          Type: string

          Required: Yes

        maxResults

          Description: The maximum number of custom channels to include in the response, used for paging.

          Type: integer

          Format: int32

          Location: query

          Maximum: 10000

          Minimum: 0

      Parameter Order: adClientId

      Path: adclients/{adClientId}/customchannels

      Description: List all custom channels in the specified ad client for this AdSense account.

      HTTP Method: GET

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
  • adsense.customchannels.get

      Parameters:

        customChannelId

          Type: string

          Required: Yes

          Description: Custom channel to retrieve.

          Location: path

        adClientId

          Type: string

          Location: path

          Required: Yes

          Description: Ad client which contains the custom channel.

      Description: Get the specified custom channel from the specified ad client.

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Parameter Order:

    • adClientId
    • customChannelId
    • HTTP Method: GET

      Path: adclients/{adClientId}/customchannels/{customChannelId}

  • adsense.customchannels.adunits.list

      Path: adclients/{adClientId}/customchannels/{customChannelId}/adunits

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Parameters:

        pageToken

          Type: string

          Location: query

          Description: A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

        customChannelId

          Description: Custom channel for which to list ad units.

          Location: path

          Required: Yes

          Type: string

        maxResults

          Format: int32

          Type: integer

          Description: The maximum number of ad units to include in the response, used for paging.

          Location: query

          Minimum: 0

          Maximum: 10000

        includeInactive

          Location: query

          Description: Whether to include inactive ad units. Default: true.

          Type: boolean

        adClientId

          Description: Ad client which contains the custom channel.

          Location: path

          Type: string

          Required: Yes

      Description: List all ad units in the specified custom channel.

      Parameter Order:

    • adClientId
    • customChannelId
    • HTTP Method: GET

  • adsense.reports.saved.list

      Path: reports/saved

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Description: List all saved reports in this AdSense account.

      HTTP Method: GET

      Parameters:

        maxResults

          Format: int32

          Type: integer

          Description: The maximum number of saved reports to include in the response, used for paging.

          Minimum: 0

          Location: query

          Maximum: 100

        pageToken

          Description: A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Location: query

          Type: string

  • adsense.reports.saved.generate

      HTTP Method: GET

      Description: Generate an AdSense report based on the saved report ID sent in the query parameters.

      Parameter Order: savedReportId

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Parameters:

        maxResults

          Format: int32

          Maximum: 50000

          Type: integer

          Location: query

          Minimum: 0

          Description: The maximum number of rows of report data to return.

        startIndex

          Description: Index of the first row of report data to return.

          Maximum: 5000

          Minimum: 0

          Type: integer

          Format: int32

          Location: query

        locale

          Type: string

          Pattern: [a-zA-Z_]+

          Description: Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

          Location: query

        savedReportId

          Description: The saved report to retrieve.

          Type: string

          Location: path

          Required: Yes

      Path: reports/{savedReportId}

  • adsense.reports.generate

      Parameters:

        dimension

          Repeated: Yes

          Description: Dimensions to base the report on.

          Pattern: [a-zA-Z_]+

          Location: query

          Type: string

        locale

          Location: query

          Description: Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

          Type: string

          Pattern: [a-zA-Z_]+

        endDate

          Pattern: \d{4}-\d{2}-\d{2}|(today|startOfMonth|startOfYear)(([\-\+]\d+[dwmy]){0,3}?)|(latest-(\d{2})-(\d{2})(-\d+y)?)|(latest-latest-(\d{2})(-\d+m)?)

          Type: string

          Description: End of the date range to report on in "YYYY-MM-DD" format, inclusive.

          Required: Yes

          Location: query

        metric

          Location: query

          Description: Numeric columns to include in the report.

          Repeated: Yes

          Type: string

          Pattern: [a-zA-Z_]+

        currency

          Type: string

          Description: Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.

          Pattern: [a-zA-Z]+

          Location: query

        sort

          Description: The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.

          Type: string

          Location: query

          Repeated: Yes

          Pattern: (\+|-)?[a-zA-Z_]+

        useTimezoneReporting

          Type: boolean

          Location: query

          Description: Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.

        maxResults

          Maximum: 50000

          Minimum: 0

          Type: integer

          Description: The maximum number of rows of report data to return.

          Location: query

          Format: int32

        startDate

          Required: Yes

          Description: Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

          Location: query

          Pattern: \d{4}-\d{2}-\d{2}|(today|startOfMonth|startOfYear)(([\-\+]\d+[dwmy]){0,3}?)|(latest-(\d{2})-(\d{2})(-\d+y)?)|(latest-latest-(\d{2})(-\d+m)?)

          Type: string

        accountId

          Location: query

          Description: Accounts upon which to report.

          Type: string

          Repeated: Yes

        startIndex

          Description: Index of the first row of report data to return.

          Minimum: 0

          Maximum: 5000

          Format: int32

          Location: query

          Type: integer

        filter

          Location: query

          Description: Filters to be run on the report.

          Repeated: Yes

          Type: string

          Pattern: [a-zA-Z_]+(==|=@).+

      HTTP Method: GET

      Supportsmediadownload: Yes

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Path: reports

      Parameter Order:

    • startDate
    • endDate
    • Description: Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

  • adsense.alerts.list

      HTTP Method: GET

      Parameters:

        locale

          Description: The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.

          Location: query

          Type: string

      Description: List the alerts for this AdSense account.

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Path: alerts

  • adsense.alerts.delete

      Path: alerts/{alertId}

      HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/adsense

      Parameters:

        alertId

          Required: Yes

          Description: Alert to delete.

          Location: path

          Type: string

      Description: Dismiss (delete) the specified alert from the publisher's AdSense account.

      Parameter Order: alertId

  • adsense.urlchannels.list

      Parameters:

        maxResults

          Type: integer

          Maximum: 10000

          Location: query

          Format: int32

          Minimum: 0

          Description: The maximum number of URL channels to include in the response, used for paging.

        pageToken

          Description: A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

          Location: query

          Type: string

        adClientId

          Location: path

          Description: Ad client for which to list URL channels.

          Required: Yes

          Type: string

      HTTP Method: GET

      Scopes:

    • https://www.googleapis.com/auth/adsense
    • https://www.googleapis.com/auth/adsense.readonly
    • Parameter Order: adClientId

      Path: adclients/{adClientId}/urlchannels

      Description: List all URL channels in the specified ad client for this AdSense account.