type PermissionError (v202502)

  • PermissionError indicates that a user lacks the necessary permissions to perform a requested action within the API.

  • PermissionError inherits from ApiError and includes specific fields like reason to detail why permission was denied, such as PERMISSION_DENIED or UNKNOWN.

  • The fieldPath, fieldPathElements, trigger, and errorString fields from the inherited ApiError provide more context about the specific request element that caused the permission issue.

Errors related to incorrect permission.


Namespace
https://www.google.com/apis/ads/publisher/v202502

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.

PermissionError

reason

PermissionError.Reason


Enumerations
PERMISSION_DENIED
User does not have the required permission for the request.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.