Package recombee_api_client :: Package api_requests :: Module add_user_property :: Class AddUserProperty
[hide private]
[frames] | no frames]

Class AddUserProperty

source code

     object --+    
              |    
request.Request --+
                  |
                 AddUserProperty

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.

Instance Methods [hide private]
 
__init__(self, property_name, type)
Required parameters:
source code
 
get_body_parameters(self)
Values of body parameters as a dictionary (name of parameter: value of the parameter).
source code
 
get_query_parameters(self)
Values of query parameters as a dictionary (name of parameter: value of the parameter).
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]

Inherited from request.Request: quote_path_param

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, property_name, type)
(Constructor)

source code 

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.

Overrides: object.__init__