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 AdRuleService and other services of the Google Ad Manager API.
ApiVersionError occurs when there's an issue with the API version used in the request, such as using an outdated version for a specific operation.
It includes fields like fieldPath, fieldPathElements, trigger, and errorString (inherited from ApiError) to provide detailed error information.
The reason field within ApiVersionError clarifies the specific reason for the error, which could be UPDATE_TO_NEWER_VERSION 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

▼

AdRuleDateError AdRuleError AdRuleFrequencyCapError AdRulePriorityError AdRuleSlotError AdRuleTargetingError ApiVersionError AuthenticationError CollectionSizeError CommonError CustomTargetingError FeatureError GeoTargetingError InternalApiError InventoryTargetingError NotNullError ParseError PermissionError PoddingError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError 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.