Method: accounts.adclients.customchannels.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the custom channels available in an ad client.
HTTP request
GET https://adsense.googleapis.com/v2/{parent=accounts/*/adclients/*}/customchannels
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The ad client which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient}
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels 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 customchannels.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to customchannels.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response definition for the custom channel list rpc.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"customChannels": [
{
object (CustomChannel)
}
],
"nextPageToken": string
} |
| Fields |
customChannels[] |
object (CustomChannel)
The custom channels returned in this list response.
|
nextPageToken |
string
Continuation token used to page through alerts. 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
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-02-28 UTC.
[null,null,["Last updated 2025-02-28 UTC."],[[["\u003cp\u003eLists all custom channels associated with a specific AdSense ad client.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large sets of custom channels.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific AdSense scopes for access.\u003c/p\u003e\n"],["\u003cp\u003eProvides details on the HTTP request structure, including path and query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of custom channels and a token for retrieving further pages.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of custom channels from an ad client using the AdSense Management API. It involves sending a `GET` HTTP request to a specified URL, including the `parent` path parameter representing the ad client. Optional query parameters `pageSize` and `pageToken` support pagination. The request body must be empty. The successful response includes a list of custom channels, and a `nextPageToken` for subsequent pages. Authorization requires either `adsense` or `adsense.readonly` OAuth scopes.\n"],null,["# Method: accounts.adclients.customchannels.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.ListCustomChannelsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the custom channels available in an ad client.\n\n### HTTP request\n\n`GET https://adsense.googleapis.com/v2/{parent=accounts/*/adclients/*}/customchannels`\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 ad client which owns the collection of custom channels. Format: accounts/{account}/adclients/{adclient} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of custom channels to include in the response, used for paging. If unspecified, at most 10000 custom channels will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. |\n| `pageToken` | `string` A page token, received from a previous `customchannels.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `customchannels.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 custom channel list rpc.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customChannels\": [ { object (/adsense/management/reference/rest/v2/accounts.adclients.customchannels#CustomChannel) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customChannels[]` | `object (`[CustomChannel](/adsense/management/reference/rest/v2/accounts.adclients.customchannels#CustomChannel)`)` The custom channels returned in this list response. |\n| `nextPageToken` | `string` Continuation token used to page through alerts. 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`"]]
