type InventoryClientApiError (v202411)
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/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.
|
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 CompanyService API handles company-related operations in Ad Manager and may throw InventoryClientApiError for AdSense inventory access issues.\u003c/p\u003e\n"],["\u003cp\u003eInventoryClientApiError inherits from ApiError, providing detailed error information like field path, trigger, and error string.\u003c/p\u003e\n"],["\u003cp\u003eInventoryClientApiError includes a \u003ccode\u003ereason\u003c/code\u003e field with an enumeration of potential causes for the error, such as access denial or AdSense authentication problems.\u003c/p\u003e\n"],["\u003cp\u003eThe namespace for this API is \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202411\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eDetailed error information is available through fields like \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003efieldPathElements\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e within the ApiError object.\u003c/p\u003e\n"]]],["The `CompanyService`'s `InventoryClientApiError` inherits from `ApiError` and handles common exceptions. It lists various error types like `ApiVersionError`, `AuthenticationError`, `InternalApiError`, and others. The `ApiError` includes details such as `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`. The `InventoryClientApiError` specifies error `reason` with enumerations like `ACCESS_DENIED`, `ADSENSE_AUTH_ERROR`, and `UNKNOWN_ERROR` for issues when accessing AdSense InventoryClient.\n"],null,["# type InventoryClientApiError (v202411)\n\n**Service** \n**CompanyService** [NetworkService](/ad-manager/api/reference/v202411/NetworkService.InventoryClientApiError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202411/CompanyService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/CompanyService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/CompanyService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/CompanyService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/CompanyService.CommonError) [CompanyCreditStatusError](/ad-manager/api/reference/v202411/CompanyService.CompanyCreditStatusError) [CompanyError](/ad-manager/api/reference/v202411/CompanyService.CompanyError) [CrossSellError](/ad-manager/api/reference/v202411/CompanyService.CrossSellError) [CustomFieldValueError](/ad-manager/api/reference/v202411/CompanyService.CustomFieldValueError) [ExchangeSignupApiError](/ad-manager/api/reference/v202411/CompanyService.ExchangeSignupApiError) [FeatureError](/ad-manager/api/reference/v202411/CompanyService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/CompanyService.InternalApiError) [InvalidEmailError](/ad-manager/api/reference/v202411/CompanyService.InvalidEmailError) [InvalidUrlError](/ad-manager/api/reference/v202411/CompanyService.InvalidUrlError) **InventoryClientApiError** [LabelEntityAssociationError](/ad-manager/api/reference/v202411/CompanyService.LabelEntityAssociationError) [McmError](/ad-manager/api/reference/v202411/CompanyService.McmError) [NetworkError](/ad-manager/api/reference/v202411/CompanyService.NetworkError) [NotNullError](/ad-manager/api/reference/v202411/CompanyService.NotNullError) [NullError](/ad-manager/api/reference/v202411/CompanyService.NullError) [ParseError](/ad-manager/api/reference/v202411/CompanyService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/CompanyService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/CompanyService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/CompanyService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/CompanyService.QuotaError) [RegExError](/ad-manager/api/reference/v202411/CompanyService.RegExError) [RequiredCollectionError](/ad-manager/api/reference/v202411/CompanyService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/CompanyService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202411/CompanyService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202411/CompanyService.ServerError) [SiteError](/ad-manager/api/reference/v202411/CompanyService.SiteError) [StatementError](/ad-manager/api/reference/v202411/CompanyService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/CompanyService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/CompanyService.StringLengthError) [TeamError](/ad-manager/api/reference/v202411/CompanyService.TeamError) [TypeError](/ad-manager/api/reference/v202411/CompanyService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/CompanyService.UniqueError)\n\n\n[ApiError](/ad-manager/api/reference/v202411/CompanyService.ApiError) for common exceptions thrown when accessing AdSense InventoryClient.\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/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/v202411/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 |"]]
