The new Search Ads 360 Reporting API is now available. Join the searchads-api-announcements Google group to stay up to date on upcoming enhancements and releases.

Package google.ads.searchads360.v0.errors

Index

AuthenticationErrorEnum (message)
AuthenticationErrorEnum.AuthenticationError (enum)
AuthorizationErrorEnum (message)
AuthorizationErrorEnum.AuthorizationError (enum)
CustomColumnErrorEnum (message)
CustomColumnErrorEnum.CustomColumnError (enum)
DateErrorEnum (message)
DateErrorEnum.DateError (enum)
DateRangeErrorEnum (message)
DateRangeErrorEnum.DateRangeError (enum)
DistinctErrorEnum (message)
DistinctErrorEnum.DistinctError (enum)
ErrorCode (message)
ErrorDetails (message)
ErrorLocation (message)
ErrorLocation.FieldPathElement (message)
HeaderErrorEnum (message)
HeaderErrorEnum.HeaderError (enum)
InternalErrorEnum (message)
InternalErrorEnum.InternalError (enum)
InvalidParameterErrorEnum (message)
InvalidParameterErrorEnum.InvalidParameterError (enum)
QueryErrorEnum (message)
QueryErrorEnum.QueryError (enum)
QuotaErrorDetails (message)
QuotaErrorDetails.QuotaRateScope (enum)
QuotaErrorEnum (message)
QuotaErrorEnum.QuotaError (enum)
RequestErrorEnum (message)
RequestErrorEnum.RequestError (enum)
SearchAds360Error (message)
SearchAds360Failure (message)
SizeLimitErrorEnum (message)
SizeLimitErrorEnum.SizeLimitError (enum)

AuthenticationErrorEnum

This type has no fields.

Container for enum describing possible authentication errors.

AuthenticationError

Enum describing possible authentication errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`AUTHENTICATION_ERROR`	Authentication of the request failed.
`CLIENT_CUSTOMER_ID_INVALID`	Client customer ID is not a number.
`CUSTOMER_NOT_FOUND`	No customer found for the provided customer ID.
`GOOGLE_ACCOUNT_DELETED`	Client's Google account is deleted.
`GOOGLE_ACCOUNT_COOKIE_INVALID`	Account login token in the cookie is invalid.
`GOOGLE_ACCOUNT_AUTHENTICATION_FAILED`	A problem occurred during Google account authentication.
`GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH`	The user in the Google account login token does not match the user ID in the cookie.
`LOGIN_COOKIE_REQUIRED`	Login cookie is required for authentication.
`NOT_ADS_USER`	The Google account that generated the OAuth access token is not associated with a Search Ads 360 account. Create a new account, or add the Google account to an existing Search Ads 360 account.
`OAUTH_TOKEN_INVALID`	OAuth token in the header is not valid.
`OAUTH_TOKEN_EXPIRED`	OAuth token in the header has expired.
`OAUTH_TOKEN_DISABLED`	OAuth token in the header has been disabled.
`OAUTH_TOKEN_REVOKED`	OAuth token in the header has been revoked.
`OAUTH_TOKEN_HEADER_INVALID`	OAuth token HTTP header is malformed.
`LOGIN_COOKIE_INVALID`	Login cookie is not valid.
`USER_ID_INVALID`	User ID in the header is not a valid ID.
`TWO_STEP_VERIFICATION_NOT_ENROLLED`	An account administrator changed this account's authentication settings. To access this account, enable 2-Step Verification in your Google account at https://www.google.com/landing/2step.
`ADVANCED_PROTECTION_NOT_ENROLLED`	An account administrator changed this account's authentication settings. To access this account, enable Advanced Protection in your Google account at https://landing.google.com/advancedprotection.

AuthorizationErrorEnum

This type has no fields.

Container for enum describing possible authorization errors.

AuthorizationError

Enum describing possible authorization errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`USER_PERMISSION_DENIED`	User doesn't have permission to access customer. Note: If you're accessing a client customer, the manager's customer ID must be set in the `login-customer-id` header. Learn more at https://developers.google.com/search-ads/reporting/concepts/call-structure#login_customer_id_header
`PROJECT_DISABLED`	The Google Cloud project sent in the request does not have permission to access the api.
`AUTHORIZATION_ERROR`	Authorization of the client failed.
`ACTION_NOT_PERMITTED`	The user does not have permission to perform this action (for example, ADD, UPDATE, REMOVE) on the resource or call a method.
`INCOMPLETE_SIGNUP`	Signup not complete.
`CUSTOMER_NOT_ENABLED`	The customer account can't be accessed because it is not yet enabled or has been deactivated.
`MISSING_TOS`	The developer must sign the terms of service. They can be found here: https://developers.google.com/terms
`INVALID_LOGIN_CUSTOMER_ID_SERVING_CUSTOMER_ID_COMBINATION`	The login customer specified does not have access to the account specified, so the request is invalid.
`SERVICE_ACCESS_DENIED`	The developer specified does not have access to the service.
`ACCESS_DENIED_FOR_ACCOUNT_TYPE`	The customer (or login customer) isn't allowed in Search Ads 360 API. It belongs to another ads system.
`METRIC_ACCESS_DENIED`	The developer does not have access to the metrics queried.

CustomColumnErrorEnum

This type has no fields.

Container for enum describing possible custom column errors.

CustomColumnError

Enum describing possible custom column errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`CUSTOM_COLUMN_NOT_FOUND`	The custom column has not been found.
`CUSTOM_COLUMN_NOT_AVAILABLE`	The custom column is not available.

DateErrorEnum

This type has no fields.

Container for enum describing possible date errors.

DateError

Enum describing possible date errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`INVALID_FIELD_VALUES_IN_DATE`	Given field values do not correspond to a valid date.
`INVALID_FIELD_VALUES_IN_DATE_TIME`	Given field values do not correspond to a valid date time.
`INVALID_STRING_DATE`	The string date's format should be yyyy-mm-dd.
`INVALID_STRING_DATE_TIME_MICROS`	The string date time's format should be yyyy-mm-dd hh:mm:ss.ssssss.
`INVALID_STRING_DATE_TIME_SECONDS`	The string date time's format should be yyyy-mm-dd hh:mm:ss.
`INVALID_STRING_DATE_TIME_SECONDS_WITH_OFFSET`	The string date time's format should be yyyy-mm-dd hh:mm:ss+\|-hh:mm.
`EARLIER_THAN_MINIMUM_DATE`	Date is before allowed minimum.
`LATER_THAN_MAXIMUM_DATE`	Date is after allowed maximum.
`DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE`	Date range bounds are not in order.
`DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL`	Both dates in range are null.

DateRangeErrorEnum

This type has no fields.

Container for enum describing possible date range errors.

DateRangeError

Enum describing possible date range errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`INVALID_DATE`	Invalid date.
`START_DATE_AFTER_END_DATE`	The start date was after the end date.
`CANNOT_SET_DATE_TO_PAST`	Cannot set date to past time
`AFTER_MAXIMUM_ALLOWABLE_DATE`	A date was used that is past the system "last" date.
`CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED`	Trying to change start date on a resource that has started.

DistinctErrorEnum

This type has no fields.

Container for enum describing possible distinct errors.

DistinctError

Enum describing possible distinct errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`DUPLICATE_ELEMENT`	Duplicate element.
`DUPLICATE_TYPE`	Duplicate type.

ErrorCode

The error reason represented by type and enum.

Fields
Union field `error_code`. The list of error enums `error_code` can be only one of the following:
`request_error`	`RequestError` An error caused by the request
`query_error`	`QueryError` An error with the query
`authorization_error`	`AuthorizationError` An error encountered when trying to authorize a user.
`internal_error`	`InternalError` An unexpected server-side error.
`quota_error`	`QuotaError` An error with the amount of quota remaining.
`authentication_error`	`AuthenticationError` Indicates failure to properly authenticate user.
`date_error`	`DateError` The reasons for the date error
`date_range_error`	`DateRangeError` The reasons for the date range error
`distinct_error`	`DistinctError` The reasons for the distinct error
`header_error`	`HeaderError` The reasons for the header error.
`size_limit_error`	`SizeLimitError` The reasons for the size limit error
`custom_column_error`	`CustomColumnError` The reasons for the custom column error
`invalid_parameter_error`	`InvalidParameterError` The reasons for invalid parameter errors.

ErrorDetails

Additional error details.

Fields

Fields
`unpublished_error_code`	`string` The error code that should have been returned, but wasn't. This is used when the error code is not published in the client specified version.
`quota_error_details`	`QuotaErrorDetails` Details on the quota error, including the scope (account or developer), the rate bucket name and the retry delay.

unpublished_error_code

string

The error code that should have been returned, but wasn't. This is used when the error code is not published in the client specified version.

quota_error_details

QuotaErrorDetails

Details on the quota error, including the scope (account or developer), the rate bucket name and the retry delay.

ErrorLocation

Describes the part of the request proto that caused the error.

Fields

Fields
`field_path_elements[]`	`FieldPathElement` A field path that indicates which field was invalid in the request.

field_path_elements[]

FieldPathElement

A field path that indicates which field was invalid in the request.

FieldPathElement

A part of a field path.

Fields

Fields
`field_name`	`string` The name of a field or a oneof
`index`	`int32` If field_name is a repeated field, this is the element that failed

field_name

string

The name of a field or a oneof

index

int32

If field_name is a repeated field, this is the element that failed

HeaderErrorEnum

This type has no fields.

Container for enum describing possible header errors.

HeaderError

Enum describing possible header errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`INVALID_USER_SELECTED_CUSTOMER_ID`	The user selected customer ID could not be validated.
`INVALID_LOGIN_CUSTOMER_ID`	The login customer ID could not be validated.

InternalErrorEnum

This type has no fields.

Container for enum describing possible internal errors.

InternalError

Enum describing possible internal errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`INTERNAL_ERROR`	API encountered unexpected internal error.
`ERROR_CODE_NOT_PUBLISHED`	The intended error code doesn't exist in specified API version. It will be released in a future API version.
`TRANSIENT_ERROR`	API encountered an unexpected transient error. The user should retry their request in these cases.
`DEADLINE_EXCEEDED`	The request took longer than a deadline.

InvalidParameterErrorEnum

This type has no fields.

Container for enum describing possible errors from an invalid parameter.

InvalidParameterError

Enum describing possible parameter errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`INVALID_CURRENCY_CODE`	The specified currency code is invalid.

QueryErrorEnum

This type has no fields.

Container for enum describing possible query errors.

QueryError

Enum describing possible query errors.

Enums
`UNSPECIFIED`	Name unspecified.
`UNKNOWN`	The received error code is not known in this version.
`QUERY_ERROR`	Returned if all other query error reasons are not applicable.
`BAD_ENUM_CONSTANT`	A condition used in the query references an invalid enum constant.
`BAD_ESCAPE_SEQUENCE`	Query contains an invalid escape sequence.
`BAD_FIELD_NAME`	Field name is invalid.
`BAD_LIMIT_VALUE`	Limit value is invalid (for example, not a number)
`BAD_NUMBER`	Encountered number can not be parsed.
`BAD_OPERATOR`	Invalid operator encountered.
`BAD_PARAMETER_NAME`	Parameter unknown or not supported.
`BAD_PARAMETER_VALUE`	Parameter have invalid value.
`BAD_RESOURCE_TYPE_IN_FROM_CLAUSE`	Invalid resource type was specified in the FROM clause.
`BAD_SYMBOL`	Non-ASCII symbol encountered outside of strings.
`BAD_VALUE`	Value is invalid.
`DATE_RANGE_TOO_WIDE`	Date filters fail to restrict date to a range smaller than 31 days. Applicable if the query is segmented by date.
`DATE_RANGE_TOO_NARROW`	Filters on date/week/month/quarter have a start date after end date.
`EXPECTED_AND`	Expected AND between values with BETWEEN operator.
`EXPECTED_BY`	Expecting ORDER BY to have BY.
`EXPECTED_DIMENSION_FIELD_IN_SELECT_CLAUSE`	There was no dimension field selected.
`EXPECTED_FILTERS_ON_DATE_RANGE`	Missing filters on date related fields.
`EXPECTED_FROM`	Missing FROM clause.
`EXPECTED_LIST`	The operator used in the conditions requires the value to be a list.
`EXPECTED_REFERENCED_FIELD_IN_SELECT_CLAUSE`	Fields used in WHERE or ORDER BY clauses are missing from the SELECT clause.
`EXPECTED_SELECT`	SELECT is missing at the beginning of query.
`EXPECTED_SINGLE_VALUE`	A list was passed as a value to a condition whose operator expects a single value.
`EXPECTED_VALUE_WITH_BETWEEN_OPERATOR`	Missing one or both values with BETWEEN operator.
`INVALID_DATE_FORMAT`	Invalid date format. Expected 'YYYY-MM-DD'.
`MISALIGNED_DATE_FOR_FILTER`	Misaligned date value for the filter. The date should be the start of a week/month/quarter if the filtered field is segments.week/segments.month/segments.quarter.
`INVALID_STRING_VALUE`	Value passed was not a string when it should have been. For example, it was a number or unquoted literal.
`INVALID_VALUE_WITH_BETWEEN_OPERATOR`	A String value passed to the BETWEEN operator does not parse as a date.
`INVALID_VALUE_WITH_DURING_OPERATOR`	The value passed to the DURING operator is not a Date range literal
`INVALID_VALUE_WITH_LIKE_OPERATOR`	A value was passed to the LIKE operator.
`OPERATOR_FIELD_MISMATCH`	An operator was provided that is inapplicable to the field being filtered.
`PROHIBITED_EMPTY_LIST_IN_CONDITION`	A Condition was found with an empty list.
`PROHIBITED_ENUM_CONSTANT`	A condition used in the query references an unsupported enum constant.
`PROHIBITED_FIELD_COMBINATION_IN_SELECT_CLAUSE`	Fields that are not allowed to be selected together were included in the SELECT clause.
`PROHIBITED_FIELD_IN_ORDER_BY_CLAUSE`	A field that is not orderable was included in the ORDER BY clause.
`PROHIBITED_FIELD_IN_SELECT_CLAUSE`	A field that is not selectable was included in the SELECT clause.
`PROHIBITED_FIELD_IN_WHERE_CLAUSE`	A field that is not filterable was included in the WHERE clause.
`PROHIBITED_RESOURCE_TYPE_IN_FROM_CLAUSE`	Resource type specified in the FROM clause is not supported by this service.
`PROHIBITED_RESOURCE_TYPE_IN_SELECT_CLAUSE`	A field that comes from an incompatible resource was included in the SELECT clause.
`PROHIBITED_RESOURCE_TYPE_IN_WHERE_CLAUSE`	A field that comes from an incompatible resource was included in the WHERE clause.
`PROHIBITED_METRIC_IN_SELECT_OR_WHERE_CLAUSE`	A metric incompatible with the main resource or other selected segmenting resources was included in the SELECT or WHERE clause.
`PROHIBITED_SEGMENT_IN_SELECT_OR_WHERE_CLAUSE`	A segment incompatible with the main resource or other selected segmenting resources was included in the SELECT or WHERE clause.
`PROHIBITED_SEGMENT_WITH_METRIC_IN_SELECT_OR_WHERE_CLAUSE`	A segment in the SELECT clause is incompatible with a metric in the SELECT or WHERE clause.
`LIMIT_VALUE_TOO_LOW`	The value passed to the limit clause is too low.
`PROHIBITED_NEWLINE_IN_STRING`	Query has a string containing a newline character.
`PROHIBITED_VALUE_COMBINATION_IN_LIST`	List contains values of different types.
`PROHIBITED_VALUE_COMBINATION_WITH_BETWEEN_OPERATOR`	The values passed to the BETWEEN operator are not of the same type.
`STRING_NOT_TERMINATED`	Query contains unterminated string.
`TOO_MANY_SEGMENTS`	Too many segments are specified in SELECT clause.
`UNEXPECTED_END_OF_QUERY`	Query is incomplete and cannot be parsed.
`UNEXPECTED_FROM_CLAUSE`	FROM clause cannot be specified in this query.
`UNRECOGNIZED_FIELD`	Query contains one or more unrecognized fields.
`UNEXPECTED_INPUT`	Query has an unexpected extra part.
`REQUESTED_METRICS_FOR_MANAGER`	Metrics cannot be requested for a manager account. To retrieve metrics, issue separate requests against each client account under the manager account.
`FILTER_HAS_TOO_MANY_VALUES`	The number of values (right-hand-side operands) in a filter exceeds the limit.

QuotaErrorDetails

Additional quota error details when there is QuotaError.

Fields

Fields
`rate_scope`	`QuotaRateScope` The rate scope of the quota limit.
`rate_name`	`string` The high level description of the quota bucket. Examples are "Get requests for standard access" or "Requests per account".
`retry_delay`	`Duration` Backoff period that customers should wait before sending next request.

rate_scope

QuotaRateScope

The rate scope of the quota limit.

rate_name

string

The high level description of the quota bucket. Examples are "Get requests for standard access" or "Requests per account".

retry_delay

Duration

Backoff period that customers should wait before sending next request.

QuotaRateScope

Enum of possible scopes that quota buckets belong to.

Enums
`UNSPECIFIED`	Unspecified enum
`UNKNOWN`	Used for return value only. Represents value unknown in this version.
`ACCOUNT`	Per customer account quota
`DEVELOPER`	Per project quota

QuotaErrorEnum

This type has no fields.

Container for enum describing possible quota errors.

QuotaError

Enum describing possible quota errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`RESOURCE_EXHAUSTED`	Too many requests.
`RESOURCE_TEMPORARILY_EXHAUSTED`	Too many requests in a short amount of time.

RequestErrorEnum

This type has no fields.

Container for enum describing possible request errors.

RequestError

Enum describing possible request errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`RESOURCE_NAME_MISSING`	Resource name is required for this request.
`RESOURCE_NAME_MALFORMED`	Resource name provided is malformed.
`BAD_RESOURCE_ID`	Resource name provided is malformed.
`INVALID_PRODUCT_NAME`	Product name is invalid.
`INVALID_CUSTOMER_ID`	Customer ID is invalid.
`OPERATION_REQUIRED`	Mutate operation should have either create, update, or remove specified.
`RESOURCE_NOT_FOUND`	Requested resource not found.
`INVALID_PAGE_TOKEN`	Next page token specified in user request is invalid.
`EXPIRED_PAGE_TOKEN`	Next page token specified in user request has expired.
`INVALID_PAGE_SIZE`	Page size specified in user request is invalid.
`REQUIRED_FIELD_MISSING`	Required field is missing.
`IMMUTABLE_FIELD`	The field cannot be modified because it's immutable. It's also possible that the field can be modified using 'create' operation but not 'update'.
`TOO_MANY_MUTATE_OPERATIONS`	Received too many entries in request.
`CANNOT_BE_EXECUTED_BY_MANAGER_ACCOUNT`	Request cannot be executed by a manager account.
`CANNOT_MODIFY_FOREIGN_FIELD`	Mutate request was attempting to modify a readonly field. For instance, Budget fields can be requested for Ad Group, but are read-only for adGroups:mutate.
`INVALID_ENUM_VALUE`	Enum value is not permitted.
`LOGIN_CUSTOMER_ID_PARAMETER_MISSING`	The login-customer-id parameter is required for this request.
`LOGIN_OR_LINKED_CUSTOMER_ID_PARAMETER_REQUIRED`	Either login-customer-id or linked-customer-id parameter is required for this request.
`VALIDATE_ONLY_REQUEST_HAS_PAGE_TOKEN`	page_token is set in the validate only request
`CANNOT_RETURN_SUMMARY_ROW_FOR_REQUEST_WITHOUT_METRICS`	return_summary_row cannot be enabled if request did not select any metrics field.
`CANNOT_RETURN_SUMMARY_ROW_FOR_VALIDATE_ONLY_REQUESTS`	return_summary_row should not be enabled for validate only requests.
`INCONSISTENT_RETURN_SUMMARY_ROW_VALUE`	return_summary_row parameter value should be the same between requests with page_token field set and their original request.
`TOTAL_RESULTS_COUNT_NOT_ORIGINALLY_REQUESTED`	The total results count cannot be returned if it was not requested in the original request.
`RPC_DEADLINE_TOO_SHORT`	Deadline specified by the client was too short.
`PRODUCT_NOT_SUPPORTED`	The product associated with the request is not supported for the current request.

SearchAds360Error

SearchAds360-specific error.

Fields
`error_code`	`ErrorCode` An enum value that indicates which error occurred.
`message`	`string` A human-readable description of the error.
`trigger`	`Value` The value that triggered the error.
`location`	`ErrorLocation` Describes the part of the request proto that caused the error.
`details`	`ErrorDetails` Additional error details, which are returned by certain error codes. Most error codes do not include details.

SearchAds360Failure

Describes how a Search Ads 360 API call failed. It's returned inside google.rpc.Status.details when a call fails.

Fields

Fields
`errors[]`	`SearchAds360Error` The list of errors that occurred.
`request_id`	`string` The unique ID of the request that is used for debugging purposes.

errors[]

SearchAds360Error

The list of errors that occurred.

request_id

string

The unique ID of the request that is used for debugging purposes.

SizeLimitErrorEnum

This type has no fields.

Container for enum describing possible size limit errors.

SizeLimitError

Enum describing possible size limit errors.

Enums
`UNSPECIFIED`	Enum unspecified.
`UNKNOWN`	The received error code is not known in this version.
`REQUEST_SIZE_LIMIT_EXCEEDED`	The number of entries in the request exceeds the system limit, or the contents of the operations exceed transaction limits due to their size or complexity. Try reducing the number of entries per request.
`RESPONSE_SIZE_LIMIT_EXCEEDED`	The number of entries in the response exceeds the system limit.