Class: Google::Apis::YoutubeV3::PlaylistItem

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

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) ⇒ PlaylistItem

Returns a new instance of PlaylistItem.



5803
5804
5805
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5803

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

Instance Attribute Details

#content_details ⇒ Google::Apis::YoutubeV3::PlaylistItemContentDetails

The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video. Corresponds to the JSON property contentDetails

Returns:



5775
5776
5777
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5775

def content_details
  @content_details
end

#etag ⇒ String

Etag of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


5780
5781
5782
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5780

def etag
  @etag
end

#id ⇒ String

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

Returns:

  • (String) 


5785
5786
5787
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5785

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


5791
5792
5793
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5791

def kind
  @kind
end

#snippet ⇒ Google::Apis::YoutubeV3::PlaylistItemSnippet

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

Returns:



5796
5797
5798
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5796

def snippet
  @snippet
end

#status ⇒ Google::Apis::YoutubeV3::PlaylistItemStatus

Information about the playlist item's privacy status. Corresponds to the JSON property status

Returns:



5801
5802
5803
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5801

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 5808

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)
  @snippet = args[:snippet] if args.key?(:snippet)
  @status = args[:status] if args.key?(:status)
end