The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Dec 24th, 2021. All users must migrate to a newer API version by that date.

Conversion

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

JSON representation
{
  "floodlightConfigurationId": string,
  "floodlightActivityId": string,
  "encryptedUserId": string,
  "mobileDeviceId": string,
  "timestampMicros": string,
  "value": number,
  "quantity": string,
  "ordinal": string,
  "customVariables": [
    {
      object (CustomFloodlightVariable)
    }
  ],
  "limitAdTracking": boolean,
  "childDirectedTreatment": boolean,
  "encryptedUserIdCandidates": [
    string
  ],
  "gclid": string,
  "nonPersonalizedAd": boolean,
  "treatmentForUnderage": boolean,
  "matchId": string,
  "kind": string
}
Fields
floodlightConfigurationId

string (int64 format)

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

floodlightActivityId

string (int64 format)

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

encryptedUserId

string

The alphanumeric encrypted user ID. When set,

encryptionInfo

should also be specified. This field is mutually exclusive with

encryptedUserIdCandidates[]

,

matchId

,

mobileDeviceId

and

gclid

. This or

encryptedUserIdCandidates[]

or

matchId

or

mobileDeviceId

or

gclid

is a required field.

mobileDeviceId

string

The mobile device ID. This field is mutually exclusive with

encryptedUserId

,

encryptedUserIdCandidates[]

,

matchId

and

gclid

. This or

encryptedUserId

or

encryptedUserIdCandidates[]

or

matchId

or

gclid

is a required field.

timestampMicros

string (int64 format)

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

value

number

The value of the conversion.

quantity

string (int64 format)

The quantity of the conversion.

ordinal

string

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.

customVariables[]

object (CustomFloodlightVariable)

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

limitAdTracking

boolean

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

childDirectedTreatment

boolean

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

encryptedUserIdCandidates[]

string

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

and

gclid

. This or

encryptedUserId

or

matchId

or

mobileDeviceId

or

gclid

is a required field.

gclid

string

The Google click ID. This field is mutually exclusive with

encryptedUserId

,

encryptedUserIdCandidates[]

,

matchId

and

mobileDeviceId

. This or

encryptedUserId

or

encryptedUserIdCandidates[]

or

matchId

or

mobileDeviceId

is a required field.

nonPersonalizedAd

boolean

Whether the conversion was for a non personalized ad.

treatmentForUnderage

boolean

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).

matchId

string

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

and

gclid

. This or

encryptedUserId

or

encryptedUserIdCandidates[]

or

mobileDeviceId

or

gclid

is a required field.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#conversion"

.

CustomFloodlightVariable

A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.

JSON representation
{
  "type": enum (Type),
  "value": string,
  "kind": string
}
Fields
type

enum (Type)

The type of custom floodlight variable to supply a value for. These map to the "

u[1-20]=

" in the tags.

value

string

The value of the custom floodlight variable. The length of string must not exceed 100 characters.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#customFloodlightVariable"

.

Type

Enums
U1
U2
U3
U4
U5
U6
U7
U8
U9
U10
U11
U12
U13
U14
U15
U16
U17
U18
U19
U20
U21
U22
U23
U24
U25
U26
U27
U28
U29
U30
U31
U32
U33
U34
U35
U36
U37
U38
U39
U40
U41
U42
U43
U44
U45
U46
U47
U48
U49
U50
U51
U52
U53
U54
U55
U56
U57
U58
U59
U60
U61
U62
U63
U64
U65
U66
U67
U68
U69
U70
U71
U72
U73
U74
U75
U76
U77
U78
U79
U80
U81
U82
U83
U84
U85
U86
U87
U88
U89
U90
U91
U92
U93
U94
U95
U96
U97
U98
U99
U100