Interface: RecommendationParams

Hierarchy

RecommendationParams

Index

Properties

`Optional` artistPlayCounts

• artistPlayCounts? : ArtistPlay[]

An array of objects each containing an artistName string, and a corresponding playCount integer. Used in conjunction with the MUSICMATCH parameter.

`Optional` country

• country? : undefined | string

Three digit country ISO code used to specify from which Radioplayer region we want to receive recommendations

`Optional` facebookArtists

• facebookArtists? : string[]

An array of artist names that when used in conjunction with the MUSICMATCH parameter can help tailor recommendations.

factors

• factors: Factors[]

What factors do you want to influence your recommendations? Multiple factors can be used. Possible values are "GEO", "TRENDING", "AFFINITY", and "MUSICMATCH"

`Optional` latitude

• latitude? : undefined | number

Recommendations can be tailored based on the user's location when the GEO factor is included - an optional latitude and longitude can be included in the body

`Optional` longitude

• longitude? : undefined | number

Recommendations can be tailored based on the user's location when the GEO factor is included - an optional latitude and longitude can be included in the body

`Optional` onDemand

• onDemand? : undefined | false | true

If true, on demand items will be included in the recommendations. Default is false.

`Optional` rpuid

• rpuid? : undefined | string

A station rpuid, typically the last listened or currently listened to station. This influences recommendations when the AFFINITY factor is included