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

type ApiVersionError (v202508)

AI-generated Key Takeaways

ApiVersionError is a type of ApiError related to the usage of API versions.
It has an inherited field fieldPath which is an OGNL field path to identify the cause of the error.
It has an inherited field fieldPathElements which is a parsed copy of the field path.
It has an inherited field trigger which is the data that caused the error.
It has its own field reason which is of type ApiVersionError.Reason and indicates the cause of the API version error, such as UPDATE_TO_NEWER_VERSION.

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 DaiEncodingProfileAdMatchin... DaiEncodingProfileContainer... DaiEncodingProfileNameError DaiEncodingProfileUpdateError DaiEncodingProfileVariantSe... EntityLimitReachedError FeatureError InternalApiError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError UniqueError

Errors related to the usage of API versions.

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.
`ApiVersionError`
`reason`	`ApiVersionError.Reason` Enumerations `UPDATE_TO_NEWER_VERSION` Indicates that the operation is not allowed in the version the request was made in. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.