Class: Google::Apis::YoutubeV3::Playlist

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/youtube_v3/classes.rb,
lib/google/apis/youtube_v3/representations.rb,
lib/google/apis/youtube_v3/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Playlist

Returns a new instance of Playlist.



5648
5649
5650
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5648

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#content_details ⇒ Google::Apis::YoutubeV3::PlaylistContentDetails

The contentDetails object contains information like video count. Corresponds to the JSON property contentDetails

Returns:



5609
5610
5611
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5609

def content_details
  @content_details
end

#etag ⇒ String

Etag of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


5614
5615
5616
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5614

def etag
  @etag
end

#id ⇒ String

The ID that YouTube uses to uniquely identify the playlist. Corresponds to the JSON property id

Returns:

  • (String) 


5619
5620
5621
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5619

def id
  @id
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "youtube# playlist". Corresponds to the JSON property kind

Returns:

  • (String) 


5625
5626
5627
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5625

def kind
  @kind
end

#localizations ⇒ Hash<String,Google::Apis::YoutubeV3::PlaylistLocalization>

Localizations for different languages Corresponds to the JSON property localizations

Returns:



5630
5631
5632
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5630

def localizations
  @localizations
end

#player ⇒ Google::Apis::YoutubeV3::PlaylistPlayer

The player object contains information that you would use to play the playlist in an embedded player. Corresponds to the JSON property player

Returns:



5636
5637
5638
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5636

def player
  @player
end

#snippet ⇒ Google::Apis::YoutubeV3::PlaylistSnippet

Basic details about a playlist, including title, description and thumbnails. Corresponds to the JSON property snippet

Returns:



5641
5642
5643
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5641

def snippet
  @snippet
end

#status ⇒ Google::Apis::YoutubeV3::PlaylistStatus

The status object contains status information for the playlist. Corresponds to the JSON property status

Returns:



5646
5647
5648
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5646

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5653

def update!(**args)
  @content_details = args[:content_details] if args.key?(:content_details)
  @etag = args[:etag] if args.key?(:etag)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @localizations = args[:localizations] if args.key?(:localizations)
  @player = args[:player] if args.key?(:player)
  @snippet = args[:snippet] if args.key?(:snippet)
  @status = args[:status] if args.key?(:status)
end