google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
392 lines (391 loc) • 13.1 kB
TypeScript
import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
import type { IBinaryWriter } from "@protobuf-ts/runtime";
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
import type { IBinaryReader } from "@protobuf-ts/runtime";
import type { PartialMessage } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
/**
* Container for enum describing possible query errors.
*
* @generated from protobuf message google.ads.googleads.v11.errors.QueryErrorEnum
*/
export interface QueryErrorEnum {
}
/**
* Enum describing possible query errors.
*
* @generated from protobuf enum google.ads.googleads.v11.errors.QueryErrorEnum.QueryError
*/
export declare enum QueryErrorEnum_QueryError {
/**
* Name unspecified.
*
* @generated from protobuf enum value: UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* The received error code is not known in this version.
*
* @generated from protobuf enum value: UNKNOWN = 1;
*/
UNKNOWN = 1,
/**
* Returned if all other query error reasons are not applicable.
*
* @generated from protobuf enum value: QUERY_ERROR = 50;
*/
QUERY_ERROR = 50,
/**
* A condition used in the query references an invalid enum constant.
*
* @generated from protobuf enum value: BAD_ENUM_CONSTANT = 18;
*/
BAD_ENUM_CONSTANT = 18,
/**
* Query contains an invalid escape sequence.
*
* @generated from protobuf enum value: BAD_ESCAPE_SEQUENCE = 7;
*/
BAD_ESCAPE_SEQUENCE = 7,
/**
* Field name is invalid.
*
* @generated from protobuf enum value: BAD_FIELD_NAME = 12;
*/
BAD_FIELD_NAME = 12,
/**
* Limit value is invalid (for example, not a number)
*
* @generated from protobuf enum value: BAD_LIMIT_VALUE = 15;
*/
BAD_LIMIT_VALUE = 15,
/**
* Encountered number can not be parsed.
*
* @generated from protobuf enum value: BAD_NUMBER = 5;
*/
BAD_NUMBER = 5,
/**
* Invalid operator encountered.
*
* @generated from protobuf enum value: BAD_OPERATOR = 3;
*/
BAD_OPERATOR = 3,
/**
* Parameter unknown or not supported.
*
* @generated from protobuf enum value: BAD_PARAMETER_NAME = 61;
*/
BAD_PARAMETER_NAME = 61,
/**
* Parameter have invalid value.
*
* @generated from protobuf enum value: BAD_PARAMETER_VALUE = 62;
*/
BAD_PARAMETER_VALUE = 62,
/**
* Invalid resource type was specified in the FROM clause.
*
* @generated from protobuf enum value: BAD_RESOURCE_TYPE_IN_FROM_CLAUSE = 45;
*/
BAD_RESOURCE_TYPE_IN_FROM_CLAUSE = 45,
/**
* Non-ASCII symbol encountered outside of strings.
*
* @generated from protobuf enum value: BAD_SYMBOL = 2;
*/
BAD_SYMBOL = 2,
/**
* Value is invalid.
*
* @generated from protobuf enum value: BAD_VALUE = 4;
*/
BAD_VALUE = 4,
/**
* Date filters fail to restrict date to a range smaller than 31 days.
* Applicable if the query is segmented by date.
*
* @generated from protobuf enum value: DATE_RANGE_TOO_WIDE = 36;
*/
DATE_RANGE_TOO_WIDE = 36,
/**
* Filters on date/week/month/quarter have a start date after
* end date.
*
* @generated from protobuf enum value: DATE_RANGE_TOO_NARROW = 60;
*/
DATE_RANGE_TOO_NARROW = 60,
/**
* Expected AND between values with BETWEEN operator.
*
* @generated from protobuf enum value: EXPECTED_AND = 30;
*/
EXPECTED_AND = 30,
/**
* Expecting ORDER BY to have BY.
*
* @generated from protobuf enum value: EXPECTED_BY = 14;
*/
EXPECTED_BY = 14,
/**
* There was no dimension field selected.
*
* @generated from protobuf enum value: EXPECTED_DIMENSION_FIELD_IN_SELECT_CLAUSE = 37;
*/
EXPECTED_DIMENSION_FIELD_IN_SELECT_CLAUSE = 37,
/**
* Missing filters on date related fields.
*
* @generated from protobuf enum value: EXPECTED_FILTERS_ON_DATE_RANGE = 55;
*/
EXPECTED_FILTERS_ON_DATE_RANGE = 55,
/**
* Missing FROM clause.
*
* @generated from protobuf enum value: EXPECTED_FROM = 44;
*/
EXPECTED_FROM = 44,
/**
* The operator used in the conditions requires the value to be a list.
*
* @generated from protobuf enum value: EXPECTED_LIST = 41;
*/
EXPECTED_LIST = 41,
/**
* Fields used in WHERE or ORDER BY clauses are missing from the SELECT
* clause.
*
* @generated from protobuf enum value: EXPECTED_REFERENCED_FIELD_IN_SELECT_CLAUSE = 16;
*/
EXPECTED_REFERENCED_FIELD_IN_SELECT_CLAUSE = 16,
/**
* SELECT is missing at the beginning of query.
*
* @generated from protobuf enum value: EXPECTED_SELECT = 13;
*/
EXPECTED_SELECT = 13,
/**
* A list was passed as a value to a condition whose operator expects a
* single value.
*
* @generated from protobuf enum value: EXPECTED_SINGLE_VALUE = 42;
*/
EXPECTED_SINGLE_VALUE = 42,
/**
* Missing one or both values with BETWEEN operator.
*
* @generated from protobuf enum value: EXPECTED_VALUE_WITH_BETWEEN_OPERATOR = 29;
*/
EXPECTED_VALUE_WITH_BETWEEN_OPERATOR = 29,
/**
* Invalid date format. Expected 'YYYY-MM-DD'.
*
* @generated from protobuf enum value: INVALID_DATE_FORMAT = 38;
*/
INVALID_DATE_FORMAT = 38,
/**
* 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.
*
* @generated from protobuf enum value: MISALIGNED_DATE_FOR_FILTER = 64;
*/
MISALIGNED_DATE_FOR_FILTER = 64,
/**
* Value passed was not a string when it should have been. For example, it
* was a number or unquoted literal.
*
* @generated from protobuf enum value: INVALID_STRING_VALUE = 57;
*/
INVALID_STRING_VALUE = 57,
/**
* A String value passed to the BETWEEN operator does not parse as a date.
*
* @generated from protobuf enum value: INVALID_VALUE_WITH_BETWEEN_OPERATOR = 26;
*/
INVALID_VALUE_WITH_BETWEEN_OPERATOR = 26,
/**
* The value passed to the DURING operator is not a Date range literal
*
* @generated from protobuf enum value: INVALID_VALUE_WITH_DURING_OPERATOR = 22;
*/
INVALID_VALUE_WITH_DURING_OPERATOR = 22,
/**
* An invalid value was passed to the LIKE operator.
*
* @generated from protobuf enum value: INVALID_VALUE_WITH_LIKE_OPERATOR = 56;
*/
INVALID_VALUE_WITH_LIKE_OPERATOR = 56,
/**
* An operator was provided that is inapplicable to the field being
* filtered.
*
* @generated from protobuf enum value: OPERATOR_FIELD_MISMATCH = 35;
*/
OPERATOR_FIELD_MISMATCH = 35,
/**
* A Condition was found with an empty list.
*
* @generated from protobuf enum value: PROHIBITED_EMPTY_LIST_IN_CONDITION = 28;
*/
PROHIBITED_EMPTY_LIST_IN_CONDITION = 28,
/**
* A condition used in the query references an unsupported enum constant.
*
* @generated from protobuf enum value: PROHIBITED_ENUM_CONSTANT = 54;
*/
PROHIBITED_ENUM_CONSTANT = 54,
/**
* Fields that are not allowed to be selected together were included in
* the SELECT clause.
*
* @generated from protobuf enum value: PROHIBITED_FIELD_COMBINATION_IN_SELECT_CLAUSE = 31;
*/
PROHIBITED_FIELD_COMBINATION_IN_SELECT_CLAUSE = 31,
/**
* A field that is not orderable was included in the ORDER BY clause.
*
* @generated from protobuf enum value: PROHIBITED_FIELD_IN_ORDER_BY_CLAUSE = 40;
*/
PROHIBITED_FIELD_IN_ORDER_BY_CLAUSE = 40,
/**
* A field that is not selectable was included in the SELECT clause.
*
* @generated from protobuf enum value: PROHIBITED_FIELD_IN_SELECT_CLAUSE = 23;
*/
PROHIBITED_FIELD_IN_SELECT_CLAUSE = 23,
/**
* A field that is not filterable was included in the WHERE clause.
*
* @generated from protobuf enum value: PROHIBITED_FIELD_IN_WHERE_CLAUSE = 24;
*/
PROHIBITED_FIELD_IN_WHERE_CLAUSE = 24,
/**
* Resource type specified in the FROM clause is not supported by this
* service.
*
* @generated from protobuf enum value: PROHIBITED_RESOURCE_TYPE_IN_FROM_CLAUSE = 43;
*/
PROHIBITED_RESOURCE_TYPE_IN_FROM_CLAUSE = 43,
/**
* A field that comes from an incompatible resource was included in the
* SELECT clause.
*
* @generated from protobuf enum value: PROHIBITED_RESOURCE_TYPE_IN_SELECT_CLAUSE = 48;
*/
PROHIBITED_RESOURCE_TYPE_IN_SELECT_CLAUSE = 48,
/**
* A field that comes from an incompatible resource was included in the
* WHERE clause.
*
* @generated from protobuf enum value: PROHIBITED_RESOURCE_TYPE_IN_WHERE_CLAUSE = 58;
*/
PROHIBITED_RESOURCE_TYPE_IN_WHERE_CLAUSE = 58,
/**
* A metric incompatible with the main resource or other selected
* segmenting resources was included in the SELECT or WHERE clause.
*
* @generated from protobuf enum value: PROHIBITED_METRIC_IN_SELECT_OR_WHERE_CLAUSE = 49;
*/
PROHIBITED_METRIC_IN_SELECT_OR_WHERE_CLAUSE = 49,
/**
* A segment incompatible with the main resource or other selected
* segmenting resources was included in the SELECT or WHERE clause.
*
* @generated from protobuf enum value: PROHIBITED_SEGMENT_IN_SELECT_OR_WHERE_CLAUSE = 51;
*/
PROHIBITED_SEGMENT_IN_SELECT_OR_WHERE_CLAUSE = 51,
/**
* A segment in the SELECT clause is incompatible with a metric in the
* SELECT or WHERE clause.
*
* @generated from protobuf enum value: PROHIBITED_SEGMENT_WITH_METRIC_IN_SELECT_OR_WHERE_CLAUSE = 53;
*/
PROHIBITED_SEGMENT_WITH_METRIC_IN_SELECT_OR_WHERE_CLAUSE = 53,
/**
* The value passed to the limit clause is too low.
*
* @generated from protobuf enum value: LIMIT_VALUE_TOO_LOW = 25;
*/
LIMIT_VALUE_TOO_LOW = 25,
/**
* Query has a string containing a newline character.
*
* @generated from protobuf enum value: PROHIBITED_NEWLINE_IN_STRING = 8;
*/
PROHIBITED_NEWLINE_IN_STRING = 8,
/**
* List contains values of different types.
*
* @generated from protobuf enum value: PROHIBITED_VALUE_COMBINATION_IN_LIST = 10;
*/
PROHIBITED_VALUE_COMBINATION_IN_LIST = 10,
/**
* The values passed to the BETWEEN operator are not of the same type.
*
* @generated from protobuf enum value: PROHIBITED_VALUE_COMBINATION_WITH_BETWEEN_OPERATOR = 21;
*/
PROHIBITED_VALUE_COMBINATION_WITH_BETWEEN_OPERATOR = 21,
/**
* Query contains unterminated string.
*
* @generated from protobuf enum value: STRING_NOT_TERMINATED = 6;
*/
STRING_NOT_TERMINATED = 6,
/**
* Too many segments are specified in SELECT clause.
*
* @generated from protobuf enum value: TOO_MANY_SEGMENTS = 34;
*/
TOO_MANY_SEGMENTS = 34,
/**
* Query is incomplete and cannot be parsed.
*
* @generated from protobuf enum value: UNEXPECTED_END_OF_QUERY = 9;
*/
UNEXPECTED_END_OF_QUERY = 9,
/**
* FROM clause cannot be specified in this query.
*
* @generated from protobuf enum value: UNEXPECTED_FROM_CLAUSE = 47;
*/
UNEXPECTED_FROM_CLAUSE = 47,
/**
* Query contains one or more unrecognized fields.
*
* @generated from protobuf enum value: UNRECOGNIZED_FIELD = 32;
*/
UNRECOGNIZED_FIELD = 32,
/**
* Query has an unexpected extra part.
*
* @generated from protobuf enum value: UNEXPECTED_INPUT = 11;
*/
UNEXPECTED_INPUT = 11,
/**
* Metrics cannot be requested for a manager account. To retrieve metrics,
* issue separate requests against each client account under the manager
* account.
*
* @generated from protobuf enum value: REQUESTED_METRICS_FOR_MANAGER = 59;
*/
REQUESTED_METRICS_FOR_MANAGER = 59,
/**
* The number of values (right-hand-side operands) in a filter exceeds the
* limit.
*
* @generated from protobuf enum value: FILTER_HAS_TOO_MANY_VALUES = 63;
*/
FILTER_HAS_TOO_MANY_VALUES = 63
}
declare class QueryErrorEnum$Type extends MessageType<QueryErrorEnum> {
constructor();
create(value?: PartialMessage<QueryErrorEnum>): QueryErrorEnum;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: QueryErrorEnum): QueryErrorEnum;
internalBinaryWrite(message: QueryErrorEnum, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.errors.QueryErrorEnum
*/
export declare const QueryErrorEnum: QueryErrorEnum$Type;
export {};