Error Response

We provide an error response as a JSON object. There are some information to help you figure out the reason for the error. Useful fields are:

{
    "code": 3,
    "message": "\"ad_account_id\" is required but missing [id:iBe7CAAUainlyPM]",
    "details": [
        {
            "@type": "type.googleapis.com/api.adcloud.common.APIErrorInfo",
            "error_log_id": "iBe7CAAUainlyPM",
            "reason": "REQUIRED",
            "context": {
                "field": "ad_account_id"
            }
        }
    ]
}

• message contains the human readable error message. This can be changed at any time.
• reason contains the error code. It categorizes the cause of the error.
• context is a map type, which provides useful information about the origin and important values. For example, we provides the name of the problematic field by the key field. There could be different information in context field for each error reason.

These information will help you resolving the error. If you still cannot find the problem, please contact us using error_log_id, which is a unique id for each error.

Common Errors

On API reference, you can find each API's possible reasons on the default response tab. It lists all the errors which can be populated from the API request.

However, for common errors which can be occur on any APIs, please see the below.

REQUIRED

Description

The required field is missing.

INVALID_VALUE

Description

The field's value is invalid. You can check the error message for more description.

MUST_BE_UNSET

Description

The value should be unset.

IMMUTABLE

Description

The field attempted to be mutated is immutable.

INVALID_TIMESTAMP

Description

The value is not a valid timestamp.

NOT_FOUND

Description

The resource is not found.

REQUEST_SIZE_LIMIT_EXCEEDED

Description

The request field has exceed its size limit.

INVALID_TIME_RANGE

Description

The time range is invalid.

UPDATE_TIMESTAMP_MISMATCH

Description

The entity trying to update is not in the same state on the server.

NOT_SUPPORTED

Description

The value is not supported for the request.

MUST_BE_SAME_FOR_BULK_API

Description

The target field must be same for all resources on bulk API request.

END_VALUE_MUST_BE_GREATER_THAN_START_VALUE

Description

The end value of range must be greater than the start value.

END_VALUE_MUST_BE_EQUAL_OR_GREATER_THAN_START_VALUE

Description

The end value of range must be equal or greater than the start value.

CANNOT_BE_NEGATIVE

Description

The value cannot be a negative value.

REQUIRED_FIELD_IS_EMPTY

Description

Requested field is not set or only contains whitespaces.

CANNOT_UPDATE_SAME_ENTITIES_ON_BULK_API

Description

The request try to update same entities in bulk.

CANNOT_BE_EMPTY

Description

Specified field cannot be empty.

LENGTH_MISMATCH

Description

Length of target fields should be same.

CANNOT_SET_BOTH

Description

Cannot set both fields.

INVALID_DATE_FORMAT

Description

The date should be in the format of YYYY-MM-DD.

REFERENCED_ENTITY_NOT_FOUND

Description

The referenced entity does not exists.

CONTAINS_EMPTY

Description

Request has a field containing nil entity.

CANNOT_CONTAIN_DUPLICATE

Description

Specified field cannot have the same value.

ENTITY_COUNTER_LIMIT_IS_REACHED

Description

Number of entities has reached the limit.

ENTITY_COUNTER_INVALID_COUNT

Description

Entity counter value has invalid value(below 0).

PERMISSION_DENIED

Description

User doesn't have permission to make the action.

AUTH_FAILED

Description

Authentication failed. Please check for credentials.

CANNOT_DELETE_REFERENCED

Description

The entity is referenced from the other entity.