embulk-input-search_analytics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73e29aa45ba4083290b9c07f2d30e938878ead246c22ad51825c6379c74b8f39
+  data.tar.gz: 9f179b0334a8c9c03e5420ff799ab3776ea9a5f86356aa43de70557629818556
+SHA512:
+  metadata.gz: 3962974f98d526db4d4bc005b9fbf2a6deaed2bdfca093ba4efe6b00816a12743160c37a0cdc04a902c3bc81115d522eddcc2e08ce35fe1906491050675feb27
+  data.tar.gz: 6ffb2eb04c64b7b85645ad9246be23d41bd404d7b298c3fdc2dda0fa3815ac4b360bd5af5aabc1d682f8c61d46967d7cbafb29d9726d06b072f9bd9de72acc63

data/.gitignore

@@ -0,0 +1,7 @@
+*~
+/pkg/
+/tmp/
+/.bundle/
+/Gemfile.lock
+/vendor/bundle
+/workspaces/

data/.ruby-version

@@ -0,0 +1 @@
+jruby-9.1.13.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org/'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Search Analytics input plugin for Embulk
+
+Embulk input plugin for Google Search Analytics.
+
+## Overview
+* **Plugin type**: input
+* **Resume supported**: no
+* **Cleanup supported**: no
+* **Guess supported**: no
+
+## Configuration
+
+- **client_id**: authentication (string, required)
+- **client_secret**: authentication (string, required)
+- **refresh_token**: authentication (string, required)
+- **site_url**: Site URL for target data
+- **start_date**: Target report start date. Valid format is "YYYY-MM-DD" (string, required)
+- **end_date**: Target report end date. Valid format is "YYYY-MM-DD" (string, required)
+- **dimensions**: Target dimensions (array, required)
+- **dimension_filter_groups**: Target dimension filter groups, see example. (array, default: nil)
+- **search_type**: Target search type, (string, default: web)
+- **row_limit**: Target row limit, (integer, default: 5000)
+
+## Example
+
+```yaml
+in:
+  type: search_analytics
+  client_id: xxxxxxx.apps.googleusercontent.com
+  client_secret: xxxxxxxxxx
+  refresh_token: 1/xxxxxxxxxx
+  site_url: https://sem-technology.info/
+  start_date: 2017-12-01
+  end_date: 2017-12-01
+  dimensions:
+    - query
+    - device
+  dimension_filter_groups:
+    - group_type: and
+      filters:
+        - dimension: country
+          operator: equals
+          expression: jpn
+```
+
+
+## Build
+
+```
+$ rake
+```

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task default: :build

data/embulk-input-search_analytics.gemspec

@@ -0,0 +1,21 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "embulk-input-search_analytics"
+  spec.version       = "0.1.0"
+  spec.authors       = ["ryota.yamada"]
+  spec.summary       = "Search Analytics input plugin for Embulk"
+  spec.description   = "Loads records from Search Analytics."
+  spec.email         = ["1987yama3@gmail.com"]
+  spec.licenses      = ["MIT"]
+  spec.homepage      = "https://github.com/sem-technology/embulk-input-search_analytics"
+
+  spec.files         = `git ls-files`.split("\n") + Dir["classpath/*.jar"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "signet"
+  spec.add_dependency "google-api-client", "~> 0.9.11"
+  spec.add_development_dependency 'embulk', ['>= 0.8.38']
+  spec.add_development_dependency 'bundler', ['>= 1.10.6']
+  spec.add_development_dependency 'rake', ['>= 10.0']
+end

data/examples/query.yml

@@ -0,0 +1,19 @@
+in:
+  type: search_analytics
+  client_id: xxxxxxx.apps.googleusercontent.com
+  client_secret: xxxxxxxxxx
+  refresh_token: 1/xxxxxxxxxx
+  site_url: https://sem-technology.info/
+  start_date: 2017-12-01
+  end_date: 2017-12-01
+  dimensions:
+    - query
+    - device
+  dimension_filter_groups:
+    - group_type: and
+      filters:
+        - dimension: country
+          operator: equals
+          expression: jpn
+out:
+  type: stdout

data/lib/embulk/input/search_analytics.rb

@@ -0,0 +1,8 @@
+require "embulk/input/search_analytics/client"
+require "embulk/input/search_analytics/plugin"
+module Embulk
+  module Input
+    module SearchAnalytics
+    end
+  end
+end

data/lib/embulk/input/search_analytics/client.rb

@@ -0,0 +1,63 @@
+require 'google/apis/webmasters_v3'
+module Embulk
+  module Input
+    module SearchAnalytics
+      class Client
+        def initialize(task, is_preview = false)
+          @task = task
+          @is_preview = is_preview
+        end
+
+        def invoke
+          response = []
+          start_row = 0
+          loop do
+            response << self.query(@task["site_url"], {
+              :row_limit => @task["row_limit"],
+              :dimensions => @task["dimensions"],
+              :dimension_filter_groups => @task["dimension_filter_groups"],
+              :search_type => @task["search_type"],
+              :start_date => @task["start_date"],
+              :end_date => @task["end_date"],
+              :start_row => start_row,
+            })
+            break if response.last.length < @task["row_limit"]
+            start_row += @task["row_limit"]
+          end
+          response.flatten
+        end
+
+        def query(site_url, params)
+          unless params[:dimension_filter_groups].nil?
+            params[:dimension_filter_groups] = JSON.parse(params[:dimension_filter_groups].to_json, symbolize_names: true)
+          end
+          self.service.query_search_analytics(site_url, params, {}).rows.collect do |row|
+            item = {}
+            @task["dimensions"].each_with_index do |dim, idx|
+              item[dim] = row.keys[idx]
+            end
+            item["clicks"] = row.clicks.to_i
+            item["impressions"] = row.impressions.to_i
+            item["ctr"] = row.ctr.to_f
+            item["position"] = row.position.to_f
+            item
+          end
+        end
+
+        def service
+          webmasters_service = ::Google::Apis::WebmastersV3::WebmastersService.new
+          webmasters_service.authorization = Signet::OAuth2::Client.new({
+            :token_credential_uri => @task["token_credential_uri"],
+            :audience => @task["audience"],
+            :client_id => @task["client_id"],
+            :client_secret => @task["client_secret"],
+            :refresh_token => @task["refresh_token"],
+            :scope => @task["scope"],
+          })
+          webmasters_service.authorization.fetch_access_token!
+          webmasters_service
+        end
+      end
+    end
+  end
+end

data/lib/embulk/input/search_analytics/plugin.rb

@@ -0,0 +1,63 @@
+module Embulk
+  module Input
+    module SearchAnalytics
+      class Plugin < InputPlugin
+        ::Embulk::Plugin.register_input("search_analytics", self)
+
+        def self.transaction(config, &control)
+          task = {
+            # API Authorize Parameters
+            "token_credential_uri" => "https://accounts.google.com/o/oauth2/token",
+            "audience" => "https://accounts.google.com/o/oauth2/token",
+            "client_id" => config.param("client_id", :string),
+            "client_secret" => config.param("client_secret", :string),
+            "refresh_token" => config.param("refresh_token", :string),
+            "scope" => "https://www.googleapis.com/auth/webmasters.readonly",
+
+            # API Request Parameters
+            "site_url" => config.param("site_url", :string),
+            "start_date" => config.param("start_date", :string),
+            "end_date" => config.param("end_date", :string),
+            "dimensions" => config.param("dimensions", :array),
+            "dimension_filter_groups" => config.param("dimension_filter_groups", :array, default: nil),
+            "search_type" => config.param("search_type", :string, default: "web"),
+            "row_limit" => config.param("row_limit", :integer, default: 5000),
+          }
+          columns = columns_from_task(task)
+          resume(task, columns, 1, &control)
+        end
+
+        def self.resume(task, columns, count, &control)
+          task_reports = yield(task, columns, count)
+
+          next_config_diff = {}
+          return next_config_diff
+        end
+
+        def self.columns_from_task(task)
+          columns = task["dimensions"].map{|dimension|
+            Column.new(nil, dimension, :string)
+          }
+          columns << Column.new(nil, "clicks", :long)
+          columns << Column.new(nil, "impressions", :long)
+          columns << Column.new(nil, "ctr", :double)
+          columns << Column.new(nil, "position", :double)
+          columns
+        end
+
+        def init
+        end
+
+        def run
+          columns = self.class.columns_from_task(task)
+          Client.new(task, @is_preview).invoke.each do |row|
+            @page_builder.add columns.map{|col| row[col.name]}
+          end
+          @page_builder.finish
+          task_report = {}
+          task_report
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: embulk-input-search_analytics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ryota.yamada
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: signet
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  name: google-api-client
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.38
+  name: embulk
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.38
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Loads records from Search Analytics.
+email:
+- 1987yama3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- embulk-input-search_analytics.gemspec
+- examples/query.yml
+- lib/embulk/input/search_analytics.rb
+- lib/embulk/input/search_analytics/client.rb
+- lib/embulk/input/search_analytics/plugin.rb
+homepage: https://github.com/sem-technology/embulk-input-search_analytics
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.13
+signing_key:
+specification_version: 4
+summary: Search Analytics input plugin for Embulk
+test_files: []