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.



7729
7730
7731
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7729

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:



7619
7620
7621
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7619

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:



7624
7625
7626
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7624

def content_details
  @content_details
end

#etag ⇒ String

Etag of this resource. Corresponds to the JSON property etag

Returns:

  • (String) 


7629
7630
7631
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7629

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:



7636
7637
7638
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7636

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) 


7641
7642
7643
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7641

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) 


7647
7648
7649
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7647

def kind
  @kind
end

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

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

Returns:



7652
7653
7654
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7652

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:



7658
7659
7660
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7658

def localizations
  @localizations
end

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

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

Returns:



7663
7664
7665
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7663

def monetization_details
  @monetization_details
end

Details about paid content, such as paid product placement, sponsorships or endorsement, contained in a YouTube video and a method to inform viewers of paid promotion. This data can only be retrieved by the video owner. Corresponds to the JSON property paidProductPlacementDetails

Returns:



7670
7671
7672
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7670

def paid_product_placement_details
  @paid_product_placement_details
end

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

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

Returns:



7675
7676
7677
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7675

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:



7681
7682
7683
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7681

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:



7694
7695
7696
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7694

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:



7699
7700
7701
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7699

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:



7705
7706
7707
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7705

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:



7711
7712
7713
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7711

def statistics
  @statistics
end

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

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

Returns:



7716
7717
7718
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7716

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:



7722
7723
7724
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7722

def suggestions
  @suggestions
end

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

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

Returns:



7727
7728
7729
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7727

def topic_details
  @topic_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 7734

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)
  @paid_product_placement_details = args[:paid_product_placement_details] if args.key?(:paid_product_placement_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