SetUserValues

Extends \Recombee\RecommApi\Requests\SetValues

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).

package

Default

Methods

Construct the request

__construct(array $values, array $optional = array()) 
inherited

Arguments

$values

array

The values for the individual properties. Example of body:

  {
    "product_description": "4K TV with 3D feature",
    "categories":   ["Electronics", "Televisions"],
    "price_usd": 342,
  }

$optional

array

Optional parameters given as an array containing pairs name of the parameter => value

  • Allowed parameters:
    • cascadeCreate
      • Type: bool
      • Description: Sets whether the given entity should be created if not present in the database.

Get body parameters

getBodyParameters() : array
inherited abstract

Response

array

Values of body parameters (name of parameter => value of the parameter)

Returns true if HTTPS must be chosen over HTTP for this request

getEnsureHttps() : boolean
inherited

Response

boolean

true if HTTPS must be chosen

Get used HTTP method

getMethod() : static
inherited abstract

Response

static

Used HTTP method

Get URI to the endpoint

getPath() : string
inherited abstract

Response

string

URI to the endpoint

Get query parameters

getQueryParameters() : array
inherited abstract

Response

array

Values of query parameters (name of parameter => value of the parameter)

Get request timeout

getTimeout() : integer
inherited

Response

integer

Request timeout in milliseconds

Sets if HTTPS must be chosen over HTTP for this request

setEnsureHttps( $ensure_https) 
inherited

Arguments

$ensure_https

Sets request timeout

setTimeout( $timeout) 
inherited

Arguments

$timeout

Properties

ID of the user which will be modified.

user_id : string
var

ID of the user which will be modified.

Type(s)

string

The values for the individual properties. Example of body: ``` { "product_description": "4K TV with 3D feature", "categories": ["Electronics", "Televisions"], "price_usd": 342, } ```

values : array
inherited
var

The values for the individual properties. Example of body:

  {
    "product_description": "4K TV with 3D feature",
    "categories":   ["Electronics", "Televisions"],
    "price_usd": 342,
  }

Type(s)

array

Sets whether the given user/item should be created if not present in the database.

cascade_create : boolean
inherited
var

Sets whether the given user/item should be created if not present in the database.

Type(s)

boolean

Timeout of the request in milliseconds

timeout : integer
inherited
var

Timeout of the request in milliseconds

Type(s)

integer

Sets if the HTTPS must be chosen over HTTP for this request

ensure_https : boolean
inherited
var

Sets if the HTTPS must be chosen over HTTP for this request

Type(s)

boolean