type AdUnitCodeError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Lists the generic errors associated with AdUnit.adUnitCode.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
Field
|
ApiError (inherited)
|
fieldPath
|
xsd:string
The OGNL field path to identify cause of error.
|
fieldPathElements
|
FieldPathElement[]
A parsed copy of the field path. For example, the field path "operations[1].operand"
corresponds to this list: {FieldPathElement(field = "operations", index = 1),
FieldPathElement(field = "operand", index = null)}.
|
trigger
|
xsd:string
The data that caused the error.
|
errorString
|
xsd:string
A simple string representation of the error and reason.
|
AdUnitCodeError
|
reason
|
AdUnitCodeError.Reason
Enumerations
-
INVALID_CHARACTERS
- For AdUnit.adUnitCode, only alpha-numeric characters,
underscores, hyphens, periods, asterisks, double quotes, back slashes,
forward slashes, exclamations, left angle brackets, colons and
parentheses are allowed.
-
INVALID_CHARACTERS_WHEN_UTF_CHARACTERS_ARE_ALLOWED
- For AdUnit.adUnitCode, only letters, numbers,
underscores, hyphens, periods, asterisks, double quotes, back slashes,
forward slashes, exclamations, left angle brackets, colons and
parentheses are allowed.
-
INVALID_CHARACTERS_FOR_LEGACY_AD_EXCHANGE_TAG
- For AdUnit.adUnitCode representing slot codes, only alphanumeric characters,
underscores, hyphens, periods and colons are allowed.
-
LEADING_FORWARD_SLASH
- For AdUnit.adUnitCode, forward slashes are not allowed as
the first character.
-
RESERVED_CODE
- Specific codes matching ca-*pub-*-tag are reserved for "Web Property IUs"
generated as part of the SlotCode migration.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
|
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\u003eThis page documents the \u003ccode\u003eAdUnitCodeError\u003c/code\u003e object in the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAdUnitCodeError\u003c/code\u003e is a type of \u003ccode\u003eApiError\u003c/code\u003e that specifically relates to issues with the \u003ccode\u003eadUnitCode\u003c/code\u003e field of an \u003ccode\u003eAdUnit\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field provides further details about the specific error, including issues with invalid characters, reserved codes, and formatting.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAdUnitCodeError\u003c/code\u003e object inherits properties from the \u003ccode\u003eApiError\u003c/code\u003e object, such as \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003efieldPathElements\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e, to provide context and debugging information.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this information to understand and resolve errors related to ad unit codes when interacting with the Ad Manager API.\u003c/p\u003e\n"]]],["The content details errors within the `InventoryService`, `ForecastService`, and `PublisherQueryLanguageService`. These include a hierarchy of errors, extending from `ApiError`, with specific error types like `AdUnitCodeError`. `AdUnitCodeError` lists reasons for invalid ad unit codes, which may be due to invalid characters, a leading forward slash, or reserved codes. The allowed characters are detailed for various `AdUnit.adUnitCode` contexts. It also include a field path to show where the error occurred.\n"],null,[]]
