google-ads-api-client
Version:
A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.
241 lines (240 loc) • 8.77 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 the external conversion source that is
* associated with a ConversionAction.
*
* @generated from protobuf message google.ads.googleads.v11.enums.ExternalConversionSourceEnum
*/
export interface ExternalConversionSourceEnum {
}
/**
* The external conversion source that is associated with a ConversionAction.
*
* @generated from protobuf enum google.ads.googleads.v11.enums.ExternalConversionSourceEnum.ExternalConversionSource
*/
export declare enum ExternalConversionSourceEnum_ExternalConversionSource {
/**
* Not specified.
*
* @generated from protobuf enum value: UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* Represents value unknown in this version.
*
* @generated from protobuf enum value: UNKNOWN = 1;
*/
UNKNOWN = 1,
/**
* Conversion that occurs when a user navigates to a particular webpage
* after viewing an ad; Displayed in Google Ads UI as 'Website'.
*
* @generated from protobuf enum value: WEBPAGE = 2;
*/
WEBPAGE = 2,
/**
* Conversion that comes from linked Google Analytics goal or transaction;
* Displayed in Google Ads UI as 'Analytics'.
*
* @generated from protobuf enum value: ANALYTICS = 3;
*/
ANALYTICS = 3,
/**
* Website conversion that is uploaded through ConversionUploadService;
* Displayed in Google Ads UI as 'Import from clicks'.
*
* @generated from protobuf enum value: UPLOAD = 4;
*/
UPLOAD = 4,
/**
* Conversion that occurs when a user clicks on a call extension directly on
* an ad; Displayed in Google Ads UI as 'Calls from ads'.
*
* @generated from protobuf enum value: AD_CALL_METRICS = 5;
*/
AD_CALL_METRICS = 5,
/**
* Conversion that occurs when a user calls a dynamically-generated phone
* number (by installed javascript) from an advertiser's website after
* clicking on an ad; Displayed in Google Ads UI as 'Calls from website'.
*
* @generated from protobuf enum value: WEBSITE_CALL_METRICS = 6;
*/
WEBSITE_CALL_METRICS = 6,
/**
* Conversion that occurs when a user visits an advertiser's retail store
* after clicking on a Google ad;
* Displayed in Google Ads UI as 'Store visits'.
*
* @generated from protobuf enum value: STORE_VISITS = 7;
*/
STORE_VISITS = 7,
/**
* Conversion that occurs when a user takes an in-app action such as a
* purchase in an Android app;
* Displayed in Google Ads UI as 'Android in-app action'.
*
* @generated from protobuf enum value: ANDROID_IN_APP = 8;
*/
ANDROID_IN_APP = 8,
/**
* Conversion that occurs when a user takes an in-app action such as a
* purchase in an iOS app;
* Displayed in Google Ads UI as 'iOS in-app action'.
*
* @generated from protobuf enum value: IOS_IN_APP = 9;
*/
IOS_IN_APP = 9,
/**
* Conversion that occurs when a user opens an iOS app for the first time;
* Displayed in Google Ads UI as 'iOS app install (first open)'.
*
* @generated from protobuf enum value: IOS_FIRST_OPEN = 10;
*/
IOS_FIRST_OPEN = 10,
/**
* Legacy app conversions that do not have an AppPlatform provided;
* Displayed in Google Ads UI as 'Mobile app'.
*
* @generated from protobuf enum value: APP_UNSPECIFIED = 11;
*/
APP_UNSPECIFIED = 11,
/**
* Conversion that occurs when a user opens an Android app for the first
* time; Displayed in Google Ads UI as 'Android app install (first open)'.
*
* @generated from protobuf enum value: ANDROID_FIRST_OPEN = 12;
*/
ANDROID_FIRST_OPEN = 12,
/**
* Call conversion that is uploaded through ConversionUploadService;
* Displayed in Google Ads UI as 'Import from calls'.
*
* @generated from protobuf enum value: UPLOAD_CALLS = 13;
*/
UPLOAD_CALLS = 13,
/**
* Conversion that comes from a linked Firebase event;
* Displayed in Google Ads UI as 'Firebase'.
*
* @generated from protobuf enum value: FIREBASE = 14;
*/
FIREBASE = 14,
/**
* Conversion that occurs when a user clicks on a mobile phone number;
* Displayed in Google Ads UI as 'Phone number clicks'.
*
* @generated from protobuf enum value: CLICK_TO_CALL = 15;
*/
CLICK_TO_CALL = 15,
/**
* Conversion that comes from Salesforce;
* Displayed in Google Ads UI as 'Salesforce.com'.
*
* @generated from protobuf enum value: SALESFORCE = 16;
*/
SALESFORCE = 16,
/**
* Conversion that comes from in-store purchases recorded by CRM;
* Displayed in Google Ads UI as 'Store sales (data partner)'.
*
* @generated from protobuf enum value: STORE_SALES_CRM = 17;
*/
STORE_SALES_CRM = 17,
/**
* Conversion that comes from in-store purchases from payment network;
* Displayed in Google Ads UI as 'Store sales (payment network)'.
*
* @generated from protobuf enum value: STORE_SALES_PAYMENT_NETWORK = 18;
*/
STORE_SALES_PAYMENT_NETWORK = 18,
/**
* Codeless Google Play conversion;
* Displayed in Google Ads UI as 'Google Play'.
*
* @generated from protobuf enum value: GOOGLE_PLAY = 19;
*/
GOOGLE_PLAY = 19,
/**
* Conversion that comes from a linked third-party app analytics event;
* Displayed in Google Ads UI as 'Third-party app analytics'.
*
* @generated from protobuf enum value: THIRD_PARTY_APP_ANALYTICS = 20;
*/
THIRD_PARTY_APP_ANALYTICS = 20,
/**
* Conversion that is controlled by Google Attribution.
*
* @generated from protobuf enum value: GOOGLE_ATTRIBUTION = 21;
*/
GOOGLE_ATTRIBUTION = 21,
/**
* Store Sales conversion based on first-party or third-party merchant data
* uploads. Displayed in Google Ads UI as 'Store sales (direct upload)'.
*
* @generated from protobuf enum value: STORE_SALES_DIRECT_UPLOAD = 23;
*/
STORE_SALES_DIRECT_UPLOAD = 23,
/**
* Store Sales conversion based on first-party or third-party merchant
* data uploads and/or from in-store purchases using cards from payment
* networks. Displayed in Google Ads UI as 'Store sales'.
*
* @generated from protobuf enum value: STORE_SALES = 24;
*/
STORE_SALES = 24,
/**
* Conversions imported from Search Ads 360 Floodlight data.
*
* @generated from protobuf enum value: SEARCH_ADS_360 = 25;
*/
SEARCH_ADS_360 = 25,
/**
* Conversions that track local actions from Google's products and services
* after interacting with an ad.
*
* @generated from protobuf enum value: GOOGLE_HOSTED = 27;
*/
GOOGLE_HOSTED = 27,
/**
* Conversions reported by Floodlight tags.
*
* @generated from protobuf enum value: FLOODLIGHT = 29;
*/
FLOODLIGHT = 29,
/**
* Conversions that come from Google Analytics specifically for Search Ads
* 360. Displayed in Google Ads UI as Analytics (SA360).
*
* @generated from protobuf enum value: ANALYTICS_SEARCH_ADS_360 = 31;
*/
ANALYTICS_SEARCH_ADS_360 = 31,
/**
* Conversion that comes from a linked Firebase event for Search Ads 360.
*
* @generated from protobuf enum value: FIREBASE_SEARCH_ADS_360 = 33;
*/
FIREBASE_SEARCH_ADS_360 = 33,
/**
* Conversion that is reported by Floodlight for DV360.
*
* @generated from protobuf enum value: DISPLAY_AND_VIDEO_360_FLOODLIGHT = 34;
*/
DISPLAY_AND_VIDEO_360_FLOODLIGHT = 34
}
declare class ExternalConversionSourceEnum$Type extends MessageType<ExternalConversionSourceEnum> {
constructor();
create(value?: PartialMessage<ExternalConversionSourceEnum>): ExternalConversionSourceEnum;
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ExternalConversionSourceEnum): ExternalConversionSourceEnum;
internalBinaryWrite(message: ExternalConversionSourceEnum, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
* @generated MessageType for protobuf message google.ads.googleads.v11.enums.ExternalConversionSourceEnum
*/
export declare const ExternalConversionSourceEnum: ExternalConversionSourceEnum$Type;
export {};