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

type ApiVersionError (v202411)

AI-generated Key Takeaways

This page documents the DaiEncodingProfileService and the errors related to the usage of API versions within Google Ad Manager.
The DaiEncodingProfileService namespace is https://www.google.com/apis/ads/publisher/v202411.
ApiVersionError is thrown if there's an issue with the API version being used, like using an older version for an operation that requires a newer one.
Errors inherit from ApiError which provides details like the error cause (fieldPath), a structured representation of the error cause (fieldPathElements), the data triggering the error (trigger), and a simple error description (errorString).
ApiVersionError has a reason field indicating the specific cause, like needing to update to a newer API version (UPDATE_TO_NEWER_VERSION) or an unknown reason (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

▼

ApiVersionError AuthenticationError CollectionSizeError CommonError DaiEncodingProfileAdMatchin... DaiEncodingProfileContainer... DaiEncodingProfileNameError DaiEncodingProfileUpdateError DaiEncodingProfileVariantSe... EntityLimitReachedError FeatureError InternalApiError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError 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.