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 Google Ad Manager API, specifically for the \u003ccode\u003eSuggestedAdUnitService\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiVersionError\u003c/code\u003e arises when there's a mismatch between the API version used in a request and the version required for the operation.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field provides further insight into the specific version incompatibility, such as needing to update to a newer version.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers should refer to this documentation to troubleshoot errors related to API versions in their Ad Manager integrations.\u003c/p\u003e\n"],["\u003cp\u003eThis error falls under the broader category of \u003ccode\u003eApiError\u003c/code\u003e within the Ad Manager API and inherits its properties.\u003c/p\u003e\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](/ad-manager/api/reference/v202411/ContentBundleService.ApiVersionError) [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** [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/SuggestedAdUnitService.ApiError) \n▼\n**ApiVersionError** [AuthenticationError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.CommonError) [EntityLimitReachedError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.InternalApiError) [InventoryUnitSizesError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.InventoryUnitSizesError) [LabelEntityAssociationError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.LabelEntityAssociationError) [NotNullError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.NotNullError) [ParseError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/SuggestedAdUnitService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/SuggestedAdUnitService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.RequiredError) [ServerError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.ServerError) [StatementError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.StringLengthError) [TypeError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/SuggestedAdUnitService.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/SuggestedAdUnitService.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/SuggestedAdUnitService.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 |"]]
