Conversion

import type { Conversion } from "https://googleapis.deno.dev/v1/doubleclicksearch:v2.ts";

A conversion containing data relevant to DoubleClick Search. Common DS3 API conversion fields: Id Range [1 - 2800]. Next Id to use: 33

interface Conversion {

adGroupId?: bigint;

adId?: bigint;

adUserDataConsent?: "UNKNOWN" | "GRANTED" | "DENIED";

advertiserId?: bigint;

agencyId?: bigint;

attributionModel?: string;

campaignId?: bigint;

channel?: string;

clickId?: string;

conversionId?: string;

conversionModifiedTimestamp?: bigint;

conversionTimestamp?: string;

countMillis?: bigint;

criterionId?: bigint;

currencyCode?: string;

customDimension?: CustomDimension[];

customerId?: string;

customMetric?: CustomMetric[];

deviceType?: string;

dsConversionId?: bigint;

engineAccountId?: bigint;

floodlightOrderId?: string;

inventoryAccountId?: bigint;

productCountry?: string;

productGroupId?: bigint;

productId?: string;

productLanguage?: string;

quantityMillis?: bigint;

revenueMicros?: string;

segmentationId?: bigint;

segmentationName?: string;

segmentationType?: string;

state?: string;

storeId?: string;

type?: string;

}

§Properties

adGroupId?: bigint

[src]

DS ad group ID.

adId?: bigint

[src]

DS ad ID.

adUserDataConsent?: "UNKNOWN" | "GRANTED" | "DENIED"

[src]

Represents consent for core platform services (CPS) preferences in settings. No default value. Acceptable values are: GRANTED: The desired consent status is to grant. Read the CPS preferences from GTE settings. DENIED: The desired consent status is to deny; CPS list is empty.

advertiserId?: bigint

[src]

DS advertiser ID.

agencyId?: bigint

[src]

DS agency ID.

attributionModel?: string

[src]

Available to advertisers only after contacting DoubleClick Search customer support.

campaignId?: bigint

[src]

DS campaign ID.

channel?: string

[src]

Sales channel for the product. Acceptable values are: - "local": a physical store - "online": an online store

clickId?: string

[src]

DS click ID for the conversion.

conversionId?: string

[src]

For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.

conversionModifiedTimestamp?: bigint

[src]

The time at which the conversion was last modified, in epoch millis UTC.

conversionTimestamp?: string

[src]

The time at which the conversion took place, in epoch millis UTC.

countMillis?: bigint

[src]

Available to advertisers only after contacting DoubleClick Search customer support.

criterionId?: bigint

[src]

DS criterion (keyword) ID.

currencyCode?: string

[src]

The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format.

customDimension?: CustomDimension[]

[src]

Custom dimensions for the conversion, which can be used to filter data in a report.

customerId?: string

[src]

Customer ID of a client account in the new Search Ads 360 experience.

customMetric?: CustomMetric[]

[src]

Custom metrics for the conversion.

deviceType?: string

[src]

The type of device on which the conversion occurred.

dsConversionId?: bigint

[src]

ID that DoubleClick Search generates for each conversion.

engineAccountId?: bigint

[src]

DS engine account ID.

floodlightOrderId?: string

[src]

The Floodlight order ID provided by the advertiser for the conversion.

inventoryAccountId?: bigint

[src]

ID that DS generates and uses to uniquely identify the inventory account that contains the product.

productCountry?: string

[src]

The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country.

productGroupId?: bigint

[src]

DS product group ID.

productId?: string

[src]

The product ID (SKU).

productLanguage?: string

[src]

The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language.

quantityMillis?: bigint

[src]

The quantity of this conversion, in millis.

revenueMicros?: string

[src]

The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10" enter "10000000" (10 million) in your request.

segmentationId?: bigint

[src]

The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID).

segmentationName?: string

[src]

The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name).

segmentationType?: string

[src]

The segmentation type of this conversion (for example, FLOODLIGHT).

state?: string

[src]

The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated.

storeId?: string

[src]

The ID of the local store for which the product was advertised. Applicable only when the channel is "local".

type?: string

[src]

The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus ecommerce purchases (TRANSACTION).