type CompanyError (v202411)
A list of all errors associated with companies.
- 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.
|
CompanyError
|
reason
|
CompanyError.Reason
Enumerations
-
CANNOT_SET_THIRD_PARTY_COMPANY_DUE_TO_TYPE
- Indicates that an attempt was made to set a third party company for a
company whose type is not the same as the third party company.
-
CANNOT_UPDATE_COMPANY_TYPE
- Indicates that an invalid attempt was made to change a company's type.
-
INVALID_COMPANY_TYPE
- Indicates that this type of company is not supported.
-
PRIMARY_CONTACT_DOES_NOT_BELONG_TO_THIS_COMPANY
- Indicates that an attempt was made to assign a primary contact who
does not belong to the specified company.
-
THIRD_PARTY_STATS_PROVIDER_IS_WRONG_ROLE_TYPE
- Indicates that the user specified as the third party stats provider
is of the wrong role type. The user must have the third party stats
provider role.
-
INVALID_LABEL_ASSOCIATION
- Labels can only be applied to Company.Type.ADVERTISER,
Company.Type.HOUSE_ADVERTISER, and Company.Type.AD_NETWORK company types.
-
INVALID_COMPANY_TYPE_FOR_DEFAULT_BILLING_SETTING
- Indicates that the Company.Type does not support default billing settings.
-
INVALID_DEFAULT_BILLING_SETTING
- Indicates that the format of the default billing setting is wrong.
-
COMPANY_HAS_ACTIVE_SHARE_ASSIGNMENTS
- Cannot remove the cross selling config from a company that has active share assignments.
-
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 2024-11-19 UTC.
[null,null,["Last updated 2024-11-19 UTC."],[[["The `CompanyError` object provides details about errors related to company operations in Google Ad Manager."],["These errors can occur due to various reasons, such as invalid company types, incorrect primary contact assignments, or issues with cross-selling configurations."],["The `reason` field within the `CompanyError` object specifies the specific cause of the error, aiding in troubleshooting."],["Detailed information about each error reason is available in the provided documentation, including descriptions and potential resolutions."],["Developers should utilize these error details to identify and address issues encountered during interactions with the CompanyService API."]]],["The document outlines error handling for the `CompanyService`, part of the `InventoryService`. It details the inheritance of `ApiError` and the specific `CompanyError`, which encompasses various error reasons. These include issues like incompatible company types, incorrect roles for third-party providers, invalid label associations, default billing setting problems, and active share assignment conflicts. The errors also contain information about `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to diagnose issues, and a detailed description of the error.\n"]]