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.



6882
6883
6884
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6882

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) 


6829
6830
6831
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6829

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) 


6834
6835
6836
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6834

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) 


6839
6840
6841
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6839

def default_language
  @default_language
end

#description ⇒ String

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

Returns:

  • (String) 


6844
6845
6846
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6844

def description
  @description
end

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

Playlist localization setting Corresponds to the JSON property localized

Returns:



6849
6850
6851
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6849

def localized
  @localized
end

#published_at ⇒ DateTime

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

Returns:

  • (DateTime) 


6854
6855
6856
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6854

def published_at
  @published_at
end

#tags ⇒ Array<String>

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

Returns:

  • (Array<String>) 


6859
6860
6861
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6859

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) 


6870
6871
6872
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6870

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:



6875
6876
6877
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6875

def thumbnails
  @thumbnails
end

#title ⇒ String

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

Returns:

  • (String) 


6880
6881
6882
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6880

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6887

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