abstract type ApiError (v202411)

  • The DaiEncodingProfileService API handles encoding profiles for Dynamic Ad Insertion (DAI).

  • ApiError is the base class for errors in the service, offering details like the error cause and location.

  • fieldPath, fieldPathElements, trigger, and errorString provide specific information about the error encountered.

  • This service allows management and configuration of encoding profiles for optimizing DAI streams.
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 DaiEncodingProfileAdMatchin... DaiEncodingProfileContainer... DaiEncodingProfileNameError DaiEncodingProfileUpdateError DaiEncodingProfileVariantSe... EntityLimitReachedError FeatureError InternalApiError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError 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.