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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/youtube_v3/classes.rb,
generated/google/apis/youtube_v3/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Playlist

Returns a new instance of Playlist


5309
5310
5311
# File 'generated/google/apis/youtube_v3/classes.rb', line 5309

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

Instance Attribute Details

#content_detailsGoogle::Apis::YoutubeV3::PlaylistContentDetails

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


5270
5271
5272
# File 'generated/google/apis/youtube_v3/classes.rb', line 5270

def content_details
  @content_details
end

#etagString

Etag of this resource. Corresponds to the JSON property etag

Returns:

  • (String)

5275
5276
5277
# File 'generated/google/apis/youtube_v3/classes.rb', line 5275

def etag
  @etag
end

#idString

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

Returns:

  • (String)

5280
5281
5282
# File 'generated/google/apis/youtube_v3/classes.rb', line 5280

def id
  @id
end

#kindString

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

Returns:

  • (String)

5286
5287
5288
# File 'generated/google/apis/youtube_v3/classes.rb', line 5286

def kind
  @kind
end

#localizationsHash<String,Google::Apis::YoutubeV3::PlaylistLocalization>

Localizations for different languages Corresponds to the JSON property localizations


5291
5292
5293
# File 'generated/google/apis/youtube_v3/classes.rb', line 5291

def localizations
  @localizations
end

#playerGoogle::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


5297
5298
5299
# File 'generated/google/apis/youtube_v3/classes.rb', line 5297

def player
  @player
end

#snippetGoogle::Apis::YoutubeV3::PlaylistSnippet

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


5302
5303
5304
# File 'generated/google/apis/youtube_v3/classes.rb', line 5302

def snippet
  @snippet
end

#statusGoogle::Apis::YoutubeV3::PlaylistStatus

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


5307
5308
5309
# File 'generated/google/apis/youtube_v3/classes.rb', line 5307

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
# File 'generated/google/apis/youtube_v3/classes.rb', line 5314

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