google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
360 lines (359 loc) • 13.4 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 campaign errors.
*
* @generated from protobuf message google.ads.googleads.v11.errors.CampaignErrorEnum
*/
export interface CampaignErrorEnum {
}
/**
* Enum describing possible campaign errors.
*
* @generated from protobuf enum google.ads.googleads.v11.errors.CampaignErrorEnum.CampaignError
*/
export declare enum CampaignErrorEnum_CampaignError {
/**
* 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,
/**
* Cannot target content network.
*
* @generated from protobuf enum value: CANNOT_TARGET_CONTENT_NETWORK = 3;
*/
CANNOT_TARGET_CONTENT_NETWORK = 3,
/**
* Cannot target search network.
*
* @generated from protobuf enum value: CANNOT_TARGET_SEARCH_NETWORK = 4;
*/
CANNOT_TARGET_SEARCH_NETWORK = 4,
/**
* Cannot cover search network without google search network.
*
* @generated from protobuf enum value: CANNOT_TARGET_SEARCH_NETWORK_WITHOUT_GOOGLE_SEARCH = 5;
*/
CANNOT_TARGET_SEARCH_NETWORK_WITHOUT_GOOGLE_SEARCH = 5,
/**
* Cannot target Google Search network for a CPM campaign.
*
* @generated from protobuf enum value: CANNOT_TARGET_GOOGLE_SEARCH_FOR_CPM_CAMPAIGN = 6;
*/
CANNOT_TARGET_GOOGLE_SEARCH_FOR_CPM_CAMPAIGN = 6,
/**
* Must target at least one network.
*
* @generated from protobuf enum value: CAMPAIGN_MUST_TARGET_AT_LEAST_ONE_NETWORK = 7;
*/
CAMPAIGN_MUST_TARGET_AT_LEAST_ONE_NETWORK = 7,
/**
* Only some Google partners are allowed to target partner search network.
*
* @generated from protobuf enum value: CANNOT_TARGET_PARTNER_SEARCH_NETWORK = 8;
*/
CANNOT_TARGET_PARTNER_SEARCH_NETWORK = 8,
/**
* Cannot target content network only as campaign has criteria-level bidding
* strategy.
*
* @generated from protobuf enum value: CANNOT_TARGET_CONTENT_NETWORK_ONLY_WITH_CRITERIA_LEVEL_BIDDING_STRATEGY = 9;
*/
CANNOT_TARGET_CONTENT_NETWORK_ONLY_WITH_CRITERIA_LEVEL_BIDDING_STRATEGY = 9,
/**
* Cannot modify the start or end date such that the campaign duration would
* not contain the durations of all runnable trials.
*
* @generated from protobuf enum value: CAMPAIGN_DURATION_MUST_CONTAIN_ALL_RUNNABLE_TRIALS = 10;
*/
CAMPAIGN_DURATION_MUST_CONTAIN_ALL_RUNNABLE_TRIALS = 10,
/**
* Cannot modify dates, budget or status of a trial campaign.
*
* @generated from protobuf enum value: CANNOT_MODIFY_FOR_TRIAL_CAMPAIGN = 11;
*/
CANNOT_MODIFY_FOR_TRIAL_CAMPAIGN = 11,
/**
* Trying to modify the name of an active or paused campaign, where the name
* is already assigned to another active or paused campaign.
*
* @generated from protobuf enum value: DUPLICATE_CAMPAIGN_NAME = 12;
*/
DUPLICATE_CAMPAIGN_NAME = 12,
/**
* Two fields are in conflicting modes.
*
* @generated from protobuf enum value: INCOMPATIBLE_CAMPAIGN_FIELD = 13;
*/
INCOMPATIBLE_CAMPAIGN_FIELD = 13,
/**
* Campaign name cannot be used.
*
* @generated from protobuf enum value: INVALID_CAMPAIGN_NAME = 14;
*/
INVALID_CAMPAIGN_NAME = 14,
/**
* Given status is invalid.
*
* @generated from protobuf enum value: INVALID_AD_SERVING_OPTIMIZATION_STATUS = 15;
*/
INVALID_AD_SERVING_OPTIMIZATION_STATUS = 15,
/**
* Error in the campaign level tracking URL.
*
* @generated from protobuf enum value: INVALID_TRACKING_URL = 16;
*/
INVALID_TRACKING_URL = 16,
/**
* Cannot set both tracking URL template and tracking setting. A user has
* to clear legacy tracking setting in order to add tracking URL template.
*
* @generated from protobuf enum value: CANNOT_SET_BOTH_TRACKING_URL_TEMPLATE_AND_TRACKING_SETTING = 17;
*/
CANNOT_SET_BOTH_TRACKING_URL_TEMPLATE_AND_TRACKING_SETTING = 17,
/**
* The maximum number of impressions for Frequency Cap should be an integer
* greater than 0.
*
* @generated from protobuf enum value: MAX_IMPRESSIONS_NOT_IN_RANGE = 18;
*/
MAX_IMPRESSIONS_NOT_IN_RANGE = 18,
/**
* Only the Day, Week and Month time units are supported.
*
* @generated from protobuf enum value: TIME_UNIT_NOT_SUPPORTED = 19;
*/
TIME_UNIT_NOT_SUPPORTED = 19,
/**
* Operation not allowed on a campaign whose serving status has ended
*
* @generated from protobuf enum value: INVALID_OPERATION_IF_SERVING_STATUS_HAS_ENDED = 20;
*/
INVALID_OPERATION_IF_SERVING_STATUS_HAS_ENDED = 20,
/**
* This budget is exclusively linked to a Campaign that is using experiments
* so it cannot be shared.
*
* @generated from protobuf enum value: BUDGET_CANNOT_BE_SHARED = 21;
*/
BUDGET_CANNOT_BE_SHARED = 21,
/**
* Campaigns using experiments cannot use a shared budget.
*
* @generated from protobuf enum value: CAMPAIGN_CANNOT_USE_SHARED_BUDGET = 22;
*/
CAMPAIGN_CANNOT_USE_SHARED_BUDGET = 22,
/**
* A different budget cannot be assigned to a campaign when there are
* running or scheduled trials.
*
* @generated from protobuf enum value: CANNOT_CHANGE_BUDGET_ON_CAMPAIGN_WITH_TRIALS = 23;
*/
CANNOT_CHANGE_BUDGET_ON_CAMPAIGN_WITH_TRIALS = 23,
/**
* No link found between the campaign and the label.
*
* @generated from protobuf enum value: CAMPAIGN_LABEL_DOES_NOT_EXIST = 24;
*/
CAMPAIGN_LABEL_DOES_NOT_EXIST = 24,
/**
* The label has already been attached to the campaign.
*
* @generated from protobuf enum value: CAMPAIGN_LABEL_ALREADY_EXISTS = 25;
*/
CAMPAIGN_LABEL_ALREADY_EXISTS = 25,
/**
* A ShoppingSetting was not found when creating a shopping campaign.
*
* @generated from protobuf enum value: MISSING_SHOPPING_SETTING = 26;
*/
MISSING_SHOPPING_SETTING = 26,
/**
* The country in shopping setting is not an allowed country.
*
* @generated from protobuf enum value: INVALID_SHOPPING_SALES_COUNTRY = 27;
*/
INVALID_SHOPPING_SALES_COUNTRY = 27,
/**
* The requested channel type is not available according to the customer's
* account setting.
*
* @generated from protobuf enum value: ADVERTISING_CHANNEL_TYPE_NOT_AVAILABLE_FOR_ACCOUNT_TYPE = 31;
*/
ADVERTISING_CHANNEL_TYPE_NOT_AVAILABLE_FOR_ACCOUNT_TYPE = 31,
/**
* The AdvertisingChannelSubType is not a valid subtype of the primary
* channel type.
*
* @generated from protobuf enum value: INVALID_ADVERTISING_CHANNEL_SUB_TYPE = 32;
*/
INVALID_ADVERTISING_CHANNEL_SUB_TYPE = 32,
/**
* At least one conversion must be selected.
*
* @generated from protobuf enum value: AT_LEAST_ONE_CONVERSION_MUST_BE_SELECTED = 33;
*/
AT_LEAST_ONE_CONVERSION_MUST_BE_SELECTED = 33,
/**
* Setting ad rotation mode for a campaign is not allowed. Ad rotation mode
* at campaign is deprecated.
*
* @generated from protobuf enum value: CANNOT_SET_AD_ROTATION_MODE = 34;
*/
CANNOT_SET_AD_ROTATION_MODE = 34,
/**
* Trying to change start date on a campaign that has started.
*
* @generated from protobuf enum value: CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED = 35;
*/
CANNOT_MODIFY_START_DATE_IF_ALREADY_STARTED = 35,
/**
* Trying to modify a date into the past.
*
* @generated from protobuf enum value: CANNOT_SET_DATE_TO_PAST = 36;
*/
CANNOT_SET_DATE_TO_PAST = 36,
/**
* Hotel center id in the hotel setting does not match any customer links.
*
* @generated from protobuf enum value: MISSING_HOTEL_CUSTOMER_LINK = 37;
*/
MISSING_HOTEL_CUSTOMER_LINK = 37,
/**
* Hotel center id in the hotel setting must match an active customer link.
*
* @generated from protobuf enum value: INVALID_HOTEL_CUSTOMER_LINK = 38;
*/
INVALID_HOTEL_CUSTOMER_LINK = 38,
/**
* Hotel setting was not found when creating a hotel ads campaign.
*
* @generated from protobuf enum value: MISSING_HOTEL_SETTING = 39;
*/
MISSING_HOTEL_SETTING = 39,
/**
* A Campaign cannot use shared campaign budgets and be part of a campaign
* group.
*
* @generated from protobuf enum value: CANNOT_USE_SHARED_CAMPAIGN_BUDGET_WHILE_PART_OF_CAMPAIGN_GROUP = 40;
*/
CANNOT_USE_SHARED_CAMPAIGN_BUDGET_WHILE_PART_OF_CAMPAIGN_GROUP = 40,
/**
* The app ID was not found.
*
* @generated from protobuf enum value: APP_NOT_FOUND = 41;
*/
APP_NOT_FOUND = 41,
/**
* Campaign.shopping_setting.enable_local is not supported for the specified
* campaign type.
*
* @generated from protobuf enum value: SHOPPING_ENABLE_LOCAL_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE = 42;
*/
SHOPPING_ENABLE_LOCAL_NOT_SUPPORTED_FOR_CAMPAIGN_TYPE = 42,
/**
* The merchant does not support the creation of campaigns for Shopping
* Comparison Listing Ads.
*
* @generated from protobuf enum value: MERCHANT_NOT_ALLOWED_FOR_COMPARISON_LISTING_ADS = 43;
*/
MERCHANT_NOT_ALLOWED_FOR_COMPARISON_LISTING_ADS = 43,
/**
* The App campaign for engagement cannot be created because there aren't
* enough installs.
*
* @generated from protobuf enum value: INSUFFICIENT_APP_INSTALLS_COUNT = 44;
*/
INSUFFICIENT_APP_INSTALLS_COUNT = 44,
/**
* The App campaign for engagement cannot be created because the app is
* sensitive.
*
* @generated from protobuf enum value: SENSITIVE_CATEGORY_APP = 45;
*/
SENSITIVE_CATEGORY_APP = 45,
/**
* Customers with Housing, Employment, or Credit ads must accept updated
* personalized ads policy to continue creating campaigns.
*
* @generated from protobuf enum value: HEC_AGREEMENT_REQUIRED = 46;
*/
HEC_AGREEMENT_REQUIRED = 46,
/**
* The field is not compatible with view through conversion optimization.
*
* @generated from protobuf enum value: NOT_COMPATIBLE_WITH_VIEW_THROUGH_CONVERSION_OPTIMIZATION = 49;
*/
NOT_COMPATIBLE_WITH_VIEW_THROUGH_CONVERSION_OPTIMIZATION = 49,
/**
* The field type cannot be excluded because an active campaign-asset link
* of this type exists.
*
* @generated from protobuf enum value: INVALID_EXCLUDED_PARENT_ASSET_FIELD_TYPE = 48;
*/
INVALID_EXCLUDED_PARENT_ASSET_FIELD_TYPE = 48,
/**
* The app pre-registration campaign cannot be created for non-Android
* applications.
*
* @generated from protobuf enum value: CANNOT_CREATE_APP_PRE_REGISTRATION_FOR_NON_ANDROID_APP = 50;
*/
CANNOT_CREATE_APP_PRE_REGISTRATION_FOR_NON_ANDROID_APP = 50,
/**
* The campaign cannot be created since the app is not available for
* pre-registration in any country.
*
* @generated from protobuf enum value: APP_NOT_AVAILABLE_TO_CREATE_APP_PRE_REGISTRATION_CAMPAIGN = 51;
*/
APP_NOT_AVAILABLE_TO_CREATE_APP_PRE_REGISTRATION_CAMPAIGN = 51,
/**
* The type of the Budget is not compatible with this Campaign.
*
* @generated from protobuf enum value: INCOMPATIBLE_BUDGET_TYPE = 52;
*/
INCOMPATIBLE_BUDGET_TYPE = 52,
/**
* Category bid list in the local services campaign setting contains
* multiple bids for the same category ID.
*
* @generated from protobuf enum value: LOCAL_SERVICES_DUPLICATE_CATEGORY_BID = 53;
*/
LOCAL_SERVICES_DUPLICATE_CATEGORY_BID = 53,
/**
* Category bid list in the local services campaign setting contains
* a bid for an invalid category ID.
*
* @generated from protobuf enum value: LOCAL_SERVICES_INVALID_CATEGORY_BID = 54;
*/
LOCAL_SERVICES_INVALID_CATEGORY_BID = 54,
/**
* Category bid list in the local services campaign setting is missing a
* bid for a category ID that must be present.
*
* @generated from protobuf enum value: LOCAL_SERVICES_MISSING_CATEGORY_BID = 55;
*/
LOCAL_SERVICES_MISSING_CATEGORY_BID = 55
}
declare class CampaignErrorEnum$Type extends MessageType<CampaignErrorEnum> {
constructor();
create(value?: PartialMessage<CampaignErrorEnum>): CampaignErrorEnum;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CampaignErrorEnum): CampaignErrorEnum;
internalBinaryWrite(message: CampaignErrorEnum, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.errors.CampaignErrorEnum
*/
export declare const CampaignErrorEnum: CampaignErrorEnum$Type;
export {};