Class: Yt::Models::Video

Inherits:
Resource show all
Defined in:
lib/yt/models/video.rb

Overview

Provides methods to interact with YouTube videos.

See Also:

Instance Attribute Summary collapse

Attributes inherited from Resource

#auth, #id

Instance Method Summary collapse

Methods inherited from Resource

#kind, #privacy_status, #private?, #public?, #unlisted?, #username

Methods included from Associations::HasOne

#has_one

Methods included from Associations::HasMany

#has_many

Methods included from Associations::HasAuthentication

#has_authentication

Instance Attribute Details

#actual_end_time ⇒ Time? (readonly)

The time when a live broadcast ended.

Returns:

  • (Time) —

    if the broadcast is over, the time it actually ended.

  • (nil) —

    if the broadcast is not over or video is not live.



340
 
# File 'lib/yt/models/video.rb', line 340

delegate :actual_end_time, to: :live_streaming_detail

#actual_start_time ⇒ Time? (readonly)

The time when a live broadcast started.

Returns:

  • (Time) —

    if the broadcast has begun, the time it actually started.

  • (nil) —

    if the broadcast has not begun or video is not live.



334
 
# File 'lib/yt/models/video.rb', line 334

delegate :actual_start_time, to: :live_streaming_detail

#ad_formats ⇒ Array<String> (readonly)

Returns the list of ad formats that the video is allowed to show. Possible values are: ‘long’, ‘overlay’, ‘standard_instream’, ‘third_party’, ‘trueview_inslate’, ‘trueview_instream’.

Returns:

  • (Array<String>) —

    the list of ad formats that the video is allowed to show. Possible values are: ‘long’, ‘overlay’, ‘standard_instream’, ‘third_party’, ‘trueview_inslate’, ‘trueview_instream’.



324
 
# File 'lib/yt/models/video.rb', line 324

delegate :ad_formats, to: :advertising_options_set

#annotations ⇒ Yt::Collections::Annotations (readonly)

Returns the video’s annotations.

Returns:



369
 
# File 'lib/yt/models/video.rb', line 369

has_many :annotations

#channel_id ⇒ String (readonly)

Returns the ID of the channel that the video belongs to.

Returns:

  • (String) —

    the ID of the channel that the video belongs to.



34
 
# File 'lib/yt/models/video.rb', line 34

delegate :channel_id, to: :snippet

#channel_title ⇒ String (readonly)

Returns the title of the channel that the video belongs to.

Returns:

  • (String) —

    the title of the channel that the video belongs to.



38
 
# File 'lib/yt/models/video.rb', line 38

delegate :channel_title, to: :snippet

#comment_count ⇒ Integer (readonly)

Returns the number of comments for the video.

Returns:

  • (Integer) —

    the number of comments for the video.



458
 
# File 'lib/yt/models/video.rb', line 458

delegate :comment_count, to: :statistics_set

#concurrent_viewers ⇒ Integer? (readonly)

The number of current viewers of a live broadcast.

Returns:

  • (Integer) —

    if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video, the number of viewers currently watching the broadcast.

  • (nil) —

    if the broadcast has ended or the broadcast owner has hidden the viewcount for the video or the video is not live.



363
 
# File 'lib/yt/models/video.rb', line 363

delegate :concurrent_viewers, to: :live_streaming_detail

#container ⇒ String (readonly)

Returns the video container of the uploaded file. (e.g. ‘mov’).

Returns:

  • (String) —

    the video container of the uploaded file. (e.g. ‘mov’).



265
 
# File 'lib/yt/models/video.rb', line 265

delegate :container, to: :file_detail

#description ⇒ String (readonly)

Returns the video’s description.

Returns:

  • (String) —

    the video’s description.



17
 
# File 'lib/yt/models/video.rb', line 17

delegate :description, to: :snippet

#dislike_count ⇒ Integer (readonly)

Returns the number of users who disliked the video.

Returns:

  • (Integer) —

    the number of users who disliked the video.



450
 
# File 'lib/yt/models/video.rb', line 450

delegate :dislike_count, to: :statistics_set

#duration ⇒ Integer (readonly)

Returns the duration of the video (in seconds).

Returns:

  • (Integer) —

    the duration of the video (in seconds).



227
 
# File 'lib/yt/models/video.rb', line 227

delegate :duration, to: :content_detail

#embed_html ⇒ String (readonly)

Returns the HTML code of an <iframe> tag that embeds a player that will play the video.

Returns:

  • (String) —

    the HTML code of an <iframe> tag that embeds a player that will play the video.



467
 
# File 'lib/yt/models/video.rb', line 467

delegate :embed_html, to: :player

#favorite_count ⇒ Integer (readonly)

Returns the number of users who marked the video as favorite.

Returns:

  • (Integer) —

    the number of users who marked the video as favorite.



454
 
# File 'lib/yt/models/video.rb', line 454

delegate :favorite_count, to: :statistics_set

#file_size ⇒ Integer (readonly)

Returns the size of the uploaded file (in bytes).

Returns:

  • (Integer) —

    the size of the uploaded file (in bytes).



256
 
# File 'lib/yt/models/video.rb', line 256

delegate :file_size, to: :file_detail

#file_type ⇒ String (readonly)

Returns the type of file uploaded. May be one of: archive, audio, document, image, other, project, video.

Returns:

  • (String) —

    the type of file uploaded. May be one of: archive, audio, document, image, other, project, video.



261
 
# File 'lib/yt/models/video.rb', line 261

delegate :file_type, to: :file_detail

#license ⇒ String (readonly)

Returns the video’s license. Possible values are: ‘creativeCommon’, ‘youtube’.

Returns:

  • (String) —

    the video’s license. Possible values are: ‘creativeCommon’, ‘youtube’.



192
 
# File 'lib/yt/models/video.rb', line 192

delegate :license, to: :status

#like_count ⇒ Integer (readonly)

Returns the number of users who liked the video.

Returns:

  • (Integer) —

    the number of users who liked the video.



446
 
# File 'lib/yt/models/video.rb', line 446

delegate :like_count, to: :statistics_set

#live_broadcast_content ⇒ String (readonly)

Returns the type of live broadcast that the video contains. Possible values are: ‘live’, ‘none’, ‘upcoming’.

Returns:

  • (String) —

    the type of live broadcast that the video contains. Possible values are: ‘live’, ‘none’, ‘upcoming’.



43
 
# File 'lib/yt/models/video.rb', line 43

delegate :live_broadcast_content, to: :snippet

#published_at ⇒ Time (readonly)

Returns the date and time that the video was published.

Returns:

  • (Time) —

    the date and time that the video was published.



30
 
# File 'lib/yt/models/video.rb', line 30

delegate :published_at, to: :snippet

#scheduled_end_time ⇒ Time? (readonly)

The time when a live broadcast is scheduled to end.

Returns:

  • (Time) —

    if the broadcast is scheduled to end, the time it is scheduled to end.

  • (nil) —

    if the broadcast is scheduled to continue indefinitely or the video is not live.



354
 
# File 'lib/yt/models/video.rb', line 354

delegate :scheduled_end_time, to: :live_streaming_detail

#scheduled_start_time ⇒ Time? (readonly)

The time when a live broadcast is scheduled to start.

Returns:

  • (Time) —

    the time that the broadcast is scheduled to begin.

  • (nil) —

    if video is not live.



346
 
# File 'lib/yt/models/video.rb', line 346

delegate :scheduled_start_time, to: :live_streaming_detail

#title ⇒ String (readonly)

Returns the video’s title.

Returns:

  • (String) —

    the video’s title.



13
 
# File 'lib/yt/models/video.rb', line 13

delegate :title, to: :snippet

#view_count ⇒ Integer (readonly)

Returns the number of times the video has been viewed.

Returns:

  • (Integer) —

    the number of times the video has been viewed.



442
 
# File 'lib/yt/models/video.rb', line 442

delegate :view_count, to: :statistics_set

Instance Method Details

#aborted? ⇒ Boolean

Returns whether the video failed to upload to YouTube because the uploading process was aborted.

Returns:

  • (Boolean) —

    whether the video failed to upload to YouTube because the uploading process was aborted.



116
117
118
 
# File 'lib/yt/models/video.rb', line 116

def aborted?
  status.failure_reason == 'uploadAborted'
end

#annotation_click_through_rate(options = {}) ⇒ Hash<Date, Float>

Returns the annotation_click_through_rate grouped by the given dimension.

Examples:

Get the annotation_click_through_rate for each day of last week:

resource.annotation_click_through_rate since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the annotation_click_through_rate.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect annotation_click_through_rate by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the annotation_click_through_rate for each day in the time-range.



422
 
# File 'lib/yt/models/video.rb', line 422

has_report :annotation_click_through_rate

#annotation_clicks(options = {}) ⇒ Hash<Date, Float>

Returns the annotation_clicks grouped by the given dimension.

Examples:

Get the annotation_clicks for each day of last week:

resource.annotation_clicks since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the annotation_clicks.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect annotation_clicks by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the annotation_clicks for each day in the time-range.



419
 
# File 'lib/yt/models/video.rb', line 419

has_report :annotation_clicks

#annotation_close_rate(options = {}) ⇒ Hash<Date, Float>

Returns the annotation_close_rate grouped by the given dimension.

Examples:

Get the annotation_close_rate for each day of last week:

resource.annotation_close_rate since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the annotation_close_rate.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect annotation_close_rate by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the annotation_close_rate for each day in the time-range.



425
 
# File 'lib/yt/models/video.rb', line 425

has_report :annotation_close_rate

#average_view_duration(options = {}) ⇒ Hash<Date, Float>

Returns the average_view_duration grouped by the given dimension.

Examples:

Get the average_view_duration for each day of last week:

resource.average_view_duration since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the average_view_duration.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect average_view_duration by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the average_view_duration for each day in the time-range.



413
 
# File 'lib/yt/models/video.rb', line 413

has_report :average_view_duration

#average_view_percentage(options = {}) ⇒ Hash<Date, Float>

Returns the average_view_percentage grouped by the given dimension.

Examples:

Get the average_view_percentage for each day of last week:

resource.average_view_percentage since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the average_view_percentage.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect average_view_percentage by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the average_view_percentage for each day in the time-range.



416
 
# File 'lib/yt/models/video.rb', line 416

has_report :average_view_percentage

#belongs_to_closed_account? ⇒ Boolean

Returns whether the video was rejected by YouTube because the account that uploaded the video has been closed.

Returns:

  • (Boolean) —

    whether the video was rejected by YouTube because the account that uploaded the video has been closed.



166
167
168
 
# File 'lib/yt/models/video.rb', line 166

def belongs_to_closed_account?
  status.rejection_reason == 'uploaderAccountClosed'
end

#belongs_to_suspended_account? ⇒ Boolean

Returns whether the video was rejected by YouTube because the account that uploaded the video has been suspended.

Returns:

  • (Boolean) —

    whether the video was rejected by YouTube because the account that uploaded the video has been suspended.



172
173
174
 
# File 'lib/yt/models/video.rb', line 172

def belongs_to_suspended_account?
  status.rejection_reason == 'uploaderAccountSuspended'
end

#captioned? ⇒ Boolean

Returns whether captions are available for the video.

Returns:

  • (Boolean) —

    whether captions are available for the video.



240
241
242
 
# File 'lib/yt/models/video.rb', line 240

def captioned?
  content_detail.caption == 'true'
end

#category_id ⇒ String

Returns ID of the YouTube category associated with the video.

Returns:

  • (String) —

    ID of the YouTube category associated with the video.



51
52
53
 
# File 'lib/yt/models/video.rb', line 51

def category_id
  ensure_complete_snippet :category_id
end

#category_title ⇒ String

Returns the video category’s title.

Returns:

  • (String) —

    the video category’s title.



311
312
313
 
# File 'lib/yt/models/video.rb', line 311

def category_title
  video_category.title
end

#claimed? ⇒ Boolean

Returns whether the video was rejected by YouTube because the video was claimed by a different account.

Returns:

  • (Boolean) —

    whether the video was rejected by YouTube because the video was claimed by a different account.



122
123
124
 
# File 'lib/yt/models/video.rb', line 122

def claimed?
  status.rejection_reason == 'claim'
end

#comments(options = {}) ⇒ Hash<Date, Float>

Returns the comments grouped by the given dimension.

Examples:

Get the comments for each day of last week:

resource.comments since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the comments.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect comments by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the comments for each day in the time-range.



385
 
# File 'lib/yt/models/video.rb', line 385

has_report :comments

#delete(options = {}) ⇒ Boolean

Deletes the video on behalf of the authenticated account.

Returns:

  • (Boolean) —

    whether the video does not exist anymore.

Raises:



490
491
492
493
 
# File 'lib/yt/models/video.rb', line 490

def delete(options = {})
  do_delete {@id = nil}
  !exists?
end

#deleted? ⇒ Boolean

Returns whether the video was deleted by the user.

Returns:

  • (Boolean) —

    whether the video was deleted by the user.



58
59
60
 
# File 'lib/yt/models/video.rb', line 58

def deleted?
  status.upload_status == 'deleted'
end

#dislike ⇒ Boolean

Dislikes the video on behalf of the authenticated account.

Returns:

  • (Boolean) —

    whether the account does not like the video.

Raises:



292
293
294
295
 
# File 'lib/yt/models/video.rb', line 292

def dislike
  rating.set :dislike
  !liked?
end

#dislikes(options = {}) ⇒ Hash<Date, Float>

Returns the dislikes grouped by the given dimension.

Examples:

Get the dislikes for each day of last week:

resource.dislikes since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the dislikes.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect dislikes by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the dislikes for each day in the time-range.



391
 
# File 'lib/yt/models/video.rb', line 391

has_report :dislikes

#duplicate? ⇒ Boolean

Returns whether the video was rejected by YouTube because the video is a duplicate of another video.

Returns:

  • (Boolean) —

    whether the video was rejected by YouTube because the video is a duplicate of another video.



134
135
136
 
# File 'lib/yt/models/video.rb', line 134

def duplicate?
  status.rejection_reason == 'duplicate'
end

#earnings(options = {}) ⇒ Hash<Date, Float>

Returns the earnings grouped by the given dimension.

Examples:

Get the earnings for each day of last week:

resource.earnings since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the earnings.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect earnings by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the earnings for each day in the time-range.



428
 
# File 'lib/yt/models/video.rb', line 428

has_report :earnings

#embeddable? ⇒ Boolean

Returns whether the video can be embedded on other websites.

Returns:

  • (Boolean) —

    whether the video can be embedded on other websites.



217
218
219
 
# File 'lib/yt/models/video.rb', line 217

def embeddable?
  status.embeddable
end

#empty? ⇒ Boolean

Returns whether the video failed to upload to YouTube because the video file is empty.

Returns:

  • (Boolean) —

    whether the video failed to upload to YouTube because the video file is empty.



97
98
99
 
# File 'lib/yt/models/video.rb', line 97

def empty?
  status.failure_reason == 'emptyFile'
end

#estimated_minutes_watched(options = {}) ⇒ Hash<Symbol, Float>, ...

Returns the estimated_minutes_watched grouped by the given dimension.

Examples:

Get yesterday’s estimated_minutes_watched by embedded player location:

resource.estimated_minutes_watched from: 1.day.ago, to: 1.day.ago, by: :embedded_player_location
# => {"fullscreen.net" => 92.0, "yahoo.com" => 14.0, …}

Get yesterday’s estimated_minutes_watched grouped by playback location:

resource.estimated_minutes_watched from: 1.day.ago, to: 1.day.ago, by: :playback_location
# => {embedded: 53.0, watch: 467.0, …}

Get yesterday’s estimated_minutes_watched by related video:

resource.estimated_minutes_watched from: 1.day.ago, to: 1.day.ago, by: :related_video
# => {#<Yt::Video @id=…> => 33.0, #<Yt::Video @id=…> => 12.0, …}

Get yesterday’s estimated_minutes_watched by device type:

resource.estimated_minutes_watched from: 1.day.ago, to: 1.day.ago, by: :device_type
# => {mobile: 133.0, tv: 412.0, …}

Get yesterday’s estimated_minutes_watched by traffic source:

resource.estimated_minutes_watched from: 1.day.ago, to: 1.day.ago, by: :traffic_source
# => {advertising: 543.0, playlist: 92.0, …}

Get the estimated_minutes_watched for each day of last week:

resource.estimated_minutes_watched since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the estimated_minutes_watched.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect estimated_minutes_watched by. Accepted values are: :day, :traffic_source, :playback_location, :related_video, :embedded_player_location.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Symbol, Float>) —

    if grouped by embedded player location, the estimated_minutes_watched for each embedded player location.

  • (Hash<Symbol, Float>) —

    if grouped by playback location, the estimated_minutes_watched for each traffic playback location.

  • (Hash<Yt::Video, Float>) —

    if grouped by related video, the estimated_minutes_watched for each related video.

  • (Hash<Yt::Video, Float>) —

    if grouped by device type, the estimated_minutes_watched for each device type.

  • (Hash<Yt::Video, Float>) —

    if grouped by traffic source, the estimated_minutes_watched for each traffic source.

  • (Hash<Date, Float>) —

    if grouped by day, the estimated_minutes_watched for each day in the time-range.



379
 
# File 'lib/yt/models/video.rb', line 379

has_report :estimated_minutes_watched

#failed? ⇒ Boolean

Returns whether the video failed to upload.

Returns:

  • (Boolean) —

    whether the video failed to upload.



63
64
65
 
# File 'lib/yt/models/video.rb', line 63

def failed?
  status.upload_status == 'failed'
end

#favorites_added(options = {}) ⇒ Hash<Date, Float>

Returns the favorites_added grouped by the given dimension.

Examples:

Get the favorites_added for each day of last week:

resource.favorites_added since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the favorites_added.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect favorites_added by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the favorites_added for each day in the time-range.



407
 
# File 'lib/yt/models/video.rb', line 407

has_report :favorites_added

#favorites_removed(options = {}) ⇒ Hash<Date, Float>

Returns the favorites_removed grouped by the given dimension.

Examples:

Get the favorites_removed for each day of last week:

resource.favorites_removed since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the favorites_removed.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect favorites_removed by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the favorites_removed for each day in the time-range.



410
 
# File 'lib/yt/models/video.rb', line 410

has_report :favorites_removed

#has_failed_conversion? ⇒ Boolean

Returns whether the video failed to upload to YouTube because YouTube was unable to convert the video.

Returns:

  • (Boolean) —

    whether the video failed to upload to YouTube because YouTube was unable to convert the video.



91
92
93
 
# File 'lib/yt/models/video.rb', line 91

def has_failed_conversion?
  status.failure_reason == 'conversion'
end

#has_public_stats_viewable? ⇒ Boolean

Returns whether the video statistics are publicly viewable.

Returns:

  • (Boolean) —

    if the resource is a video, whether the extended video statistics on the video’s watch page are publicly viewable. By default, those statistics are viewable, and statistics like a video’s viewcount and ratings will still be publicly visible even if this property’s value is set to false.



212
213
214
 
# File 'lib/yt/models/video.rb', line 212

def has_public_stats_viewable?
  status.public_stats_viewable
end

#hd? ⇒ Boolean

Returns whether the video is available in high definition.

Returns:

  • (Boolean) —

    whether the video is available in high definition.



235
236
237
 
# File 'lib/yt/models/video.rb', line 235

def hd?
  content_detail.definition == 'hd'
end

#impressions(options = {}) ⇒ Hash<Date, Float>

Returns the impressions grouped by the given dimension.

Examples:

Get the impressions for each day of last week:

resource.impressions since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the impressions.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect impressions by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the impressions for each day in the time-range.



431
 
# File 'lib/yt/models/video.rb', line 431

has_report :impressions

#inappropriate? ⇒ Boolean

Returns whether the video was rejected by YouTube because the video contains inappropriate content.

Returns:

  • (Boolean) —

    whether the video was rejected by YouTube because the video contains inappropriate content.



140
141
142
 
# File 'lib/yt/models/video.rb', line 140

def inappropriate?
  status.rejection_reason == 'inappropriate'
end

#infringes_copyright? ⇒ Boolean

Returns whether the video was rejected by YouTube because the video commits a copyright infringement.

Returns:

  • (Boolean) —

    whether the video was rejected by YouTube because the video commits a copyright infringement.



128
129
130
 
# File 'lib/yt/models/video.rb', line 128

def infringes_copyright?
  status.rejection_reason == 'copyright'
end

#infringes_trademark? ⇒ Boolean

Returns whether the video was rejected by YouTube because the video infringes a trademark.

Returns:

  • (Boolean) —

    whether the video was rejected by YouTube because the video infringes a trademark.

See Also:



160
161
162
 
# File 'lib/yt/models/video.rb', line 160

def infringes_trademark?
  status.rejection_reason == 'trademark'
end

#invalid? ⇒ Boolean

Returns whether the video failed to upload to YouTube because the video uses an unsupported file format.

Returns:

  • (Boolean) —

    whether the video failed to upload to YouTube because the video uses an unsupported file format.

See Also:



104
105
106
 
# File 'lib/yt/models/video.rb', line 104

def invalid?
  status.failure_reason == 'invalidFile'
end

#licensed? ⇒ Boolean

Returns whether the video represents licensed content, which means that the content has been claimed by a YouTube content partner.

Returns:

  • (Boolean) —

    whether the video represents licensed content, which means that the content has been claimed by a YouTube content partner.



246
247
248
 
# File 'lib/yt/models/video.rb', line 246

def licensed?
  content_detail.licensed_content || false
end

#licensed_as_creative_commons? ⇒ Boolean

Returns whether the video uses a Creative Commons license.

Returns:

  • (Boolean) —

    whether the video uses a Creative Commons license.

See Also:



202
203
204
 
# File 'lib/yt/models/video.rb', line 202

def licensed_as_creative_commons?
  license == 'creativeCommon'
end

#licensed_as_standard_youtube? ⇒ Boolean

Returns whether the video uses the Standard YouTube license.

Returns:

  • (Boolean) —

    whether the video uses the Standard YouTube license.

See Also:



196
197
198
 
# File 'lib/yt/models/video.rb', line 196

def licensed_as_standard_youtube?
  license == 'youtube'
end

#like ⇒ Boolean

Likes the video on behalf of the authenticated account.

Returns:

  • (Boolean) —

    whether the authenticated account likes the video.

Raises:



283
284
285
286
 
# File 'lib/yt/models/video.rb', line 283

def like
  rating.set :like
  liked?
end

#liked? ⇒ Boolean

Returns whether the authenticated account likes the video.

Returns:

  • (Boolean) —

    whether the authenticated account likes the video.

Raises:



275
276
277
 
# File 'lib/yt/models/video.rb', line 275

def liked?
  rating.rating == :like
end

#likes(options = {}) ⇒ Hash<Date, Float>

Returns the likes grouped by the given dimension.

Examples:

Get the likes for each day of last week:

resource.likes since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the likes.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect likes by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the likes for each day in the time-range.



388
 
# File 'lib/yt/models/video.rb', line 388

has_report :likes

#monetized_playbacks(options = {}) ⇒ Hash<Date, Float>

Returns the monetized_playbacks grouped by the given dimension.

Examples:

Get the monetized_playbacks for each day of last week:

resource.monetized_playbacks since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the monetized_playbacks.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect monetized_playbacks by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the monetized_playbacks for each day in the time-range.



434
 
# File 'lib/yt/models/video.rb', line 434

has_report :monetized_playbacks

#processed? ⇒ Boolean

Returns whether the video has been fully processed by YouTube.

Returns:

  • (Boolean) —

    whether the video has been fully processed by YouTube.



68
69
70
 
# File 'lib/yt/models/video.rb', line 68

def processed?
  status.upload_status == 'processed'
end

#rejected? ⇒ Boolean

Returns whether the video was rejected by YouTube.

Returns:

  • (Boolean) —

    whether the video was rejected by YouTube.



73
74
75
 
# File 'lib/yt/models/video.rb', line 73

def rejected?
  status.upload_status == 'rejected'
end

#scheduled? ⇒ Boolean

Returns whether the video is scheduled to be published.

Returns:

  • (Boolean) —

    whether the video is scheduled to be published.



185
186
187
 
# File 'lib/yt/models/video.rb', line 185

def scheduled?
  private? && status.publish_at
end

#scheduled_at ⇒ Time?

Returns the time when a video is scheduled to be published.

Returns:

  • (Time) —

    if the video is scheduled to be published, the time when it will become public.

  • (nil) —

    if the video is not scheduled to be published.



180
181
182
 
# File 'lib/yt/models/video.rb', line 180

def scheduled_at
  status.publish_at if scheduled?
end

#shares(options = {}) ⇒ Hash<Date, Float>

Returns the shares grouped by the given dimension.

Examples:

Get the shares for each day of last week:

resource.shares since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the shares.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect shares by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the shares for each day in the time-range.



394
 
# File 'lib/yt/models/video.rb', line 394

has_report :shares

#stereoscopic? ⇒ Boolean

Returns whether the video is available in 3D.

Returns:

  • (Boolean) —

    whether the video is available in 3D.



230
231
232
 
# File 'lib/yt/models/video.rb', line 230

def stereoscopic?
  content_detail.dimension == '3d'
end

#subscribers_gained(options = {}) ⇒ Hash<Date, Float>

Note:

This is not the total number of subscribers gained by the video’s channel, but the subscribers gained from the video’s page.

Returns the subscribers_gained grouped by the given dimension.

Examples:

Get the subscribers_gained for each day of last week:

resource.subscribers_gained since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the subscribers_gained.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect subscribers_gained by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the subscribers_gained for each day in the time-range.



399
 
# File 'lib/yt/models/video.rb', line 399

has_report :subscribers_gained

#subscribers_lost(options = {}) ⇒ Hash<Date, Float>

Note:

This is not the total number of subscribers lost by the video’s channel, but the subscribers lost from the video’s page.

Returns the subscribers_lost grouped by the given dimension.

Examples:

Get the subscribers_lost for each day of last week:

resource.subscribers_lost since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the subscribers_lost.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect subscribers_lost by. Accepted values are: :day.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Date, Float>) —

    if grouped by day, the subscribers_lost for each day in the time-range.



404
 
# File 'lib/yt/models/video.rb', line 404

has_report :subscribers_lost

#tags ⇒ Array<String>

Returns the list of tags attached to the video.

Returns:

  • (Array<String>) —

    the list of tags attached to the video.



46
47
48
 
# File 'lib/yt/models/video.rb', line 46

def tags
  ensure_complete_snippet :tags
end

#thumbnail_url(size = :default) ⇒ String?

Returns the URL of the video’s thumbnail.

Parameters:

  • size (Symbol, String) (defaults to: :default) —

    The size of the video’s thumbnail.

Returns:

  • (String) —

    if size is default, the URL of a 120x90px image.

  • (String) —

    if size is medium, the URL of a 320x180px image.

  • (String) —

    if size is high, the URL of a 480x360px image.

  • (nil) —

    if the size is not default, medium or high.



26
 
# File 'lib/yt/models/video.rb', line 26

delegate :thumbnail_url, to: :snippet

#too_long? ⇒ Boolean

Returns whether the video was rejected by YouTube because the video exceeds the maximum duration for YouTube.

Returns:

  • (Boolean) —

    whether the video was rejected by YouTube because the video exceeds the maximum duration for YouTube.

See Also:



147
148
149
 
# File 'lib/yt/models/video.rb', line 147

def too_long?
  status.rejection_reason == 'length'
end

#too_small? ⇒ Boolean

Returns whether the video failed to upload to YouTube because the video file is too small for YouTube.

Returns:

  • (Boolean) —

    whether the video failed to upload to YouTube because the video file is too small for YouTube.



110
111
112
 
# File 'lib/yt/models/video.rb', line 110

def too_small?
  status.failure_reason == 'tooSmall'
end

#unlike ⇒ Boolean

Resets the rating of the video on behalf of the authenticated account.

Returns:

  • (Boolean) —

    whether the account does not like the video.

Raises:



301
302
303
304
 
# File 'lib/yt/models/video.rb', line 301

def unlike
  rating.set :none
  !liked?
end

#update(attributes = {}) ⇒ Boolean

Updates the attributes of a video.

Examples:

Update title and description of a video.

video.update title: 'New title', description: 'New description'

Update tags and category ID of a video.

video.update tags: ['new', 'tags'], category_id: '22'

Update status of a video.

video.update privacy_status: 'public', public_stats_viewable: true

Update visibility/license of a video.

video.update embeddable: true, license: :youtube

Update the time when a private video will become public.

video.update publish_at: 3.days.from_now.utc.iso8601(3)

Parameters:

  • attributes (Hash) (defaults to: {}) —

    the attributes to update.

Options Hash (attributes):

  • :title (String) —

    The new video’s title. Cannot have more than 100 characters. Can include the characters < and >, which are replaced to ‹ › in order to be accepted by YouTube.

  • :description (String) —

    The new video’s description. Cannot have more than 5000 bytes. Can include the characters < and >, which are replaced to ‹ › in order to be accepted by YouTube.

  • :tags (Array<String>) —

    The new video’s tags. Cannot have more than 500 characters. Can include the characters < and >, which are replaced to ‹ › in order to be accepted by YouTube.

  • :category_id (String) —

    The new video’s category ID.

  • :privacy_status (String) —

    The new video’s privacy status. Must be one of: private, unscheduled, public.

  • :embeddable (Boolean) —

    The new value to specify whether the video can be embedded on other websites.

  • :license (String) —

    The new video’s license. Must be one of: youtube, creativeCommon.

  • :public_stats_viewable (Boolean) —

    The new value to specify whether the video’s statistics are publicly viewable.

  • :publish_at (Object) —

    The new timestamp when the video will be made public. Must be in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sZ).

Returns:

  • (Boolean) —

    whether the video was successfully updated.

Raises:



530
531
532
 
# File 'lib/yt/models/video.rb', line 530

def update(attributes = {})
  super
end

#upload_thumbnail(path_or_url) ⇒ Object

Uploads a thumbnail

Parameters:

  • path_or_url (String) —

    the image to upload. Can either be the path of a local file or the URL of a remote file.

Returns:

  • the new thumbnail resource for the given image.

Raises:



477
478
479
480
481
482
483
484
 
# File 'lib/yt/models/video.rb', line 477

def upload_thumbnail(path_or_url)
  file = open(path_or_url, 'rb') rescue StringIO.new
  session = resumable_sessions.insert file.size

  session.update(body: file) do |data|
    snippet.instance_variable_set :@thumbnails, data['items'].first
  end
end

#uploading? ⇒ Boolean

Returns whether the video is being uploaded to YouTube.

Returns:

  • (Boolean) —

    whether the video is being uploaded to YouTube.



78
79
80
 
# File 'lib/yt/models/video.rb', line 78

def uploading?
  status.upload_status == 'uploaded'
end

#uses_unsupported_codec? ⇒ Boolean

Returns whether the video failed to upload to YouTube because of an unsupported codec.

Returns:

  • (Boolean) —

    whether the video failed to upload to YouTube because of an unsupported codec.

See Also:



85
86
87
 
# File 'lib/yt/models/video.rb', line 85

def uses_unsupported_codec?
  status.failure_reason == 'codec'
end

#viewer_percentage(options = {}) ⇒ Hash<Symbol, Float>, ...

Returns the viewer_percentage grouped by the given dimension.

Examples:

Get yesterday’s viewer percentage by gender:

resource.viewer_percentage from: 1.day.ago, to: 1.day.ago, by: :gender
# => {female: 53.0, male: 47.0}

Get yesterday’s viewer_percentage grouped by age group:

resource.viewer_percentage from: 1.day.ago, to: 1.day.ago, by: :age_group
# => {"18-24" => 4.54, "35-24" => 12.31, "45-34" => 8.92, …}

Get yesterday’s viewer_percentage by gender and age group:

resource.viewer_percentage from: 1.day.ago, to: 1.day.ago
# => {female: {"18-24" => 12.12, "25-34" => 16.16, …}, male:…}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the viewer_percentage.

Options Hash (options):

  • :by (Symbol) — default: :gender_age_group —

    The dimension to show viewer percentage by. Accepted values are: :gender, :age_group, :gender_age_group.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Symbol, Float>) —

    if grouped by gender, the viewer percentage by gender.

  • (Hash<String, Float>) —

    if grouped by age group, the viewer percentage by age group.

  • (Hash<Symbol, [Hash<String, Float>]>) —

    if grouped by gender and age group, the viewer percentage by gender/age group.



382
 
# File 'lib/yt/models/video.rb', line 382

has_report :viewer_percentage

#views(options = {}) ⇒ Hash<Symbol, Float>, ...

Returns the views grouped by the given dimension.

Examples:

Get yesterday’s views by embedded player location:

resource.views from: 1.day.ago, to: 1.day.ago, by: :embedded_player_location
# => {"fullscreen.net" => 92.0, "yahoo.com" => 14.0, …}

Get yesterday’s views grouped by playback location:

resource.views from: 1.day.ago, to: 1.day.ago, by: :playback_location
# => {embedded: 53.0, watch: 467.0, …}

Get yesterday’s views by related video:

resource.views from: 1.day.ago, to: 1.day.ago, by: :related_video
# => {#<Yt::Video @id=…> => 33.0, #<Yt::Video @id=…> => 12.0, …}

Get yesterday’s views by device type:

resource.views from: 1.day.ago, to: 1.day.ago, by: :device_type
# => {mobile: 133.0, tv: 412.0, …}

Get yesterday’s views by traffic source:

resource.views from: 1.day.ago, to: 1.day.ago, by: :traffic_source
# => {advertising: 543.0, playlist: 92.0, …}

Get the views for each day of last week:

resource.views since: 2.weeks.ago, until: 1.week.ago, by: :day
# => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}

Parameters:

  • options (Hash) (defaults to: {}) —

    the time-range and dimensions for the views.

Options Hash (options):

  • :by (Symbol) — default: :day —

    The dimension to collect views by. Accepted values are: :day, :traffic_source, :playback_location, :related_video, :embedded_player_location.

  • :since (#to_date) —

    The first day of the time-range. Also aliased as :from.

  • :until (#to_date) —

    The last day of the time-range. Also aliased as :to.

Returns:

  • (Hash<Symbol, Float>) —

    if grouped by embedded player location, the views for each embedded player location.

  • (Hash<Symbol, Float>) —

    if grouped by playback location, the views for each traffic playback location.

  • (Hash<Yt::Video, Float>) —

    if grouped by related video, the views for each related video.

  • (Hash<Yt::Video, Float>) —

    if grouped by device type, the views for each device type.

  • (Hash<Yt::Video, Float>) —

    if grouped by traffic source, the views for each traffic source.

  • (Hash<Date, Float>) —

    if grouped by day, the views for each day in the time-range.



376
 
# File 'lib/yt/models/video.rb', line 376

has_report :views

#violates_terms_of_use? ⇒ Boolean

Returns whether the video was rejected by YouTube because the video violates the Terms of Use.

Returns:

  • (Boolean) —

    whether the video was rejected by YouTube because the video violates the Terms of Use.



153
154
155
 
# File 'lib/yt/models/video.rb', line 153

def violates_terms_of_use?
  status.rejection_reason == 'termsOfUse'
end