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

type ApiVersionError (v202411)

AI-generated Key Takeaways

ApiVersionError is a type of ApiError related to API version usage.
ApiVersionError contains a field called reason which specifies the cause of the error.
Possible reasons for an ApiVersionError include the operation not being allowed in the requested API version or an unknown issue.

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 EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError InternalApiError NotNullError NullError ParseError PermissionError PlacementError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TypeError 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.