type InventoryClientApiError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
ApiError for common exceptions thrown when accessing AdSense InventoryClient.
- 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.
|
InventoryClientApiError
|
reason
|
InventoryClientApiError.Reason
Enumerations
-
ACCESS_DENIED
-
ADSENSE_AUTH_ERROR
-
ADSENSE_RPC_ERROR
-
DOMAIN_NO_SCHEME
-
DOMAIN_INVALID_HOST
-
DOMAIN_INVALID_TLD
-
DOMAIN_ONE_STRING_AND_PUBLIC_SUFFIX
-
DOMAIN_INVALID_INPUT
-
DOMAIN_NO_PUBLIC_SUFFIX
-
UNKNOWN_ERROR
|
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\u003eThe \u003ccode\u003eCompanyService.InventoryClientApiError\u003c/code\u003e object represents errors encountered when accessing AdSense InventoryClient.\u003c/p\u003e\n"],["\u003cp\u003eIt inherits from \u003ccode\u003eApiError\u003c/code\u003e and includes fields like \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e for detailed error information.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field provides specific error codes like \u003ccode\u003eACCESS_DENIED\u003c/code\u003e and \u003ccode\u003eADSENSE_AUTH_ERROR\u003c/code\u003e, using the \u003ccode\u003eInventoryClientApiError.Reason\u003c/code\u003e enumeration.\u003c/p\u003e\n"],["\u003cp\u003eThe namespace for this error object is \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202408\u003c/code\u003e.\u003c/p\u003e\n"]]],["The `CompanyService`'s `NetworkService` uses `InventoryClientApiError`, inheriting from `ApiError`, to handle exceptions. `ApiError` includes fields like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`. `InventoryClientApiError` specifies a `reason` for the error, with potential causes such as `ACCESS_DENIED`, `ADSENSE_AUTH_ERROR`, domain-related issues, or `UNKNOWN_ERROR`. It lists various error types, including authentication, collection size, and internal errors. The service defines error conditions and their corresponding messages.\n"],null,["# type InventoryClientApiError (v202408)\n\n**Service** \n**CompanyService** [NetworkService](/ad-manager/api/reference/v202408/NetworkService.InventoryClientApiError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/CompanyService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/CompanyService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/CompanyService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CompanyService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CompanyService.CommonError) [CompanyCreditStatusError](/ad-manager/api/reference/v202408/CompanyService.CompanyCreditStatusError) [CompanyError](/ad-manager/api/reference/v202408/CompanyService.CompanyError) [CrossSellError](/ad-manager/api/reference/v202408/CompanyService.CrossSellError) [CustomFieldValueError](/ad-manager/api/reference/v202408/CompanyService.CustomFieldValueError) [ExchangeSignupApiError](/ad-manager/api/reference/v202408/CompanyService.ExchangeSignupApiError) [FeatureError](/ad-manager/api/reference/v202408/CompanyService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CompanyService.InternalApiError) [InvalidEmailError](/ad-manager/api/reference/v202408/CompanyService.InvalidEmailError) [InvalidUrlError](/ad-manager/api/reference/v202408/CompanyService.InvalidUrlError) **InventoryClientApiError** [LabelEntityAssociationError](/ad-manager/api/reference/v202408/CompanyService.LabelEntityAssociationError) [McmError](/ad-manager/api/reference/v202408/CompanyService.McmError) [NetworkError](/ad-manager/api/reference/v202408/CompanyService.NetworkError) [NotNullError](/ad-manager/api/reference/v202408/CompanyService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CompanyService.NullError) [ParseError](/ad-manager/api/reference/v202408/CompanyService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CompanyService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CompanyService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CompanyService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CompanyService.QuotaError) [RegExError](/ad-manager/api/reference/v202408/CompanyService.RegExError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CompanyService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CompanyService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202408/CompanyService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202408/CompanyService.ServerError) [SiteError](/ad-manager/api/reference/v202408/CompanyService.SiteError) [StatementError](/ad-manager/api/reference/v202408/CompanyService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/CompanyService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/CompanyService.StringLengthError) [TeamError](/ad-manager/api/reference/v202408/CompanyService.TeamError) [TypeError](/ad-manager/api/reference/v202408/CompanyService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/CompanyService.UniqueError)\n\n\n[ApiError](/ad-manager/api/reference/v202408/CompanyService.ApiError) for common exceptions thrown when accessing AdSense InventoryClient.\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/CompanyService.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| **`InventoryClientApiError`** ||\n| ### `reason` | ` `[InventoryClientApiError.Reason](/ad-manager/api/reference/v202408/CompanyService.InventoryClientApiError.Reason)` ` *** ** * ** *** **Enumerations** `ACCESS_DENIED` : `ADSENSE_AUTH_ERROR` : `ADSENSE_RPC_ERROR` : `DOMAIN_NO_SCHEME` : `DOMAIN_INVALID_HOST` : `DOMAIN_INVALID_TLD` : `DOMAIN_ONE_STRING_AND_PUBLIC_SUFFIX` : `DOMAIN_INVALID_INPUT` : `DOMAIN_NO_PUBLIC_SUFFIX` : `UNKNOWN_ERROR` : \u003cbr /\u003e |"]]
