Package recombee_api_client :: Package api_requests :: Module set_user_values :: Class SetUserValues
[hide private]
[frames] | no frames]

Class SetUserValues

source code

      object --+        
               |        
 request.Request --+    
                   |    
set_values.SetValues --+
                       |
                      SetUserValues

Set/update (some) property values of a given user. The properties (columns) must be previously created by [Add user property](https://docs.recombee.com/api.html#add-user-property).

Instance Methods [hide private]
 
__init__(self, user_id, values, cascade_create=None)
Required parameters: @param user_id: ID of the user which will be modified.
source code

Inherited from set_values.SetValues: get_body_parameters, get_query_parameters

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, user_id, values, cascade_create=None)
(Constructor)

source code 

Required parameters:
@param user_id: ID of the user which will be modified.


@param values: The values for the individual properties.

Example:

```

E{lb}

    "country": "US",
    "sex": "F",
E{rb}

```

Optional parameters:

@param cascade_create: Sets whether the given user should be created if not present in the database.

Parameters:
  • values - The values for the individual properties.

    Example:

    ```

    {

    "product_description": "4K TV with 3D feature",

    "categories": ["Electronics", "Televisions"],

    "price_usd": 342,

    "!cascadeCreate": True }

    Optional parameters:

  • cascade_create - Sets whether the given enity should be created if not present in the database. ```
Overrides: object.__init__