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 Google Ad Manager API, specifically for the CustomFieldService.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiVersionError\u003c/code\u003e occurs when there's an issue with the API version being used, like attempting an operation not supported in the requested version.\u003c/p\u003e\n"],["\u003cp\u003eThe error provides details such as the reason for the error (e.g., needing to update to a newer version), a field path for identifying the cause, and a general error string.\u003c/p\u003e\n"],["\u003cp\u003eThe namespace for this error is \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202408\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this information to troubleshoot and resolve API version-related errors when interacting with the CustomFieldService.\u003c/p\u003e\n"]]],["The document outlines numerous services within an ad management API, including AdRule, Adjustment, AdsTxt, AudienceSegment, and many others, totaling over 40. It also details error handling, with `ApiError` as the base, and `ApiVersionError` specifically addressing version-related issues. This `ApiVersionError` includes reasons such as `UPDATE_TO_NEWER_VERSION`, signifying an operation is unsupported in the current API version. Field properties are provided with descriptions for `ApiError`.\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** [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/CustomFieldService.ApiError) \n▼\n**ApiVersionError** [AuthenticationError](/ad-manager/api/reference/v202408/CustomFieldService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CustomFieldService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CustomFieldService.CommonError) [CustomFieldError](/ad-manager/api/reference/v202408/CustomFieldService.CustomFieldError) [EntityLimitReachedError](/ad-manager/api/reference/v202408/CustomFieldService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/CustomFieldService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CustomFieldService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202408/CustomFieldService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CustomFieldService.NullError) [ParseError](/ad-manager/api/reference/v202408/CustomFieldService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CustomFieldService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CustomFieldService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CustomFieldService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CustomFieldService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CustomFieldService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CustomFieldService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/CustomFieldService.ServerError) [StatementError](/ad-manager/api/reference/v202408/CustomFieldService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/CustomFieldService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/CustomFieldService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/CustomFieldService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/CustomFieldService.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/CustomFieldService.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/CustomFieldService.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 |"]]
