Use the mappings in the tables to map an
conversions.batchinsert in the Campaign Manager 360 API to its
IngestEventsRequest equivalent in the Data Manager API.
Request fields
conversions.batchinsert (Campaign Manager 360 API) |
IngestEventsRequest (Data Manager API) |
Notes |
|---|---|---|
profileId URL path parameter |
No equivalent | |
kind |
No equivalent | Metadata field; not used by the Data Manager API. |
conversions |
events |
Required. The list of conversions or events. See the Conversion fields section for details. |
encryptionInfo |
Moved to events.adIdentifiers.encryptedUserIds |
Defined at the event level. Campaign Manager 360 encryption information is now specified in each encrypted user ID. See the Conversion fields section. |
| No equivalent | encryptionInfo |
The request-level encryptionInfo is the encryption information for encrypted UserData user identifiers. See Encryption for details. |
| No equivalent | destinations |
Required. A list of Destination objects that define the target account and Floodlight activity for the events. See the Destinations guide for details. Map individual fields as shown in the Conversion fields section. |
| No equivalent | consent |
Optional default consent settings for events in the request. You can override this value for an individual event by setting the consent field of Event. |
| No equivalent | encoding |
Required if sending user identifiers: Set to the Encoding used for UserIdentifier values. If not using user identifiers, this field is ignored. |
| No equivalent | validateOnly |
If true, the request is validated, but not executed. |
Conversion fields
Conversion (Campaign Manager 360 API) |
Event (Data Manager API) |
Notes |
|---|---|---|
floodlightConfigurationId |
destinations[].operatingAccount.accountId |
Defined at the request level. Set to the Floodlight configuration ID. |
| No equivalent | destinations[].operatingAccount.accountType |
Defined at the request level. Set to FLOODLIGHT_CONFIG. |
floodlightActivityId |
destinations[].productDestinationId |
Defined at the request level. Set to the Floodlight activity ID (previously known as Floodlight activity ID). |
kind |
No equivalent | Metadata field; not used by the Data Manager API. |
| No equivalent | destinations[].reference |
Defined at the request level. A user-defined identifier for the destination. Set this field if you are sending events to multiple destinations in a single request. |
adUserDataConsent |
consent.adUserData |
See Consent for more details. |
nonPersonalizedAd |
consent.adPersonalization |
See Consent for more details. |
| No equivalent | destinationReferences |
If sending events to multiple destinations in a single request, set this field to the corresponding reference of the destination. |
timestampMicros |
eventTimestamp |
See Timestamp format for details. |
value |
conversionValue |
|
quantity |
conversionCount |
|
ordinal |
No equivalent |
The ordinal field from the Campaign Manager 360 API is not present in the Data Manager API.
Instead, transactionId can be used to control how conversions from the same
user and day are deduplicated.
In Campaign Manager 360 API, you could ensure events would be deduplicated by setting ordinal to a fixed, constant value such as 1. In Data Manager API,
transactionId must be set to a unique identifier for each event.
|
| No equivalent | transactionId |
In Data Manager API, transactionId is used to control how
conversions from the same user and day are deduplicated. This field must be set
to a unique identifier for each event.
This field is optional when sending Floodlight offline conversions. See Convert the data to Event objects for more
details.
|
customVariables |
customVariables |
A list of CustomVariable objects. The Data Manager API uses strings as keys instead of enums. Use keys like U1, U2 for the variable field. |
limitAdTracking |
consent.adPersonalization |
See Consent for more details. |
childDirectedTreatment |
consent.adPersonalization |
See Consent for more details. |
treatmentForUnderage |
consent.adPersonalization |
See Consent for more details. |
gclid |
adIdentifiers.gclid |
See AdIdentifiers for more details. |
dclid |
adIdentifiers.dclid |
See AdIdentifiers for more details. |
matchId |
adIdentifiers.matchId |
See AdIdentifiers for more details. |
mobileDeviceId |
adIdentifiers.mobileId |
See AdIdentifiers for more details. |
impressionId |
adIdentifiers.impressionId |
See AdIdentifiers for more details. |
encryptedUserId |
adIdentifiers.encryptedUserIds |
The Data Manager API supports multiple encrypted user IDs. See AdIdentifiers for more details. |
encryptedUserIdCandidates |
adIdentifiers.encryptedUserIds |
Each candidate ID maps to an EncryptedUserId object in the list. |
encryptionInfo.kind |
No equivalent | Metadata field; not used by the Data Manager API. |
encryptionInfo.encryptionEntityType |
adIdentifiers.encryptedUserIds[].entityType |
Instead of specifying the encryption info once per request, it is specified per encrypted user ID. |
encryptionInfo.encryptionEntityId |
adIdentifiers.encryptedUserIds[].entityId |
Instead of specifying the encryption info once per request, it is specified per encrypted user ID. |
encryptionInfo.encryptionSource |
adIdentifiers.encryptedUserIds[].source |
Instead of specifying the encryption info once per request, it is specified per encrypted user ID. |
sessionAttributesEncoded |
adIdentifiers.sessionAttributes |
See AdIdentifiers for more details. |
cartData |
cartData |
See Cart data fields for details. |
userIdentifiers |
userData.userIdentifiers |
See User identifier fields for details. |
User identifier fields
In the Data Manager API, user identifiers are grouped within a
UserData object under the userData field of the
Event. This differs from the Campaign Manager 360 API, where identifiers are directly
attached to the Conversion object.
UserIdentifier (Campaign Manager 360 API) |
UserIdentifier (Data Manager API) |
Notes |
|---|---|---|
hashedEmail |
emailAddress |
Set to the formatted and hashed email address. You can also encrypt the hashed email address. |
hashedPhoneNumber |
phoneNumber |
Set to the formatted and hashed phone number. You can also encrypt the hashed phone number. |
addressInfo |
address |
Set to an AddressInfo object. Follow the formatting and hashing guidelines. You can also encrypt the hashed attributes of an address. |
addressInfo.hashedFirstName |
address.givenName |
|
addressInfo.hashedLastName |
address.familyName |
|
addressInfo.countryCode |
address.regionCode |
|
addressInfo.postalCode |
address.postalCode |
|
addressInfo.city |
No equivalent | Not supported in the current version of the Data Manager API. |
addressInfo.state |
No equivalent | Not supported in the current version of the Data Manager API. |
addressInfo.hashedStreetAddress |
No equivalent | Not supported in the current version of the Data Manager API. |
Cart data fields
CartData (Campaign Manager 360 API) |
CartData (Data Manager API) |
Notes |
|---|---|---|
kind |
No equivalent | Metadata field; not used by the Data Manager API. |
merchantId |
merchantId |
|
merchantFeedLabel |
merchantFeedLabel |
|
merchantFeedLanguage |
merchantFeedLanguageCode |
|
items |
items |
A list of Item objects. See Item fields for more details.. |
Item fields for cart data
Item (Campaign Manager 360 API) |
Item (Data Manager API) |
Notes |
|---|---|---|
kind |
No equivalent | Metadata field; not used by the Data Manager API. |
| No equivalent | itemId |
Optional. A unique identifier for the item. |
itemId |
merchantProductId |
Required. Set to the Merchant Center product ID for the item. |
quantity |
quantity |
Required. |
unitPrice |
unitPrice |
Required. |