Class: Yt::Models::Channel

Inherits:

Resource

• Object
• Base
• Resource
• Yt::Models::Channel

Defined in:

lib/yt/models/channel.rb

Overview

A channel resource contains information about a YouTube channel.

See Also:

• https://developers.google.com/youtube/v3/docs/channels

Instance Attribute Summary

• #playlists ⇒ Yt::Collections::Playlists readonly

  The channel’s playlists.

• #statistics_set ⇒ Yt::Models::StatisticsSet readonly

  The statistics for the video.

• #subscriptions ⇒ Yt::Collections::Subscriptions readonly

  The channel’s subscriptions.

• #videos ⇒ Yt::Collections::Videos readonly

  The channel’s videos.

Attributes inherited from Resource

#auth

Instance Method Summary

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

  The comments for a range of a days.

• #comments_on(date) ⇒ Float

  The comments for a single day.

• #create_playlist(params = {}) ⇒ Object
• #delete_playlists(attrs = {}) ⇒ Object
• #dislikes(options = {}) ⇒ Hash<Date, Float>

  The dislikes for a range of a days.

• #dislikes_on(date) ⇒ Float

  The dislikes for a single day.

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

  The earnings for a range of a days.

• #earnings_on(date) ⇒ Float

  The earnings for a single day.

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

  The impressions for a range of a days.

• #impressions_on(date) ⇒ Float

  The impressions for a single day.

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

  The likes for a range of a days.

• #likes_on(date) ⇒ Float

  The likes for a single day.

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

  The shares for a range of a days.

• #shares_on(date) ⇒ Float

  The shares for a single day.

• #subscribe ⇒ Object

  Subscribes the authenticated account to the channel.

• #subscribe! ⇒ Object

  Subscribes the authenticated account to the channel.

• #subscribed? ⇒ Boolean

  Returns whether the authenticated account is subscribed to the channel.

• #unsubscribe ⇒ Object

  Unsubscribes the authenticated account from the channel.

• #unsubscribe! ⇒ Object

  Unsubscribes the authenticated account from the channel.

• #viewer_percentage(filters = {}) ⇒ Float

  The percentage of viewer matching the filters.

• #viewer_percentages ⇒ Hash<Symbol,Hash<String,Float>>

  The viewer percentages.

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

  The views for a range of a days.

• #views_on(date) ⇒ Float

  The views for a single day.

Methods inherited from Resource

#initialize, #kind, #username

Methods included from Associations::HasReports

#has_report

Methods included from Associations::HasViewerPercentages

#has_viewer_percentages

Methods included from Associations::HasOne

#has_one

Methods included from Associations::HasMany

#has_many

Methods included from Associations::HasAuthentication

#has_authentication

Constructor Details

This class inherits a constructor from Yt::Models::Resource

Instance Attribute Details

#playlists ⇒ Yt::Collections::Playlists (readonly)

Returns the channel’s playlists.

Returns:

• (Yt::Collections::Playlists) —

  the channel’s playlists.

# File 'lib/yt/models/channel.rb', line 18

has_many :playlists

#statistics_set ⇒ Yt::Models::StatisticsSet (readonly)

Returns the statistics for the video.

Returns:

• (Yt::Models::StatisticsSet) —

  the statistics for the video.

# File 'lib/yt/models/channel.rb', line 46

has_one :statistics_set

#subscriptions ⇒ Yt::Collections::Subscriptions (readonly)

Returns the channel’s subscriptions.

Returns:

• (Yt::Collections::Subscriptions) —

  the channel’s subscriptions.

# File 'lib/yt/models/channel.rb', line 10

has_many :subscriptions

#videos ⇒ Yt::Collections::Videos (readonly)

Returns the channel’s videos.

Returns:

• (Yt::Collections::Videos) —

  the channel’s videos.

# File 'lib/yt/models/channel.rb', line 14

has_many :videos

Instance Method Details

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

Returns the comments for a range of a days.

Parameters:

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

  the range of days to get the comments for.

Options Hash (options):

• :since (#to_date) —

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

• :until (#to_date) —

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

Returns:

• (Hash<Date, Float>) —

  the comments for a range of a days.

# File 'lib/yt/models/channel.rb', line 27

has_report :comments

#comments_on(date) ⇒ Float

Returns the comments for a single day.

Parameters:

• date (#to_date) —

  The single day to get the comments for.

Returns:

• (Float) —

  the comments for a single day.

# File 'lib/yt/models/channel.rb', line 27

has_report :comments

#create_playlist(params = {}) ⇒ Object

# File 'lib/yt/models/channel.rb', line 109

def create_playlist(params = {})
  playlists.insert params
end

#delete_playlists(attrs = {}) ⇒ Object

# File 'lib/yt/models/channel.rb', line 113

def delete_playlists(attrs = {})
  playlists.delete_all attrs
end

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

Returns the dislikes for a range of a days.

Parameters:

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

  the range of days to get the dislikes for.

Options Hash (options):

• :since (#to_date) —

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

• :until (#to_date) —

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

Returns:

• (Hash<Date, Float>) —

  the dislikes for a range of a days.

# File 'lib/yt/models/channel.rb', line 33

has_report :dislikes

#dislikes_on(date) ⇒ Float

Returns the dislikes for a single day.

Parameters:

• date (#to_date) —

  The single day to get the dislikes for.

Returns:

• (Float) —

  the dislikes for a single day.

# File 'lib/yt/models/channel.rb', line 33

has_report :dislikes

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

Returns the earnings for a range of a days.

Parameters:

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

  the range of days to get the earnings for.

Options Hash (options):

• :since (#to_date) —

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

• :until (#to_date) —

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

Returns:

• (Hash<Date, Float>) —

  the earnings for a range of a days.

# File 'lib/yt/models/channel.rb', line 21

has_report :earnings

#earnings_on(date) ⇒ Float

Returns the earnings for a single day.

Parameters:

• date (#to_date) —

  The single day to get the earnings for.

Returns:

• (Float) —

  the earnings for a single day.

# File 'lib/yt/models/channel.rb', line 21

has_report :earnings

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

Returns the impressions for a range of a days.

Parameters:

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

  the range of days to get the impressions for.

Options Hash (options):

• :since (#to_date) —

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

• :until (#to_date) —

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

Returns:

• (Hash<Date, Float>) —

  the impressions for a range of a days.

# File 'lib/yt/models/channel.rb', line 39

has_report :impressions

#impressions_on(date) ⇒ Float

Returns the impressions for a single day.

Parameters:

• date (#to_date) —

  The single day to get the impressions for.

Returns:

• (Float) —

  the impressions for a single day.

# File 'lib/yt/models/channel.rb', line 39

has_report :impressions

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

Returns the likes for a range of a days.

Parameters:

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

  the range of days to get the likes for.

Options Hash (options):

• :since (#to_date) —

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

• :until (#to_date) —

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

Returns:

• (Hash<Date, Float>) —

  the likes for a range of a days.

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

has_report :likes

#likes_on(date) ⇒ Float

Returns the likes for a single day.

Parameters:

• date (#to_date) —

  The single day to get the likes for.

Returns:

• (Float) —

  the likes for a single day.

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

has_report :likes

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

Returns the shares for a range of a days.

Parameters:

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

  the range of days to get the shares for.

Options Hash (options):

• :since (#to_date) —

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

• :until (#to_date) —

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

Returns:

• (Hash<Date, Float>) —

  the shares for a range of a days.

# File 'lib/yt/models/channel.rb', line 36

has_report :shares

#shares_on(date) ⇒ Float

Returns the shares for a single day.

Parameters:

• date (#to_date) —

  The single day to get the shares for.

Returns:

• (Float) —

  the shares for a single day.

# File 'lib/yt/models/channel.rb', line 36

has_report :shares

#subscribe ⇒ Object

Subscribes the authenticated account to the channel. Does not raise an error if the account was already subscribed.

This method requires auth to return an authenticated instance of Account.

Raises:

• (Yt::Errors::Unauthorized) —

  if auth does not return an authenticated account.

# File 'lib/yt/models/channel.rb', line 68

def subscribe
  subscriptions.insert ignore_errors: true
end

#subscribe! ⇒ Object

Subscribes the authenticated account to the channel. Raises an error if the account was already subscribed.

This method requires auth to return an authenticated instance of Account.

Raises:

• (Yt::Errors::RequestError) —

  if auth was already subscribed to the channel.

• (Yt::Errors::Unauthorized) —

  if auth does not return an authenticated account.

# File 'lib/yt/models/channel.rb', line 81

def subscribe!
  subscriptions.insert
end

#subscribed? ⇒ Boolean

Returns whether the authenticated account is subscribed to the channel.

This method requires auth to return an authenticated instance of Account.

Returns:

• (Boolean) —

  whether the account is subscribed to the channel.

Raises:

• (Yt::Errors::Unauthorized) —

  if auth does not return an authenticated account.

# File 'lib/yt/models/channel.rb', line 57

def subscribed?
  subscriptions.any?{|s| s.exists?}
end

#unsubscribe ⇒ Object

Unsubscribes the authenticated account from the channel. Does not raise an error if the account was not subscribed.

This method requires auth to return an authenticated instance of Account.

Raises:

• (Yt::Errors::Unauthorized) —

  if auth does not return an authenticated account.

# File 'lib/yt/models/channel.rb', line 92

def unsubscribe
  subscriptions.delete_all({}, ignore_errors: true)
end

#unsubscribe! ⇒ Object

Unsubscribes the authenticated account from the channel. Raises an error if the account was not subscribed.

This method requires auth to return an authenticated instance of Account.

Raises:

• (Yt::Errors::RequestError) —

  if auth was not subscribed to the channel.

• (Yt::Errors::Unauthorized) —

  if auth does not return an authenticated account.

# File 'lib/yt/models/channel.rb', line 105

def unsubscribe!
  subscriptions.delete_all
end

#viewer_percentage(filters = {}) ⇒ Float

Returns the percentage of viewer matching the filters.

Examples:

Return the % of male viewers of a video

channel.viewer_percentage(gender: :male) #=> 52.02

Parameters:

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

  The type of viewers to be accounted for.

Options Hash (filters):

• :gender (Symbol) —

  Either :male or :female.

Returns:

• (Float) —

  the percentage of viewer matching the filters.

# File 'lib/yt/models/channel.rb', line 42

has_viewer_percentages

#viewer_percentages ⇒ Hash<Symbol,Hash<String,Float>>

Returns the viewer percentages. The first-level hash identifies the genres (:female, :male). The second-level hash identifies the age ranges (‘18-24’, ‘25-34’, ‘35-44’, ‘45-54’, ‘55-64’, ‘65-’).

Examples:

Return the % of male viewers of a channel older than 64

channel.viewer_percentages[:male]['65-'] #=> 12.02

Returns:

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

  the viewer percentages. The first-level hash identifies the genres (:female, :male). The second-level hash identifies the age ranges (‘18-24’, ‘25-34’, ‘35-44’, ‘45-54’, ‘55-64’, ‘65-’)

# File 'lib/yt/models/channel.rb', line 42

has_viewer_percentages

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

Returns the views for a range of a days.

Parameters:

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

  the range of days to get the views for.

Options Hash (options):

• :since (#to_date) —

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

• :until (#to_date) —

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

Returns:

• (Hash<Date, Float>) —

  the views for a range of a days.

# File 'lib/yt/models/channel.rb', line 24

has_report :views

#views_on(date) ⇒ Float

Returns the views for a single day.

Parameters:

• date (#to_date) —

  The single day to get the views for.

Returns:

• (Float) —

  the views for a single day.

# File 'lib/yt/models/channel.rb', line 24

has_report :views