Class: Google::Apis::YoutubeV3::Video

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

A video resource represents a YouTube video.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Video

Returns a new instance of Video.



7603
7604
7605
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7603

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

Instance Attribute Details

#age_gating ⇒ Google::Apis::YoutubeV3::VideoAgeGating

Age restriction details related to a video. This data can only be retrieved by the video owner. Corresponds to the JSON property ageGating

Returns:



7500
7501
7502
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7500

def age_gating
  @age_gating
end

#content_details ⇒ Google::Apis::YoutubeV3::VideoContentDetails

Details about the content of a YouTube Video. Corresponds to the JSON property contentDetails

Returns:



7505
7506
7507
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7505

def content_details
  @content_details
end

#etag ⇒ String

Etag of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


7510
7511
7512
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7510

def etag
  @etag
end

#file_details ⇒ Google::Apis::YoutubeV3::VideoFileDetails

Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. Corresponds to the JSON property fileDetails

Returns:



7517
7518
7519
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7517

def file_details
  @file_details
end

#id ⇒ String

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

Returns:

  • (String) 


7522
7523
7524
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7522

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


7528
7529
7530
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7528

def kind
  @kind
end

#live_streaming_details ⇒ Google::Apis::YoutubeV3::VideoLiveStreamingDetails

Details about the live streaming metadata. Corresponds to the JSON property liveStreamingDetails

Returns:



7533
7534
7535
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7533

def live_streaming_details
  @live_streaming_details
end

#localizations ⇒ Hash<String,Google::Apis::YoutubeV3::VideoLocalization>

The localizations object contains localized versions of the basic details about the video, such as its title and description. Corresponds to the JSON property localizations

Returns:



7539
7540
7541
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7539

def localizations
  @localizations
end

#monetization_details ⇒ Google::Apis::YoutubeV3::VideoMonetizationDetails

Details about monetization of a YouTube Video. Corresponds to the JSON property monetizationDetails

Returns:



7544
7545
7546
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7544

def monetization_details
  @monetization_details
end

#player ⇒ Google::Apis::YoutubeV3::VideoPlayer

Player to be used for a video playback. Corresponds to the JSON property player

Returns:



7549
7550
7551
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7549

def player
  @player
end

#processing_details ⇒ Google::Apis::YoutubeV3::VideoProcessingDetails

Describes processing status and progress and availability of some other Video resource parts. Corresponds to the JSON property processingDetails

Returns:



7555
7556
7557
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7555

def processing_details
  @processing_details
end

#project_details ⇒ Google::Apis::YoutubeV3::VideoProjectDetails

DEPRECATED. b/157517979: This part was never populated after it was added. However, it sees non-zero traffic because there is generated client code in the wild that refers to it [1]. We keep this field and do NOT remove it because otherwise V3 would return an error when this part gets requested [2]. [ 1] https://developers.google.com/resources/api-libraries/documentation/youtube/ v3/csharp/latest/ classGoogle_1_1Apis_1_1YouTube_1_1v3_1_1Data_1_1VideoProjectDetails.html [2] http://google3/video/youtube/src/python/servers/data_api/common.py?l=1565-1569& rcl=344141677 Corresponds to the JSON property projectDetails

Returns:



7568
7569
7570
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7568

def project_details
  @project_details
end

#recording_details ⇒ Google::Apis::YoutubeV3::VideoRecordingDetails

Recording information associated with the video. Corresponds to the JSON property recordingDetails

Returns:



7573
7574
7575
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7573

def recording_details
  @recording_details
end

#snippet ⇒ Google::Apis::YoutubeV3::VideoSnippet

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

Returns:



7579
7580
7581
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7579

def snippet
  @snippet
end

#statistics ⇒ Google::Apis::YoutubeV3::VideoStatistics

Statistics about the video, such as the number of times the video was viewed or liked. Corresponds to the JSON property statistics

Returns:



7585
7586
7587
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7585

def statistics
  @statistics
end

#status ⇒ Google::Apis::YoutubeV3::VideoStatus

Basic details about a video category, such as its localized title. Next Id: 18 Corresponds to the JSON property status

Returns:



7590
7591
7592
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7590

def status
  @status
end

#suggestions ⇒ Google::Apis::YoutubeV3::VideoSuggestions

Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. Corresponds to the JSON property suggestions

Returns:



7596
7597
7598
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7596

def suggestions
  @suggestions
end

#topic_details ⇒ Google::Apis::YoutubeV3::VideoTopicDetails

Freebase topic information related to the video. Corresponds to the JSON property topicDetails

Returns:



7601
7602
7603
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7601

def topic_details
  @topic_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7608

def update!(**args)
  @age_gating = args[:age_gating] if args.key?(:age_gating)
  @content_details = args[:content_details] if args.key?(:content_details)
  @etag = args[:etag] if args.key?(:etag)
  @file_details = args[:file_details] if args.key?(:file_details)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @live_streaming_details = args[:live_streaming_details] if args.key?(:live_streaming_details)
  @localizations = args[:localizations] if args.key?(:localizations)
  @monetization_details = args[:monetization_details] if args.key?(:monetization_details)
  @player = args[:player] if args.key?(:player)
  @processing_details = args[:processing_details] if args.key?(:processing_details)
  @project_details = args[:project_details] if args.key?(:project_details)
  @recording_details = args[:recording_details] if args.key?(:recording_details)
  @snippet = args[:snippet] if args.key?(:snippet)
  @statistics = args[:statistics] if args.key?(:statistics)
  @status = args[:status] if args.key?(:status)
  @suggestions = args[:suggestions] if args.key?(:suggestions)
  @topic_details = args[:topic_details] if args.key?(:topic_details)
end