yt 0.15.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54209e7c3dedc665ad4d6b0d93bcf6c6d9d6f546
-  data.tar.gz: 6e09959e44cbf2aad7bcf29df8dfa25f6cc903c6
+  metadata.gz: 55d205cb0c564e1554416cc0342e78a3db861869
+  data.tar.gz: 847dc6cb07e91a609a599bf80076323bb4ed8da8
 SHA512:
-  metadata.gz: 3a83c419303aa9980ecc4769c711798742aa0a3a77202ef04e18300ba32d414994f9e2b3fa6dd5042489e5b9caaca75966c4bdcfe1a3e1a995f641d176f5a89f
-  data.tar.gz: 5f31bea6b6e1d473a42f73f2971efd7567220d0283c645b488ea6f35870be5e460352346996469179408f11fc9190ce61e17ce2ac435499ae89e732ead1e65b0
+  metadata.gz: aa186798f0c5e32c895d92a73b96f9db76eebf7377b1a7e7ebda53e9ef18c0ad4b48ee62aa3b987ef2baa96ad9a7a031b83c8b847bab803ea4b50c6c2de5115f
+  data.tar.gz: b6476451e5c3ead27bffa4e15ad4056387a9bcbf583dc37d0bce98b356a12b810ddf95046862151e0df23d7e24552a983f49433eb467a76360ed0f8f9893029a

data/CHANGELOG.md

@@ -6,6 +6,13 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+
+## 0.15.1 - 2015-04-19
+
+* [FEATURE] New `annotation clicks` report for videos and channels.
+* [FEATURE] New `annotation click-through rate` report for videos and channels.
+* [FEATURE] New `annotation close rate` report for videos and channels.
+
 ## 0.15.0 - 2015-04-19
 
 **How to upgrade**

data/README.md

@@ -41,7 +41,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.15.0'
+    gem 'yt', '~> 0.15.1'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -148,7 +148,7 @@ Use [Yt::Channel](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Chan
 * access the channels that the channel is subscribed to
 * subscribe to and unsubscribe from a channel
 * delete playlists from a channel
-* retrieve the daily earnings, views, comments, likes, dislikes, shares, subscribers gained/lost, estimated/average video watch and impressions of a channel by day
+* retrieve the daily earnings, views, comments, likes, dislikes, shares, subscribers gained/lost, annotation clicks, annotation click-through rate, annotation close rate, estimated/average video watch and impressions of a channel by day
 * retrieve the views and estimated minutes watched by traffic source
 * retrieve the views and estimated minutes watched by playback location
 * retrieve the views and estimated minutes watched by embedded player location
@@ -215,6 +215,9 @@ channel.favorites_removed from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug
 channel.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
 channel.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
 channel.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
+channel.annotation_clicks #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
+channel.annotation_click_through_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
+channel.annotation_close_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
 channel.viewer_percentage #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
 
 channel.views since: 7.days.ago, by: :traffic_source #=> {advertising: 10.0, related_video: 20.0, promoted: 5.0, subscriber: 1.0, channel: 3.0, other: 7.0}
@@ -257,6 +260,9 @@ channel.subscribers_lost from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 2
 channel.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
 channel.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
 channel.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
+channel.annotation_clicks #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
+channel.annotation_click_through_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
+channel.annotation_close_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
 channel.viewer_percentage since: 7.days.ago #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
 
 channel.views since: 7.days.ago, by: :traffic_source #=> {advertising: 10.0, related_video: 20.0, promoted: 5.0, subscriber: 1.0, channel: 3.0, other: 7.0}
@@ -294,7 +300,7 @@ Use [Yt::Video](http://rubydoc.info/github/Fullscreen/yt/master/Yt/Models/Video)
 * access the annotations of a video
 * delete a video
 * like and dislike a video
-* retrieve the daily earnings, views, comments, likes, dislikes, shares, subscribers gained/lost, impressions and monetized playbacks of a video by day
+* retrieve the daily earnings, views, comments, likes, dislikes, shares, subscribers gained/lost, impressions, annotation clicks, annotation click-through rate, annotation close rate and monetized playbacks of a video by day
 * retrieve the views of a video by traffic source
 * retrieve the views of a video by playback location
 * retrieve the views of a video by embedded player location
@@ -397,6 +403,9 @@ video.favorites_removed from: '2014-08-30', to: '2014-08-31' #=> {Sat, 30 Aug 20
 video.average_view_duration #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
 video.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 Feb 2015=>37.40014235438217, …}
 video.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
+video.annotation_clicks #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
+video.annotation_click_through_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
+video.annotation_close_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
 video.viewer_percentage #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
 
 video.views since: 7.days.ago, by: :traffic_source #=> {advertising: 10.0, related_video: 20.0, promoted: 5.0, subscriber: 1.0, channel: 3.0, other: 7.0}
@@ -431,6 +440,9 @@ video.average_view_percentage # {Sun, 22 Feb 2015=>38.858253094977265, Mon, 23 F
 video.estimated_minutes_watched #=> {Sun, 22 Feb 2015=>2433258.0, Mon, 23 Feb 2015=>2634360.0, …}
 video.impressions_on 5.days.ago #=> 157.0
 video.monetized_playbacks_on 5.days.ago #=> 123.0
+video.annotation_clicks #=>  {Sun, 22 Feb 2015=>329.0, Mon, 23 Feb 2015=>326.0, …}
+video.annotation_click_through_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
+video.annotation_close_rate #=>  {Sun, 22 Feb 2015=>0.02, Mon, 23 Feb 2015=>0.03, …}
 video.viewer_percentage #=> {female: {'18-24' => 12.12, '25-34' => 16.16,…}…}
 
 video.views since: 7.days.ago, by: :traffic_source #=> {advertising: 10.0, related_video: 20.0, promoted: 5.0, subscriber: 1.0, channel: 3.0, other: 7.0}

data/lib/yt/models/channel.rb

@@ -58,6 +58,15 @@ module Yt
       # @macro has_report
       has_report :monetized_playbacks
 
+      # @macro has_report
+      has_report :annotation_clicks
+
+      # @macro has_report
+      has_report :annotation_click_through_rate
+
+      # @macro has_report
+      has_report :annotation_close_rate
+
       # @macro has_report
       has_report :viewer_percentage
 

data/lib/yt/models/video.rb

@@ -89,6 +89,15 @@ module Yt
       # @macro has_report
       has_report :monetized_playbacks
 
+      # @macro has_report
+      has_report :annotation_clicks
+
+      # @macro has_report
+      has_report :annotation_click_through_rate
+
+      # @macro has_report
+      has_report :annotation_close_rate
+
       # @macro has_report
       has_report :viewer_percentage
 

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.15.0'
+  VERSION = '0.15.1'
 end

data/spec/requests/as_account/channel_spec.rb

@@ -175,6 +175,9 @@ describe Yt::Channel, :device_app do
       expect{channel.estimated_minutes_watched}.not_to raise_error
       expect{channel.average_view_duration}.not_to raise_error
       expect{channel.average_view_percentage}.not_to raise_error
+      expect{channel.annotation_clicks}.not_to raise_error
+      expect{channel.annotation_click_through_rate}.not_to raise_error
+      expect{channel.annotation_close_rate}.not_to raise_error
       expect{channel.viewer_percentage}.not_to raise_error
       expect{channel.earnings}.to raise_error Yt::Errors::Unauthorized
       expect{channel.impressions}.to raise_error Yt::Errors::Unauthorized

data/spec/requests/as_account/video_spec.rb

@@ -292,6 +292,9 @@ describe Yt::Video, :device_app do
       expect{video.estimated_minutes_watched}.not_to raise_error
       expect{video.average_view_duration}.not_to raise_error
       expect{video.average_view_percentage}.not_to raise_error
+      expect{video.annotation_clicks}.not_to raise_error
+      expect{video.annotation_click_through_rate}.not_to raise_error
+      expect{video.annotation_close_rate}.not_to raise_error
       expect{video.viewer_percentage}.not_to raise_error
       expect{video.earnings}.to raise_error Yt::Errors::Unauthorized
       expect{video.impressions}.to raise_error Yt::Errors::Unauthorized

data/spec/requests/as_content_owner/channel_spec.rb

@@ -845,6 +845,87 @@ describe Yt::Channel, :partner do
         end
       end
 
+      describe 'annotation clicks can be retrieved for a range of days' do
+        let(:date) { ENV['YT_TEST_PARTNER_VIDEO_DATE'] }
+        let(:date_to) { Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5 }
+
+        specify 'with a given start (:since option) and a given end (:until option)' do
+          expect(channel.annotation_clicks(since: date, until: date_to).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option) and a given end (:to option)' do
+          expect(channel.annotation_clicks(from: date, to: date_to).keys.min).to eq date.to_date
+        end
+      end
+
+      describe 'annotation clicks can be grouped by day' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5} }
+
+        specify 'without a :by option (default)' do
+          annotation_clicks = channel.annotation_clicks range
+          expect(annotation_clicks.values).to all(be_instance_of Float)
+        end
+
+        specify 'with the :by option set to :day' do
+          annotation_clicks = channel.annotation_clicks range.merge by: :day
+          expect(annotation_clicks.values).to all(be_instance_of Float)
+        end
+      end
+
+      describe 'annotation click-through rate can be retrieved for a range of days' do
+        let(:date) { ENV['YT_TEST_PARTNER_VIDEO_DATE'] }
+        let(:date_to) { Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5 }
+
+        specify 'with a given start (:since option) and a given end (:until option)' do
+          expect(channel.annotation_click_through_rate(since: date, until: date_to).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option) and a given end (:to option)' do
+          expect(channel.annotation_click_through_rate(from: date, to: date_to).keys.min).to eq date.to_date
+        end
+      end
+
+      describe 'annotation click-through rate can be grouped by day' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5} }
+
+        specify 'without a :by option (default)' do
+          annotation_click_through_rate = channel.annotation_click_through_rate range
+          expect(annotation_click_through_rate.values).to all(be_instance_of Float)
+        end
+
+        specify 'with the :by option set to :day' do
+          annotation_click_through_rate = channel.annotation_click_through_rate range.merge by: :day
+          expect(annotation_click_through_rate.values).to all(be_instance_of Float)
+        end
+      end
+
+      describe 'annotation close rate can be retrieved for a range of days' do
+        let(:date) { ENV['YT_TEST_PARTNER_VIDEO_DATE'] }
+        let(:date_to) { Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5 }
+
+        specify 'with a given start (:since option) and a given end (:until option)' do
+          expect(channel.annotation_close_rate(since: date, until: date_to).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option) and a given end (:to option)' do
+          expect(channel.annotation_close_rate(from: date, to: date_to).keys.min).to eq date.to_date
+        end
+      end
+
+      describe 'annotation close rate can be grouped by day' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5} }
+
+        specify 'without a :by option (default)' do
+          annotation_close_rate = channel.annotation_close_rate range
+          expect(annotation_close_rate.values).to all(be_instance_of Float)
+        end
+
+        specify 'with the :by option set to :day' do
+          annotation_close_rate = channel.annotation_close_rate range.merge by: :day
+          expect(annotation_close_rate.values).to all(be_instance_of Float)
+        end
+      end
+
       describe 'viewer percentage can be retrieved for a range of days' do
         let(:viewer_percentage) { channel.viewer_percentage since: 1.year.ago, until: 10.days.ago}
         it { expect(viewer_percentage).to be_a Hash }

data/spec/requests/as_content_owner/video_spec.rb

@@ -753,6 +753,87 @@ describe Yt::Video, :partner do
         end
       end
 
+      describe 'annotation clicks can be retrieved for a range of days' do
+        let(:date) { ENV['YT_TEST_PARTNER_VIDEO_DATE'] }
+        let(:date_to) { Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5 }
+
+        specify 'with a given start (:since option) and a given end (:until option)' do
+          expect(video.annotation_clicks(since: date, until: date_to).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option) and a given end (:to option)' do
+          expect(video.annotation_clicks(from: date, to: date_to).keys.min).to eq date.to_date
+        end
+      end
+
+      describe 'annotation clicks can be grouped by day' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5} }
+
+        specify 'without a :by option (default)' do
+          annotation_clicks = video.annotation_clicks range
+          expect(annotation_clicks.values).to all(be_instance_of Float)
+        end
+
+        specify 'with the :by option set to :day' do
+          annotation_clicks = video.annotation_clicks range.merge by: :day
+          expect(annotation_clicks.values).to all(be_instance_of Float)
+        end
+      end
+
+      describe 'annotation click-through rate can be retrieved for a range of days' do
+        let(:date) { ENV['YT_TEST_PARTNER_VIDEO_DATE'] }
+        let(:date_to) { Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5 }
+
+        specify 'with a given start (:since option) and a given end (:until option)' do
+          expect(video.annotation_click_through_rate(since: date, until: date_to).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option) and a given end (:to option)' do
+          expect(video.annotation_click_through_rate(from: date, to: date_to).keys.min).to eq date.to_date
+        end
+      end
+
+      describe 'annotation click-through rate can be grouped by day' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5} }
+
+        specify 'without a :by option (default)' do
+          annotation_click_through_rate = video.annotation_click_through_rate range
+          expect(annotation_click_through_rate.values).to all(be_instance_of Float)
+        end
+
+        specify 'with the :by option set to :day' do
+          annotation_click_through_rate = video.annotation_click_through_rate range.merge by: :day
+          expect(annotation_click_through_rate.values).to all(be_instance_of Float)
+        end
+      end
+
+      describe 'annotation close rate can be retrieved for a range of days' do
+        let(:date) { ENV['YT_TEST_PARTNER_VIDEO_DATE'] }
+        let(:date_to) { Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5 }
+
+        specify 'with a given start (:since option) and a given end (:until option)' do
+          expect(video.annotation_close_rate(since: date, until: date_to).keys.min).to eq date.to_date
+        end
+
+        specify 'with a given start (:from option) and a given end (:to option)' do
+          expect(video.annotation_close_rate(from: date, to: date_to).keys.min).to eq date.to_date
+        end
+      end
+
+      describe 'annotation close rate can be grouped by day' do
+        let(:range) { {since: ENV['YT_TEST_PARTNER_VIDEO_DATE'], until: Date.parse(ENV['YT_TEST_PARTNER_VIDEO_DATE']) + 5} }
+
+        specify 'without a :by option (default)' do
+          annotation_close_rate = video.annotation_close_rate range
+          expect(annotation_close_rate.values).to all(be_instance_of Float)
+        end
+
+        specify 'with the :by option set to :day' do
+          annotation_close_rate = video.annotation_close_rate range.merge by: :day
+          expect(annotation_close_rate.values).to all(be_instance_of Float)
+        end
+      end
+
       describe 'viewer percentage can be retrieved for a range of days' do
         let(:viewer_percentage) { video.viewer_percentage since: 1.year.ago, until: 10.days.ago}
         it { expect(viewer_percentage).to be_a Hash }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Claudio Baccigalupo