type ApiVersionError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Errors related to the usage of API versions.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThis documentation details the \u003ccode\u003eApiVersionError\u003c/code\u003e within the CreativeWrapperService of the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiVersionError\u003c/code\u003e arises when there are issues related to the API version being used for a request.\u003c/p\u003e\n"],["\u003cp\u003eThis error may occur if the requested operation is not supported in the specified API version, prompting an update to a newer version.\u003c/p\u003e\n"],["\u003cp\u003eThe provided table outlines the error's properties, including field path, trigger, error string, and a specific reason code.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers should consult this documentation to understand and resolve \u003ccode\u003eApiVersionError\u003c/code\u003e instances when interacting with the Ad Manager API.\u003c/p\u003e\n"]]],["The core content lists various services within an API, including `AdRuleService`, `AdjustmentService`, `CreativeService`, and many others, spanning from content management to ad delivery. These services are part of the `v202408` API version. The document details the `ApiVersionError`, which flags issues related to API version usage, with the `UPDATE_TO_NEWER_VERSION` reason indicating that an operation is incompatible with the current version. Each service is linked to specific documentation.\n"],null,["# type ApiVersionError (v202408)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202408/AdRuleService.ApiVersionError) [AdjustmentService](/ad-manager/api/reference/v202408/AdjustmentService.ApiVersionError) [AdsTxtService](/ad-manager/api/reference/v202408/AdsTxtService.ApiVersionError) [AudienceSegmentService](/ad-manager/api/reference/v202408/AudienceSegmentService.ApiVersionError) [CdnConfigurationService](/ad-manager/api/reference/v202408/CdnConfigurationService.ApiVersionError) [CmsMetadataService](/ad-manager/api/reference/v202408/CmsMetadataService.ApiVersionError) [CompanyService](/ad-manager/api/reference/v202408/CompanyService.ApiVersionError) [ContactService](/ad-manager/api/reference/v202408/ContactService.ApiVersionError) [ContentBundleService](/ad-manager/api/reference/v202408/ContentBundleService.ApiVersionError) [ContentService](/ad-manager/api/reference/v202408/ContentService.ApiVersionError) [CreativeService](/ad-manager/api/reference/v202408/CreativeService.ApiVersionError) [CreativeSetService](/ad-manager/api/reference/v202408/CreativeSetService.ApiVersionError) [CreativeTemplateService](/ad-manager/api/reference/v202408/CreativeTemplateService.ApiVersionError) **CreativeWrapperService** [CustomFieldService](/ad-manager/api/reference/v202408/CustomFieldService.ApiVersionError) [CustomTargetingService](/ad-manager/api/reference/v202408/CustomTargetingService.ApiVersionError) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202408/DaiAuthenticationKeyService.ApiVersionError) [DaiEncodingProfileService](/ad-manager/api/reference/v202408/DaiEncodingProfileService.ApiVersionError) [ForecastService](/ad-manager/api/reference/v202408/ForecastService.ApiVersionError) [InventoryService](/ad-manager/api/reference/v202408/InventoryService.ApiVersionError) [LabelService](/ad-manager/api/reference/v202408/LabelService.ApiVersionError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202408/LineItemCreativeAssociationService.ApiVersionError) [LineItemService](/ad-manager/api/reference/v202408/LineItemService.ApiVersionError) [LineItemTemplateService](/ad-manager/api/reference/v202408/LineItemTemplateService.ApiVersionError) [LiveStreamEventService](/ad-manager/api/reference/v202408/LiveStreamEventService.ApiVersionError) [MobileApplicationService](/ad-manager/api/reference/v202408/MobileApplicationService.ApiVersionError) [NativeStyleService](/ad-manager/api/reference/v202408/NativeStyleService.ApiVersionError) [NetworkService](/ad-manager/api/reference/v202408/NetworkService.ApiVersionError) [OrderService](/ad-manager/api/reference/v202408/OrderService.ApiVersionError) [PlacementService](/ad-manager/api/reference/v202408/PlacementService.ApiVersionError) [ProposalLineItemService](/ad-manager/api/reference/v202408/ProposalLineItemService.ApiVersionError) [ProposalService](/ad-manager/api/reference/v202408/ProposalService.ApiVersionError) [PublisherQueryLanguageService](/ad-manager/api/reference/v202408/PublisherQueryLanguageService.ApiVersionError) [ReportService](/ad-manager/api/reference/v202408/ReportService.ApiVersionError) [SegmentPopulationService](/ad-manager/api/reference/v202408/SegmentPopulationService.ApiVersionError) [SiteService](/ad-manager/api/reference/v202408/SiteService.ApiVersionError) [StreamActivityMonitorService](/ad-manager/api/reference/v202408/StreamActivityMonitorService.ApiVersionError) [SuggestedAdUnitService](/ad-manager/api/reference/v202408/SuggestedAdUnitService.ApiVersionError) [TargetingPresetService](/ad-manager/api/reference/v202408/TargetingPresetService.ApiVersionError) [TeamService](/ad-manager/api/reference/v202408/TeamService.ApiVersionError) [UserService](/ad-manager/api/reference/v202408/UserService.ApiVersionError) [UserTeamAssociationService](/ad-manager/api/reference/v202408/UserTeamAssociationService.ApiVersionError) [YieldGroupService](/ad-manager/api/reference/v202408/YieldGroupService.ApiVersionError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/CreativeWrapperService.ApiError) \n▼\n**ApiVersionError** [AuthenticationError](/ad-manager/api/reference/v202408/CreativeWrapperService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CreativeWrapperService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CreativeWrapperService.CommonError) [CreativeWrapperError](/ad-manager/api/reference/v202408/CreativeWrapperService.CreativeWrapperError) [FeatureError](/ad-manager/api/reference/v202408/CreativeWrapperService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CreativeWrapperService.InternalApiError) [LabelError](/ad-manager/api/reference/v202408/CreativeWrapperService.LabelError) [NotNullError](/ad-manager/api/reference/v202408/CreativeWrapperService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CreativeWrapperService.NullError) [ParseError](/ad-manager/api/reference/v202408/CreativeWrapperService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CreativeWrapperService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CreativeWrapperService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CreativeWrapperService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CreativeWrapperService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CreativeWrapperService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CreativeWrapperService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/CreativeWrapperService.ServerError) [StatementError](/ad-manager/api/reference/v202408/CreativeWrapperService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/CreativeWrapperService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/CreativeWrapperService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/CreativeWrapperService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/CreativeWrapperService.UniqueError)\n\nErrors related to the usage of API versions.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\n\n| Field ----- ||\n|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **`ApiError` (inherited)** ||\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202408/CreativeWrapperService.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)}. |\n| ### `trigger` | ` `xsd:`string` The data that caused the error. |\n| ### `errorString` | ` `xsd:`string` A simple string representation of the error and reason. |\n| **`ApiVersionError`** ||\n| ### `reason` | ` `[ApiVersionError.Reason](/ad-manager/api/reference/v202408/CreativeWrapperService.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. \u003cbr /\u003e |"]]
