Method: accounts.adclients.adunits.getAdcode
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://adsense.googleapis.com/v2/{name=accounts/*/adclients/*/adunits/*}/adcode
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Name of the adunit for which to get the adcode. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit}
|
Request body
The request body must be empty.
Response body
Representation of the ad unit code for a given ad unit.
For more information, see About the AdSense code and Where to place the ad code in your HTML.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"adCode": string
} |
| Fields |
adCode |
string
Output only. The code snippet to add to the body of an HTML page.
|
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\u003eRetrieves the ad unit code for a specified ad unit, allowing publishers to implement ads on their webpages.\u003c/p\u003e\n"],["\u003cp\u003eRequires the ad unit name in the request URL, formatted as accounts/{account}/adclients/{adclient}/adunits/{adunit}.\u003c/p\u003e\n"],["\u003cp\u003eReturns the ad code snippet in the response body, which can be directly added to an HTML page.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with either \u003ccode\u003ehttps://www.googleapis.com/auth/adsense\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/adsense.readonly\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This describes retrieving an ad unit's code via a GET request to `https://adsense.googleapis.com/v2/{name=accounts/*/adclients/*/adunits/*}/adcode`. The `name` parameter, formatted as `accounts/{account}/adclients/{adclient}/adunits/{adunit}`, is required within the path. The request body must be empty. A successful response contains the ad code within a JSON structure: `{ \"adCode\": string }`. Authorization requires either the `adsense` or `adsense.readonly` OAuth scope. The `adcode` is a string output designed to be added into the HTML of a website.\n"],null,["# Method: accounts.adclients.adunits.getAdcode\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.AdUnitAdCode.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets the ad unit code for a given ad unit.\n\nFor more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634) and [Where to place the ad code in your HTML](https://support.google.com/adsense/answer/9190028).\n\n### HTTP request\n\n`GET https://adsense.googleapis.com/v2/{name=accounts/*/adclients/*/adunits/*}/adcode`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Name of the adunit for which to get the adcode. Format: accounts/{account}/adclients/{adclient}/adunits/{adunit} |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nRepresentation of the ad unit code for a given ad unit.\n\nFor more information, see [About the AdSense code](https://support.google.com/adsense/answer/9274634) and [Where to place the ad code in your HTML](https://support.google.com/adsense/answer/9190028).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------|\n| ``` { \"adCode\": string } ``` |\n\n| Fields ||\n|----------|----------------------------------------------------------------------------|\n| `adCode` | `string` Output only. The code snippet to add to the body of an HTML page. |\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`"]]
