Method: accounts.platforms.groups.list
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-04 UTC.
[null,null,["Last updated 2025-07-04 UTC."],[[["\u003cp\u003eThis endpoint retrieves a list of Platform Groups for a specific Platform using a GET request to the provided URL with a required \u003ccode\u003eparent\u003c/code\u003e path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request accepts optional \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters for managing the number of groups returned and for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, as all parameters are passed either in the URL path or as query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains a JSON object with a list of \u003ccode\u003eplatformGroups\u003c/code\u003e and a \u003ccode\u003enextPageToken\u003c/code\u003e for retrieving subsequent pages of results.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this request requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/adsense\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/adsense.readonly\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of Platform Groups for a specific Platform using the AdSense Platform API. The `GET` request is made to a URL containing the platform's account and platform identifiers. Optional query parameters (`pageSize`, `pageToken`) control pagination. The request body must be empty. The response includes an array of `platformGroups` and a `nextPageToken` for further pagination, if required. Authentication requires either `adsense` or `adsense.readonly` OAuth scopes.\n"],null,["# Method: accounts.platforms.groups.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListPlatformGroupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists Platform Groups for a specified Platform.\n\n### HTTP request\n\n`GET https://adsenseplatform.googleapis.com/v1alpha/{parent=accounts/*/platforms/*}/groups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The name of the platform to retrieve. Format: accounts/{account}/platforms/{platform} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `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. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse definition for the platform groups list rpc.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"platformGroups\": [ { object (/adsense/platforms/reference/rest/v1alpha/accounts.platforms.groups#PlatformGroup) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `platformGroups[]` | `object (`[PlatformGroup](/adsense/platforms/reference/rest/v1alpha/accounts.platforms.groups#PlatformGroup)`)` The platform groups returned in this list response. |\n| `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. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/adsense`\n- `\n https://www.googleapis.com/auth/adsense.readonly`"]]
