This is one of several requests that demonstrates how Rovi can generate personalized entertainment recommendations for your customers. To understand this feature, we suggest working with these calls in this order:
| This Request . . . | Demonstrates . . . |
|
How an item taste profile gets added to a user taste profile. What an item taste profile looks like. What a user taste profile looks like. How personalized recommendations are generated from a user taste profile. |
Event modifies the taste profile of the user based on a user action or opinion. A taste profile consists of normalized scores of Rovi entertainment categories, and the user action determines the categories and the algorithm that are applied. For example, if a user clicks Like on an item, the taste profile of that item is added to the taste profile of the user.
Notes:
| endpoint/event? | nameid=nameid trackid=trackid albumid=albumid amgvideoid=amgvideoid cosmoprogramid=cosmoprogramid |
&apikey=apikey&sig=sig& userid=userid [&rating=rating] [×tamp=timestamp] |
| Parameter | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| apikey | Yes | Access code that authorizes your request for data from Rovi. | ||||||||
| endpoint | Yes | Database of the item.
| ||||||||
| event | Yes | One of the following user events:
| ||||||||
| sig | Yes | A calculated authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three strings:
Perform the calculation at the time of each request to be sure it's within a five-minute window of the server time. If you're testing the call in a browser, use our online signature generator to perform the calculation. | ||||||||
| userid | Yes | ID of the user. IDs that have not been used before are automatically created. | ||||||||
| albumid | Conditional | Rovi Music ID for an album, consisting of the prefix MW followed by a ten-digit number. For a request with an album ID, specify an endpoint of music. Here are some album IDs you can use for evaluation tests:
Condition: The request must contain just one of these parameters, unless the event type is reset:
| ||||||||
| amgvideoid | Conditional | All Media Guide (AMG) database ID for a movie or TV series, consisting of a ten-character string that starts with V and is followed by 9 digits with leading spaces. For a request with an amgvideo ID, specify an endpoint of amgvideo. Here are some amgvideo IDs you can use for evaluation tests:
Condition: The request must contain just one of these parameters, unless the event type is reset:
| ||||||||
| cosmoprogramid | Conditional | Cosmo database ID for a movie or television series. For a request with a Cosmo ID, specify an endpoint of video. Here are some Cosmo IDs you can use for evaluation tests:
Condition: The request must contain just one of these parameters, unless the event type is reset:
| ||||||||
| nameid | Conditional | Rovi Name ID for a person or group that has worked in music, consisting of the prefix MN followed by a ten-digit number. For a request with a name ID, specify an endpoint of music. Here are some name IDs you can use for evaluation tests:
Condition: The request must contain just one of these parameters, unless the event type is reset:
| ||||||||
| rating | Conditional | User rating from 0 to 100 for the content that is specified by the ID.
Condition: Required for an event of rate. Does not apply to other events. | ||||||||
| trackid | Conditional | Rovi Music ID for a song, consisting of the prefix MT followed by a ten-digit number. For a request with a track ID, specify an endpoint of music. Here are some track IDs you can use for evaluation tests:
Condition: The request must contain just one of these parameters, unless the event type is reset:
| ||||||||
| timestamp | No | Time of the event, specified in one of the following formats:
|
| Response | Type | Description |
|---|---|---|
| controlSet | ControlSet | The HTTP response status. |
| id | string | Server transaction ID for the response. |
| Response | Type | Description |
|---|---|---|
| messages | message [ ] | Success message or error message. |