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\u003e\u003ccode\u003eAdUnitCodeError\u003c/code\u003e outlines errors related to the \u003ccode\u003eadUnitCode\u003c/code\u003e field within Ad Units.\u003c/p\u003e\n"],["\u003cp\u003eThis error type inherits from \u003ccode\u003eApiError\u003c/code\u003e, providing context about the error's origin.\u003c/p\u003e\n"],["\u003cp\u003eSeveral reasons for this error exist, including invalid characters, reserved codes, and formatting issues in the \u003ccode\u003eadUnitCode\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eadUnitCode\u003c/code\u003e has character restrictions; certain symbols are allowed while others are prohibited, depending on the context.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation details the allowed and disallowed characters for \u003ccode\u003eadUnitCode\u003c/code\u003e in different scenarios, including legacy Ad Exchange tags.\u003c/p\u003e\n"]]],["The document details `AdUnitCodeError`, a specific error type within the `PublisherQueryLanguageService`. It focuses on errors related to `AdUnit.adUnitCode`, listing various error reasons, including `INVALID_CHARACTERS`, `LEADING_FORWARD_SLASH`, and `RESERVED_CODE`. These errors specify which characters are allowed or disallowed in `adUnitCode`. `ApiError` fields, are described, with properties like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to identify the cause of errors. Other `Error` types are listed.\n"],null,[]]
