Class: Yt::Models::VideoGroup

Inherits:
Base
  • Object
show all
Defined in:
lib/yt/models/video_group.rb

Overview

Provides methods to interact with YouTube Analytics video-groups.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#group_items ⇒ Yt::Collections::GroupItems (readonly)

Returns the group’s items.

Returns:

  • (Yt::Collections::GroupItems) —

    the group’s items.



31
 
# File 'lib/yt/models/video_group.rb', line 31

has_many :group_items

#item_count ⇒ Integer (readonly)

Returns the number of resources in the group.

Returns:

  • (Integer) —

    the number of resources in the group.



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

delegate :item_count, to: :group_info

#published_at ⇒ Time (readonly)

Returns the date and time when the group was created.

Returns:

  • (Time) —

    the date and time when the group was created.



25
 
# File 'lib/yt/models/video_group.rb', line 25

delegate :published_at, to: :group_info

#title ⇒ String (readonly)

Returns the title of the group.

Returns:

  • (String) —

    the title of the group.



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

delegate :title, to: :group_info

Instance Method Details

#ad_impressions(options = {}) ⇒ Hash<Date, Integer>, ...

Returns the ad_impressions grouped by the given dimension.

Examples:

Get the ad_impressions for each day of last week:

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

Get the ad_impressions for this and last month:

resource.ad_impressions since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the ad_impressions for the whole last week:

resource.ad_impressions since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the ad_impressions for the whole last week in France only:

resource.ad_impressions since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

Parameters:

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

    the time-range and dimensions for the ad_impressions.

Options Hash (options):

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

    The dimension to collect ad_impressions by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the ad_impressions to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

    if grouped by month, the ad_impressions for each month in the time-range.

  • (Hash<Symbol, Integer>) —

    if grouped by range, the ad_impressions for the entire time-range (under the key :total).



111
 
# File 'lib/yt/models/video_group.rb', line 111

has_report :ad_impressions, Integer

#all_channel_ids ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/yt/models/video_group.rb', line 163

def all_channel_ids
  resource_ids = group_items.map {|item| item.data['resource']['id']}.uniq
  case group_info.data['itemType']
  when "youtube#video"
    resource_ids.flat_map do |video_id|
      Yt::Video.new(id: video_id, auth: @auth).channel_id
    end.uniq
  when "youtube#channel"
    resource_ids
  else
    []
  end
end

#all_video_ids ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/yt/models/video_group.rb', line 141

def all_video_ids
  resource_ids = group_items.map{|item| item.data['resource']['id']}.uniq
  case group_info.data["itemType"]
  when "youtube#video"
    resource_ids
  when "youtube#channel"
    resource_ids.flat_map do |channel_id|
      Yt::Channel.new(id: channel_id, auth: @auth).videos.map(&:id)
    end
  else
    []
  end
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.0, …}

Get the annotation_click_through_rate for this and last month:

resource.annotation_click_through_rate since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the annotation_click_through_rate for the whole last week:

resource.annotation_click_through_rate since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the annotation_click_through_rate for the whole last week in Texas only:

resource.annotation_click_through_rate since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the annotation_click_through_rate to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Float>) —

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

  • (Hash<Range<Date, Date>, Float>) —

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

  • (Hash<Symbol, Float>) —

    if grouped by range, the annotation_click_through_rate for the entire time-range (under the key :total).



84
 
# File 'lib/yt/models/video_group.rb', line 84

has_report :annotation_click_through_rate, Float

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

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.0, …}

Get the annotation_clicks for this and last month:

resource.annotation_clicks since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the annotation_clicks for the whole last week:

resource.annotation_clicks since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the annotation_clicks for the whole last week in Texas only:

resource.annotation_clicks since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the annotation_clicks to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the annotation_clicks for the entire time-range (under the key :total).



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

has_report :annotation_clicks, Integer

#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.0, …}

Get the annotation_close_rate for this and last month:

resource.annotation_close_rate since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the annotation_close_rate for the whole last week:

resource.annotation_close_rate since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the annotation_close_rate for the whole last week in Texas only:

resource.annotation_close_rate since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the annotation_close_rate to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Float>) —

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

  • (Hash<Range<Date, Date>, Float>) —

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

  • (Hash<Symbol, Float>) —

    if grouped by range, the annotation_close_rate for the entire time-range (under the key :total).



87
 
# File 'lib/yt/models/video_group.rb', line 87

has_report :annotation_close_rate, Float

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

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.0, …}

Get the average_view_duration for this and last month:

resource.average_view_duration since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the average_view_duration for the whole last week:

resource.average_view_duration since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the average_view_duration for the whole last week in Texas only:

resource.average_view_duration since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the average_view_duration to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the average_view_duration for the entire time-range (under the key :total).



75
 
# File 'lib/yt/models/video_group.rb', line 75

has_report :average_view_duration, Integer

#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.0, …}

Get the average_view_percentage for this and last month:

resource.average_view_percentage since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the average_view_percentage for the whole last week:

resource.average_view_percentage since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the average_view_percentage for the whole last week in Texas only:

resource.average_view_percentage since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the average_view_percentage to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Float>) —

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

  • (Hash<Range<Date, Date>, Float>) —

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

  • (Hash<Symbol, Float>) —

    if grouped by range, the average_view_percentage for the entire time-range (under the key :total).



78
 
# File 'lib/yt/models/video_group.rb', line 78

has_report :average_view_percentage, Float

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

Returns the card_click_rate grouped by the given dimension.

Examples:

Get the card_click_rate for each day of last week:

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

Get the card_click_rate for this and last month:

resource.card_click_rate since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the card_click_rate for the whole last week:

resource.card_click_rate since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the card_click_rate for the whole last week in Texas only:

resource.card_click_rate since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

Parameters:

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

    the time-range and dimensions for the card_click_rate.

Options Hash (options):

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

    The dimension to collect card_click_rate by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the card_click_rate to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Float>) —

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

  • (Hash<Range<Date, Date>, Float>) —

    if grouped by month, the card_click_rate for each month in the time-range.

  • (Hash<Symbol, Float>) —

    if grouped by range, the card_click_rate for the entire time-range (under the key :total).



96
 
# File 'lib/yt/models/video_group.rb', line 96

has_report :card_click_rate, Float

#card_clicks(options = {}) ⇒ Hash<Date, Integer>, ...

Returns the card_clicks grouped by the given dimension.

Examples:

Get the card_clicks for each day of last week:

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

Get the card_clicks for this and last month:

resource.card_clicks since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the card_clicks for the whole last week:

resource.card_clicks since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the card_clicks for the whole last week in Texas only:

resource.card_clicks since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

Parameters:

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

    the time-range and dimensions for the card_clicks.

Options Hash (options):

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

    The dimension to collect card_clicks by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the card_clicks to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

    if grouped by month, the card_clicks for each month in the time-range.

  • (Hash<Symbol, Integer>) —

    if grouped by range, the card_clicks for the entire time-range (under the key :total).



93
 
# File 'lib/yt/models/video_group.rb', line 93

has_report :card_clicks, Integer

#card_impressions(options = {}) ⇒ Hash<Date, Integer>, ...

Returns the card_impressions grouped by the given dimension.

Examples:

Get the card_impressions for each day of last week:

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

Get the card_impressions for this and last month:

resource.card_impressions since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the card_impressions for the whole last week:

resource.card_impressions since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the card_impressions for the whole last week in Texas only:

resource.card_impressions since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

Parameters:

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

    the time-range and dimensions for the card_impressions.

Options Hash (options):

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

    The dimension to collect card_impressions by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the card_impressions to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

    if grouped by month, the card_impressions for each month in the time-range.

  • (Hash<Symbol, Integer>) —

    if grouped by range, the card_impressions for the entire time-range (under the key :total).



90
 
# File 'lib/yt/models/video_group.rb', line 90

has_report :card_impressions, Integer

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

Returns the card_teaser_click_rate grouped by the given dimension.

Examples:

Get the card_teaser_click_rate for each day of last week:

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

Get the card_teaser_click_rate for this and last month:

resource.card_teaser_click_rate since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the card_teaser_click_rate for the whole last week:

resource.card_teaser_click_rate since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the card_teaser_click_rate for the whole last week in Texas only:

resource.card_teaser_click_rate since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

Parameters:

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

    the time-range and dimensions for the card_teaser_click_rate.

Options Hash (options):

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

    The dimension to collect card_teaser_click_rate by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the card_teaser_click_rate to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Float>) —

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

  • (Hash<Range<Date, Date>, Float>) —

    if grouped by month, the card_teaser_click_rate for each month in the time-range.

  • (Hash<Symbol, Float>) —

    if grouped by range, the card_teaser_click_rate for the entire time-range (under the key :total).



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

has_report :card_teaser_click_rate, Float

#card_teaser_clicks(options = {}) ⇒ Hash<Date, Integer>, ...

Returns the card_teaser_clicks grouped by the given dimension.

Examples:

Get the card_teaser_clicks for each day of last week:

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

Get the card_teaser_clicks for this and last month:

resource.card_teaser_clicks since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the card_teaser_clicks for the whole last week:

resource.card_teaser_clicks since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the card_teaser_clicks for the whole last week in Texas only:

resource.card_teaser_clicks since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

Parameters:

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

    the time-range and dimensions for the card_teaser_clicks.

Options Hash (options):

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

    The dimension to collect card_teaser_clicks by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the card_teaser_clicks to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

    if grouped by month, the card_teaser_clicks for each month in the time-range.

  • (Hash<Symbol, Integer>) —

    if grouped by range, the card_teaser_clicks for the entire time-range (under the key :total).



102
 
# File 'lib/yt/models/video_group.rb', line 102

has_report :card_teaser_clicks, Integer

#card_teaser_impressions(options = {}) ⇒ Hash<Date, Integer>, ...

Returns the card_teaser_impressions grouped by the given dimension.

Examples:

Get the card_teaser_impressions for each day of last week:

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

Get the card_teaser_impressions for this and last month:

resource.card_teaser_impressions since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the card_teaser_impressions for the whole last week:

resource.card_teaser_impressions since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the card_teaser_impressions for the whole last week in Texas only:

resource.card_teaser_impressions since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

Parameters:

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

    the time-range and dimensions for the card_teaser_impressions.

Options Hash (options):

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

    The dimension to collect card_teaser_impressions by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the card_teaser_impressions to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

    if grouped by month, the card_teaser_impressions for each month in the time-range.

  • (Hash<Symbol, Integer>) —

    if grouped by range, the card_teaser_impressions for the entire time-range (under the key :total).



99
 
# File 'lib/yt/models/video_group.rb', line 99

has_report :card_teaser_impressions, Integer

#channels ⇒ Object 



177
178
179
180
181
182
183
 
# File 'lib/yt/models/video_group.rb', line 177

def channels
  all_channel_ids.each_slice(50).flat_map do |channel_ids|
    conditions = {id: channel_ids.join(',')}
    conditions[:part] = 'snippet'
    Collections::Channels.new(auth: @auth).where(conditions).map(&:itself)
  end
end

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

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.0, …}

Get the comments for this and last month:

resource.comments since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the comments for the whole last week:

resource.comments since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the comments for the whole last week in France only:

resource.comments since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the comments to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the comments for the entire time-range (under the key :total).



47
 
# File 'lib/yt/models/video_group.rb', line 47

has_report :comments, Integer

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

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.0, …}

Get the dislikes for this and last month:

resource.dislikes since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the dislikes for the whole last week:

resource.dislikes since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the dislikes for the whole last week in France only:

resource.dislikes since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the dislikes to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the dislikes for the entire time-range (under the key :total).



53
 
# File 'lib/yt/models/video_group.rb', line 53

has_report :dislikes, Integer

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

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 since: 1.day.ago, until: 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 since: 1.day.ago, until: 1.day.ago, by: :playback_location
# => {embedded: 53.0, watch: 467.0, …}

Get yesterday’s estimated_minutes_watched by related video, eager-loading the snippet of each video 

resource.estimated_minutes_watched since: 1.day.ago, until: 1.day.ago, by: :related_video, includes: [:snippet]
# => {#<Yt::Video @id=…> => 33.0, #<Yt::Video @id=…> => 12.0, …}

Get yesterday’s estimated_minutes_watched by search term:

resource.estimated_minutes_watched since: 1.day.ago, until: 1.day.ago, by: :search_term
# => {"fullscreen" => 33.0, "good music" => 12.0, …}

Get yesterday’s estimated_minutes_watched by URL that referred to the resource:

resource.estimated_minutes_watched since: 1.day.ago, until: 1.day.ago, by: :referrer
# => {"Google Search" => 33.0, "ytimg.com" => 12.0, …}

Get yesterday’s estimated_minutes_watched by device type:

resource.estimated_minutes_watched since: 1.day.ago, until: 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 since: 1.day.ago, until: 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.0, …}

Get the estimated_minutes_watched for this and last month:

resource.estimated_minutes_watched since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the estimated_minutes_watched for the whole last week:

resource.estimated_minutes_watched since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the estimated_minutes_watched for the whole last week in Texas only:

resource.estimated_minutes_watched since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

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, :month, :range, :traffic_source,:search_term, :playback_location, :related_video, :embedded_player_location.

  • :includes (Array<Symbol>) — default: [:id] —

    if grouped by related video, the parts of each video to eager-load. Accepted values are: :id, :snippet, :status, :statistics, :content_details.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the estimated_minutes_watched to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Symbol, Integer>) —

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

  • (Hash<Symbol, Integer>) —

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

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

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

  • (Hash<Symbol, Integer>) —

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

  • (Hash<String, Integer>) —

    if grouped by search term, the estimated_minutes_watched for each search term that led viewers to the content.

  • (Hash<String, Integer>) —

    if grouped by search term, the estimated_minutes_watched for each search term that led viewers to the content.

  • (Hash<Symbol, Integer>) —

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

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the estimated_minutes_watched for the entire time-range (under the key :total).



41
 
# File 'lib/yt/models/video_group.rb', line 41

has_report :estimated_minutes_watched, Integer

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

Returns the estimated_revenue grouped by the given dimension.

Examples:

Get the estimated_revenue for each day of last week:

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

Get the estimated_revenue for this and last month:

resource.estimated_revenue since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the estimated_revenue for the whole last week:

resource.estimated_revenue since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the estimated_revenue for the whole last week in France only:

resource.estimated_revenue since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

Parameters:

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

    the time-range and dimensions for the estimated_revenue.

Options Hash (options):

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

    The dimension to collect estimated_revenue by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the estimated_revenue to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Float>) —

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

  • (Hash<Range<Date, Date>, Float>) —

    if grouped by month, the estimated_revenue for each month in the time-range.

  • (Hash<Symbol, Float>) —

    if grouped by range, the estimated_revenue for the entire time-range (under the key :total).



108
 
# File 'lib/yt/models/video_group.rb', line 108

has_report :estimated_revenue, Float

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

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.0, …}

Get the likes for this and last month:

resource.likes since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the likes for the whole last week:

resource.likes since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the likes for the whole last week in France only:

resource.likes since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the likes to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the likes for the entire time-range (under the key :total).



50
 
# File 'lib/yt/models/video_group.rb', line 50

has_report :likes, Integer

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

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.0, …}

Get the monetized_playbacks for this and last month:

resource.monetized_playbacks since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the monetized_playbacks for the whole last week:

resource.monetized_playbacks since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the monetized_playbacks for the whole last week in France only:

resource.monetized_playbacks since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the monetized_playbacks to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the monetized_playbacks for the entire time-range (under the key :total).



114
 
# File 'lib/yt/models/video_group.rb', line 114

has_report :monetized_playbacks, Integer

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

Returns the playback_based_cpm grouped by the given dimension.

Examples:

Get the playback_based_cpm for each day of last week:

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

Get the playback_based_cpm for this and last month:

resource.playback_based_cpm since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the playback_based_cpm for the whole last week:

resource.playback_based_cpm since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the playback_based_cpm for the whole last week in France only:

resource.playback_based_cpm since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

Parameters:

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

    the time-range and dimensions for the playback_based_cpm.

Options Hash (options):

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

    The dimension to collect playback_based_cpm by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the playback_based_cpm to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Float>) —

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

  • (Hash<Range<Date, Date>, Float>) —

    if grouped by month, the playback_based_cpm for each month in the time-range.

  • (Hash<Symbol, Float>) —

    if grouped by range, the playback_based_cpm for the entire time-range (under the key :total).



117
 
# File 'lib/yt/models/video_group.rb', line 117

has_report :playback_based_cpm, Float

#reports(options = {}) ⇒ Hash<Symbol, Hash>

Returns the reports for the given metrics grouped by the given dimension.

Examples:

Get the views and estimated minutes watched by day for last week:

resource.reports only: [:views, :estimated_minutes_watched] since: 1.week.ago, by: :day
# => {views: {Wed, 8 May 2014 => 12, Thu, 9 May 2014 => 34, …}, estimated_minutes_watched: {Wed, 8 May 2014 => 9, Thu, 9 May 2014 => 6, …}}

Parameters:

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

    the metrics, time-range and dimensions for the reports.

Options Hash (options):

  • :only (Array<Symbol>) —

    The metrics to generate reports for.

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

    The dimension to collect metrics by. Accepted values are: :day, :month.

  • :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, Hash>) —

    the reports for each metric specified.




# File 'lib/yt/models/video_group.rb', line 35

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

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.0, …}

Get the shares for this and last month:

resource.shares since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the shares for the whole last week:

resource.shares since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the shares for the whole last week in France only:

resource.shares since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the shares to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the shares for the entire time-range (under the key :total).



56
 
# File 'lib/yt/models/video_group.rb', line 56

has_report :shares, Integer

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

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.0, …}

Get the subscribers_gained for this and last month:

resource.subscribers_gained since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the subscribers_gained for the whole last week:

resource.subscribers_gained since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the subscribers_gained for the whole last week in France only:

resource.subscribers_gained since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the subscribers_gained to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the subscribers_gained for the entire time-range (under the key :total).



61
 
# File 'lib/yt/models/video_group.rb', line 61

has_report :subscribers_gained, Integer

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

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.0, …}

Get the subscribers_lost for this and last month:

resource.subscribers_lost since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the subscribers_lost for the whole last week:

resource.subscribers_lost since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the subscribers_lost for the whole last week in France only:

resource.subscribers_lost since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

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, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the subscribers_lost to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the subscribers_lost for the entire time-range (under the key :total).



66
 
# File 'lib/yt/models/video_group.rb', line 66

has_report :subscribers_lost, Integer

#videos ⇒ Object 



155
156
157
158
159
160
161
 
# File 'lib/yt/models/video_group.rb', line 155

def videos
  all_video_ids.each_slice(50).flat_map do |video_ids|
    conditions = {id: video_ids.join(',')}
    conditions[:part] = 'snippet,status,statistics,contentDetails'
    Collections::Videos.new(auth: @auth).where(conditions).map(&:itself)
  end
end

#videos_added_to_playlists(options = {}) ⇒ Hash<Date, Integer>, ...

Returns the videos_added_to_playlists grouped by the given dimension.

Examples:

Get the videos_added_to_playlists for each day of last week:

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

Get the videos_added_to_playlists for this and last month:

resource.videos_added_to_playlists since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the videos_added_to_playlists for the whole last week:

resource.videos_added_to_playlists since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the videos_added_to_playlists for the whole last week in France only:

resource.videos_added_to_playlists since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

Parameters:

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

    the time-range and dimensions for the videos_added_to_playlists.

Options Hash (options):

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

    The dimension to collect videos_added_to_playlists by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the videos_added_to_playlists to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

    if grouped by month, the videos_added_to_playlists for each month in the time-range.

  • (Hash<Symbol, Integer>) —

    if grouped by range, the videos_added_to_playlists for the entire time-range (under the key :total).



69
 
# File 'lib/yt/models/video_group.rb', line 69

has_report :videos_added_to_playlists, Integer

#videos_removed_from_playlists(options = {}) ⇒ Hash<Date, Integer>, ...

Returns the videos_removed_from_playlists grouped by the given dimension.

Examples:

Get the videos_removed_from_playlists for each day of last week:

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

Get the videos_removed_from_playlists for this and last month:

resource.videos_removed_from_playlists since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the videos_removed_from_playlists for the whole last week:

resource.videos_removed_from_playlists since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the videos_removed_from_playlists for the whole last week in France only:

resource.videos_removed_from_playlists since: 2.weeks.ago, until: 1.week.ago, by: :range, in: 'FR'
# => {total: 44.0}

Parameters:

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

    the time-range and dimensions for the videos_removed_from_playlists.

Options Hash (options):

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

    The dimension to collect videos_removed_from_playlists by. Accepted values are: :day, :month, :range.

  • :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.

  • :in (<String, Hash>) —

    The country to limit the videos_removed_from_playlists to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash with the code in the :country key, such as {country: “US”}.

Returns:

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

    if grouped by month, the videos_removed_from_playlists for each month in the time-range.

  • (Hash<Symbol, Integer>) —

    if grouped by range, the videos_removed_from_playlists for the entire time-range (under the key :total).



72
 
# File 'lib/yt/models/video_group.rb', line 72

has_report :videos_removed_from_playlists, Integer

#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 since: 1.day.ago, until: 1.day.ago, by: :gender
# => {female: 53.0, male: 47.0}

Get yesterday’s viewer_percentage grouped by age group:

resource.viewer_percentage since: 1.day.ago, until: 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 since: 1.day.ago, until: 1.day.ago
# => {female: {"18-24" => 12.12, "25-34" => 16.16, …}, male:…}

Get yesterday’s viewer_percentage by gender and age group in France only:

resource.viewer_percentage since: 1.day.ago, until: 1.day.ago, in: 'FR'
# => {female: {"18-24" => 16.12, "25-34" => 13.16, …}, male:…}

Get the viewer_percentage for the whole last week in Texas only:

resource.viewer_percentage since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

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.

  • :in (<String, Hash>) —

    The location to limit the viewer_percentage to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

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.



44
 
# File 'lib/yt/models/video_group.rb', line 44

has_report :viewer_percentage, Float

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

Returns the views grouped by the given dimension.

Examples:

Get yesterday’s views by embedded player location:

resource.views since: 1.day.ago, until: 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 since: 1.day.ago, until: 1.day.ago, by: :playback_location
# => {embedded: 53.0, watch: 467.0, …}

Get yesterday’s views by related video, eager-loading the snippet of each video 

resource.views since: 1.day.ago, until: 1.day.ago, by: :related_video, includes: [:snippet]
# => {#<Yt::Video @id=…> => 33.0, #<Yt::Video @id=…> => 12.0, …}

Get yesterday’s views by search term:

resource.views since: 1.day.ago, until: 1.day.ago, by: :search_term
# => {"fullscreen" => 33.0, "good music" => 12.0, …}

Get yesterday’s views by URL that referred to the resource:

resource.views since: 1.day.ago, until: 1.day.ago, by: :referrer
# => {"Google Search" => 33.0, "ytimg.com" => 12.0, …}

Get yesterday’s views by device type:

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

Get yesterday’s views by traffic source:

resource.views since: 1.day.ago, until: 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.0, …}

Get the views for this and last month:

resource.views since: 1.month.ago, by: :month
# => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}

Get the views for the whole last week:

resource.views since: 2.weeks.ago, until: 1.week.ago, by: :range
# => {total: 564.0}

Get the views for the whole last week in Texas only:

resource.views since: 2.weeks.ago, until: 1.week.ago, by: :range, in: {state: 'TX'}
# => {total: 19.0}

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, :month, :range, :traffic_source,:search_term, :playback_location, :related_video, :embedded_player_location.

  • :includes (Array<Symbol>) — default: [:id] —

    if grouped by related video, the parts of each video to eager-load. Accepted values are: :id, :snippet, :status, :statistics, :content_details.

  • :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.

  • :in (<String, Hash>) —

    The location to limit the views to. Can either be the two-letter ISO-3166-1 code of a country, such as “US”, or a Hash that either contains the :country key, such as {country: “US”} or the :state key, such as {state: “TX”}. Note that YouTube API only provides data for US states.

Returns:

  • (Hash<Symbol, Integer>) —

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

  • (Hash<Symbol, Integer>) —

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

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

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

  • (Hash<Symbol, Integer>) —

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

  • (Hash<String, Integer>) —

    if grouped by search term, the views for each search term that led viewers to the content.

  • (Hash<String, Integer>) —

    if grouped by search term, the views for each search term that led viewers to the content.

  • (Hash<Symbol, Integer>) —

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

  • (Hash<Date, Integer>) —

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

  • (Hash<Range<Date, Date>, Integer>) —

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

  • (Hash<Symbol, Integer>) —

    if grouped by range, the views for the entire time-range (under the key :total).



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

has_report :views, Integer