type CompanyCreditStatusError (v202411)

  • CompanyCreditStatusError lists errors related to the Company.creditStatus, affecting various services including CompanyService, ForecastService, LineItemService, LineItemTemplateService, and OrderService.

  • This error inherits properties from ApiError, such as fieldPath, fieldPathElements, trigger, and errorString, which help identify the cause of the error.

  • The reason field in CompanyCreditStatusError provides an enum indicating specific issues, such as insufficient user permission to change credit status, network not enabled for credit status settings, or unacceptable credit status for orders and line items.

  • Other specific reasons for this error include being unable to block a company with too many approved orders and an unknown reason indicating an unexposed value in the API version.

Lists all errors due to Company.creditStatus.


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.

CompanyCreditStatusError

reason

CompanyCreditStatusError.Re...

The error reason represented by an enum.


Enumerations
COMPANY_CREDIT_STATUS_CHANGE_NOT_ALLOWED
The user's role does not have permission to change Company.creditStatus from the default value. The default value is Company.CreditStatus.ACTIVE for the Basic credit status setting and Company.CreditStatus.ON_HOLD for the Advanced credit status setting.
CANNOT_USE_CREDIT_STATUS_SETTING
The network has not been enabled for editing credit status settings for companies.
CANNOT_USE_ADVANCED_CREDIT_STATUS_SETTING
The network has not been enabled for the Advanced credit status settings for companies. Company.creditStatus must be either ACTIVE or INACTIVE.
UNACCEPTABLE_COMPANY_CREDIT_STATUS_FOR_ORDER
An order cannot be created or updated because the Order.advertiserId or the Order.agencyId it is associated with has Company.creditStatus that is not ACTIVE or ON_HOLD.
UNACCEPTABLE_COMPANY_CREDIT_STATUS_FOR_LINE_ITEM
A line item cannot be created for the order because the Order.advertiserId or {Order#agencyId} it is associated with has Company.creditStatus that is not ACTIVE or ON_HOLD.
CANNOT_BLOCK_COMPANY_TOO_MANY_APPROVED_ORDERS
The company cannot be blocked because there are more than 200 approved orders of the company. Archive some, so that there are less than 200 of them.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.