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 in Google Ad Manager's API, specifically for version v202411.
ApiVersionError occurs when there are issues related to the API version being used for a request.
It includes fields like fieldPath, trigger, and errorString inherited from ApiError for identifying the error cause.
The reason field provides specific information about the API version error, like requiring an update to a newer version.
Developers should consult this documentation to understand and troubleshoot ApiVersionError instances in their Ad Manager API integrations.

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 ExchangeSignupApiError FeatureError InternalApiError InvalidEmailError InventoryClientApiError LiveStreamEventSlateError McmError NetworkError NotNullError ParseError PermissionError PrecisionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequestError RequiredCollectionError RequiredError RequiredNumberError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError TypeError UniqueError UrlError

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.