type ApiVersionError (v202411)
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/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.
|
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 ContentBundleService 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 requests.\u003c/p\u003e\n"],["\u003cp\u003eThis error commonly occurs if the requested operation is not supported by the API version or if an update to a newer version is required.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation provides a detailed breakdown of the error, including its namespace, fields, and potential reasons for its occurrence.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this information to troubleshoot and resolve \u003ccode\u003eApiVersionError\u003c/code\u003e instances encountered while interacting with the Ad Manager API.\u003c/p\u003e\n"]]],["The provided content details various services within an ad management API, including AdRuleService, AdjustmentService, and many others. It also outlines the `ApiVersionError`, a specific error type related to incorrect API version usage. `ApiVersionError` inherits from `ApiError` and includes fields like `fieldPath`, `trigger`, and `reason`, which can be `UPDATE_TO_NEWER_VERSION` or `UNKNOWN`. The namespace for these services is `https://www.google.com/apis/ads/publisher/v202411`.\n"],null,["# type ApiVersionError (v202411)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202411/AdRuleService.ApiVersionError) [AdjustmentService](/ad-manager/api/reference/v202411/AdjustmentService.ApiVersionError) [AdsTxtService](/ad-manager/api/reference/v202411/AdsTxtService.ApiVersionError) [AudienceSegmentService](/ad-manager/api/reference/v202411/AudienceSegmentService.ApiVersionError) [CdnConfigurationService](/ad-manager/api/reference/v202411/CdnConfigurationService.ApiVersionError) [CmsMetadataService](/ad-manager/api/reference/v202411/CmsMetadataService.ApiVersionError) [CompanyService](/ad-manager/api/reference/v202411/CompanyService.ApiVersionError) [ContactService](/ad-manager/api/reference/v202411/ContactService.ApiVersionError) **ContentBundleService** [ContentService](/ad-manager/api/reference/v202411/ContentService.ApiVersionError) [CreativeService](/ad-manager/api/reference/v202411/CreativeService.ApiVersionError) [CreativeSetService](/ad-manager/api/reference/v202411/CreativeSetService.ApiVersionError) [CreativeTemplateService](/ad-manager/api/reference/v202411/CreativeTemplateService.ApiVersionError) [CreativeWrapperService](/ad-manager/api/reference/v202411/CreativeWrapperService.ApiVersionError) [CustomFieldService](/ad-manager/api/reference/v202411/CustomFieldService.ApiVersionError) [CustomTargetingService](/ad-manager/api/reference/v202411/CustomTargetingService.ApiVersionError) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202411/DaiAuthenticationKeyService.ApiVersionError) [DaiEncodingProfileService](/ad-manager/api/reference/v202411/DaiEncodingProfileService.ApiVersionError) [ForecastService](/ad-manager/api/reference/v202411/ForecastService.ApiVersionError) [InventoryService](/ad-manager/api/reference/v202411/InventoryService.ApiVersionError) [LabelService](/ad-manager/api/reference/v202411/LabelService.ApiVersionError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202411/LineItemCreativeAssociationService.ApiVersionError) [LineItemService](/ad-manager/api/reference/v202411/LineItemService.ApiVersionError) [LineItemTemplateService](/ad-manager/api/reference/v202411/LineItemTemplateService.ApiVersionError) [LiveStreamEventService](/ad-manager/api/reference/v202411/LiveStreamEventService.ApiVersionError) [MobileApplicationService](/ad-manager/api/reference/v202411/MobileApplicationService.ApiVersionError) [NativeStyleService](/ad-manager/api/reference/v202411/NativeStyleService.ApiVersionError) [NetworkService](/ad-manager/api/reference/v202411/NetworkService.ApiVersionError) [OrderService](/ad-manager/api/reference/v202411/OrderService.ApiVersionError) [PlacementService](/ad-manager/api/reference/v202411/PlacementService.ApiVersionError) [ProposalLineItemService](/ad-manager/api/reference/v202411/ProposalLineItemService.ApiVersionError) [ProposalService](/ad-manager/api/reference/v202411/ProposalService.ApiVersionError) [PublisherQueryLanguageService](/ad-manager/api/reference/v202411/PublisherQueryLanguageService.ApiVersionError) [ReportService](/ad-manager/api/reference/v202411/ReportService.ApiVersionError) [SegmentPopulationService](/ad-manager/api/reference/v202411/SegmentPopulationService.ApiVersionError) [SiteService](/ad-manager/api/reference/v202411/SiteService.ApiVersionError) [StreamActivityMonitorService](/ad-manager/api/reference/v202411/StreamActivityMonitorService.ApiVersionError) [SuggestedAdUnitService](/ad-manager/api/reference/v202411/SuggestedAdUnitService.ApiVersionError) [TargetingPresetService](/ad-manager/api/reference/v202411/TargetingPresetService.ApiVersionError) [TeamService](/ad-manager/api/reference/v202411/TeamService.ApiVersionError) [UserService](/ad-manager/api/reference/v202411/UserService.ApiVersionError) [UserTeamAssociationService](/ad-manager/api/reference/v202411/UserTeamAssociationService.ApiVersionError) [YieldGroupService](/ad-manager/api/reference/v202411/YieldGroupService.ApiVersionError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202411/ContentBundleService.ApiError) \n▼\n**ApiVersionError** [AuthenticationError](/ad-manager/api/reference/v202411/ContentBundleService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/ContentBundleService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/ContentBundleService.CommonError) [ContentFilterError](/ad-manager/api/reference/v202411/ContentBundleService.ContentFilterError) [FeatureError](/ad-manager/api/reference/v202411/ContentBundleService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/ContentBundleService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202411/ContentBundleService.NotNullError) [ParseError](/ad-manager/api/reference/v202411/ContentBundleService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/ContentBundleService.PermissionError) [PlacementError](/ad-manager/api/reference/v202411/ContentBundleService.PlacementError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/ContentBundleService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/ContentBundleService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/ContentBundleService.QuotaError) [RequestError](/ad-manager/api/reference/v202411/ContentBundleService.RequestError) [RequiredCollectionError](/ad-manager/api/reference/v202411/ContentBundleService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/ContentBundleService.RequiredError) [ServerError](/ad-manager/api/reference/v202411/ContentBundleService.ServerError) [StatementError](/ad-manager/api/reference/v202411/ContentBundleService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/ContentBundleService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/ContentBundleService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202411/ContentBundleService.UniqueError)\n\nErrors related to the usage of API versions.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\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/v202411/ContentBundleService.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/v202411/ContentBundleService.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 |"]]
