Shared
ModelsExpand Collapse
class AlbumRestrictionObject:
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Reason> reason
The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content. Additional reasons may be added in the future.
class ArtistObject:
Optional<String> id
The Spotify ID for the artist.
Known external URLs for this artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Information about the followers of the artist.
Optional<String> href
This will always be set to null, as the Web API does not support it at the moment.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Long> total
The total number of followers.
Optional<List<String>> genres
A list of the genres the artist is associated with. If not yet classified, the array is empty.
Optional<String> href
A link to the Web API endpoint providing full details of the artist.
Images of the artist in various sizes, widest first.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> name
The name of the artist.
Optional<Long> popularity
The popularity of the artist. The value will be between 0 and 100, with 100 being the most popular. The artist's popularity is calculated from the popularity of all the artist's tracks.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Type> type
The object type.
Optional<String> uri
The Spotify URI for the artist.
class AudiobookBase:
String id
The Spotify ID for the audiobook.
List<AuthorObject> authors
The author(s) for the audiobook.
Optional<String> name
The name of the author.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
List<String> availableMarkets
A list of the countries in which the audiobook can be played, identified by their ISO 3166-1 alpha-2 code.
List<CopyrightObject> copyrights
The copyright statements of the audiobook.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> text
The copyright text for this content.
Optional<String> type
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
String description
A description of the audiobook. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
boolean explicit
Whether or not the audiobook has explicit content (true = yes it does; false = no it does not OR unknown).
ExternalUrlObject externalUrls
External URLs for this audiobook.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
String href
A link to the Web API endpoint providing full details of the audiobook.
String htmlDescription
A description of the audiobook. This field may contain HTML tags.
List<ImageObject> images
The cover art for the audiobook in various sizes, widest first.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
List<String> languages
A list of the languages used in the audiobook, identified by their ISO 639 code.
String mediaType
The media type of the audiobook.
String name
The name of the audiobook.
List<NarratorObject> narrators
The narrator(s) for the audiobook.
Optional<String> name
The name of the Narrator.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
String publisher
The publisher of the audiobook.
long totalChapters
The number of chapters in this audiobook.
JsonValue; type "audiobook"constant"audiobook"constant
The object type.
String uri
The Spotify URI for the audiobook.
Optional<String> edition
The edition of the audiobook.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
class AuthorObject:
Optional<String> name
The name of the author.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
class ChapterRestrictionObject:
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> reason
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.payment_required- Payment is required to play the content item.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
class CopyrightObject:
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> text
The copyright text for this content.
Optional<String> type
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
class EpisodeObject:
String id
The Spotify ID for the episode.
DeprecatedOptional<String> audioPreviewUrl
A URL to a 30 second preview (MP3 format) of the episode. null if not available.
String description
A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
long durationMs
The episode length in milliseconds.
boolean explicit
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
ExternalUrlObject externalUrls
External URLs for this episode.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
String href
A link to the Web API endpoint providing full details of the episode.
String htmlDescription
A description of the episode. This field may contain HTML tags.
List<ImageObject> images
The cover art for the episode in various sizes, widest first.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
boolean isExternallyHosted
True if the episode is hosted outside of Spotify's CDN.
boolean isPlayable
True if the episode is playable in the given market. Otherwise false.
List<String> languages
A list of the languages used in the episode, identified by their ISO 639-1 code.
String name
The name of the episode.
String releaseDate
The date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".
ReleaseDatePrecision releaseDatePrecision
The precision with which release_date value is known.
ShowBase show
The show on which the episode belongs.
String id
The Spotify ID for the show.
List<String> availableMarkets
A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
List<CopyrightObject> copyrights
The copyright statements of the show.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> text
The copyright text for this content.
Optional<String> type
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
String description
A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
boolean explicit
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
ExternalUrlObject externalUrls
External URLs for this show.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
String href
A link to the Web API endpoint providing full details of the show.
String htmlDescription
A description of the show. This field may contain HTML tags.
List<ImageObject> images
The cover art for the show in various sizes, widest first.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
boolean isExternallyHosted
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
List<String> languages
A list of the languages used in the show, identified by their ISO 639 code.
String mediaType
The media type of the show.
String name
The name of the episode.
String publisher
The publisher of the show.
long totalEpisodes
The total number of episodes in the show.
JsonValue; type "show"constant"show"constant
The object type.
String uri
The Spotify URI for the show.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
JsonValue; type "episode"constant"episode"constant
The object type.
String uri
The Spotify URI for the episode.
DeprecatedOptional<String> language
The language used in the episode, identified by a ISO 639 code. This field is deprecated and might be removed in the future. Please use the languages field instead.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> reason
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
Optional<Boolean> fullyPlayed
Whether or not the episode has been fully played by the user.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Long> resumePositionMs
The user's most recent position in the episode in milliseconds.
class EpisodeRestrictionObject:
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> reason
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
class ExternalIdObject:
Optional<String> ean
Optional<String> isrc
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> upc
class ExternalUrlObject:
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
class FollowersObject:
Optional<String> href
This will always be set to null, as the Web API does not support it at the moment.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Long> total
The total number of followers.
class ImageObject:
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
class LinkedTrackObject:
Optional<String> id
The Spotify ID for the track.
Known external URLs for this track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> type
The object type: "track".
Optional<String> uri
The Spotify URI for the track.
class NarratorObject:
Optional<String> name
The name of the Narrator.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
class PagingPlaylistObject:
String href
A link to the Web API endpoint returning the full result of the request
long limit
The maximum number of items in the response (as set in the query or by default).
Optional<String> next
URL to the next page of items. ( null if none)
long offset
The offset of the items returned (as set in the query or by default)
Optional<String> previous
URL to the previous page of items. ( null if none)
long total
The total number of items available to return.
Optional<String> id
The Spotify ID for the playlist.
Optional<Boolean> collaborative
true if the owner allows other users to modify the playlist.
Optional<String> description
The playlist description. Only returned for modified, verified playlists, otherwise null.
Known external URLs for this playlist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the playlist.
Images for the playlist. The array may be empty or contain up to three images. The images are returned by size in descending order. See Working with Playlists. Note: If returned, the source URL for the image (url) is temporary and will expire in less than a day.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> name
The name of the playlist.
Optional<Owner> owner
The user who owns the playlist
Optional<String> displayName
The name displayed on the user's profile. null if not available.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> snapshotId
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version
A collection containing a link ( href ) to the Web API endpoint where full details of the playlist's tracks can be retrieved, along with the total number of tracks in the playlist. Note, a track object may be null. This can happen if a track is no longer available.
Optional<String> href
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Long> total
Number of tracks in the playlist.
Optional<String> type
The object type: "playlist"
Optional<String> uri
The Spotify URI for the playlist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
class PlaylistTrackObject:
Optional<LocalDateTime> addedAt
The date and time the track or episode was added. Note: some very old playlists may return null in this field.
The Spotify user who added the track or episode. Note: some very old playlists may return null in this field.
Optional<String> id
The Spotify user ID for this user.
Known public external URLs for this user.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint for this user.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Type> type
The object type.
Optional<String> uri
The Spotify URI for this user.
Optional<Boolean> isLocal
Whether this track or episode is a local file or not.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Track> track
Information about the track or episode.
class TrackObject:
Optional<String> id
The Spotify ID for the track.
Optional<Album> album
The album on which the track appears. The album object includes a link in href to full information about the album.
String id
The Spotify ID for the album.
AlbumType albumType
The type of the album.
List<SimplifiedArtistObject> artists
The artists of the album. Each artist object includes a link in href to more detailed information about the artist.
Optional<String> id
The Spotify ID for the artist.
Known external URLs for this artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the artist.
Optional<String> name
The name of the artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Type> type
The object type.
Optional<String> uri
The Spotify URI for the artist.
List<String> availableMarkets
The markets in which the album is available: ISO 3166-1 alpha-2 country codes. NOTE: an album is considered available in a market when at least 1 of its tracks is available in that market.
ExternalUrlObject externalUrls
Known external URLs for this album.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
String href
A link to the Web API endpoint providing full details of the album.
List<ImageObject> images
The cover art for the album in various sizes, widest first.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
String name
The name of the album. In case of an album takedown, the value may be an empty string.
String releaseDate
The date the album was first released.
ReleaseDatePrecision releaseDatePrecision
The precision with which release_date value is known.
long totalTracks
The number of tracks in the album.
JsonValue; type "album"constant"album"constant
The object type.
String uri
The Spotify URI for the album.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Reason> reason
The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content. Additional reasons may be added in the future.
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
Optional<String> id
The Spotify ID for the artist.
Known external URLs for this artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the artist.
Optional<String> name
The name of the artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Type> type
The object type.
Optional<String> uri
The Spotify URI for the artist.
Optional<List<String>> availableMarkets
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
Optional<Long> discNumber
The disc number (usually 1 unless the album consists of more than one disc).
Optional<Long> durationMs
The track length in milliseconds.
Optional<Boolean> explicit
Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
Known external IDs for the track.
Optional<String> ean
Optional<String> isrc
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> upc
Known external URLs for this track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the track.
Optional<Boolean> isLocal
Whether or not the track is from a local file.
Optional<Boolean> isPlayable
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the linked_from object contains information about the originally requested track.
Optional<String> id
The Spotify ID for the track.
Known external URLs for this track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> type
The object type: "track".
Optional<String> uri
The Spotify URI for the track.
Optional<String> name
The name of the track.
Optional<Long> popularity
The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.
The popularity of a track is a value between 0 and 100, with 100 being the most popular. The popularity is calculated by algorithm and is based, in the most part, on the total number of plays the track has had and how recent those plays are.
Generally speaking, songs that are being played a lot now will have a higher popularity than songs that were played a lot in the past. Duplicate tracks (e.g. the same track from a single and an album) are rated independently. Artist and album popularity is derived mathematically from track popularity. Note: the popularity value may lag actual popularity by a few days: the value is not updated in real time.
DeprecatedOptional<String> previewUrl
A link to a 30 second preview (MP3 format) of the track. Can be null
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> reason
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
Optional<Long> trackNumber
The number of the track. If an album has several discs, the track number is the number on the specified disc.
Optional<Type> type
The object type: "track".
Optional<String> uri
The Spotify URI for the track.
class EpisodeObject:
String id
The Spotify ID for the episode.
DeprecatedOptional<String> audioPreviewUrl
A URL to a 30 second preview (MP3 format) of the episode. null if not available.
String description
A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
long durationMs
The episode length in milliseconds.
boolean explicit
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
ExternalUrlObject externalUrls
External URLs for this episode.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
String href
A link to the Web API endpoint providing full details of the episode.
String htmlDescription
A description of the episode. This field may contain HTML tags.
List<ImageObject> images
The cover art for the episode in various sizes, widest first.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
boolean isExternallyHosted
True if the episode is hosted outside of Spotify's CDN.
boolean isPlayable
True if the episode is playable in the given market. Otherwise false.
List<String> languages
A list of the languages used in the episode, identified by their ISO 639-1 code.
String name
The name of the episode.
String releaseDate
The date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".
ReleaseDatePrecision releaseDatePrecision
The precision with which release_date value is known.
ShowBase show
The show on which the episode belongs.
String id
The Spotify ID for the show.
List<String> availableMarkets
A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
List<CopyrightObject> copyrights
The copyright statements of the show.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> text
The copyright text for this content.
Optional<String> type
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
String description
A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
boolean explicit
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
ExternalUrlObject externalUrls
External URLs for this show.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
String href
A link to the Web API endpoint providing full details of the show.
String htmlDescription
A description of the show. This field may contain HTML tags.
List<ImageObject> images
The cover art for the show in various sizes, widest first.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
boolean isExternallyHosted
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
List<String> languages
A list of the languages used in the show, identified by their ISO 639 code.
String mediaType
The media type of the show.
String name
The name of the episode.
String publisher
The publisher of the show.
long totalEpisodes
The total number of episodes in the show.
JsonValue; type "show"constant"show"constant
The object type.
String uri
The Spotify URI for the show.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
JsonValue; type "episode"constant"episode"constant
The object type.
String uri
The Spotify URI for the episode.
DeprecatedOptional<String> language
The language used in the episode, identified by a ISO 639 code. This field is deprecated and might be removed in the future. Please use the languages field instead.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> reason
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
Optional<Boolean> fullyPlayed
Whether or not the episode has been fully played by the user.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Long> resumePositionMs
The user's most recent position in the episode in milliseconds.
class PlaylistTracksRefObject:
Optional<String> href
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Long> total
Number of tracks in the playlist.
class PlaylistUserObject:
Optional<String> id
The Spotify user ID for this user.
Known public external URLs for this user.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint for this user.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Type> type
The object type.
Optional<String> uri
The Spotify URI for this user.
class ResumePointObject:
Optional<Boolean> fullyPlayed
Whether or not the episode has been fully played by the user.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Long> resumePositionMs
The user's most recent position in the episode in milliseconds.
class ShowBase:
String id
The Spotify ID for the show.
List<String> availableMarkets
A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
List<CopyrightObject> copyrights
The copyright statements of the show.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> text
The copyright text for this content.
Optional<String> type
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
String description
A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
boolean explicit
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
ExternalUrlObject externalUrls
External URLs for this show.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
String href
A link to the Web API endpoint providing full details of the show.
String htmlDescription
A description of the show. This field may contain HTML tags.
List<ImageObject> images
The cover art for the show in various sizes, widest first.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
boolean isExternallyHosted
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
List<String> languages
A list of the languages used in the show, identified by their ISO 639 code.
String mediaType
The media type of the show.
String name
The name of the episode.
String publisher
The publisher of the show.
long totalEpisodes
The total number of episodes in the show.
JsonValue; type "show"constant"show"constant
The object type.
String uri
The Spotify URI for the show.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
class SimplifiedArtistObject:
Optional<String> id
The Spotify ID for the artist.
Known external URLs for this artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the artist.
Optional<String> name
The name of the artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Type> type
The object type.
Optional<String> uri
The Spotify URI for the artist.
class SimplifiedEpisodeObject:
String id
The Spotify ID for the episode.
DeprecatedOptional<String> audioPreviewUrl
A URL to a 30 second preview (MP3 format) of the episode. null if not available.
String description
A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
long durationMs
The episode length in milliseconds.
boolean explicit
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
ExternalUrlObject externalUrls
External URLs for this episode.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
String href
A link to the Web API endpoint providing full details of the episode.
String htmlDescription
A description of the episode. This field may contain HTML tags.
List<ImageObject> images
The cover art for the episode in various sizes, widest first.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
boolean isExternallyHosted
True if the episode is hosted outside of Spotify's CDN.
boolean isPlayable
True if the episode is playable in the given market. Otherwise false.
List<String> languages
A list of the languages used in the episode, identified by their ISO 639-1 code.
String name
The name of the episode.
String releaseDate
The date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".
ReleaseDatePrecision releaseDatePrecision
The precision with which release_date value is known.
JsonValue; type "episode"constant"episode"constant
The object type.
String uri
The Spotify URI for the episode.
DeprecatedOptional<String> language
The language used in the episode, identified by a ISO 639 code. This field is deprecated and might be removed in the future. Please use the languages field instead.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> reason
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
Optional<Boolean> fullyPlayed
Whether or not the episode has been fully played by the user.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Long> resumePositionMs
The user's most recent position in the episode in milliseconds.
class SimplifiedPlaylistObject:
Optional<String> id
The Spotify ID for the playlist.
Optional<Boolean> collaborative
true if the owner allows other users to modify the playlist.
Optional<String> description
The playlist description. Only returned for modified, verified playlists, otherwise null.
Known external URLs for this playlist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the playlist.
Images for the playlist. The array may be empty or contain up to three images. The images are returned by size in descending order. See Working with Playlists. Note: If returned, the source URL for the image (url) is temporary and will expire in less than a day.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> name
The name of the playlist.
Optional<Owner> owner
The user who owns the playlist
Optional<String> displayName
The name displayed on the user's profile. null if not available.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> snapshotId
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version
A collection containing a link ( href ) to the Web API endpoint where full details of the playlist's tracks can be retrieved, along with the total number of tracks in the playlist. Note, a track object may be null. This can happen if a track is no longer available.
Optional<String> href
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Long> total
Number of tracks in the playlist.
Optional<String> type
The object type: "playlist"
Optional<String> uri
The Spotify URI for the playlist.
class SimplifiedTrackObject:
Optional<String> id
The Spotify ID for the track.
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
Optional<String> id
The Spotify ID for the artist.
Known external URLs for this artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the artist.
Optional<String> name
The name of the artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Type> type
The object type.
Optional<String> uri
The Spotify URI for the artist.
Optional<List<String>> availableMarkets
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
Optional<Long> discNumber
The disc number (usually 1 unless the album consists of more than one disc).
Optional<Long> durationMs
The track length in milliseconds.
Optional<Boolean> explicit
Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
External URLs for this track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the track.
Optional<Boolean> isLocal
Whether or not the track is from a local file.
Optional<Boolean> isPlayable
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
Part of the response when Track Relinking is applied and is only part of the response if the track linking, in fact, exists. The requested track has been replaced with a different track. The track in the linked_from object contains information about the originally requested track.
Optional<String> id
The Spotify ID for the track.
Known external URLs for this track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> type
The object type: "track".
Optional<String> uri
The Spotify URI for the track.
Optional<String> name
The name of the track.
DeprecatedOptional<String> previewUrl
A URL to a 30 second preview (MP3 format) of the track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> reason
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
Optional<Long> trackNumber
The number of the track. If an album has several discs, the track number is the number on the specified disc.
Optional<String> type
The object type: "track".
Optional<String> uri
The Spotify URI for the track.
class TrackObject:
Optional<String> id
The Spotify ID for the track.
Optional<Album> album
The album on which the track appears. The album object includes a link in href to full information about the album.
String id
The Spotify ID for the album.
AlbumType albumType
The type of the album.
List<SimplifiedArtistObject> artists
The artists of the album. Each artist object includes a link in href to more detailed information about the artist.
Optional<String> id
The Spotify ID for the artist.
Known external URLs for this artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the artist.
Optional<String> name
The name of the artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Type> type
The object type.
Optional<String> uri
The Spotify URI for the artist.
List<String> availableMarkets
The markets in which the album is available: ISO 3166-1 alpha-2 country codes. NOTE: an album is considered available in a market when at least 1 of its tracks is available in that market.
ExternalUrlObject externalUrls
Known external URLs for this album.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
String href
A link to the Web API endpoint providing full details of the album.
List<ImageObject> images
The cover art for the album in various sizes, widest first.
Optional<Long> height
The image height in pixels.
String url
The source URL of the image.
Optional<Long> width
The image width in pixels.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
String name
The name of the album. In case of an album takedown, the value may be an empty string.
String releaseDate
The date the album was first released.
ReleaseDatePrecision releaseDatePrecision
The precision with which release_date value is known.
long totalTracks
The number of tracks in the album.
JsonValue; type "album"constant"album"constant
The object type.
String uri
The Spotify URI for the album.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Reason> reason
The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content. Additional reasons may be added in the future.
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
Optional<String> id
The Spotify ID for the artist.
Known external URLs for this artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the artist.
Optional<String> name
The name of the artist.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<Type> type
The object type.
Optional<String> uri
The Spotify URI for the artist.
Optional<List<String>> availableMarkets
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
Optional<Long> discNumber
The disc number (usually 1 unless the album consists of more than one disc).
Optional<Long> durationMs
The track length in milliseconds.
Optional<Boolean> explicit
Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
Known external IDs for the track.
Optional<String> ean
Optional<String> isrc
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> upc
Known external URLs for this track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the track.
Optional<Boolean> isLocal
Whether or not the track is from a local file.
Optional<Boolean> isPlayable
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the linked_from object contains information about the originally requested track.
Optional<String> id
The Spotify ID for the track.
Known external URLs for this track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> spotify
The Spotify URL for the object.
Optional<String> href
A link to the Web API endpoint providing full details of the track.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> type
The object type: "track".
Optional<String> uri
The Spotify URI for the track.
Optional<String> name
The name of the track.
Optional<Long> popularity
The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.
The popularity of a track is a value between 0 and 100, with 100 being the most popular. The popularity is calculated by algorithm and is based, in the most part, on the total number of plays the track has had and how recent those plays are.
Generally speaking, songs that are being played a lot now will have a higher popularity than songs that were played a lot in the past. Duplicate tracks (e.g. the same track from a single and an album) are rated independently. Artist and album popularity is derived mathematically from track popularity. Note: the popularity value may lag actual popularity by a few days: the value is not updated in real time.
DeprecatedOptional<String> previewUrl
A link to a 30 second preview (MP3 format) of the track. Can be null
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> reason
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
Optional<Long> trackNumber
The number of the track. If an album has several discs, the track number is the number on the specified disc.
Optional<Type> type
The object type: "track".
Optional<String> uri
The Spotify URI for the track.
class TrackRestrictionObject:
Optional<Boolean> published
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Optional<String> reason
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.