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

type ApiVersionError (v202411)

AI-generated Key Takeaways

This documentation details the ApiVersionError within the CreativeTemplateService of the Google Ad Manager API.
ApiVersionError arises when there are issues related to the usage of API versions, such as using an outdated version for a specific operation.
The error includes details like fieldPath, trigger, and reason to help diagnose the issue.
The reason field specifically indicates the cause of the error, whether it's due to using an older API version or an unknown reason.
Developers should refer to the provided namespace and field descriptions for integrating this error handling into their Ad Manager applications.

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 CreativeTemplateError CreativeTemplateOperationError FeatureError InternalApiError InvalidUrlError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError 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.