Method: accounts.platforms.groups.list

  • This endpoint retrieves a list of Platform Groups for a specific Platform using a GET request to the provided URL with a required parent path parameter.

  • The request accepts optional pageSize and pageToken query parameters for managing the number of groups returned and for pagination.

  • The request body must be empty, as all parameters are passed either in the URL path or as query parameters.

  • The response body contains a JSON object with a list of platformGroups and a nextPageToken for retrieving subsequent pages of results.

  • Authorization for this request requires either the https://www.googleapis.com/auth/adsense or https://www.googleapis.com/auth/adsense.readonly OAuth scope.

Lists Platform Groups for a specified Platform.

HTTP request

GET https://adsenseplatform.googleapis.com/v1alpha/{parent=accounts/*/platforms/*}/groups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the platform to retrieve. Format: accounts/{account}/platforms/{platform}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of groups to include in the response, used for paging. If unspecified, at most 10000 groups will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
pageToken

string

Optional. A page token, received from a previous groups.list call. Provide this to retrieve the subsequent page.

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

Request body

The request body must be empty.

Response body

Response definition for the platform groups list rpc.

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

JSON representation 
{
  "platformGroups": [
    {
      object (PlatformGroup)
    }
  ],
  "nextPageToken": string
}
Fields
platformGroups[]

object (PlatformGroup)

The platform groups returned in this list response.
nextPageToken

string

Continuation token used to page through platforms. 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