Class: Google::Apis::YoutubeV3::PlaylistSnippet

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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PlaylistSnippet

Returns a new instance of PlaylistSnippet.



6739
6740
6741
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6739

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

Instance Attribute Details

#channel_id ⇒ String

The ID that YouTube uses to uniquely identify the channel that published the playlist. Corresponds to the JSON property channelId

Returns:

  • (String) 


6686
6687
6688
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6686

def channel_id
  @channel_id
end

#channel_title ⇒ String

The channel title of the channel that the video belongs to. Corresponds to the JSON property channelTitle

Returns:

  • (String) 


6691
6692
6693
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6691

def channel_title
  @channel_title
end

#default_language ⇒ String

The language of the playlist's default title and description. Corresponds to the JSON property defaultLanguage

Returns:

  • (String) 


6696
6697
6698
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6696

def default_language
  @default_language
end

#description ⇒ String

The playlist's description. Corresponds to the JSON property description

Returns:

  • (String) 


6701
6702
6703
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6701

def description
  @description
end

#localized ⇒ Google::Apis::YoutubeV3::PlaylistLocalization

Playlist localization setting Corresponds to the JSON property localized

Returns:



6706
6707
6708
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6706

def localized
  @localized
end

#published_at ⇒ DateTime

The date and time that the playlist was created. Corresponds to the JSON property publishedAt

Returns:

  • (DateTime) 


6711
6712
6713
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6711

def published_at
  @published_at
end

#tags ⇒ Array<String>

Keyword tags associated with the playlist. Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


6716
6717
6718
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6716

def tags
  @tags
end

#thumbnail_video_id ⇒ String

Note: if the playlist has a custom thumbnail, this field will not be populated. The video id selected by the user that will be used as the thumbnail of this playlist. This field defaults to the first publicly viewable video in the playlist, if: 1. The user has never selected a video to be the thumbnail of the playlist. 2. The user selects a video to be the thumbnail, and then removes that video from the playlist. 3. The user selects a non-owned video to be the thumbnail, but that video becomes private, or gets deleted. Corresponds to the JSON property thumbnailVideoId

Returns:

  • (String) 


6727
6728
6729
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6727

def thumbnail_video_id
  @thumbnail_video_id
end

#thumbnails ⇒ Google::Apis::YoutubeV3::ThumbnailDetails

Internal representation of thumbnails for a YouTube resource. Corresponds to the JSON property thumbnails

Returns:



6732
6733
6734
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6732

def thumbnails
  @thumbnails
end

#title ⇒ String

The playlist's title. Corresponds to the JSON property title

Returns:

  • (String) 


6737
6738
6739
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6737

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6744

def update!(**args)
  @channel_id = args[:channel_id] if args.key?(:channel_id)
  @channel_title = args[:channel_title] if args.key?(:channel_title)
  @default_language = args[:default_language] if args.key?(:default_language)
  @description = args[:description] if args.key?(:description)
  @localized = args[:localized] if args.key?(:localized)
  @published_at = args[:published_at] if args.key?(:published_at)
  @tags = args[:tags] if args.key?(:tags)
  @thumbnail_video_id = args[:thumbnail_video_id] if args.key?(:thumbnail_video_id)
  @thumbnails = args[:thumbnails] if args.key?(:thumbnails)
  @title = args[:title] if args.key?(:title)
end