Conversion

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

A Conversion represents when a user successfully performs a desired action after seeing an ad.

interface Conversion {

adUserDataConsent?: "GRANTED" | "DENIED";

childDirectedTreatment?: boolean;

customVariables?: CustomFloodlightVariable[];

dclid?: string;

encryptedUserId?: string;

encryptedUserIdCandidates?: string[];

floodlightActivityId?: bigint;

floodlightConfigurationId?: bigint;

gclid?: string;

impressionId?: string;

kind?: string;

limitAdTracking?: boolean;

matchId?: string;

mobileDeviceId?: string;

nonPersonalizedAd?: boolean;

ordinal?: string;

quantity?: bigint;

timestampMicros?: bigint;

treatmentForUnderage?: boolean;

userIdentifiers?: UserIdentifier[];

value?: number;

}

§Properties

adUserDataConsent?: "GRANTED" | "DENIED"

[src]

This represents consent for ad user data.

childDirectedTreatment?: boolean

[src]

Whether this particular request may come from a user under the age of 13, under COPPA compliance.

customVariables?: CustomFloodlightVariable[]

[src]

Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate.

dclid?: string

[src]

The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid, and impressionId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or impressionId is a required field.

encryptedUserId?: string

[src]

The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid, dclid, and impressionId. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid or impressionId is a required field.

encryptedUserIdCandidates?: string[]

[src]

A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid dclid, and impressionId. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid or impressionId is a required field.

floodlightActivityId?: bigint

[src]

Floodlight Activity ID of this conversion. This is a required field.

floodlightConfigurationId?: bigint

[src]

Floodlight Configuration ID of this conversion. This is a required field.

gclid?: string

[src]

The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, dclid, and impressionId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid or impressionId is a required field.

impressionId?: string

[src]

The impression ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, and gclid. One of these identifiers must be set.

kind?: string

[src]

Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".

limitAdTracking?: boolean

[src]

Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.

matchId?: string

[src]

The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid, dclid, and impressionId. This or encryptedUserId orencryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid or impressionIdis a required field.

mobileDeviceId?: string

[src]

The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid, dclid, and impressionId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid or impressionId is a required field.

nonPersonalizedAd?: boolean

[src]

Whether the conversion was for a non personalized ad.

ordinal?: string

[src]

The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.

quantity?: bigint

[src]

The quantity of the conversion. This is a required field.

timestampMicros?: bigint

[src]

The timestamp of conversion, in Unix epoch micros. This is a required field.

treatmentForUnderage?: boolean

[src]

Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).

userIdentifiers?: UserIdentifier[]

[src]

The user identifiers to enhance the conversion. The maximum number of user identifiers for each conversion is 5.

value?: number

[src]

The value of the conversion. This is a required field.