recombee_api_client.api_requests.add_user_property module¶
-
class
recombee_api_client.api_requests.add_user_property.
AddUserProperty
(property_name: str, type: str)¶ Bases:
recombee_api_client.api_requests.request.Request
Adding an user property is somehow equivalent to adding a column to the table of users. The users may be characterized by various properties of different types.
Required parameters:
- Parameters
property_name – Name of the user property to be created. Currently, the following names are reserved:id, userid, case insensitively. Also, the length of the property name must not exceed 63 characters.
type – Value type of the user property to be created. One of: int, double, string, boolean, timestamp, set.
int - Signed integer number.
double - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).
string - UTF-8 string.
boolean - true / false
timestamp - Value representing date and time.
set - Set of strings.
-
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).