My favorites | English | Sign in

Documentation for the requested version is not available.Documentation for the requested diff is not available.

ApiError

Link to this version

Represents the details of a user error in the API. Errors are accumulated during the processing of a call and then thrown as part of an ApiException.

Fields

code int
Error code identifying this error.
detail string
The error message. A detailed description of the violation.
field string
Name of the field in the API data object where the error occurred.
index int
Index into input array of the element that caused this error. For example, given an array of Criterion passed in to addCriteria, if the 5th element caused this error, index would be value 4.
isExemptable boolean
True if user can request an exemption for this violation. For example, this field is true for a trademark violation on a keyword, which means you can request an exemption.
textIndex int
The character index into the text string that caused the error. For example, if the problem is with the 5th character in the text of an ad, textIndex would be value 4.
textLength int
The number of characters in the string that caused the error.
trigger string
The text that is in violation of policy