embulk-input-lkqd 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 866f3cba36f1579e65bfd63ed2db19ec2781dddc
-  data.tar.gz: 095f3b63d64f391babe144787e32a0b7070d2691
+  metadata.gz: e78a508c2bc1e83afe5ede32c630eac17f91090c
+  data.tar.gz: 30f105b4e714b3ab8279a9299cd01520e7e87fb4
 SHA512:
-  metadata.gz: f064a350f85fb9734439f0d7197f8405d29199dbd0a7ac35cf097240284c3ecd0fa6c8de291077fef296c6572661abf25f47e714be35a3a0ca443d972846f039
-  data.tar.gz: ba4818c5483cf6347a6a81d0ab8c248ba0a8908e5aa4edb4bfaf930b6e25adae4eff66dcb2ad0af415d86b4bb6c332a6e1482a0a74af9b285a4004ac9caf28a4
+  metadata.gz: e87b274e23130b4f6851ded3e1115d18822402617a576f717d3dc9dad161a34ca3758890b01bf6df733db38745783c9ea5b6606fe3fea8c948cb0ec0b3110895
+  data.tar.gz: 6bad46bac5acfe15126a677e4a7a734ec921b01103d18613e5c1629eb8d5c6e452e34ca3e44197b574268ab12c9bc0eee46b235a30d53d5b84a6225c1d27e701

data/README.md

@@ -11,10 +11,12 @@ Loads reporting data from LKQD API.
 
 ## Configuration
 
-- **secret_key_id**: API Secret Key ID (string, required)
-- **secret_key**: API Secret Key (string, required)
-- **endpoint**: API endpoint (string, default: `'https://api.lkqd.com/reports'`)
-- **report_parameters**: Report parameters documented in https://wiki.lkqd.com/display/API/LKQD+API (hash, default: `{}`)
+- **secret_key_id**: API Secret Key ID (required string, required)
+- **secret_key**: API Secret Key (required string, required)
+- **endpoint**: API endpoint (optional string, default: `'https://api.lkqd.com/reports'`)
+- **report_parameters**: Report parameters documented in https://wiki.lkqd.com/display/API/LKQD+API (required hash, default: `{}`)
+- **measurable_impressions**: calculate and inject `Measurable Impressions` column, required `"IMPRESSIONS"`, `"VIEWABILITY_MEASURED_RATE"` specified in "metrics" (optional boolean, default: false)
+- **viewable_impressions**: calculate and inject `Viewable Impressions` column, required `"IMPRESSIONS"`, `"VIEWABILITY_MEASURED_RATE"`, `"VIEWABILITY_RATE"` specified in "metrics" (optional boolean, default: false)
 
 ## Example
 

data/embulk-input-lkqd.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "embulk-input-lkqd"
-  spec.version       = "0.5.0"
+  spec.version       = "0.6.0"
   spec.authors       = ["Ming Liu"]
   spec.summary       = "LKQD input plugin for Embulk"
   spec.description   = "Loads reporting data from LKQD API."

data/lib/embulk/input/lkqd.rb

@@ -16,7 +16,10 @@ module Embulk
           "secret_key_id" => config.param("secret_key_id", :string),
           "secret_key" => config.param("secret_key", :string),
           "endpoint" => config.param("endpoint", :string, default: 'https://api.lkqd.com/reports'),
-          "try_convert" => config.param("try_convert", :string, default: "true"),
+          "copy_temp_to" => config.param("copy_temp_to", :string, default: nil),
+          "try_convert" => config.param("try_convert", :bool, default: true),
+          "measurable_impressions" => config.param("measurable_impressions", :bool, default: false),
+          "viewable_impressions" => config.param("viewable_impressions", :bool, default: false),
           "report_parameters" => config.param("report_parameters", :hash, default: {}),
         }
         task['authorization'] = Base64.urlsafe_encode64("#{task['secret_key_id']}:#{task['secret_key']}")
@@ -29,10 +32,28 @@ module Embulk
         tempfile.close
         task['tempfile_path'] = tempfile.path
 
+        FileUtils.cp(task['tempfile_path'], task['copy_temp_to']) if task['copy_temp_to']
+
         columns = []
         ::CSV.foreach(tempfile.path).first.each_with_index do |column_name, index|
           column_type = guess_column_type(task['report_parameters']['metrics'], column_name)
-          columns << Column.new({index: index}.merge(column_type))
+          column = Column.new({index: index}.merge(column_type))
+          if column.name == 'Viewability Measured Rate'
+            task['viewability_measured_rate_index'] = index
+          elsif column.name == 'Viewability Rate'
+            task['viewability_rate_index'] = index
+          elsif column.name == 'Impressions'
+            task['impressions_index'] = index
+          end
+          columns << column
+        end
+
+        if measurable_impressions?(task)
+          columns << Column.new({index: columns.size, type: :double, name: 'Measurable Impressions'})
+        end
+
+        if viewable_impressions?(task)
+          columns << Column.new({index: columns.size, type: :double, name: 'Viewable Impressions'})
         end
 
         resume(task, columns, 1, &control)
@@ -84,14 +105,36 @@ module Embulk
         end
       end
 
+      def self.measurable_impressions?(task)
+        task['try_convert'] && task['measurable_impressions'] &&
+        task['viewability_measured_rate_index'] && task['impressions_index']
+      end
+
+      def self.viewable_impressions?(task)
+        task['try_convert'] && task['viewable_impressions'] &&
+        task['viewability_rate_index'] && task['viewability_measured_rate_index'] && task['impressions_index']
+      end
+
       def init
         @task = task
       end
 
       def run
         convert_options = {timezone: @task['report_parameters']['timezone']}
+        try_convert = @task['try_convert']
+        viewability_measured_rate_index = @task['viewability_measured_rate_index']
+        viewability_rate_index = @task['viewability_rate_index']
+        impressions_index = @task['impressions_index']
+
         CSV.foreach(@task['tempfile_path'], {headers: true}).each do |row|
-          row = @task['try_convert'] == "true" ? Lkqd.try_convert(row, convert_options) : row
+          row = try_convert ? Lkqd.try_convert(row, convert_options) : row
+          if Lkqd.measurable_impressions?(@task)
+            row << row[impressions_index] * row[viewability_measured_rate_index]
+          end
+
+          if Lkqd.viewable_impressions?(@task)
+            row << row[impressions_index] * row[viewability_measured_rate_index] * row[viewability_rate_index]
+          end
           page_builder.add(row)
         end
         page_builder.finish
@@ -140,6 +183,7 @@ module Embulk
         'Clicks' => { 'type' => 'long' },
         'CTR' => { 'type' => 'double' },
         'Ad Starts' => { 'type' => 'long' },
+        'Ad Starts Rate' => { 'type' => 'double' },
         '25% Views' => { 'type' => 'long' },
         '50% Views' => { 'type' => 'long' },
         '75% Views' => { 'type' => 'long' },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: embulk-input-lkqd
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ming Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2017-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http