spotifywebapipython.models.episodesimplified

@export
class EpisodeSimplified:

Spotify Web API Simplified Episode object.

EpisodeSimplified(root: dict = None)

Initializes a new instance of the class.

Arguments:
  • root (dict): Spotify Web API JSON response in dictionary format, used to load object attributes; otherwise, None to not load attributes.
AudioPreviewUrl: str

A URL to a 30 second preview (MP3 format) of the episode, or null if not available.

Important policy note: Spotify Audio preview clips can not be a standalone service.

Example: https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17

Description: str

A description of the episode.

HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.

DurationMS: int

The episode length in milliseconds.

Example: 1686230

Explicit: bool

Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).

ExternalUrls: spotifywebapipython.models.externalurls.ExternalUrls

Known external URLs for the episode.

Href: str

A link to the Web API endpoint providing full details of the episode.

Example: https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ

HtmlDescription: str

A description of the episode. This field may contain HTML tags.

Id: str

The Spotify ID for the episode.

Example: 5Xt5DXGzch68nYYamXrNxZ

IdOrigin: str

The origin Spotify ID for the episode.

The Id value is always returned, as linkfrom details do not exist for episodes.

This is a helper property, and is not part of the Spotify Web API specification.

Images: list[spotifywebapipython.models.imageobject.ImageObject]

The cover art for the episode in various sizes, widest first.

ImageUrl: str

Returns the highest resolution order image from the Images list, if images are defined; otherwise, null.

IsExternallyHosted: bool

True if the episode is hosted outside of Spotify's CDN.

IsLinkedFrom: bool

Whether or not the episode is linked from another episode.

False is always returned, as linkfrom details do not exist for episodes.

This is a helper property, and is not part of the Spotify Web API specification.

IsPlayable: bool

True if the episode is playable in the given market. Otherwise false.

Languages: list[str]

A list of the languages used in the episode, identified by their ISO 639-1 code.

Example: [fr,en]

Name: str

The name of the episode.

ReleaseDate: str

The date the episode was first released.

Example: 1981-12
Depending on the precision, it might be shown as "1981" or "1981-12".

ReleaseDatePrecision: str

The precision with which release_date value is known.
Allowed values: year, month, day.

Example: year

Restrictions: spotifywebapipython.models.restrictions.Restrictions

Included in the response when a content restriction is applied.

ResumePoint: spotifywebapipython.models.resumepoint.ResumePoint

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'.

Type: str

The object type: episode.

Uri: str

The Spotify URI for the episode.

Example: spotify:episode:0zLhl3WsOCQHbe1BPTiHgr

UriOrigin: str

The origin Spotify URI for the episode.

The Uri value is always returned, as linkfrom details do not exist for episodes.

This is a helper property, and is not part of the Spotify Web API specification.

def ToDictionary(self) -> dict:

Returns a dictionary representation of the class.

def ToString(self, includeTitle: bool = True) -> str:

Returns a displayable string representation of the class.

Arguments:
  • includeTitle (str): True to include the class name title prefix.