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.



6209
6210
6211
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6209

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) 


6156
6157
6158
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6156

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) 


6161
6162
6163
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6161

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) 


6166
6167
6168
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6166

def default_language
  @default_language
end

#description ⇒ String

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

Returns:

  • (String) 


6171
6172
6173
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6171

def description
  @description
end

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

Playlist localization setting Corresponds to the JSON property localized

Returns:



6176
6177
6178
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6176

def localized
  @localized
end

#published_at ⇒ DateTime

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

Returns:

  • (DateTime) 


6181
6182
6183
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6181

def published_at
  @published_at
end

#tags ⇒ Array<String>

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

Returns:

  • (Array<String>) 


6186
6187
6188
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6186

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) 


6197
6198
6199
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6197

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:



6202
6203
6204
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6202

def thumbnails
  @thumbnails
end

#title ⇒ String

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

Returns:

  • (String) 


6207
6208
6209
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6207

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 6214

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