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.



5488
5489
5490
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5488

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:



5449
5450
5451
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5449

def content_details
  @content_details
end

#etag ⇒ String

Etag of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


5454
5455
5456
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5454

def etag
  @etag
end

#id ⇒ String

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

Returns:

  • (String) 


5459
5460
5461
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5459

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) 


5465
5466
5467
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5465

def kind
  @kind
end

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

Localizations for different languages Corresponds to the JSON property localizations

Returns:



5470
5471
5472
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5470

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:



5476
5477
5478
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5476

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:



5481
5482
5483
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5481

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:



5486
5487
5488
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5486

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 5493

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