Looking for a REST API? The Ad Manager API (Beta) is now available.

type PublisherQueryLanguageSyntaxError (v202502)

AI-generated Key Takeaways

This document details the PublisherQueryLanguageSyntaxError, which occurs when there is a parsing error in a PQL query within a Statement object.
The error inherits fields from ApiError including fieldPath, fieldPathElements, trigger, and errorString.
Specific to this error is the reason field, which is an enum indicating whether the error is UNPARSABLE or UNKNOWN.

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 EntityLimitReachedError FeatureError InternalApiError NotNullError NullError OrderError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TeamError TypeError UniqueError

An error that occurs while parsing a PQL query contained in a Statement object.

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.
`PublisherQueryLanguageSyntaxError`
`reason`	`PublisherQueryLanguageSynta...` The error reason represented by an enum. Enumerations `UNPARSABLE` Indicates that there was a PQL syntax error. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.