Method: accounts.adclients.urlchannels.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists active url channels.
HTTP request
GET https://adsense.googleapis.com/v2/{parent=accounts/*/adclients/*}/urlchannels
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
parent |
string
Required. The ad client which owns the collection of url channels. Format: accounts/{account}/adclients/{adclient}
|
Query parameters
Parameters |
pageSize |
integer
The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url 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 urlchannels.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to urlchannels.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response definition for the url channels list rpc.
If successful, the response body contains data with the following structure:
JSON representation |
{
"urlChannels": [
{
object (UrlChannel )
}
],
"nextPageToken": string
} |
Fields |
urlChannels[] |
object (UrlChannel )
The url channels returned in this list response.
|
nextPageToken |
string
Continuation token used to page through url channels. 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 active URL channels for a given AdSense ad client.\u003c/p\u003e\n"],["\u003cp\u003eAllows pagination to retrieve large sets of URL channels.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific AdSense scopes.\u003c/p\u003e\n"],["\u003cp\u003eProvides details like URL channel information and pagination tokens in the response.\u003c/p\u003e\n"]]],["This describes how to list active URL channels via an HTTP GET request to `https://adsense.googleapis.com/v2/{parent=accounts/*/adclients/*}/urlchannels`. The `parent` path parameter is required, specifying the ad client. Query parameters `pageSize` (max 10000) and `pageToken` are used for pagination. The request body must be empty. The response body, in JSON, contains an array of `urlChannels` and `nextPageToken` for continuation. Authorization requires either `adsense` or `adsense.readonly` scopes.\n"],null,["# Method: accounts.adclients.urlchannels.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.ListUrlChannelsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists active url channels.\n\n### HTTP request\n\n`GET https://adsense.googleapis.com/v2/{parent=accounts/*/adclients/*}/urlchannels`\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 url channels. Format: accounts/{account}/adclients/{adclient} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of url channels to include in the response, used for paging. If unspecified, at most 10000 url 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 `urlchannels.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `urlchannels.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 url channels list rpc.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"urlChannels\": [ { object (/adsense/management/reference/rest/v2/accounts.adclients.urlchannels#UrlChannel) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `urlChannels[]` | `object (`[UrlChannel](/adsense/management/reference/rest/v2/accounts.adclients.urlchannels#UrlChannel)`)` The url channels returned in this list response. |\n| `nextPageToken` | `string` Continuation token used to page through url channels. 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`"]]