User profiles import
Use this feature to UPSERT or DELETE user profiles in your datamart.
How-to
Use the bulk import endpoints to create a document import with theUSER_PROFILE
document type and APPLICATION_X_NDJSON
mime type. Only ndjson
data is supported for user profiles.
Then, create an execution with your user profile import commands formatted in ndjson
.
User profile import command
Each line in the uploaded file can have the following properties:
field
type
description
operation
Enum
Either UPSERT
or DELETE
compartment_id
String (Optional)
The Compartment ID, acting as a user identifier in correlation with user_account_id
user_account_id
String (Optional)
The User Account ID, acting as an identifier in correlation with compartment_id
force_replace
Boolean (Optional)
Mandatory when the operation is UPSERT
.
If true, then the User Profile will be completely replaced by the object passed in the user_profile field.
If false, the object passed in the user_profile
field will be merged with the existing User Profile of the User Point.
merge_objects
Boolean (Optional)
Only considered if force_replace
is false.
Manage the comportement between two objects with a same property.
If false (default value), the new object overrides the existing one.
If true the new object is merged in deep to the existing one (see example).
user_profile
JSON Object (Optional)
Mandatory when operation == UPSERT.
JSON Object representing the User Profile. Please refer to the user profile object for more information.
Example
You can, of course, upload multiple user profiles at once. Note the uploaded data is in ndjson
and not json
. That means the different profiles are not separated by commas, but by a line separator \n
When importing profiles with identifiers, only one identifier is allowed per line. For example, you shouldn't specify the user agent ID if the Email Hash is already used in a line.
More details on merge_objects
behavior :
Last updated