REST Resource: accounts.adclients.customchannels
Stay organized with collections
Save and categorize content based on your preferences.
Resource: CustomChannel
Representation of a custom channel.
| JSON representation |
{
"name": string,
"reportingDimensionId": string,
"displayName": string,
"active": boolean
} |
| Fields |
name |
string
Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel}
|
reportingDimensionId |
string
Output only. Unique ID of the custom channel as used in the CUSTOM_CHANNEL_ID reporting dimension.
|
displayName |
string
Required. Display name of the custom channel.
|
active |
boolean
Whether the custom channel is active and collecting data. See https://support.google.com/adsense/answer/10077192.
|
Methods |
|
|
Creates a custom channel. |
|
|
Deletes a custom channel. |
|
|
Gets information about the selected custom channel. |
|
|
Lists all the custom channels available in an ad client. |
|
|
Lists all the ad units available for a custom channel. |
|
|
Updates a custom channel. |
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\u003eCustomChannel resource represents custom channels, providing a way to organize ad units for reporting purposes.\u003c/p\u003e\n"],["\u003cp\u003eCustom channels are defined by a name, display name, reporting ID, and activation status, manageable through various methods.\u003c/p\u003e\n"],["\u003cp\u003eThe resource offers methods like create, delete, get, list, listLinkedAdUnits, and patch for managing and interacting with custom channels.\u003c/p\u003e\n"],["\u003cp\u003eKey fields of a custom channel include name, reportingDimensionId, displayName, and active, indicating its identity and operational status.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the provided links for detailed information and usage instructions on each available method.\u003c/p\u003e\n"]]],["Custom channels are defined by a `name`, `reportingDimensionId`, `displayName`, and an `active` status, represented in JSON. Key actions include creating, deleting, getting, listing, updating, and listing linked ad units associated with custom channels. The `displayName` is required for each channel. Custom channels store data, and each channel is uniquely identified for reporting purposes. The methods provided enable managing the lifecycle and information associated with these channels.\n"],null,["# REST Resource: accounts.adclients.customchannels\n\n- [Resource: CustomChannel](#CustomChannel)\n - [JSON representation](#CustomChannel.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CustomChannel\n-----------------------\n\nRepresentation of a custom channel.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"reportingDimensionId\": string, \"displayName\": string, \"active\": boolean } ``` |\n\n| Fields ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name of the custom channel. Format: accounts/{account}/adclients/{adclient}/customchannels/{customchannel} |\n| `reportingDimensionId` | `string` Output only. Unique ID of the custom channel as used in the `CUSTOM_CHANNEL_ID` reporting dimension. |\n| `displayName` | `string` Required. Display name of the custom channel. |\n| `active` | `boolean` Whether the custom channel is active and collecting data. See \u003chttps://support.google.com/adsense/answer/10077192\u003e. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|\n| ### [create](/adsense/management/reference/rest/v2/accounts.adclients.customchannels/create) | Creates a custom channel. |\n| ### [delete](/adsense/management/reference/rest/v2/accounts.adclients.customchannels/delete) | Deletes a custom channel. |\n| ### [get](/adsense/management/reference/rest/v2/accounts.adclients.customchannels/get) | Gets information about the selected custom channel. |\n| ### [list](/adsense/management/reference/rest/v2/accounts.adclients.customchannels/list) | Lists all the custom channels available in an ad client. |\n| ### [listLinkedAdUnits](/adsense/management/reference/rest/v2/accounts.adclients.customchannels/listLinkedAdUnits) | Lists all the ad units available for a custom channel. |\n| ### [patch](/adsense/management/reference/rest/v2/accounts.adclients.customchannels/patch) | Updates a custom channel. |"]]
