type AdUnitCodeError (v202411)
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/v202411
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\u003eAdUnitCodeError outlines errors related to the \u003ccode\u003eadUnitCode\u003c/code\u003e field of an AdUnit.\u003c/p\u003e\n"],["\u003cp\u003eIt primarily deals with invalid characters within the \u003ccode\u003eadUnitCode\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eSpecific reserved codes, like \u003ccode\u003eca-*-tag\u003c/code\u003e, are for designated purposes.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eadUnitCode\u003c/code\u003e validation rules differ based on context and Ad Exchange compatibility.\u003c/p\u003e\n"],["\u003cp\u003eThis error helps ensure the \u003ccode\u003eadUnitCode\u003c/code\u003e adheres to the platform's requirements for format and usage.\u003c/p\u003e\n"]]],["The core content outlines the `AdUnitCodeError` within the `InventoryService`, detailing specific error types related to the `AdUnit.adUnitCode`. It specifies allowed characters, restrictions on forward slashes as the first character, and reserved codes. `AdUnitCodeError` inherits from `ApiError`, which includes fields like `fieldPath`, `trigger`, and `errorString`. Enumerations define reasons for the error, such as `INVALID_CHARACTERS` or `RESERVED_CODE`, with different rules based on the usage context.\n"],null,[]]
