type SuggestedAdUnit (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Service
SuggestedAdUnitService
A SuggestedAdUnit represents a suggestion for a new ad unit, based on an ad tag that has
been served at least ten times in the past week, but which does not correspond to a defined ad
unit. This type is read-only.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
Field
|
id
|
xsd:string
The unique ID of the suggested ad unit. After API version 201311 this field will be a numerical
ID. Earlier versions will return a string value which is the complete path to the suggested ad
unit with path elements separated by '/' characters. This attribute is read-only and is
populated by Google.
|
numRequests
|
xsd:long
Returns the number of times the ad tag corresponding to this suggested ad unit has been served
in the previous week. Suggested ad units are only created when they have been served at least
ten times in that period. This attribute is read-only and is populated by Google.
|
path
|
xsd:string[]
The hierarchical path from the last existing ad unit after this and all
suggested parent ad units have been created. Each path element is a separate ad unit code in
the returned list. This attribute is read-only and is populated by Google.
|
parentPath
|
AdUnitParent[]
The existing hierarchical path leading up to, and including, the
parent of the first suggested ad unit in the ad unit hierarchy. The
parentPath and the
path make up the full path of
the suggested ad unit after it is approved. This attribute is
read-only and is populated by Google.
Note: The ad unit code for each of the parent
ad units will not be provided.
|
targetWindow
|
AdUnit.TargetWindow
The target attribute of the underlying ad tag, as defined in the AdUnit. This
attribute is read-only and is populated by Google.
Enumerations
-
TOP
- Specifies that the link should open in the full body of the page.
-
BLANK
- Specifies that the link should open in a new window.
|
|
|
TargetPlatform
The target platform for the browser that clicked the underlying ad tag. This attribute is
read-only and is populated by Google.
Enumerations
-
WEB
- The desktop web.
-
MOBILE
- Mobile devices.
-
ANY
- An universal target platform that combines mobile and desktop features.
|
suggestedAdUnitSizes
|
AdUnitSize[]
The target sizes associated with this SuggestedAdUnit. This attribute is read-only and
is populated by Google.
|
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-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003e\u003ccode\u003eSuggestedAdUnit\u003c/code\u003e objects represent suggestions for new ad units based on frequently served ad tags that lack corresponding defined ad units.\u003c/p\u003e\n"],["\u003cp\u003eThese suggestions are read-only and automatically generated when an ad tag is served at least 10 times within a week.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eSuggestedAdUnit\u003c/code\u003e includes information like a unique ID, serving frequency, hierarchical path, target window, target platform, and suggested sizes.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparentPath\u003c/code\u003e and \u003ccode\u003epath\u003c/code\u003e attributes combine to provide the complete hierarchical path of the suggested ad unit upon approval.\u003c/p\u003e\n"],["\u003cp\u003eAd Manager users can leverage these suggestions to easily create new ad units that align with existing ad serving patterns.\u003c/p\u003e\n"]]],["`SuggestedAdUnit` offers read-only suggestions for new ad units based on ad tags served at least ten times weekly without a corresponding defined ad unit. Key information includes the `id`, `numRequests` (number of weekly servings), `path` (hierarchical path of suggested ad units), `parentPath` (existing path to the suggested ad unit's parent), `targetWindow` (target of the ad tag), `targetPlatform` (platform target for the user) and `suggestedAdUnitSizes`. The data provides insights into ad unit performance and organization.\n"],null,["# type SuggestedAdUnit (v202411)\n\n**Service** \n**SuggestedAdUnitService** **Dependencies** \n[SuggestedAdUnitPage](/ad-manager/api/reference/v202411/SuggestedAdUnitService.SuggestedAdUnitPage) \n▼\n**SuggestedAdUnit**\n\nA `SuggestedAdUnit` represents a suggestion for a new ad unit, based on an ad tag that has\nbeen served at least ten times in the past week, but which does not correspond to a defined ad\nunit. This type is read-only.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `id` | ` `xsd:`string` The unique ID of the suggested ad unit. After API version 201311 this field will be a numerical ID. Earlier versions will return a string value which is the complete path to the suggested ad unit with path elements separated by '/' characters. This attribute is read-only and is populated by Google. |\n| ### `numRequests` | ` `xsd:`long` Returns the number of times the ad tag corresponding to this suggested ad unit has been served in the previous week. Suggested ad units are only created when they have been served at least ten times in that period. This attribute is read-only and is populated by Google. |\n| ### `path` | ` `xsd:`string[]` The hierarchical path from the [last existing ad unit](#parentPath) after this and all suggested parent ad units have been created. Each path element is a separate ad unit code in the returned list. This attribute is read-only and is populated by Google. |\n| ### `parentPath` | ` `[AdUnitParent](/ad-manager/api/reference/v202411/SuggestedAdUnitService.AdUnitParent)`[]` The existing hierarchical path leading up to, and including, the parent of the first suggested ad unit in the ad unit hierarchy. The `parentPath` and the `path` make up the full path of the suggested ad unit after it is approved. This attribute is read-only and is populated by Google. **Note:** The ad unit code for each of the parent ad units will not be provided. \u003cbr /\u003e |\n| ### `targetWindow` | ` `[AdUnit.TargetWindow](/ad-manager/api/reference/v202411/SuggestedAdUnitService.AdUnit.TargetWindow)` ` The `target` attribute of the underlying ad tag, as defined in the [AdUnit](/ad-manager/api/reference/v202411/InventoryService.AdUnit). This attribute is read-only and is populated by Google. *** ** * ** *** **Enumerations** `TOP` : Specifies that the link should open in the full body of the page. `BLANK` : Specifies that the link should open in a new window. \u003cbr /\u003e |\n| ### `targetPlatform` | ` `[TargetPlatform](/ad-manager/api/reference/v202411/SuggestedAdUnitService.TargetPlatform)` ` The target platform for the browser that clicked the underlying ad tag. This attribute is read-only and is populated by Google. *** ** * ** *** **Enumerations** `WEB` : The desktop web. `MOBILE` : Mobile devices. `ANY` : An universal target platform that combines mobile and desktop features. \u003cbr /\u003e |\n| ### `suggestedAdUnitSizes` | ` `[AdUnitSize](/ad-manager/api/reference/v202411/SuggestedAdUnitService.AdUnitSize)`[]` The target sizes associated with this `SuggestedAdUnit`. This attribute is read-only and is populated by Google. |"]]
