playlist

Types

Playlist

A playlist resource represents a YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. A playlist can contain up to 200 videos, and YouTube does not limit the number of playlists that each user creates. By default, playlists are publicly visible to other users, but playlists can be public or private. YouTube also uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company’s videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods.

pub type Playlist {
  Playlist(
    content_details: option.Option(PlaylistContentDetails),
    etag: option.Option(String),
    id: option.Option(String),
    kind: option.Option(String),
    localizations: option.Option(
      dict.Dict(String, PlaylistLocalization),
    ),
    player: option.Option(PlaylistPlayer),
    snippet: option.Option(PlaylistSnippet),
    status: option.Option(PlaylistStatus),
  )
}

Constructors

Playlist(
  content_details: option.Option(PlaylistContentDetails),
  etag: option.Option(String),
  id: option.Option(String),
  kind: option.Option(String),
  localizations: option.Option(
    dict.Dict(String, PlaylistLocalization),
  ),
  player: option.Option(PlaylistPlayer),
  snippet: option.Option(PlaylistSnippet),
  status: option.Option(PlaylistStatus),
)

PlaylistContentDetails

</>

pub type PlaylistContentDetails {
  PlaylistContentDetails(item_count: option.Option(Int))
}

Constructors

PlaylistContentDetails(item_count: option.Option(Int))

PlaylistImage

</>

pub type PlaylistImage {
  PlaylistImage(
    id: option.Option(String),
    kind: option.Option(String),
    snippet: option.Option(PlaylistImageSnippet),
  )
}

Constructors

PlaylistImage(
  id: option.Option(String),
  kind: option.Option(String),
  snippet: option.Option(PlaylistImageSnippet),
)

PlaylistImageListResponse

</>

pub type PlaylistImageListResponse {
  PlaylistImageListResponse(
    items: option.Option(List(PlaylistImage)),
    kind: option.Option(String),
    next_page_token: option.Option(String),
    page_info: option.Option(page_info.PageInfo),
    prev_page_token: option.Option(String),
  )
}

Constructors

PlaylistImageListResponse(
  items: option.Option(List(PlaylistImage)),
  kind: option.Option(String),
  next_page_token: option.Option(String),
  page_info: option.Option(page_info.PageInfo),
  prev_page_token: option.Option(String),
)

PlaylistImageSnippet

</>

A playlistImage resource identifies another resource, such as a image, that is associated with a playlist. In addition, the playlistImage resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company’s videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistImages.list method to retrieve image data for any of those playlists. You can also add or remove images from those lists by calling the playlistImages.insert and playlistImages.delete methods.

pub type PlaylistImageSnippet {
  PlaylistImageSnippet(
    height: option.Option(Int),
    playlist_id: option.Option(String),
    type_: option.Option(Type),
    width: option.Option(Int),
  )
}

Constructors

PlaylistImageSnippet(
  height: option.Option(Int),
  playlist_id: option.Option(String),
  type_: option.Option(Type),
  width: option.Option(Int),
)

PlaylistItem

</>

A playlistItem resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company’s videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user’s channel.

pub type PlaylistItem {
  PlaylistItem(
    content_details: option.Option(PlaylistItemContentDetails),
    etag: option.Option(String),
    id: option.Option(String),
    kind: option.Option(String),
    snippet: option.Option(PlaylistItemSnippet),
    status: option.Option(PlaylistItemStatus),
  )
}

Constructors

PlaylistItem(
  content_details: option.Option(PlaylistItemContentDetails),
  etag: option.Option(String),
  id: option.Option(String),
  kind: option.Option(String),
  snippet: option.Option(PlaylistItemSnippet),
  status: option.Option(PlaylistItemStatus),
)

PlaylistItemContentDetails

</>

pub type PlaylistItemContentDetails {
  PlaylistItemContentDetails(
    end_at: option.Option(String),
    note: option.Option(String),
    start_at: option.Option(String),
    video_id: option.Option(String),
    video_published_at: option.Option(String),
  )
}

Constructors

PlaylistItemContentDetails(
  end_at: option.Option(String),
  note: option.Option(String),
  start_at: option.Option(String),
  video_id: option.Option(String),
  video_published_at: option.Option(String),
)

PlaylistItemListResponse

</>

pub type PlaylistItemListResponse {
  PlaylistItemListResponse(
    etag: option.Option(String),
    event_id: option.Option(String),
    items: option.Option(List(PlaylistItem)),
    kind: option.Option(String),
    next_page_token: option.Option(String),
    page_info: option.Option(page_info.PageInfo),
    prev_page_token: option.Option(String),
    token_pagination: option.Option(
      token_pagination.TokenPagination,
    ),
    visitor_id: option.Option(String),
  )
}

Constructors

PlaylistItemListResponse(
  etag: option.Option(String),
  event_id: option.Option(String),
  items: option.Option(List(PlaylistItem)),
  kind: option.Option(String),
  next_page_token: option.Option(String),
  page_info: option.Option(page_info.PageInfo),
  prev_page_token: option.Option(String),
  token_pagination: option.Option(
    token_pagination.TokenPagination,
  ),
  visitor_id: option.Option(String),
)

PlaylistItemSnippet

</>

Basic details about a playlist, including title, description and thumbnails. Basic details of a YouTube Playlist item provided by the author. Next ID: 15

pub type PlaylistItemSnippet {
  PlaylistItemSnippet(
    channel_id: option.Option(String),
    channel_title: option.Option(String),
    description: option.Option(String),
    playlist_id: option.Option(String),
    position: option.Option(Int),
    published_at: option.Option(String),
    resource_id: option.Option(resource_id.ResourceId),
    thumbnails: option.Option(thumbnail.ThumbnailDetails),
    title: option.Option(String),
    video_owner_channel_id: option.Option(String),
    video_owner_channel_title: option.Option(String),
  )
}

Constructors

PlaylistItemSnippet(
  channel_id: option.Option(String),
  channel_title: option.Option(String),
  description: option.Option(String),
  playlist_id: option.Option(String),
  position: option.Option(Int),
  published_at: option.Option(String),
  resource_id: option.Option(resource_id.ResourceId),
  thumbnails: option.Option(thumbnail.ThumbnailDetails),
  title: option.Option(String),
  video_owner_channel_id: option.Option(String),
  video_owner_channel_title: option.Option(String),
)

PlaylistItemStatus

</>

Information about the playlist item’s privacy status.

pub type PlaylistItemStatus {
  PlaylistItemStatus(
    privacy_status: option.Option(PlaylistItemStatusPrivacyStatus),
  )
}

Constructors

PlaylistItemStatus(
  privacy_status: option.Option(PlaylistItemStatusPrivacyStatus),
)

PlaylistItemStatusPrivacyStatus

</>

This resource’s privacy status.

pub type PlaylistItemStatusPrivacyStatus {
  PlaylistItemStatusPrivacyStatusPublic
  PlaylistItemStatusPrivacyStatusUnlisted
  PlaylistItemStatusPrivacyStatusPrivate
}

Constructors

```
PlaylistItemStatusPrivacyStatusPublic
```
```
PlaylistItemStatusPrivacyStatusUnlisted
```
```
PlaylistItemStatusPrivacyStatusPrivate
```

PlaylistListResponse

</>

pub type PlaylistListResponse {
  PlaylistListResponse(
    etag: option.Option(String),
    event_id: option.Option(String),
    items: option.Option(List(Playlist)),
    kind: option.Option(String),
    next_page_token: option.Option(String),
    page_info: option.Option(page_info.PageInfo),
    prev_page_token: option.Option(String),
    token_pagination: option.Option(
      token_pagination.TokenPagination,
    ),
    visitor_id: option.Option(String),
  )
}

Constructors

PlaylistListResponse(
  etag: option.Option(String),
  event_id: option.Option(String),
  items: option.Option(List(Playlist)),
  kind: option.Option(String),
  next_page_token: option.Option(String),
  page_info: option.Option(page_info.PageInfo),
  prev_page_token: option.Option(String),
  token_pagination: option.Option(
    token_pagination.TokenPagination,
  ),
  visitor_id: option.Option(String),
)

PlaylistLocalization

</>

Playlist localization setting

pub type PlaylistLocalization {
  PlaylistLocalization(
    description: option.Option(String),
    title: option.Option(String),
  )
}

Constructors

PlaylistLocalization(
  description: option.Option(String),
  title: option.Option(String),
)

PlaylistPlayer

</>

pub type PlaylistPlayer {
  PlaylistPlayer(embed_html: option.Option(String))
}

Constructors

PlaylistPlayer(embed_html: option.Option(String))

PlaylistSnippet

</>

Basic details about a playlist, including title, description and thumbnails.

pub type PlaylistSnippet {
  PlaylistSnippet(
    channel_id: option.Option(String),
    channel_title: option.Option(String),
    default_language: option.Option(String),
    description: option.Option(String),
    localized: option.Option(PlaylistLocalization),
    published_at: option.Option(String),
    tags: option.Option(List(String)),
    thumbnail_video_id: option.Option(String),
    thumbnails: option.Option(thumbnail.ThumbnailDetails),
    title: option.Option(String),
  )
}

Constructors

PlaylistSnippet(
  channel_id: option.Option(String),
  channel_title: option.Option(String),
  default_language: option.Option(String),
  description: option.Option(String),
  localized: option.Option(PlaylistLocalization),
  published_at: option.Option(String),
  tags: option.Option(List(String)),
  thumbnail_video_id: option.Option(String),
  thumbnails: option.Option(thumbnail.ThumbnailDetails),
  title: option.Option(String),
)

PlaylistStatus

</>

pub type PlaylistStatus {
  PlaylistStatus(
    podcast_status: option.Option(PodcastStatus),
    privacy_status: option.Option(PlaylistStatusPrivacyStatus),
  )
}

Constructors

PlaylistStatus(
  podcast_status: option.Option(PodcastStatus),
  privacy_status: option.Option(PlaylistStatusPrivacyStatus),
)

PlaylistStatusPrivacyStatus

</>

The playlist’s privacy status.

pub type PlaylistStatusPrivacyStatus {
  PlaylistStatusPrivacyStatusPublic
  PlaylistStatusPrivacyStatusUnlisted
  PlaylistStatusPrivacyStatusPrivate
}

Constructors

```
PlaylistStatusPrivacyStatusPublic
```
```
PlaylistStatusPrivacyStatusUnlisted
```
```
PlaylistStatusPrivacyStatusPrivate
```

PodcastStatus

</>

The playlist’s podcast status.

pub type PodcastStatus {
  PodcastStatusEnabled
  PodcastStatusDisabled
}

Constructors

```
PodcastStatusEnabled
```
```
PodcastStatusDisabled
```

Type

</>

The image type.

pub type Type {
  TypeHero
}

Constructors

```
TypeHero
```

Values

playlist_content_details_decoder

</>

pub fn playlist_content_details_decoder() -> decode.Decoder(
  PlaylistContentDetails,
)

playlist_content_details_to_json

</>

pub fn playlist_content_details_to_json(
  value: PlaylistContentDetails,
) -> json.Json

playlist_decoder

</>

pub fn playlist_decoder() -> decode.Decoder(Playlist)

playlist_image_decoder

</>

pub fn playlist_image_decoder() -> decode.Decoder(PlaylistImage)

playlist_image_list_response_decoder

</>

pub fn playlist_image_list_response_decoder() -> decode.Decoder(
  PlaylistImageListResponse,
)

playlist_image_list_response_to_json

</>

pub fn playlist_image_list_response_to_json(
  value: PlaylistImageListResponse,
) -> json.Json

playlist_image_snippet_decoder

</>

pub fn playlist_image_snippet_decoder() -> decode.Decoder(
  PlaylistImageSnippet,
)

playlist_image_snippet_to_json

</>

pub fn playlist_image_snippet_to_json(
  value: PlaylistImageSnippet,
) -> json.Json

playlist_image_to_json

</>

pub fn playlist_image_to_json(value: PlaylistImage) -> json.Json

playlist_item_content_details_decoder

</>

pub fn playlist_item_content_details_decoder() -> decode.Decoder(
  PlaylistItemContentDetails,
)

playlist_item_content_details_to_json

</>

pub fn playlist_item_content_details_to_json(
  value: PlaylistItemContentDetails,
) -> json.Json

playlist_item_decoder

</>

pub fn playlist_item_decoder() -> decode.Decoder(PlaylistItem)

playlist_item_list_response_decoder

</>

pub fn playlist_item_list_response_decoder() -> decode.Decoder(
  PlaylistItemListResponse,
)

playlist_item_list_response_to_json

</>

pub fn playlist_item_list_response_to_json(
  value: PlaylistItemListResponse,
) -> json.Json

playlist_item_snippet_decoder

</>

pub fn playlist_item_snippet_decoder() -> decode.Decoder(
  PlaylistItemSnippet,
)

playlist_item_snippet_to_json

</>

pub fn playlist_item_snippet_to_json(
  value: PlaylistItemSnippet,
) -> json.Json

playlist_item_status_decoder

</>

pub fn playlist_item_status_decoder() -> decode.Decoder(
  PlaylistItemStatus,
)

playlist_item_status_privacy_status_decoder

</>

pub fn playlist_item_status_privacy_status_decoder() -> decode.Decoder(
  PlaylistItemStatusPrivacyStatus,
)

playlist_item_status_privacy_status_to_string

</>

pub fn playlist_item_status_privacy_status_to_string(
  value: PlaylistItemStatusPrivacyStatus,
) -> String

playlist_item_status_to_json

</>

pub fn playlist_item_status_to_json(
  value: PlaylistItemStatus,
) -> json.Json

playlist_item_to_json

</>

pub fn playlist_item_to_json(value: PlaylistItem) -> json.Json

playlist_list_response_decoder

</>

pub fn playlist_list_response_decoder() -> decode.Decoder(
  PlaylistListResponse,
)

playlist_list_response_to_json

</>

pub fn playlist_list_response_to_json(
  value: PlaylistListResponse,
) -> json.Json

playlist_localization_decoder

</>

pub fn playlist_localization_decoder() -> decode.Decoder(
  PlaylistLocalization,
)

playlist_localization_to_json

</>

pub fn playlist_localization_to_json(
  value: PlaylistLocalization,
) -> json.Json

playlist_player_decoder

</>

pub fn playlist_player_decoder() -> decode.Decoder(PlaylistPlayer)

playlist_player_to_json

</>

pub fn playlist_player_to_json(
  value: PlaylistPlayer,
) -> json.Json

playlist_snippet_decoder

</>

pub fn playlist_snippet_decoder() -> decode.Decoder(
  PlaylistSnippet,
)

playlist_snippet_to_json

</>

pub fn playlist_snippet_to_json(
  value: PlaylistSnippet,
) -> json.Json

playlist_status_decoder

</>

pub fn playlist_status_decoder() -> decode.Decoder(PlaylistStatus)

playlist_status_privacy_status_decoder

</>

pub fn playlist_status_privacy_status_decoder() -> decode.Decoder(
  PlaylistStatusPrivacyStatus,
)

playlist_status_privacy_status_to_string

</>

pub fn playlist_status_privacy_status_to_string(
  value: PlaylistStatusPrivacyStatus,
) -> String

playlist_status_to_json

</>

pub fn playlist_status_to_json(
  value: PlaylistStatus,
) -> json.Json

playlist_to_json

</>

pub fn playlist_to_json(value: Playlist) -> json.Json

podcast_status_decoder

</>

pub fn podcast_status_decoder() -> decode.Decoder(PodcastStatus)

podcast_status_to_string

</>

pub fn podcast_status_to_string(value: PodcastStatus) -> String

type_decoder

</>

pub fn type_decoder() -> decode.Decoder(Type)

type_to_string

</>

pub fn type_to_string(value: Type) -> String