Method: Yt::Models::VideoGroup#viewer_percentage

Defined in:

lib/yt/models/video_group.rb

#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.

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

has_report :viewer_percentage, Float