Spotify.NET/web/personalization.html
2020-03-09 19:50:13 +00:00

29 lines
18 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Personalization | SpotifyAPI-NET</title>
<meta name="description" content="🔉 An API for the Spotify-Client and the Spotify Web API, written in C#/.NET">
<link rel="preload" href="/SpotifyAPI-NET/assets/css/0.styles.d9299793.css" as="style"><link rel="preload" href="/SpotifyAPI-NET/assets/js/app.bbaebb05.js" as="script"><link rel="preload" href="/SpotifyAPI-NET/assets/js/2.287d9ab7.js" as="script"><link rel="preload" href="/SpotifyAPI-NET/assets/js/18.9d99294a.js" as="script"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/10.81642073.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/11.7371183a.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/12.e1511024.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/13.77befe42.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/14.d80587f4.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/15.321c151d.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/16.fd1aff28.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/17.7360dccd.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/19.80197dc7.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/20.7af15869.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/21.387f41fb.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/22.96500635.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/23.6d1546f5.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/24.be2f7a96.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/25.6979c250.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/26.3876e2f9.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/3.0be01aa8.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/4.a1a659d3.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/5.e6e88ab3.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/6.f529ddfb.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/7.a8a3630c.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/8.a3754bd9.js"><link rel="prefetch" href="/SpotifyAPI-NET/assets/js/9.dbbf5553.js">
<link rel="stylesheet" href="/SpotifyAPI-NET/assets/css/0.styles.d9299793.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/SpotifyAPI-NET/" class="home-link router-link-active"><!----> <span class="site-name">SpotifyAPI-NET</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/SpotifyAPI-NET/" class="nav-link">Home</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="SpotifyAPI.Web" class="dropdown-title"><span class="title">SpotifyAPI.Web</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/getting_started.html" class="nav-link">Getting Started</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/examples.html" class="nav-link">Examples</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/proxy.html" class="nav-link">Proxy</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/albums.html" class="nav-link">- Albums</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/artists.html" class="nav-link">- Artists</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/browse.html" class="nav-link">- Browse</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/follow.html" class="nav-link">- Follow</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/library.html" class="nav-link">- Library</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/personalization.html" class="nav-link router-link-exact-active router-link-active">- Personalization</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/player.html" class="nav-link">- Player</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/playlists.html" class="nav-link">- Playlists</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/profiles.html" class="nav-link">- Profiles</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/search.html" class="nav-link">- Search</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/tracks.html" class="nav-link">- Tracks</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/utils.html" class="nav-link">Utilities</a></li></ul></div></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="SpotifyAPI.Auth" class="dropdown-title"><span class="title">SpotifyAPI.Auth</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/getting_started.html" class="nav-link">Getting Started</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/implicit_grant.html" class="nav-link">- ImplicitGrantAuth</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/token_swap.html" class="nav-link">- TokenSwapAuth</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/authorization_code.html" class="nav-link">- AutorizationCodeAuth</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/client_credentials.html" class="nav-link">- ClientCredentialsAuth</a></li></ul></div></div> <a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="repo-link">
🚀 GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/SpotifyAPI-NET/" class="nav-link">Home</a></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="SpotifyAPI.Web" class="dropdown-title"><span class="title">SpotifyAPI.Web</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/getting_started.html" class="nav-link">Getting Started</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/examples.html" class="nav-link">Examples</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/proxy.html" class="nav-link">Proxy</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/albums.html" class="nav-link">- Albums</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/artists.html" class="nav-link">- Artists</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/browse.html" class="nav-link">- Browse</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/follow.html" class="nav-link">- Follow</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/library.html" class="nav-link">- Library</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/personalization.html" class="nav-link router-link-exact-active router-link-active">- Personalization</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/player.html" class="nav-link">- Player</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/playlists.html" class="nav-link">- Playlists</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/profiles.html" class="nav-link">- Profiles</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/search.html" class="nav-link">- Search</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/tracks.html" class="nav-link">- Tracks</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/web/utils.html" class="nav-link">Utilities</a></li></ul></div></div><div class="nav-item"><div class="dropdown-wrapper"><button type="button" aria-label="SpotifyAPI.Auth" class="dropdown-title"><span class="title">SpotifyAPI.Auth</span> <span class="arrow right"></span></button> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/getting_started.html" class="nav-link">Getting Started</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/implicit_grant.html" class="nav-link">- ImplicitGrantAuth</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/token_swap.html" class="nav-link">- TokenSwapAuth</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/authorization_code.html" class="nav-link">- AutorizationCodeAuth</a></li><li class="dropdown-item"><!----> <a href="/SpotifyAPI-NET/auth/client_credentials.html" class="nav-link">- ClientCredentialsAuth</a></li></ul></div></div> <a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET" target="_blank" rel="noopener noreferrer" class="repo-link">
🚀 GitHub
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>Personalization</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/SpotifyAPI-NET/web/personalization.html#getuserstoptracks" class="sidebar-link">GetUsersTopTracks</a></li><li><a href="/SpotifyAPI-NET/web/personalization.html#getuserstopartists" class="sidebar-link">GetUsersTopArtists</a></li><li><a href="/SpotifyAPI-NET/web/personalization.html#getusersrecentlyplayedtracks" class="sidebar-link">GetUsersRecentlyPlayedTracks</a></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="personalization"><a href="#personalization" aria-hidden="true" class="header-anchor">#</a> Personalization</h1> <h2 id="getuserstoptracks"><a href="#getuserstoptracks" aria-hidden="true" class="header-anchor">#</a> GetUsersTopTracks</h2> <blockquote><p>Get the current users top tracks based on calculated affinity.</p></blockquote> <p><strong>Parameters</strong></p> <table><thead><tr><th>Name</th> <th>Description</th> <th>Example</th></tr></thead> <tbody><tr><td>[timeRange]</td> <td>Over what time frame the affinities are compute.</td> <td><code>TimeRangeType.MediumTerm</code></td></tr> <tr><td>[limit]</td> <td>The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</td> <td><code>20</code></td></tr> <tr><td>[offset]</td> <td>The index of the first entity to return. Default: 0 (i.e., the first track). Use with limit to get the next set of entities.</td> <td><code>0</code></td></tr></tbody></table> <p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#track-object-full" target="_blank" rel="noopener noreferrer">FullTrack<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> wrapped inside a <a href="https://developer.spotify.com/web-api/object-model/#paging-object" target="_blank" rel="noopener noreferrer">Paging-object<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></p> <p><strong>Usage</strong></p> <div class="language- extra-class"><pre class="language-text"><code>Paging&lt;FullTrack&gt; tracks = _spotify.GetUsersTopTracks();
tracks.Items.ForEach(item =&gt; Console.WriteLine(item.Name)); //Display all fetched Track-Names (max 20)
Console.WriteLine(tracks.Total.ToString()) //Display total album track count
</code></pre></div><hr> <h2 id="getuserstopartists"><a href="#getuserstopartists" aria-hidden="true" class="header-anchor">#</a> GetUsersTopArtists</h2> <blockquote><p>Get the current users top artists based on calculated affinity.</p></blockquote> <p><strong>Parameters</strong></p> <table><thead><tr><th>Name</th> <th>Description</th> <th>Example</th></tr></thead> <tbody><tr><td>[timeRange]</td> <td>Over what time frame the affinities are compute.</td> <td><code>TimeRangeType.MediumTerm</code></td></tr> <tr><td>[limit]</td> <td>The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</td> <td><code>20</code></td></tr> <tr><td>[offset]</td> <td>The index of the first entity to return. Default: 0 (i.e., the first track). Use with limit to get the next set of entities.</td> <td><code>0</code></td></tr></tbody></table> <p>Returns a <a href="https://developer.spotify.com/web-api/object-model/#artist-object-full" target="_blank" rel="noopener noreferrer">FullArtist<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> wrapped inside a <a href="https://developer.spotify.com/web-api/object-model/#paging-object" target="_blank" rel="noopener noreferrer">Paging-object<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></p> <p><strong>Usage</strong></p> <div class="language- extra-class"><pre class="language-text"><code>Paging&lt;FullArtist&gt; artists = _spotify.GetUsersTopArtists();
artists.Items.ForEach(item =&gt; Console.WriteLine(item.Name)); //Display all fetched Artist-Names (max 20)
</code></pre></div><hr> <h2 id="getusersrecentlyplayedtracks"><a href="#getusersrecentlyplayedtracks" aria-hidden="true" class="header-anchor">#</a> GetUsersRecentlyPlayedTracks</h2> <blockquote><p>Get tracks from the current users recent play history.</p></blockquote> <p><strong>Parameters</strong></p> <table><thead><tr><th>Name</th> <th>Description</th> <th>Example</th></tr></thead> <tbody><tr><td>[limit]</td> <td>The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</td> <td><code>20</code></td></tr> <tr><td>[after]</td> <td>Returns all items after (but not including) this cursor position.</td> <td><code>DateTime.Now.AddDays(-1)</code></td></tr> <tr><td>[before]</td> <td>Returns all items before (but not including) this cursor position.</td> <td><code>DateTime.Now.AddDays(-1)</code></td></tr></tbody></table> <p>Returns a <code>PlayHistory</code> wrapped inside a <a href="https://developer.spotify.com/web-api/object-model/#cursor-based-paging-object" target="_blank" rel="noopener noreferrer">CursorPaging-object<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></p> <p><strong>Usage</strong></p> <div class="language- extra-class"><pre class="language-text"><code>CursorPaging&lt;PlayHistory&gt; histories = _spotify.GetUsersRecentlyPlayedTracks();
histories.Items.ForEach(item =&gt; Console.WriteLine(item.Track.Name));
</code></pre></div><hr></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/JohnnyCrazy/SpotifyAPI-NET/edit/master/SpotifyAPI.Docs/docs/web/personalization.md" target="_blank" rel="noopener noreferrer">Help us improve this page!</a> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></div> <div class="last-updated"><span class="prefix">Last Updated:</span> <span class="time">3/9/2020, 7:48:14 PM</span></div></footer> <!----> </main></div><div class="global-ui"></div></div>
<script src="/SpotifyAPI-NET/assets/js/app.bbaebb05.js" defer></script><script src="/SpotifyAPI-NET/assets/js/2.287d9ab7.js" defer></script><script src="/SpotifyAPI-NET/assets/js/18.9d99294a.js" defer></script>
</body>
</html>