Class: Google::Apis::YoutubeV3::SearchResultSnippet

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

Basic details about a search result, including title, description and thumbnails of the item referenced by the search result.

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

Returns a new instance of SearchResultSnippet



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

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

Instance Attribute Details

#channel_id ⇒ String

The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies. Corresponds to the JSON property channelId

Returns:

  • (String) 


6150
6151
6152
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6150

def channel_id
  @channel_id
end

#channel_title ⇒ String

The title of the channel that published the resource that the search result identifies. Corresponds to the JSON property channelTitle

Returns:

  • (String) 


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

def channel_title
  @channel_title
end

#description ⇒ String

A description of the search result. Corresponds to the JSON property description

Returns:

  • (String) 


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

def description
  @description
end

#live_broadcast_content ⇒ String

It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts. Corresponds to the JSON property liveBroadcastContent

Returns:

  • (String) 


6168
6169
6170
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6168

def live_broadcast_content
  @live_broadcast_content
end

#published_at ⇒ DateTime

The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Corresponds to the JSON property publishedAt

Returns:

  • (DateTime) 


6174
6175
6176
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6174

def published_at
  @published_at
end

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

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

Returns:



6179
6180
6181
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6179

def thumbnails
  @thumbnails
end

#title ⇒ String

The title of the search result. Corresponds to the JSON property title

Returns:

  • (String) 


6184
6185
6186
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6184

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6191
6192
6193
6194
6195
6196
6197
6198
6199
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 6191

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