get_show_episodes {spotifyr} | R Documentation |
Get Spotify catalog information about an show's episodes. Optional parameters can be used to limit the number of episodes returned.
Description
Get Spotify catalog information about an show's episodes. Optional parameters can be used to limit the number of episodes returned.
Usage
get_show_episodes(
id,
limit = 20,
offset = 0,
market = NULL,
authorization = get_spotify_authorization_code(),
include_meta_info = FALSE
)
Arguments
id |
Required. The Spotify ID for the show.
|
limit |
Optional.
Maximum number of results to return.
Default: 20
Minimum: 1
Maximum: 50
|
offset |
Optional.
The index of the first album to return.
Default: 0 (the first album).
Maximum offset (including limit): 10,000.
Use with limit to get the next set of episodes.
|
market |
Optional.
An ISO 3166-1 alpha-2 country code or the string
"from_token" . If a country code is specified, only shows and episodes that are 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.
|
authorization |
Required. A valid access token from the Spotify Accounts service. See the
Web API authorization Guide for more details.
Defaults to spotifyr::get_spotify_authorization_code() . The access token must have been issued on behalf of the current user.
Reading the user’s resume points on episode objects requires the user-read-playback-position scope. See
Using Scopes.
|
include_meta_info |
Optional. Boolean indicating whether to include full result, with meta information such as "total" ,
and "limit" . Defaults to FALSE .
|
Value
Returns a data frame of results containing show data. See the official API documentation for more information.
[Package
spotifyr version 2.2.5
Index]