recommendationengine.projects.locations.catalogs.event Stores.user Events.write
POST {{baseUrl}}/v1beta1/:parent/userEvents:write?$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Writes a single user event.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
Request Body
{"eventDetail"=>{"eventAttributes"=>{"categoricalFeatures"=>"<object>", "numericalFeatures"=>"<object>"}, "experimentIds"=>["<string>", "<string>"], "pageViewId"=>"<string>", "recommendationToken"=>"<string>", "referrerUri"=>"<string>", "uri"=>"<string>"}, "eventSource"=>"<string>", "eventTime"=>"<google-datetime>", "eventType"=>"<string>", "productEventDetail"=>{"cartId"=>"<string>", "listId"=>"<string>", "pageCategories"=>[{"categories"=>["<string>", "<string>"]}, {"categories"=>["<string>", "<string>"]}], "productDetails"=>[{"availableQuantity"=>"<integer>", "currencyCode"=>"<string>", "displayPrice"=>"<float>", "id"=>"<string>", "itemAttributes"=>{"categoricalFeatures"=>"<object>", "numericalFeatures"=>"<object>"}, "originalPrice"=>"<float>", "quantity"=>"<integer>", "stockState"=>"<string>"}, {"availableQuantity"=>"<integer>", "currencyCode"=>"<string>", "displayPrice"=>"<float>", "id"=>"<string>", "itemAttributes"=>{"categoricalFeatures"=>"<object>", "numericalFeatures"=>"<object>"}, "originalPrice"=>"<float>", "quantity"=>"<integer>", "stockState"=>"<string>"}], "purchaseTransaction"=>{"costs"=>"<object>", "currencyCode"=>"<string>", "id"=>"<string>", "revenue"=>"<float>", "taxes"=>"<object>"}, "searchQuery"=>"<string>"}, "userInfo"=>{"directUserRequest"=>"<boolean>", "ipAddress"=>"<string>", "userAgent"=>"<string>", "userId"=>"<string>", "visitorId"=>"<string>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"eventDetail":{"eventAttributes":{"categoricalFeatures":"\u003cobject\u003e","numericalFeatures":"\u003cobject\u003e"},"experimentIds":["\u003cstring\u003e","\u003cstring\u003e"],"pageViewId":"\u003cstring\u003e","recommendationToken":"\u003cstring\u003e","referrerUri":"\u003cstring\u003e","uri":"\u003cstring\u003e"},"eventSource":"\u003cstring\u003e","eventTime":"\u003cgoogle-datetime\u003e","eventType":"\u003cstring\u003e","productEventDetail":{"cartId":"\u003cstring\u003e","listId":"\u003cstring\u003e","pageCategories":[{"categories":["\u003cstring\u003e","\u003cstring\u003e"]},{"categories":["\u003cstring\u003e","\u003cstring\u003e"]}],"productDetails":[{"availableQuantity":"\u003cinteger\u003e","currencyCode":"\u003cstring\u003e","displayPrice":"\u003cfloat\u003e","id":"\u003cstring\u003e","itemAttributes":{"categoricalFeatures":"\u003cobject\u003e","numericalFeatures":"\u003cobject\u003e"},"originalPrice":"\u003cfloat\u003e","quantity":"\u003cinteger\u003e","stockState":"\u003cstring\u003e"},{"availableQuantity":"\u003cinteger\u003e","currencyCode":"\u003cstring\u003e","displayPrice":"\u003cfloat\u003e","id":"\u003cstring\u003e","itemAttributes":{"categoricalFeatures":"\u003cobject\u003e","numericalFeatures":"\u003cobject\u003e"},"originalPrice":"\u003cfloat\u003e","quantity":"\u003cinteger\u003e","stockState":"\u003cstring\u003e"}],"purchaseTransaction":{"costs":"\u003cobject\u003e","currencyCode":"\u003cstring\u003e","id":"\u003cstring\u003e","revenue":"\u003cfloat\u003e","taxes":"\u003cobject\u003e"},"searchQuery":"\u003cstring\u003e"},"userInfo":{"directUserRequest":"\u003cboolean\u003e","ipAddress":"\u003cstring\u003e","userAgent":"\u003cstring\u003e","userId":"\u003cstring\u003e","visitorId":"\u003cstring\u003e"}}