google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
377 lines (376 loc) • 12.7 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 url field errors.
*
* @generated from protobuf message google.ads.googleads.v11.errors.UrlFieldErrorEnum
*/
export interface UrlFieldErrorEnum {
}
/**
* Enum describing possible url field errors.
*
* @generated from protobuf enum google.ads.googleads.v11.errors.UrlFieldErrorEnum.UrlFieldError
*/
export declare enum UrlFieldErrorEnum_UrlFieldError {
/**
* Enum 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,
/**
* The tracking url template is invalid.
*
* @generated from protobuf enum value: INVALID_TRACKING_URL_TEMPLATE = 2;
*/
INVALID_TRACKING_URL_TEMPLATE = 2,
/**
* The tracking url template contains invalid tag.
*
* @generated from protobuf enum value: INVALID_TAG_IN_TRACKING_URL_TEMPLATE = 3;
*/
INVALID_TAG_IN_TRACKING_URL_TEMPLATE = 3,
/**
* The tracking url template must contain at least one tag (for example,
* {lpurl}), This applies only to tracking url template associated with
* website ads or product ads.
*
* @generated from protobuf enum value: MISSING_TRACKING_URL_TEMPLATE_TAG = 4;
*/
MISSING_TRACKING_URL_TEMPLATE_TAG = 4,
/**
* The tracking url template must start with a valid protocol (or lpurl
* tag).
*
* @generated from protobuf enum value: MISSING_PROTOCOL_IN_TRACKING_URL_TEMPLATE = 5;
*/
MISSING_PROTOCOL_IN_TRACKING_URL_TEMPLATE = 5,
/**
* The tracking url template starts with an invalid protocol.
*
* @generated from protobuf enum value: INVALID_PROTOCOL_IN_TRACKING_URL_TEMPLATE = 6;
*/
INVALID_PROTOCOL_IN_TRACKING_URL_TEMPLATE = 6,
/**
* The tracking url template contains illegal characters.
*
* @generated from protobuf enum value: MALFORMED_TRACKING_URL_TEMPLATE = 7;
*/
MALFORMED_TRACKING_URL_TEMPLATE = 7,
/**
* The tracking url template must contain a host name (or lpurl tag).
*
* @generated from protobuf enum value: MISSING_HOST_IN_TRACKING_URL_TEMPLATE = 8;
*/
MISSING_HOST_IN_TRACKING_URL_TEMPLATE = 8,
/**
* The tracking url template has an invalid or missing top level domain
* extension.
*
* @generated from protobuf enum value: INVALID_TLD_IN_TRACKING_URL_TEMPLATE = 9;
*/
INVALID_TLD_IN_TRACKING_URL_TEMPLATE = 9,
/**
* The tracking url template contains nested occurrences of the same
* conditional tag (for example, {ifmobile:{ifmobile:x}}).
*
* @generated from protobuf enum value: REDUNDANT_NESTED_TRACKING_URL_TEMPLATE_TAG = 10;
*/
REDUNDANT_NESTED_TRACKING_URL_TEMPLATE_TAG = 10,
/**
* The final url is invalid.
*
* @generated from protobuf enum value: INVALID_FINAL_URL = 11;
*/
INVALID_FINAL_URL = 11,
/**
* The final url contains invalid tag.
*
* @generated from protobuf enum value: INVALID_TAG_IN_FINAL_URL = 12;
*/
INVALID_TAG_IN_FINAL_URL = 12,
/**
* The final url contains nested occurrences of the same conditional tag
* (for example, {ifmobile:{ifmobile:x}}).
*
* @generated from protobuf enum value: REDUNDANT_NESTED_FINAL_URL_TAG = 13;
*/
REDUNDANT_NESTED_FINAL_URL_TAG = 13,
/**
* The final url must start with a valid protocol.
*
* @generated from protobuf enum value: MISSING_PROTOCOL_IN_FINAL_URL = 14;
*/
MISSING_PROTOCOL_IN_FINAL_URL = 14,
/**
* The final url starts with an invalid protocol.
*
* @generated from protobuf enum value: INVALID_PROTOCOL_IN_FINAL_URL = 15;
*/
INVALID_PROTOCOL_IN_FINAL_URL = 15,
/**
* The final url contains illegal characters.
*
* @generated from protobuf enum value: MALFORMED_FINAL_URL = 16;
*/
MALFORMED_FINAL_URL = 16,
/**
* The final url must contain a host name.
*
* @generated from protobuf enum value: MISSING_HOST_IN_FINAL_URL = 17;
*/
MISSING_HOST_IN_FINAL_URL = 17,
/**
* The tracking url template has an invalid or missing top level domain
* extension.
*
* @generated from protobuf enum value: INVALID_TLD_IN_FINAL_URL = 18;
*/
INVALID_TLD_IN_FINAL_URL = 18,
/**
* The final mobile url is invalid.
*
* @generated from protobuf enum value: INVALID_FINAL_MOBILE_URL = 19;
*/
INVALID_FINAL_MOBILE_URL = 19,
/**
* The final mobile url contains invalid tag.
*
* @generated from protobuf enum value: INVALID_TAG_IN_FINAL_MOBILE_URL = 20;
*/
INVALID_TAG_IN_FINAL_MOBILE_URL = 20,
/**
* The final mobile url contains nested occurrences of the same conditional
* tag (for example, {ifmobile:{ifmobile:x}}).
*
* @generated from protobuf enum value: REDUNDANT_NESTED_FINAL_MOBILE_URL_TAG = 21;
*/
REDUNDANT_NESTED_FINAL_MOBILE_URL_TAG = 21,
/**
* The final mobile url must start with a valid protocol.
*
* @generated from protobuf enum value: MISSING_PROTOCOL_IN_FINAL_MOBILE_URL = 22;
*/
MISSING_PROTOCOL_IN_FINAL_MOBILE_URL = 22,
/**
* The final mobile url starts with an invalid protocol.
*
* @generated from protobuf enum value: INVALID_PROTOCOL_IN_FINAL_MOBILE_URL = 23;
*/
INVALID_PROTOCOL_IN_FINAL_MOBILE_URL = 23,
/**
* The final mobile url contains illegal characters.
*
* @generated from protobuf enum value: MALFORMED_FINAL_MOBILE_URL = 24;
*/
MALFORMED_FINAL_MOBILE_URL = 24,
/**
* The final mobile url must contain a host name.
*
* @generated from protobuf enum value: MISSING_HOST_IN_FINAL_MOBILE_URL = 25;
*/
MISSING_HOST_IN_FINAL_MOBILE_URL = 25,
/**
* The tracking url template has an invalid or missing top level domain
* extension.
*
* @generated from protobuf enum value: INVALID_TLD_IN_FINAL_MOBILE_URL = 26;
*/
INVALID_TLD_IN_FINAL_MOBILE_URL = 26,
/**
* The final app url is invalid.
*
* @generated from protobuf enum value: INVALID_FINAL_APP_URL = 27;
*/
INVALID_FINAL_APP_URL = 27,
/**
* The final app url contains invalid tag.
*
* @generated from protobuf enum value: INVALID_TAG_IN_FINAL_APP_URL = 28;
*/
INVALID_TAG_IN_FINAL_APP_URL = 28,
/**
* The final app url contains nested occurrences of the same conditional tag
* (for example, {ifmobile:{ifmobile:x}}).
*
* @generated from protobuf enum value: REDUNDANT_NESTED_FINAL_APP_URL_TAG = 29;
*/
REDUNDANT_NESTED_FINAL_APP_URL_TAG = 29,
/**
* More than one app url found for the same OS type.
*
* @generated from protobuf enum value: MULTIPLE_APP_URLS_FOR_OSTYPE = 30;
*/
MULTIPLE_APP_URLS_FOR_OSTYPE = 30,
/**
* The OS type given for an app url is not valid.
*
* @generated from protobuf enum value: INVALID_OSTYPE = 31;
*/
INVALID_OSTYPE = 31,
/**
* The protocol given for an app url is not valid. (For example,
* "android-app://")
*
* @generated from protobuf enum value: INVALID_PROTOCOL_FOR_APP_URL = 32;
*/
INVALID_PROTOCOL_FOR_APP_URL = 32,
/**
* The package id (app id) given for an app url is not valid.
*
* @generated from protobuf enum value: INVALID_PACKAGE_ID_FOR_APP_URL = 33;
*/
INVALID_PACKAGE_ID_FOR_APP_URL = 33,
/**
* The number of url custom parameters for an resource exceeds the maximum
* limit allowed.
*
* @generated from protobuf enum value: URL_CUSTOM_PARAMETERS_COUNT_EXCEEDS_LIMIT = 34;
*/
URL_CUSTOM_PARAMETERS_COUNT_EXCEEDS_LIMIT = 34,
/**
* An invalid character appears in the parameter key.
*
* @generated from protobuf enum value: INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_KEY = 39;
*/
INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_KEY = 39,
/**
* An invalid character appears in the parameter value.
*
* @generated from protobuf enum value: INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_VALUE = 40;
*/
INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_VALUE = 40,
/**
* The url custom parameter value fails url tag validation.
*
* @generated from protobuf enum value: INVALID_TAG_IN_URL_CUSTOM_PARAMETER_VALUE = 41;
*/
INVALID_TAG_IN_URL_CUSTOM_PARAMETER_VALUE = 41,
/**
* The custom parameter contains nested occurrences of the same conditional
* tag (for example, {ifmobile:{ifmobile:x}}).
*
* @generated from protobuf enum value: REDUNDANT_NESTED_URL_CUSTOM_PARAMETER_TAG = 42;
*/
REDUNDANT_NESTED_URL_CUSTOM_PARAMETER_TAG = 42,
/**
* The protocol (http:// or https://) is missing.
*
* @generated from protobuf enum value: MISSING_PROTOCOL = 43;
*/
MISSING_PROTOCOL = 43,
/**
* Unsupported protocol in URL. Only http and https are supported.
*
* @generated from protobuf enum value: INVALID_PROTOCOL = 52;
*/
INVALID_PROTOCOL = 52,
/**
* The url is invalid.
*
* @generated from protobuf enum value: INVALID_URL = 44;
*/
INVALID_URL = 44,
/**
* Destination Url is deprecated.
*
* @generated from protobuf enum value: DESTINATION_URL_DEPRECATED = 45;
*/
DESTINATION_URL_DEPRECATED = 45,
/**
* The url contains invalid tag.
*
* @generated from protobuf enum value: INVALID_TAG_IN_URL = 46;
*/
INVALID_TAG_IN_URL = 46,
/**
* The url must contain at least one tag (for example, {lpurl}).
*
* @generated from protobuf enum value: MISSING_URL_TAG = 47;
*/
MISSING_URL_TAG = 47,
/**
* Duplicate url id.
*
* @generated from protobuf enum value: DUPLICATE_URL_ID = 48;
*/
DUPLICATE_URL_ID = 48,
/**
* Invalid url id.
*
* @generated from protobuf enum value: INVALID_URL_ID = 49;
*/
INVALID_URL_ID = 49,
/**
* The final url suffix cannot begin with '?' or '&' characters and must be
* a valid query string.
*
* @generated from protobuf enum value: FINAL_URL_SUFFIX_MALFORMED = 50;
*/
FINAL_URL_SUFFIX_MALFORMED = 50,
/**
* The final url suffix cannot contain {lpurl} related or {ignore} tags.
*
* @generated from protobuf enum value: INVALID_TAG_IN_FINAL_URL_SUFFIX = 51;
*/
INVALID_TAG_IN_FINAL_URL_SUFFIX = 51,
/**
* The top level domain is invalid, for example, not a public top level
* domain listed in publicsuffix.org.
*
* @generated from protobuf enum value: INVALID_TOP_LEVEL_DOMAIN = 53;
*/
INVALID_TOP_LEVEL_DOMAIN = 53,
/**
* Malformed top level domain in URL.
*
* @generated from protobuf enum value: MALFORMED_TOP_LEVEL_DOMAIN = 54;
*/
MALFORMED_TOP_LEVEL_DOMAIN = 54,
/**
* Malformed URL.
*
* @generated from protobuf enum value: MALFORMED_URL = 55;
*/
MALFORMED_URL = 55,
/**
* No host found in URL.
*
* @generated from protobuf enum value: MISSING_HOST = 56;
*/
MISSING_HOST = 56,
/**
* Custom parameter value cannot be null.
*
* @generated from protobuf enum value: NULL_CUSTOM_PARAMETER_VALUE = 57;
*/
NULL_CUSTOM_PARAMETER_VALUE = 57,
/**
* Track parameter is not supported.
*
* @generated from protobuf enum value: VALUE_TRACK_PARAMETER_NOT_SUPPORTED = 58;
*/
VALUE_TRACK_PARAMETER_NOT_SUPPORTED = 58
}
declare class UrlFieldErrorEnum$Type extends MessageType<UrlFieldErrorEnum> {
constructor();
create(value?: PartialMessage<UrlFieldErrorEnum>): UrlFieldErrorEnum;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: UrlFieldErrorEnum): UrlFieldErrorEnum;
internalBinaryWrite(message: UrlFieldErrorEnum, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.errors.UrlFieldErrorEnum
*/
export declare const UrlFieldErrorEnum: UrlFieldErrorEnum$Type;
export {};