recommendationengine.projects.locations.catalogs.event Stores.placements.predict
POST {{baseUrl}}/v1beta1/{{name}}:predict?$.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>
Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. Learn more.
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
{"dryRun"=>"<boolean>", "filter"=>"<string>", "labels"=>"<object>", "pageSize"=>"<integer>", "pageToken"=>"<string>", "params"=>"<object>", "userEvent"=>{"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
{"dryRun":true,"itemsMissingInCatalog":["amet consectetur","amet nostrud culpa"],"metadata":{},"nextPageToken":"ea amet aliqua dolore","recommendationToken":"ex occae","results":[{"id":"Ut commodo magna eiusmod sunt","itemMetadata":{}},{"id":"ad","itemMetadata":{}}]}