Package de.sonallux.spotify.api.apis.playlists

Class GetPlaylistsTracksRequest

java.lang.Object
de.sonallux.spotify.api.apis.playlists.GetPlaylistsTracksRequest
public class GetPlaylistsTracksRequest extends Object

Get Playlist Items request

Required OAuth scopes

playlist-read-private

Response

Pages of tracks

  • Constructor Details

    • GetPlaylistsTracksRequest

      public GetPlaylistsTracksRequest(ApiClient apiClient, String playlistId)
      Get Playlist Items request
      Parameters:
      apiClient -

      The API client

      playlistId -

      The Spotify ID of the playlist.

  • Method Details

    • market

      public GetPlaylistsTracksRequest market(String market)
      Parameters:
      market -

      An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.
      If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.
      Note: If neither market or user country are provided, the content is considered unavailable for the client.
      Users can view the country that is associated with their account in the account settings.

      Returns:
      this request

    • fields

      public GetPlaylistsTracksRequest fields(String fields)
      Parameters:
      fields -

      Filters for the query: a comma-separated list of the fields to return. If omitted, all fields are returned. For example, to get just the total number of items and the request limit:
      fields=total,limit
      A dot separator can be used to specify non-reoccurring fields, while parentheses can be used to specify reoccurring fields within objects. For example, to get just the added date and user ID of the adder:
      fields=items(added_at,added_by.id)
      Use multiple parentheses to drill down into nested objects, for example:
      fields=items(track(name,href,album(name,href)))
      Fields can be excluded by prefixing them with an exclamation mark, for example:
      fields=items.track.album(!external_urls,images)

      Returns:
      this request

    • limit

      public GetPlaylistsTracksRequest limit(int limit)
      Parameters:
      limit -

      The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 100.

      Returns:
      this request

    • offset

      public GetPlaylistsTracksRequest offset(int offset)
      Parameters:
      offset -

      The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

      Returns:
      this request

    • additionalTypes

      public GetPlaylistsTracksRequest additionalTypes(String additionalTypes)
      Parameters:
      additionalTypes -

      A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
      Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future.
      In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object.

      Returns:
      this request

    • build

      public ApiCall<Paging<PlaylistTrack>> build()
      Build the request into an executable api call
      Returns:
      an executable api call