type InternalApiError (v202411)

  • InternalApiError signifies a server-side error, typically not caused by invalid client requests.

  • These errors often arise from unexpected internal issues or transient problems.

  • InternalApiError includes a reason field with an enum value indicating the specific error cause, such as UNEXPECTED_INTERNAL_API_ERROR or TRANSIENT_ERROR.

  • The namespace for InternalApiError is https://www.google.com/apis/ads/publisher/v202411.

  • Detailed information about the error is available through inherited fields like fieldPath, fieldPathElements, trigger, and errorString.

Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client.


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.

InternalApiError

reason

InternalApiError.Reason

The error reason represented by an enum.


Enumerations
UNEXPECTED_INTERNAL_API_ERROR
API encountered an unexpected internal error.
TRANSIENT_ERROR
A temporary error occurred during the request. Please retry.
UNKNOWN
The cause of the error is not known or only defined in newer versions.
DOWNTIME
The API is currently unavailable for a planned downtime.
ERROR_GENERATING_RESPONSE
Mutate succeeded but server was unable to build response. Client should not retry mutate.