Method: accounts.adclients.list

Lists all the ad clients available in an account.

HTTP request

GET https://adsense.googleapis.com/v2/{parent=accounts/*}/adclients

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The account which owns the collection of ad clients. Format: accounts/{account}

Query parameters

Parameters
pageSize

integer

The maximum number of ad clients to include in the response, used for paging. If unspecified, at most 10000 ad clients 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 adclients.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to adclients.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response definition for the ad client list rpc.

JSON representation
{
  "adClients": [
    {
      object (AdClient)
    }
  ],
  "nextPageToken": string
}
Fields
adClients[]

object (AdClient)

The ad clients returned in this list response.

nextPageToken

string

Continuation token used to page through ad clients. To retrieve the next page of the results, set the next request's "pageToken" value to this.

Authorization Scopes

Requires one of the following OAuth scopes:

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

AdClient

Representation of an ad client. An ad client represents a user's subscription with a specific AdSense product.

JSON representation
{
  "name": string,
  "reportingDimensionId": string,
  "productCode": string
}
Fields
name

string

Resource name of the ad client. Format: accounts/{account}/adclients/{adclient}

reportingDimensionId

string

Output only. Unique ID of the ad client as used in the AD_CLIENT_ID reporting dimension. Present only if the ad client supports reporting.

productCode

string

Output only. Product code of the ad client. For example, "AFC" for AdSense for Content.