Inserts conversions.
batchinsert(profileId, body)
Inserts conversions.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Insert Conversions Request.
"conversions": [ # The set of conversions to insert.
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
"ordinal": "A 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.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
"childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with mobileDeviceId. This or mobileDeviceId is a required field.
"customVariables": [ # Custom floodlight variables.
{ # A custom floodlight variable.
"kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
},
],
"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
"value": 3.14, # The value of the conversion.
"limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
"quantity": "A String", # The quantity of the conversion.
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId. This or encryptedUserId is a required field.
},
],
"kind": "dfareporting#conversionsBatchInsertRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
"encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
"kind": "dfareporting#encryptionInfo", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
"encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
"encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
"encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
},
}
Returns:
An object of the form:
{ # Insert Conversions Response.
"status": [ # The status of each conversion's insertion status. The status is returned in the same order that conversions are inserted.
{ # The original conversion that was inserted and whether there were any errors.
"conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted.
"ordinal": "A 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.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
"childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with mobileDeviceId. This or mobileDeviceId is a required field.
"customVariables": [ # Custom floodlight variables.
{ # A custom floodlight variable.
"kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
},
],
"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
"value": 3.14, # The value of the conversion.
"limitAdTracking": True or False, # Whether the user has Limit Ad Tracking set.
"quantity": "A String", # The quantity of the conversion.
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId. This or encryptedUserId is a required field.
},
"errors": [ # A list of errors related to this conversion.
{ # The error code and description for a conversion that failed to insert.
"kind": "dfareporting#conversionError", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
"code": "A String", # The error code.
"message": "A String", # A description of the error.
},
],
"kind": "dfareporting#conversionStatus", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
},
],
"hasFailures": True or False, # Indicates that some or all conversions failed to insert.
"kind": "dfareporting#conversionsBatchInsertResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
}