type PermissionError (v202411)

  • This page documents the PermissionError object in the Google Ad Manager API.

  • PermissionError is triggered when a user lacks the necessary permissions for a specific request.

  • The error provides details like the fieldPath, trigger, and errorString to help identify the cause.

  • PermissionError.Reason further clarifies if the error is due to denied permissions or an unknown reason.

  • Developers should use this information to handle permission-related issues in their Ad Manager integrations.
Service
AdRuleService AdjustmentService AdsTxtService AudienceSegmentService CdnConfigurationService CmsMetadataService CompanyService ContactService ContentBundleService ContentService CreativeService CreativeSetService CreativeTemplateService CreativeWrapperService CustomFieldService CustomTargetingService DaiAuthenticationKeyService DaiEncodingProfileService ForecastService InventoryService LabelService LineItemCreativeAssociationService LineItemService LineItemTemplateService LiveStreamEventService MobileApplicationService NativeStyleService NetworkService OrderService PlacementService ProposalLineItemService ProposalService PublisherQueryLanguageService ReportService SegmentPopulationService SiteService StreamActivityMonitorService SuggestedAdUnitService TargetingPresetService TeamService UserService UserTeamAssociationService YieldGroupService
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError DaiAuthenticationKeyActionE... FeatureError InternalApiError NotNullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError UniqueError

Errors related to incorrect permission.

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.

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.