embulk-input-google_adwords 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65cd09fea336300d023ad6c3dea7a395c988a05c7aeabc956e65f43a2215d104
+  data.tar.gz: 22637169c16dfafd9fcc7e3364b5f089a2705f68e322080c1bd9230e4012f781
+SHA512:
+  metadata.gz: db84b6a0f5f49f2a5a1d5b69b2bccab96487ba5e58df35a652cb50c53fd528c4694000602eed9764646733ce71476214c2f100b8bb5ee36039bf8aee1ac09a23
+  data.tar.gz: 06f6b69c63d5c73322890e3795630f73540cf1686d3b1c4a8d75633bac5eb1963042392bd653c1ccbc23b1563c76cbaa8170f19a57c04eb8791061b174f8e98f

data/.gitignore

@@ -0,0 +1,6 @@
+*~
+/pkg/
+/tmp/
+/.bundle/
+/Gemfile.lock
+config.yml

data/.ruby-version

@@ -0,0 +1 @@
+jruby-9.1.5.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,31 @@
+# Google AdWords input plugin for Embulk
+
+Embulk input plugin for Google AdWords reports.
+
+## Configuration
+### Authentication
+
+- **auth_method**: OAuth2 (Authentication method must be OAuth2 for AdWords API access.)
+- **auth_oauth2_client_id**: OAuth2 client ID
+- **auth_oauth2_client_secret**: OAuth2 client secret
+- **auth_developer_token**: Developer token for AdWords API access
+- **auth_client_customer_id**: Account number of the AdWords client account, e.g. 123-456-7890
+- **auth_user_agent**: User agent string, e.g. Embulk plugin for Google Adwords
+- **oauth2_access_token**: OAuth2 access token
+- **oauth2_refresh_token**: OAuth2 refresh token
+- **oauth2_issued_at**: The date and time when the OAuth2 access token has been issued
+- **oauth2_expires_in**: Expiration duration of OAuth2 access token
+### Query
+- **report_type**: Report type to query, e.g. CAMPAIGN_PERFORMANCE_REPORT
+- **fields**: Field list to query
+- **conditions**: Condition list of the query
+- **daterange**: Date range of the query
+### How to get configuration values
+You can check `config.yml.example` file.<br/>
+There are links in there.
+
+## Build
+
+```
+$ rake
+```

data/Rakefile

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

data/config.yml.example

@@ -0,0 +1,59 @@
+in:
+    type: google_adwords
+
+    #######################################################################################################
+    #                                     authentication informations                                     #
+    #   for the details, refer to https://developers.google.com/adwords/api/docs/guides/first-api-call    #
+    #######################################################################################################
+    auth_method: OAuth2 # authentication method should be OAuth2
+
+    # OAuth2 client ID and client secret
+    # refer to https://developers.google.com/adwords/api/docs/guides/first-api-call#set_up_oauth2_authentication
+    auth_oauth2_client_id: OAUTH2_CLIENT_ID
+    auth_oauth2_client_secret: OAUTH2_CLIENT_SECRET
+
+    # developer token for AdWords API access
+    # refer to https://developers.google.com/adwords/api/docs/guides/first-api-call#request_a_developer_token
+    auth_developer_token: DEVELOPER_TOKEN
+
+    # account number of the AdWords client account, e.g. 123-456-7890
+    auth_client_customer_id: CLIENT_CUSTOMER_ID
+
+    auth_user_agent: Embulk plugin for Google Adwords
+
+    # OAuth2 tokens
+    # refer to https://developers.google.com/adwords/api/docs/guides/first-api-call#get_an_oauth2_refresh_token_and_configure_your_client
+    oauth2_access_token: ACCESS_TOKEN
+    oauth2_refresh_token: REFRESH_TOKEN
+    oauth2_issued_at: ISSUED_DATE_TIME
+    oauth2_expires_in: 3600
+
+    #######################################################################################################
+    #                                         query informations                                          #
+    #######################################################################################################
+
+    # report type, required
+    # for available report types, refer to https://developers.google.com/adwords/api/docs/appendix/reports
+    report_type: REPORT_TYPE # e.g. CAMPAIGN_PERFORMANCE_REPORT
+
+    # field list to query, required
+    # fields must not contain 'Date' and 'Week' fields if you omit date range
+    # for the available fields per report type, refer to the following link.
+    # https://developers.google.com/adwords/api/docs/appendix/reports/all-reports
+    fields:
+        - FIELD to query # e.g. Amount
+        - FIELD to query # e.g. Clicks
+        - ...
+
+    # query condition list, optional
+    # for the details, refer to https://developers.google.com/adwords/api/docs/guides/awql#formal_grammar
+    conditions:
+        - CONDITION # e.g. CampaignStatus = PAUSED
+        - CONDITION # e.g. CampaignStatus IN [ENABLED, PAUSED]
+        - ...
+
+    # date range, optional, get data for all dates if omitted
+    daterange: DATE_RANGE # e.g. LAST_7_DAYS, e.g. 20170101,20170625
+
+out:
+    type: stdout

data/embulk-input-google_adwords.gemspec

@@ -0,0 +1,21 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "embulk-input-google_adwords"
+  spec.version       = "0.1.0"
+  spec.authors       = ["topdeveloper"]
+  spec.summary       = "Google Adwords input plugin for Embulk"
+  spec.description   = "Loads records from Google Adwords."
+  # TODO set this: spec.email         = [""]
+  spec.licenses      = ["MIT"]
+  # TODO set this: spec.homepage      = ""
+
+  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 'google-adwords-api', ['>= 0.25.0']
+
+  spec.add_development_dependency 'embulk', ['>= 0.8.25']
+  spec.add_development_dependency 'bundler', ['>= 1.10.6']
+  spec.add_development_dependency 'rake', ['>= 10.0']
+end

data/lib/embulk/input/google_adwords.rb

@@ -0,0 +1,130 @@
+require 'adwords_api'
+
+module Embulk
+  module Input
+
+    class GoogleAdwords < InputPlugin
+      Plugin.register_input("google_adwords", self)
+
+      def self.transaction(config, &control)
+        # configuration code:
+        task = {
+          "adwords_api_options" => {
+            "authentication" => {
+              "method" => config.param("auth_method", :string),
+              "oauth2_client_id" => config.param("auth_oauth2_client_id", :string),
+              "oauth2_client_secret" => config.param("auth_oauth2_client_secret", :string),
+              "developer_token" => config.param("auth_developer_token", :string),
+              "client_customer_id" => config.param("auth_client_customer_id", :string),
+              "user_agent" => config.param("auth_user_agent", :string),
+              "oauth2_token" => {
+                "access_token" => config.param("oauth2_access_token", :string),
+                "refresh_token" => config.param("oauth2_refresh_token", :string),
+                "issued_at" => config.param("oauth2_issued_at", :string),
+                "expires_in" => config.param("oauth2_expires_in", :string),
+                "id_token" => ""
+              }
+            },
+            "service" => {
+              "environment" => "PRODUCTION"
+            },
+            "connection" => {
+              "enable_gzip" => false
+            },
+            "library" => {
+              "log_level" => "INFO",
+              "skip_report_header" => true,
+              "skip_column_header" => true,
+              "skip_report_summary" => true
+            }
+          },
+          "report_type" => config.param("report_type", :string),
+          "fields" => config.param("fields", :array),
+          "conditions" => config.param("conditions", :array, default: []),
+          "daterange" => config.param("daterange", :string, default: "")
+        }
+
+        raise ConfigError.new("The parameter report_type must not be empty.") if task["report_type"].empty?
+        raise ConfigError.new("The parameter fields must not be empty array.") if task["fields"].empty?
+
+        columns = task["fields"].map do |col_name|
+          Column.new(nil, col_name, :string)
+        end
+
+        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
+
+      # TODO
+      # def self.guess(config)
+      #   sample_records = [
+      #     {"example"=>"a", "column"=>1, "value"=>0.1},
+      #     {"example"=>"a", "column"=>2, "value"=>0.2},
+      #   ]
+      #   columns = Guess::SchemaGuess.from_hash_records(sample_records)
+      #   return {"columns" => columns}
+      # end
+
+      def init
+        # initialization code:
+      end
+
+      def run
+        selectors = task["fields"].join(", ")
+        conditions = task["conditions"].join(" AND ")
+
+        query = "SELECT " + selectors + " FROM " + task["report_type"]
+        query << " WHERE " + conditions unless conditions.empty?
+        query << " DURING " + task["daterange"] unless task["daterange"].empty?
+
+        begin
+          query_report_results(query) do |row|
+            page_builder.add row
+          end
+
+        # Authorization error.
+        rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+          raise ConfigError.new(e.message)
+
+        # HTTP errors.
+        rescue AdsCommon::Errors::HttpError => e
+          raise ConfigError.new(e.message)
+
+        # API errors.
+        rescue AdwordsApi::Errors::ReportError => e
+          raise ConfigError.new(e.message)
+        end
+
+        page_builder.finish
+
+        task_report = {}
+        return task_report
+      end
+
+      API_VERSION = :v201705
+
+      def query_report_results(query, &block)
+        # AdwordsApi::Api
+        adwords = AdwordsApi::Api.new(task["adwords_api_options"])
+
+        # Get report utilities for the version.
+        report_utils = adwords.report_utils(API_VERSION)
+
+        # Allowing rows with zero impressions to show is not supported with AWQL.
+        adwords.include_zero_impressions = false
+
+        report_utils.get_stream_helper_with_awql(query, 'CSV').each_line do |line|
+          row = line.split(",")
+          block.call row
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: embulk-input-google_adwords
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- topdeveloper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-adwords-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+- !ruby/object:Gem::Dependency
+  name: embulk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.25
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Loads records from Google Adwords.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.yml.example
+- embulk-input-google_adwords.gemspec
+- lib/.DS_Store
+- lib/embulk/input/google_adwords.rb
+homepage: 
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Google Adwords input plugin for Embulk
+test_files: []