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 in Google Ad Manager, which arises from issues related to API versions used in requests.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiVersionError\u003c/code\u003e typically occurs when an operation is attempted in an unsupported API version or the requested version doesn't expose the necessary functionalities.\u003c/p\u003e\n"],["\u003cp\u003eThe error includes details like the problematic field path, a parsed representation of the path, the error trigger, a description of the error, and the specific reason for the version conflict.\u003c/p\u003e\n"],["\u003cp\u003eTwo primary reasons for \u003ccode\u003eApiVersionError\u003c/code\u003e are identified: \u003ccode\u003eUPDATE_TO_NEWER_VERSION\u003c/code\u003e (operation not allowed in the requested version) and \u003ccode\u003eUNKNOWN\u003c/code\u003e (requested version doesn't expose the specific value).\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can refer to the provided namespace and field details to understand and troubleshoot \u003ccode\u003eApiVersionError\u003c/code\u003e occurrences in their Google Ad Manager integrations.\u003c/p\u003e\n"]]],["The content details numerous services for managing ads, including AdRule, Adjustment, AdsTxt, AudienceSegment, and CdnConfiguration. Additional services cover CmsMetadata, Companies, Contacts, Content, Creatives, CustomFields, and Forecasting. It lists more services like Inventory, LineItems, Orders, Placements, Proposals, and Reports. It defines `ApiError` and `ApiVersionError` for version-related issues, outlining reasons like `UPDATE_TO_NEWER_VERSION` and specifying fields like `fieldPath` and `errorString`.\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](/ad-manager/api/reference/v202408/CreativeWrapperService.ApiVersionError) [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** [UserTeamAssociationService](/ad-manager/api/reference/v202408/UserTeamAssociationService.ApiVersionError) [YieldGroupService](/ad-manager/api/reference/v202408/YieldGroupService.ApiVersionError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/UserService.ApiError) \n▼\n**ApiVersionError** [AuthenticationError](/ad-manager/api/reference/v202408/UserService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/UserService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/UserService.CommonError) [CustomFieldValueError](/ad-manager/api/reference/v202408/UserService.CustomFieldValueError) [EntityLimitReachedError](/ad-manager/api/reference/v202408/UserService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/UserService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/UserService.InternalApiError) [InvalidEmailError](/ad-manager/api/reference/v202408/UserService.InvalidEmailError) [NotNullError](/ad-manager/api/reference/v202408/UserService.NotNullError) [ParseError](/ad-manager/api/reference/v202408/UserService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/UserService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/UserService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/UserService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/UserService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/UserService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/UserService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/UserService.ServerError) [StatementError](/ad-manager/api/reference/v202408/UserService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/UserService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/UserService.StringLengthError) [TeamError](/ad-manager/api/reference/v202408/UserService.TeamError) [TimeZoneError](/ad-manager/api/reference/v202408/UserService.TimeZoneError) [TokenError](/ad-manager/api/reference/v202408/UserService.TokenError) [TypeError](/ad-manager/api/reference/v202408/UserService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/UserService.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/UserService.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/UserService.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 |"]]
