Batchupdate
|
|||||
|
|
||||
Updates existing conversions
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage DoubleClick Digital Marketing conversions
Input
This building block consumes 27 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
conversions[] |
OBJECT |
A Conversion represents when a user successfully performs a desired action after seeing an ad |
conversions[].childDirectedTreatment |
BOOLEAN |
Whether this particular request may come from a user under the age of 13, under COPPA compliance |
conversions[].customVariables[] |
OBJECT |
A custom floodlight variable |
conversions[].customVariables[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable" |
conversions[].customVariables[].type |
ENUMERATION |
The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags |
conversions[].customVariables[].value |
STRING |
The value of the custom floodlight variable. The length of string must not exceed 50 characters |
conversions[].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 |
conversions[].encryptedUserIdCandidates[] |
STRING |
|
conversions[].floodlightActivityId |
INTEGER |
Floodlight Activity ID of this conversion. This is a required field |
conversions[].floodlightConfigurationId |
INTEGER |
Floodlight Configuration ID of this conversion. This is a required field |
conversions[].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 |
conversions[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion" |
conversions[].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 |
conversions[].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 |
conversions[].nonPersonalizedAd |
BOOLEAN |
Whether the conversion was for a non personalized ad |
conversions[].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 |
conversions[].quantity |
INTEGER |
The quantity of the conversion |
conversions[].timestampMicros |
INTEGER |
The timestamp of conversion, in Unix epoch micros. This is a required field |
conversions[].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) |
conversions[].value |
NUMBER |
The value of the conversion |
encryptionInfo |
OBJECT |
A description of how user IDs are encrypted |
encryptionInfo.encryptionEntityId |
INTEGER |
The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer |
encryptionInfo.encryptionEntityType |
ENUMERATION |
The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer |
encryptionInfo.encryptionSource |
ENUMERATION |
Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer |
encryptionInfo.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo" |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest" |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
conversions[] OBJECT A Conversion represents when a user successfully performs a desired action after seeing an ad |
|
conversions[].childDirectedTreatment BOOLEAN Whether this particular request may come from a user under the age of 13, under COPPA compliance |
|
conversions[].customVariables[] OBJECT A custom floodlight variable |
|
conversions[].customVariables[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable" |
|
conversions[].customVariables[].type ENUMERATION The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags |
|
conversions[].customVariables[].value STRING The value of the custom floodlight variable. The length of string must not exceed 50 characters |
|
conversions[].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 |
|
conversions[].encryptedUserIdCandidates[] STRING |
|
conversions[].floodlightActivityId INTEGER Floodlight Activity ID of this conversion. This is a required field |
|
conversions[].floodlightConfigurationId INTEGER Floodlight Configuration ID of this conversion. This is a required field |
|
conversions[].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 |
|
conversions[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion" |
|
conversions[].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 |
|
conversions[].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 |
|
conversions[].nonPersonalizedAd BOOLEAN Whether the conversion was for a non personalized ad |
|
conversions[].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 |
|
conversions[].quantity INTEGER The quantity of the conversion |
|
conversions[].timestampMicros INTEGER The timestamp of conversion, in Unix epoch micros. This is a required field |
|
conversions[].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) |
|
conversions[].value NUMBER The value of the conversion |
|
encryptionInfo OBJECT A description of how user IDs are encrypted |
|
encryptionInfo.encryptionEntityId INTEGER The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer |
|
encryptionInfo.encryptionEntityType ENUMERATION The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer |
|
encryptionInfo.encryptionSource ENUMERATION Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer |
|
encryptionInfo.kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo" |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest" |
Output
This building block provides 25 output parameters
| Name | Format | Description |
|---|---|---|
hasFailures |
BOOLEAN |
Indicates that some or all conversions failed to update |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse" |
status[] |
OBJECT |
The original conversion that was inserted or updated and whether there were any errors |
status[].conversion |
OBJECT |
A Conversion represents when a user successfully performs a desired action after seeing an ad |
status[].conversion.childDirectedTreatment |
BOOLEAN |
Whether this particular request may come from a user under the age of 13, under COPPA compliance |
status[].conversion.customVariables[] |
OBJECT |
A custom floodlight variable |
status[].conversion.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 |
status[].conversion.encryptedUserIdCandidates[] |
STRING |
|
status[].conversion.floodlightActivityId |
INTEGER |
Floodlight Activity ID of this conversion. This is a required field |
status[].conversion.floodlightConfigurationId |
INTEGER |
Floodlight Configuration ID of this conversion. This is a required field |
status[].conversion.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 |
status[].conversion.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion" |
status[].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 |
status[].conversion.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 |
status[].conversion.nonPersonalizedAd |
BOOLEAN |
Whether the conversion was for a non personalized ad |
status[].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 |
status[].conversion.quantity |
INTEGER |
The quantity of the conversion |
status[].conversion.timestampMicros |
INTEGER |
The timestamp of conversion, in Unix epoch micros. This is a required field |
status[].conversion.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) |
status[].conversion.value |
NUMBER |
The value of the conversion |
status[].errors[] |
OBJECT |
The error code and description for a conversion that failed to insert or update |
status[].errors[].code |
ENUMERATION |
The error code |
status[].errors[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError" |
status[].errors[].message |
STRING |
A description of the error |
status[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus" |
= Parameter name
= Format
|
hasFailures BOOLEAN Indicates that some or all conversions failed to update |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse" |
|
status[] OBJECT The original conversion that was inserted or updated and whether there were any errors |
|
status[].conversion OBJECT A Conversion represents when a user successfully performs a desired action after seeing an ad |
|
status[].conversion.childDirectedTreatment BOOLEAN Whether this particular request may come from a user under the age of 13, under COPPA compliance |
|
status[].conversion.customVariables[] OBJECT A custom floodlight variable |
|
status[].conversion.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 |
|
status[].conversion.encryptedUserIdCandidates[] STRING |
|
status[].conversion.floodlightActivityId INTEGER Floodlight Activity ID of this conversion. This is a required field |
|
status[].conversion.floodlightConfigurationId INTEGER Floodlight Configuration ID of this conversion. This is a required field |
|
status[].conversion.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 |
|
status[].conversion.kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion" |
|
status[].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 |
|
status[].conversion.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 |
|
status[].conversion.nonPersonalizedAd BOOLEAN Whether the conversion was for a non personalized ad |
|
status[].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 |
|
status[].conversion.quantity INTEGER The quantity of the conversion |
|
status[].conversion.timestampMicros INTEGER The timestamp of conversion, in Unix epoch micros. This is a required field |
|
status[].conversion.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) |
|
status[].conversion.value NUMBER The value of the conversion |
|
status[].errors[] OBJECT The error code and description for a conversion that failed to insert or update |
|
status[].errors[].code ENUMERATION The error code |
|
status[].errors[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError" |
|
status[].errors[].message STRING A description of the error |
|
status[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus" |