Conversions

For a list of methods for this resource, see the end of this page.

Resource representations

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

{
  "kind": "dfareporting#conversion",
  "floodlightConfigurationId": long,
  "floodlightActivityId": long,
  "encryptedUserId": string,
  "encryptedUserIdCandidates": [
    string
  ],
  "mobileDeviceId": string,
  "gclid": string,
  "limitAdTracking": boolean,
  "childDirectedTreatment": boolean,
  "timestampMicros": long,
  "value": double,
  "quantity": long,
  "ordinal": string,
  "customVariables": [
    {
      "kind": "dfareporting#customFloodlightVariable",
      "type": string,
      "value": string
    }
  ]
}
Property name Value Description Notes
childDirectedTreatment boolean Whether the conversion was directed toward children.
customVariables[] list Custom floodlight variables.
customVariables[].kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
customVariables[].type string The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.

Acceptable values are:
  • "U1"
  • "U10"
  • "U100"
  • "U11"
  • "U12"
  • "U13"
  • "U14"
  • "U15"
  • "U16"
  • "U17"
  • "U18"
  • "U19"
  • "U2"
  • "U20"
  • "U21"
  • "U22"
  • "U23"
  • "U24"
  • "U25"
  • "U26"
  • "U27"
  • "U28"
  • "U29"
  • "U3"
  • "U30"
  • "U31"
  • "U32"
  • "U33"
  • "U34"
  • "U35"
  • "U36"
  • "U37"
  • "U38"
  • "U39"
  • "U4"
  • "U40"
  • "U41"
  • "U42"
  • "U43"
  • "U44"
  • "U45"
  • "U46"
  • "U47"
  • "U48"
  • "U49"
  • "U5"
  • "U50"
  • "U51"
  • "U52"
  • "U53"
  • "U54"
  • "U55"
  • "U56"
  • "U57"
  • "U58"
  • "U59"
  • "U6"
  • "U60"
  • "U61"
  • "U62"
  • "U63"
  • "U64"
  • "U65"
  • "U66"
  • "U67"
  • "U68"
  • "U69"
  • "U7"
  • "U70"
  • "U71"
  • "U72"
  • "U73"
  • "U74"
  • "U75"
  • "U76"
  • "U77"
  • "U78"
  • "U79"
  • "U8"
  • "U80"
  • "U81"
  • "U82"
  • "U83"
  • "U84"
  • "U85"
  • "U86"
  • "U87"
  • "U88"
  • "U89"
  • "U9"
  • "U90"
  • "U91"
  • "U92"
  • "U93"
  • "U94"
  • "U95"
  • "U96"
  • "U97"
  • "U98"
  • "U99"
customVariables[].value string The value of the custom floodlight variable. The length of string must not exceed 50 characters.
encryptedUserId string The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required field.
encryptedUserIdCandidates[] list 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 NO_COOKIE_MATCH_FOUND 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, mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid is a required field.
floodlightActivityId long Floodlight Activity ID of this conversion. This is a required field.
floodlightConfigurationId long Floodlight Configuration ID of this conversion. This is a required field.
gclid string The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
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.
mobileDeviceId string The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[] and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or gclid is a required field.
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.
quantity long The quantity of the conversion.
timestampMicros long The timestamp of conversion, in Unix epoch micros. This is a required field.
value double The value of the conversion.

Methods

batchinsert
Inserts conversions.
batchupdate
Updates existing conversions.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager