Method: accounts.adclients.customchannels.listLinkedAdUnits
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the ad units available for a custom channel.
HTTP request
GET https://adsense.googleapis.com/v2/{parent=accounts/*/adclients/*/customchannels/*}:listLinkedAdUnits
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The custom channel which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units 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.listLinkedAdUnits call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to customchannels.listLinkedAdUnits must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response definition for the ad units linked to a custom channel list rpc.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"adUnits": [
{
object (AdUnit)
}
],
"nextPageToken": string
} |
| Fields |
adUnits[] |
object (AdUnit)
The ad units returned in the list response.
|
nextPageToken |
string
Continuation token used to page through ad units. 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 ad units linked to a specified custom channel within your AdSense account.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large lists of ad units, with customizable page sizes.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization using your AdSense account credentials, with read or read/write access.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of ad units with details and a token for retrieving the next page if available.\u003c/p\u003e\n"],["\u003cp\u003eUses a standard HTTP GET request with path and query parameters to specify the channel and retrieval options.\u003c/p\u003e\n"]]],["This describes how to list ad units linked to a custom channel using the AdSense Management API. A `GET` HTTP request is sent to a specified URL, including a required `parent` path parameter defining the custom channel. Optional query parameters `pageSize` and `pageToken` support pagination. The request body must be empty. The response contains an array of `adUnits` and a `nextPageToken` for further pagination. Authentication requires specific OAuth scopes: `adsense` or `adsense.readonly`.\n"],null,["# Method: accounts.adclients.customchannels.listLinkedAdUnits\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.ListLinkedAdUnitsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the ad units available for a custom channel.\n\n### HTTP request\n\n`GET https://adsense.googleapis.com/v2/{parent=accounts/*/adclients/*/customchannels/*}:listLinkedAdUnits`\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 custom channel which owns the collection of ad units. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of ad units to include in the response, used for paging. If unspecified, at most 10000 ad units 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.listLinkedAdUnits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `customchannels.listLinkedAdUnits` 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 ad units linked to a custom channel list rpc.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"adUnits\": [ { object (/adsense/management/reference/rest/v2/accounts.adclients.adunits#AdUnit) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adUnits[]` | `object (`[AdUnit](/adsense/management/reference/rest/v2/accounts.adclients.adunits#AdUnit)`)` The ad units returned in the list response. |\n| `nextPageToken` | `string` Continuation token used to page through ad units. 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`"]]
