UNPKG

google-ads-api-client

Version:

A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.

692 lines (691 loc) 22.7 kB
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 validation errors of a feed item. * * @generated from protobuf message google.ads.googleads.v11.errors.FeedItemValidationErrorEnum */ export interface FeedItemValidationErrorEnum { } /** * The possible validation errors of a feed item. * * @generated from protobuf enum google.ads.googleads.v11.errors.FeedItemValidationErrorEnum.FeedItemValidationError */ export declare enum FeedItemValidationErrorEnum_FeedItemValidationError { /** * No value has been specified. * * @generated from protobuf enum value: UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** * Used for return value only. Represents value unknown in this version. * * @generated from protobuf enum value: UNKNOWN = 1; */ UNKNOWN = 1, /** * String is too short. * * @generated from protobuf enum value: STRING_TOO_SHORT = 2; */ STRING_TOO_SHORT = 2, /** * String is too long. * * @generated from protobuf enum value: STRING_TOO_LONG = 3; */ STRING_TOO_LONG = 3, /** * Value is not provided. * * @generated from protobuf enum value: VALUE_NOT_SPECIFIED = 4; */ VALUE_NOT_SPECIFIED = 4, /** * Phone number format is invalid for region. * * @generated from protobuf enum value: INVALID_DOMESTIC_PHONE_NUMBER_FORMAT = 5; */ INVALID_DOMESTIC_PHONE_NUMBER_FORMAT = 5, /** * String does not represent a phone number. * * @generated from protobuf enum value: INVALID_PHONE_NUMBER = 6; */ INVALID_PHONE_NUMBER = 6, /** * Phone number format is not compatible with country code. * * @generated from protobuf enum value: PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRY = 7; */ PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRY = 7, /** * Premium rate number is not allowed. * * @generated from protobuf enum value: PREMIUM_RATE_NUMBER_NOT_ALLOWED = 8; */ PREMIUM_RATE_NUMBER_NOT_ALLOWED = 8, /** * Phone number type is not allowed. * * @generated from protobuf enum value: DISALLOWED_NUMBER_TYPE = 9; */ DISALLOWED_NUMBER_TYPE = 9, /** * Specified value is outside of the valid range. * * @generated from protobuf enum value: VALUE_OUT_OF_RANGE = 10; */ VALUE_OUT_OF_RANGE = 10, /** * Call tracking is not supported in the selected country. * * @generated from protobuf enum value: CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY = 11; */ CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY = 11, /** * Customer is not on the allow-list for call tracking. * * @generated from protobuf enum value: CUSTOMER_NOT_IN_ALLOWLIST_FOR_CALLTRACKING = 99; */ CUSTOMER_NOT_IN_ALLOWLIST_FOR_CALLTRACKING = 99, /** * Country code is invalid. * * @generated from protobuf enum value: INVALID_COUNTRY_CODE = 13; */ INVALID_COUNTRY_CODE = 13, /** * The specified mobile app id is invalid. * * @generated from protobuf enum value: INVALID_APP_ID = 14; */ INVALID_APP_ID = 14, /** * Some required field attributes are missing. * * @generated from protobuf enum value: MISSING_ATTRIBUTES_FOR_FIELDS = 15; */ MISSING_ATTRIBUTES_FOR_FIELDS = 15, /** * Invalid email button type for email extension. * * @generated from protobuf enum value: INVALID_TYPE_ID = 16; */ INVALID_TYPE_ID = 16, /** * Email address is invalid. * * @generated from protobuf enum value: INVALID_EMAIL_ADDRESS = 17; */ INVALID_EMAIL_ADDRESS = 17, /** * The HTTPS URL in email extension is invalid. * * @generated from protobuf enum value: INVALID_HTTPS_URL = 18; */ INVALID_HTTPS_URL = 18, /** * Delivery address is missing from email extension. * * @generated from protobuf enum value: MISSING_DELIVERY_ADDRESS = 19; */ MISSING_DELIVERY_ADDRESS = 19, /** * FeedItem scheduling start date comes after end date. * * @generated from protobuf enum value: START_DATE_AFTER_END_DATE = 20; */ START_DATE_AFTER_END_DATE = 20, /** * FeedItem scheduling start time is missing. * * @generated from protobuf enum value: MISSING_FEED_ITEM_START_TIME = 21; */ MISSING_FEED_ITEM_START_TIME = 21, /** * FeedItem scheduling end time is missing. * * @generated from protobuf enum value: MISSING_FEED_ITEM_END_TIME = 22; */ MISSING_FEED_ITEM_END_TIME = 22, /** * Cannot compute system attributes on a FeedItem that has no FeedItemId. * * @generated from protobuf enum value: MISSING_FEED_ITEM_ID = 23; */ MISSING_FEED_ITEM_ID = 23, /** * Call extension vanity phone numbers are not supported. * * @generated from protobuf enum value: VANITY_PHONE_NUMBER_NOT_ALLOWED = 24; */ VANITY_PHONE_NUMBER_NOT_ALLOWED = 24, /** * Invalid review text. * * @generated from protobuf enum value: INVALID_REVIEW_EXTENSION_SNIPPET = 25; */ INVALID_REVIEW_EXTENSION_SNIPPET = 25, /** * Invalid format for numeric value in ad parameter. * * @generated from protobuf enum value: INVALID_NUMBER_FORMAT = 26; */ INVALID_NUMBER_FORMAT = 26, /** * Invalid format for date value in ad parameter. * * @generated from protobuf enum value: INVALID_DATE_FORMAT = 27; */ INVALID_DATE_FORMAT = 27, /** * Invalid format for price value in ad parameter. * * @generated from protobuf enum value: INVALID_PRICE_FORMAT = 28; */ INVALID_PRICE_FORMAT = 28, /** * Unrecognized type given for value in ad parameter. * * @generated from protobuf enum value: UNKNOWN_PLACEHOLDER_FIELD = 29; */ UNKNOWN_PLACEHOLDER_FIELD = 29, /** * Enhanced sitelinks must have both description lines specified. * * @generated from protobuf enum value: MISSING_ENHANCED_SITELINK_DESCRIPTION_LINE = 30; */ MISSING_ENHANCED_SITELINK_DESCRIPTION_LINE = 30, /** * Review source is ineligible. * * @generated from protobuf enum value: REVIEW_EXTENSION_SOURCE_INELIGIBLE = 31; */ REVIEW_EXTENSION_SOURCE_INELIGIBLE = 31, /** * Review text cannot contain hyphens or dashes. * * @generated from protobuf enum value: HYPHENS_IN_REVIEW_EXTENSION_SNIPPET = 32; */ HYPHENS_IN_REVIEW_EXTENSION_SNIPPET = 32, /** * Review text cannot contain double quote characters. * * @generated from protobuf enum value: DOUBLE_QUOTES_IN_REVIEW_EXTENSION_SNIPPET = 33; */ DOUBLE_QUOTES_IN_REVIEW_EXTENSION_SNIPPET = 33, /** * Review text cannot contain quote characters. * * @generated from protobuf enum value: QUOTES_IN_REVIEW_EXTENSION_SNIPPET = 34; */ QUOTES_IN_REVIEW_EXTENSION_SNIPPET = 34, /** * Parameters are encoded in the wrong format. * * @generated from protobuf enum value: INVALID_FORM_ENCODED_PARAMS = 35; */ INVALID_FORM_ENCODED_PARAMS = 35, /** * URL parameter name must contain only letters, numbers, underscores, and * dashes. * * @generated from protobuf enum value: INVALID_URL_PARAMETER_NAME = 36; */ INVALID_URL_PARAMETER_NAME = 36, /** * Cannot find address location. * * @generated from protobuf enum value: NO_GEOCODING_RESULT = 37; */ NO_GEOCODING_RESULT = 37, /** * Review extension text has source name. * * @generated from protobuf enum value: SOURCE_NAME_IN_REVIEW_EXTENSION_TEXT = 38; */ SOURCE_NAME_IN_REVIEW_EXTENSION_TEXT = 38, /** * Some phone numbers can be shorter than usual. Some of these short numbers * are carrier-specific, and we disallow those in ad extensions because they * will not be available to all users. * * @generated from protobuf enum value: CARRIER_SPECIFIC_SHORT_NUMBER_NOT_ALLOWED = 39; */ CARRIER_SPECIFIC_SHORT_NUMBER_NOT_ALLOWED = 39, /** * Triggered when a request references a placeholder field id that does not * exist. * * @generated from protobuf enum value: INVALID_PLACEHOLDER_FIELD_ID = 40; */ INVALID_PLACEHOLDER_FIELD_ID = 40, /** * URL contains invalid ValueTrack tags or format. * * @generated from protobuf enum value: INVALID_URL_TAG = 41; */ INVALID_URL_TAG = 41, /** * Provided list exceeds acceptable size. * * @generated from protobuf enum value: LIST_TOO_LONG = 42; */ LIST_TOO_LONG = 42, /** * Certain combinations of attributes aren't allowed to be specified in the * same feed item. * * @generated from protobuf enum value: INVALID_ATTRIBUTES_COMBINATION = 43; */ INVALID_ATTRIBUTES_COMBINATION = 43, /** * An attribute has the same value repeatedly. * * @generated from protobuf enum value: DUPLICATE_VALUES = 44; */ DUPLICATE_VALUES = 44, /** * Advertisers can link a conversion action with a phone number to indicate * that sufficiently long calls forwarded to that phone number should be * counted as conversions of the specified type. This is an error message * indicating that the conversion action specified is invalid (for example, * the conversion action does not exist within the appropriate Google Ads * account, or it is a type of conversion not appropriate to phone call * conversions). * * @generated from protobuf enum value: INVALID_CALL_CONVERSION_ACTION_ID = 45; */ INVALID_CALL_CONVERSION_ACTION_ID = 45, /** * Tracking template requires final url to be set. * * @generated from protobuf enum value: CANNOT_SET_WITHOUT_FINAL_URLS = 46; */ CANNOT_SET_WITHOUT_FINAL_URLS = 46, /** * An app id was provided that doesn't exist in the given app store. * * @generated from protobuf enum value: APP_ID_DOESNT_EXIST_IN_APP_STORE = 47; */ APP_ID_DOESNT_EXIST_IN_APP_STORE = 47, /** * Invalid U2 final url. * * @generated from protobuf enum value: INVALID_FINAL_URL = 48; */ INVALID_FINAL_URL = 48, /** * Invalid U2 tracking url. * * @generated from protobuf enum value: INVALID_TRACKING_URL = 49; */ INVALID_TRACKING_URL = 49, /** * Final URL should start from App download URL. * * @generated from protobuf enum value: INVALID_FINAL_URL_FOR_APP_DOWNLOAD_URL = 50; */ INVALID_FINAL_URL_FOR_APP_DOWNLOAD_URL = 50, /** * List provided is too short. * * @generated from protobuf enum value: LIST_TOO_SHORT = 51; */ LIST_TOO_SHORT = 51, /** * User Action field has invalid value. * * @generated from protobuf enum value: INVALID_USER_ACTION = 52; */ INVALID_USER_ACTION = 52, /** * Type field has invalid value. * * @generated from protobuf enum value: INVALID_TYPE_NAME = 53; */ INVALID_TYPE_NAME = 53, /** * Change status for event is invalid. * * @generated from protobuf enum value: INVALID_EVENT_CHANGE_STATUS = 54; */ INVALID_EVENT_CHANGE_STATUS = 54, /** * The header of a structured snippets extension is not one of the valid * headers. * * @generated from protobuf enum value: INVALID_SNIPPETS_HEADER = 55; */ INVALID_SNIPPETS_HEADER = 55, /** * Android app link is not formatted correctly * * @generated from protobuf enum value: INVALID_ANDROID_APP_LINK = 56; */ INVALID_ANDROID_APP_LINK = 56, /** * Phone number incompatible with call tracking for country. * * @generated from protobuf enum value: NUMBER_TYPE_WITH_CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY = 57; */ NUMBER_TYPE_WITH_CALLTRACKING_NOT_SUPPORTED_FOR_COUNTRY = 57, /** * The input is identical to a reserved keyword * * @generated from protobuf enum value: RESERVED_KEYWORD_OTHER = 58; */ RESERVED_KEYWORD_OTHER = 58, /** * Each option label in the message extension must be unique. * * @generated from protobuf enum value: DUPLICATE_OPTION_LABELS = 59; */ DUPLICATE_OPTION_LABELS = 59, /** * Each option prefill in the message extension must be unique. * * @generated from protobuf enum value: DUPLICATE_OPTION_PREFILLS = 60; */ DUPLICATE_OPTION_PREFILLS = 60, /** * In message extensions, the number of optional labels and optional * prefills must be the same. * * @generated from protobuf enum value: UNEQUAL_LIST_LENGTHS = 61; */ UNEQUAL_LIST_LENGTHS = 61, /** * All currency codes in an ad extension must be the same. * * @generated from protobuf enum value: INCONSISTENT_CURRENCY_CODES = 62; */ INCONSISTENT_CURRENCY_CODES = 62, /** * Headers in price extension are not unique. * * @generated from protobuf enum value: PRICE_EXTENSION_HAS_DUPLICATED_HEADERS = 63; */ PRICE_EXTENSION_HAS_DUPLICATED_HEADERS = 63, /** * Header and description in an item are the same. * * @generated from protobuf enum value: ITEM_HAS_DUPLICATED_HEADER_AND_DESCRIPTION = 64; */ ITEM_HAS_DUPLICATED_HEADER_AND_DESCRIPTION = 64, /** * Price extension has too few items. * * @generated from protobuf enum value: PRICE_EXTENSION_HAS_TOO_FEW_ITEMS = 65; */ PRICE_EXTENSION_HAS_TOO_FEW_ITEMS = 65, /** * The given value is not supported. * * @generated from protobuf enum value: UNSUPPORTED_VALUE = 66; */ UNSUPPORTED_VALUE = 66, /** * Invalid final mobile url. * * @generated from protobuf enum value: INVALID_FINAL_MOBILE_URL = 67; */ INVALID_FINAL_MOBILE_URL = 67, /** * The given string value of Label contains invalid characters * * @generated from protobuf enum value: INVALID_KEYWORDLESS_AD_RULE_LABEL = 68; */ INVALID_KEYWORDLESS_AD_RULE_LABEL = 68, /** * The given URL contains value track parameters. * * @generated from protobuf enum value: VALUE_TRACK_PARAMETER_NOT_SUPPORTED = 69; */ VALUE_TRACK_PARAMETER_NOT_SUPPORTED = 69, /** * The given value is not supported in the selected language of an * extension. * * @generated from protobuf enum value: UNSUPPORTED_VALUE_IN_SELECTED_LANGUAGE = 70; */ UNSUPPORTED_VALUE_IN_SELECTED_LANGUAGE = 70, /** * The iOS app link is not formatted correctly. * * @generated from protobuf enum value: INVALID_IOS_APP_LINK = 71; */ INVALID_IOS_APP_LINK = 71, /** * iOS app link or iOS app store id is missing. * * @generated from protobuf enum value: MISSING_IOS_APP_LINK_OR_IOS_APP_STORE_ID = 72; */ MISSING_IOS_APP_LINK_OR_IOS_APP_STORE_ID = 72, /** * Promotion time is invalid. * * @generated from protobuf enum value: PROMOTION_INVALID_TIME = 73; */ PROMOTION_INVALID_TIME = 73, /** * Both the percent off and money amount off fields are set. * * @generated from protobuf enum value: PROMOTION_CANNOT_SET_PERCENT_OFF_AND_MONEY_AMOUNT_OFF = 74; */ PROMOTION_CANNOT_SET_PERCENT_OFF_AND_MONEY_AMOUNT_OFF = 74, /** * Both the promotion code and orders over amount fields are set. * * @generated from protobuf enum value: PROMOTION_CANNOT_SET_PROMOTION_CODE_AND_ORDERS_OVER_AMOUNT = 75; */ PROMOTION_CANNOT_SET_PROMOTION_CODE_AND_ORDERS_OVER_AMOUNT = 75, /** * Too many decimal places are specified. * * @generated from protobuf enum value: TOO_MANY_DECIMAL_PLACES_SPECIFIED = 76; */ TOO_MANY_DECIMAL_PLACES_SPECIFIED = 76, /** * Ad Customizers are present and not allowed. * * @generated from protobuf enum value: AD_CUSTOMIZERS_NOT_ALLOWED = 77; */ AD_CUSTOMIZERS_NOT_ALLOWED = 77, /** * Language code is not valid. * * @generated from protobuf enum value: INVALID_LANGUAGE_CODE = 78; */ INVALID_LANGUAGE_CODE = 78, /** * Language is not supported. * * @generated from protobuf enum value: UNSUPPORTED_LANGUAGE = 79; */ UNSUPPORTED_LANGUAGE = 79, /** * IF Function is present and not allowed. * * @generated from protobuf enum value: IF_FUNCTION_NOT_ALLOWED = 80; */ IF_FUNCTION_NOT_ALLOWED = 80, /** * Final url suffix is not valid. * * @generated from protobuf enum value: INVALID_FINAL_URL_SUFFIX = 81; */ INVALID_FINAL_URL_SUFFIX = 81, /** * Final url suffix contains an invalid tag. * * @generated from protobuf enum value: INVALID_TAG_IN_FINAL_URL_SUFFIX = 82; */ INVALID_TAG_IN_FINAL_URL_SUFFIX = 82, /** * Final url suffix is formatted incorrectly. * * @generated from protobuf enum value: INVALID_FINAL_URL_SUFFIX_FORMAT = 83; */ INVALID_FINAL_URL_SUFFIX_FORMAT = 83, /** * Consent for call recording, which is required for the use of call * extensions, was not provided by the advertiser. See * https://support.google.com/google-ads/answer/7412639. * * @generated from protobuf enum value: CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED = 84; */ CUSTOMER_CONSENT_FOR_CALL_RECORDING_REQUIRED = 84, /** * Multiple message delivery options are set. * * @generated from protobuf enum value: ONLY_ONE_DELIVERY_OPTION_IS_ALLOWED = 85; */ ONLY_ONE_DELIVERY_OPTION_IS_ALLOWED = 85, /** * No message delivery option is set. * * @generated from protobuf enum value: NO_DELIVERY_OPTION_IS_SET = 86; */ NO_DELIVERY_OPTION_IS_SET = 86, /** * String value of conversion reporting state field is not valid. * * @generated from protobuf enum value: INVALID_CONVERSION_REPORTING_STATE = 87; */ INVALID_CONVERSION_REPORTING_STATE = 87, /** * Image size is not right. * * @generated from protobuf enum value: IMAGE_SIZE_WRONG = 88; */ IMAGE_SIZE_WRONG = 88, /** * Email delivery is not supported in the country specified in the country * code field. * * @generated from protobuf enum value: EMAIL_DELIVERY_NOT_AVAILABLE_IN_COUNTRY = 89; */ EMAIL_DELIVERY_NOT_AVAILABLE_IN_COUNTRY = 89, /** * Auto reply is not supported in the country specified in the country code * field. * * @generated from protobuf enum value: AUTO_REPLY_NOT_AVAILABLE_IN_COUNTRY = 90; */ AUTO_REPLY_NOT_AVAILABLE_IN_COUNTRY = 90, /** * Invalid value specified for latitude. * * @generated from protobuf enum value: INVALID_LATITUDE_VALUE = 91; */ INVALID_LATITUDE_VALUE = 91, /** * Invalid value specified for longitude. * * @generated from protobuf enum value: INVALID_LONGITUDE_VALUE = 92; */ INVALID_LONGITUDE_VALUE = 92, /** * Too many label fields provided. * * @generated from protobuf enum value: TOO_MANY_LABELS = 93; */ TOO_MANY_LABELS = 93, /** * Invalid image url. * * @generated from protobuf enum value: INVALID_IMAGE_URL = 94; */ INVALID_IMAGE_URL = 94, /** * Latitude value is missing. * * @generated from protobuf enum value: MISSING_LATITUDE_VALUE = 95; */ MISSING_LATITUDE_VALUE = 95, /** * Longitude value is missing. * * @generated from protobuf enum value: MISSING_LONGITUDE_VALUE = 96; */ MISSING_LONGITUDE_VALUE = 96, /** * Unable to find address. * * @generated from protobuf enum value: ADDRESS_NOT_FOUND = 97; */ ADDRESS_NOT_FOUND = 97, /** * Cannot target provided address. * * @generated from protobuf enum value: ADDRESS_NOT_TARGETABLE = 98; */ ADDRESS_NOT_TARGETABLE = 98, /** * The specified asset ID does not exist. * * @generated from protobuf enum value: INVALID_ASSET_ID = 100; */ INVALID_ASSET_ID = 100, /** * The asset type cannot be set for the field. * * @generated from protobuf enum value: INCOMPATIBLE_ASSET_TYPE = 101; */ INCOMPATIBLE_ASSET_TYPE = 101, /** * The image has unexpected size. * * @generated from protobuf enum value: IMAGE_ERROR_UNEXPECTED_SIZE = 102; */ IMAGE_ERROR_UNEXPECTED_SIZE = 102, /** * The image aspect ratio is not allowed. * * @generated from protobuf enum value: IMAGE_ERROR_ASPECT_RATIO_NOT_ALLOWED = 103; */ IMAGE_ERROR_ASPECT_RATIO_NOT_ALLOWED = 103, /** * The image file is too large. * * @generated from protobuf enum value: IMAGE_ERROR_FILE_TOO_LARGE = 104; */ IMAGE_ERROR_FILE_TOO_LARGE = 104, /** * The image format is unsupported. * * @generated from protobuf enum value: IMAGE_ERROR_FORMAT_NOT_ALLOWED = 105; */ IMAGE_ERROR_FORMAT_NOT_ALLOWED = 105, /** * Image violates constraints without more details. * * @generated from protobuf enum value: IMAGE_ERROR_CONSTRAINTS_VIOLATED = 106; */ IMAGE_ERROR_CONSTRAINTS_VIOLATED = 106, /** * An error occurred when validating image. * * @generated from protobuf enum value: IMAGE_ERROR_SERVER_ERROR = 107; */ IMAGE_ERROR_SERVER_ERROR = 107 } declare class FeedItemValidationErrorEnum$Type extends MessageType<FeedItemValidationErrorEnum> { constructor(); create(value?: PartialMessage<FeedItemValidationErrorEnum>): FeedItemValidationErrorEnum; internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: FeedItemValidationErrorEnum): FeedItemValidationErrorEnum; internalBinaryWrite(message: FeedItemValidationErrorEnum, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter; } /** * @generated MessageType for protobuf message google.ads.googleads.v11.errors.FeedItemValidationErrorEnum */ export declare const FeedItemValidationErrorEnum: FeedItemValidationErrorEnum$Type; export {};