abstract type ApiError (v202411)

  • The ApiError object provides details about errors encountered while processing service requests in the Google Ad Manager API.

  • It includes information like the OGNL field path, parsed field path elements, trigger data, and an error string for debugging.

  • The fieldPath helps identify the specific data element causing the error, while fieldPathElements provides a parsed representation for easier analysis.

  • trigger indicates the data that led to the error, and errorString offers a concise description of the error and its reason.

  • Developers can use this information to understand and resolve issues arising from API interactions.
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
Dependencies
ApiException
▼
ApiError
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError ContentFilterError FeatureError InternalApiError NotNullError ParseError PermissionError PlacementError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequestError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError UniqueError

The API error base class that provides details about an error that occurred while processing a service request.

The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

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

Field

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.