recombee_api_client.api_requests.merge_users module

class recombee_api_client.api_requests.merge_users.MergeUsers(target_user_id: str, source_user_id: str, cascade_create: bool = UUID('93b78bbb-b8cf-44f1-a19e-b967ddc5a03e'))

Bases: recombee_api_client.api_requests.request.Request

Merges interactions (purchases, ratings, bookmarks, detail views …) of two different users under a single user ID. This is especially useful for online e-commerce applications working with anonymous users identified by unique tokens such as the session ID. In such applications, it may often happen that a user owns a persistent account, yet accesses the system anonymously while, e.g., putting items into a shopping cart. At some point in time, such as when the user wishes to confirm the purchase, (s)he logs into the system using his/her username and password. The interactions made under anonymous session ID then become connected with the persistent account, and merging these two together becomes desirable.

Merging happens between two users referred to as the target and the source. After the merge, all the interactions of the source user are attributed to the target user, and the source user is deleted.

Required parameters:

Parameters

• target_user_id – ID of the targer user.

• source_user_id – ID of the source user.

Optional parameters:

Parameters

cascade_create – Sets whether the user targetUserId should be created if not present in the database.

get_body_parameters() → dict

Values of body parameters as a dictionary (name of parameter: value of the parameter).

get_query_parameters() → dict

Values of query parameters as a dictionary (name of parameter: value of the parameter).