type ApiVersionError (v202411)

  • This documentation details the ApiVersionError in Google Ad Manager's API.

  • ApiVersionError occurs when there are issues related to the API version being used, such as using an unsupported version for a specific operation.

  • It includes fields like reason, which provides insight into the specific cause of the error (e.g., needing to update to a newer API version).

  • Developers can use the information provided to troubleshoot and resolve API version-related errors in their Ad Manager 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 CustomTargetingError DateError DateTimeRangeTargetingError DayPartTargetingError EntityLimitReachedError FeatureError ForecastAdjustmentError ForecastError GenericTargetingError GeoTargetingError InternalApiError InvalidUrlError InventoryTargetingError InventoryUnitError InventoryUnitSizesError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TechnologyTargetingError TrafficForecastSegmentError TypeError UniqueError UserDomainTargetingError

Errors related to the usage of API versions.

Namespace
https://www.google.com/apis/ads/publisher/v202411

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.