blurb 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4dbb2bb4d310954fc88eb34aa67d42855edc270
-  data.tar.gz: e8875b313e4ed401c7187aa7f2e8287c076069c4
+  metadata.gz: 63a760f4bc9527d16c8807493e9c18fb0119b32e
+  data.tar.gz: 0a9ac5d8323d027edbc2f0955309408c081598c1
 SHA512:
-  metadata.gz: fc4a236ed208b06b0873869fadaaf1c6d18c8c02f8c259e5eae570ba10e44c29c3de09aea2862c10dcc184092303c47eb4e7a24b057fc993687bd6eff4bd17b7
-  data.tar.gz: 6431425442c125f580a44ad34155ab374dc7f50e8d1327de26d17ee090c1909f8b4c31dcfb55ad16f0b86a97d739288a2f64f001b14eeada704dd968da638291
+  metadata.gz: 91605250485ba4b8f3b7916b223ba897eb5867df87b81d49fc798f2db157ac458e33985c73dece02b5db505a27715beba4df24e450a7147bc2b92275837abdf1
+  data.tar.gz: e5d06e3a7bdf21e35e77b44bccede935db2071552a1aea90bb6e0880944945eb63fc66835b38b8d77acc1e6e6c9818ade1c69b363b8cf08f6f317aaee833d8a7

data/.circleci/config.yml

@@ -6,15 +6,7 @@ version: 2
 jobs:
   build:
     docker:
-      # specify the version you desire here
-       - image: circleci/ruby:2.3-node-browsers
-
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/postgres:9.4
-
-    working_directory: ~/repo
+       - image: circleci/ruby:2.4.4
 
     steps:
       - checkout
@@ -33,7 +25,7 @@ jobs:
 
       - save_cache:
           paths:
-            - ./vendor/bundle
+            - vendor/bundle
           key: v1-dependencies-{{ checksum "Gemfile.lock" }}
 
       # run tests!

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+.env

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.4.4
 before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in blurb.gemspec
 gemspec
-
-ruby '2.3.5'

data/README.md

@@ -1,10 +1,14 @@
 # Blurb
 
 [![CircleCI](https://circleci.com/gh/iserve-products/blurb.svg?style=shield)](https://circleci.com/gh/iserve-products/blurb)
+[![TravisCI](https://travis-ci.org/iserve-products/blurb.svg?branch=master)](https://travis-ci.org/iserve-products/blurb)
+[![Gem Version](https://badge.fury.io/rb/blurb.svg)](https://badge.fury.io/rb/blurb)
 
 Blurb is an API wrapper (written in Ruby and packaged as a Gem) for the Amazon Advertising API. The Amazon Ad API lets you tie in programmatically to
 Amazon's Advertising Service. More info can be found at [Amazon Advertising](https://services.amazon.com/advertising/overview.htm?ld=NSGoogleAS)
 
+Version 0.2.0 has been updated to use v2.0 of the Amazon Advertising API.  
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,12 +29,12 @@ Or install it yourself as:
 
 Getting setup to make calls to the Amazon Advertising API can unfortunately be a tedious process.
 You will need to apply for and have a valid Amazon Advertising Account. You can find that info
-here: [Amazon Advertising](https://services.amazon.com/advertising/overview.htm?ld=NSGoogleAS)
+here: [Amazon Advertising](https://advertising.amazon.com/)
 
 You may also want to get a copy of the advertising docs and getting started guides which can be found here:
 
-1. [Amazon Advertising API Getting Started Guide.pdf](https://advertising.amazon.com/downloads/Amazon_Advertising_API_Getting_Started_Guide.pdf)
-2. [Amazon Advertising API Reference.pdf](https://advertising.amazon.com/downloads/Amazon_Advertising_API_Reference.pdf)
+1. [Amazon Advertising API Getting Started Guide](https://advertising.amazon.com/API/docs/v2/guides/get_started?ref_=a20m_us_api_dc1)
+2. [Amazon Advertising API Reference](https://advertising.amazon.com/API/docs/v2/reference/profiles?ref_=a20m_us_api_dc2)
 
 Once you have an account you will be assigned a "client_id" and a "client_secret".
 
@@ -128,6 +132,8 @@ Blurb.test_env = true
 All API calls have been setup as closely as possible to REST Resource calls.
 All you need to do is find the appropriate resource object and make a method call on it and Blurb will do the rest.
 
+In calls that require 'campaign_type' as a parameter, you must pass in either 'sp' for sponsored products or 'hsa' for sponsored brands (formerly known as headline search ads).  
+
 NOTE: Not all API endpoints are currently supported by Blurb.  Over time we will get more
 endpoints added. In the mean time you are always welcome to submit a pull request.
 
@@ -142,21 +148,20 @@ Blurb::Profile.list()
 List campaigns
 
 ```ruby
-Blurb::Campaign.list()
+Blurb::Campaign.list(campaign_type)
 ```
 
 Get a campaign
 
 ```ruby
-Blurb::Campaign.retrieve(campaign_id)
+Blurb::Campaign.retrieve(campaign_id, campaign_type)
 ```
 
 Create a campaign
 
 ```ruby
-Blurb::Campaign.create({
+Blurb::Campaign.create(campaign_type, {
   "name" => "test",
-  "campaignType" => "sponsoredProducts",
   "state" => "enabled",
   "dailyBudget" => 10,
   "startDate" => (Time.now).strftime('%Y%m%d'),
@@ -164,16 +169,20 @@ Blurb::Campaign.create({
 })
 ```
 
+Note: Sponsored Brands cannot be created through the Amazon Advertising API and must be added through the user interface.  The create call only works for Sponsored Products.
+
 ### Reports
 Request a report
 
 ```ruby
 payload_response = Blurb::Report.create({
+  "campaignType" => Blurb::Report::SPONSORED_PRODUCTS,
   "recordType" => Blurb::Report::KEYWORDS,
   "reportDate" => (Time.now - 2592000).strftime('%Y%m%d'),
   "metrics" => "impressions,clicks"
 })
 ```
+If no metrics are included in the request, blurb will request all available metrics available for the given campaign type and report type.
 
 Report record types are
 
@@ -184,6 +193,13 @@ Blurb::Report::AD_GROUPS
 Blurb::Report::PRODUCT_ADS
 ```
 
+Campaign types are
+
+```ruby
+Blurb::Report::SPONSORED_PRODUCTS
+Blurb::Report::SPONSORED_BRANDS
+```
+
 Check report status
 
 ```ruby

data/lib/blurb/base_resource.rb

@@ -7,8 +7,9 @@ module Blurb
           method: :get,
           url: "#{Blurb.active_api_url}#{api_path}",
           headers: {
-            :Authorization => "Bearer #{access_token['access_token']}",
-            "Content-Type" => "application/json"
+            "Authorization" => "Bearer #{access_token['access_token']}",
+            "Content-Type" => "application/json",
+            "Amazon-Advertising-API-ClientId" => Blurb.client_id
           }
         }
 
@@ -25,7 +26,8 @@ module Blurb
       headers_hash = {
         "Authorization" => "Bearer #{access_token['access_token']}",
         "Content-Type" => "application/json",
-        "Amazon-Advertising-API-Scope" => Blurb.profile_id
+        "Amazon-Advertising-API-Scope" => Blurb.profile_id,
+        "Amazon-Advertising-API-ClientId" => Blurb.client_id
       }
 
       headers_hash["Content-Encoding"] = "gzip" if opts[:gzip]
@@ -38,17 +40,7 @@ module Blurb
           max_redirects: 0
         }
 
-      begin
-        resp = RestClient::Request.execute(request_config)
-      rescue RestClient::ExceptionWithResponse => err
-        # If this happens, then we are downloading a report from the api, so we can simply download the location
-        if err.response.code == 307
-          return RestClient.get(err.response.headers[:location])
-        end
-      end
-
-      response = JSON.parse(resp) if resp
-      return response
+      return make_request(request_config)
     end
 
     def self.post_request(api_path, payload)
@@ -59,14 +51,32 @@ module Blurb
           url: "#{Blurb::API_URL}#{api_path}",
           payload: payload.to_json,
           headers: {
-            :Authorization => "Bearer #{access_token['access_token']}",
+            "Authorization" => "Bearer #{access_token['access_token']}",
             "Content-Type" => "application/json",
-            "Amazon-Advertising-API-Scope" => Blurb.profile_id.to_i
+            "Amazon-Advertising-API-Scope" => Blurb.profile_id.to_i,
+            "Amazon-Advertising-API-ClientId" => Blurb.client_id
           }
         }
 
-      resp = RestClient::Request.execute(request_config)
-      return JSON.parse(resp)
+      return make_request(request_config)
+    end
+
+    private
+
+    def self.make_request(request_config)
+      begin
+        resp = RestClient::Request.execute(request_config)
+      rescue RestClient::ExceptionWithResponse => err
+        # If this happens, then we are downloading a report from the api, so we can simply download the location
+        if err.response.code == 307
+          return RestClient.get(err.response.headers[:location])
+        else
+          return err.response.body
+        end
+      end
+
+      response = JSON.parse(resp) if resp
+      return response
     end
   end
 end

data/lib/blurb/bid_recommendation.rb

@@ -4,21 +4,21 @@ module Blurb
       # required argument checks
       raise ArgumentError.new("params hash must contain an adGroupId") unless params["adGroupId"]
 
-      get_request("/v1/adGroups/#{params["adGroupId"]}/bidRecommendations")
+      get_request("/v2/adGroups/#{params["adGroupId"]}/bidRecommendations")
     end
 
     def self.keyword_recommendations(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an keywordId") unless params["keywordId"]
 
-      get_request("/v1/keywords/#{params["keywordId"]}/bidRecommendations")
+      get_request("/v2/keywords/#{params["keywordId"]}/bidRecommendations")
     end
 
     def self.bulk_keyword_recommendations(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an array of keywordIds") unless params["keywordIds"]
 
-      post_request("/v1/keywords/bidRecommendations", params["keywordIds"])
+      post_request("/v2/keywords/bidRecommendations", params["keywordIds"])
     end
   end
 end

data/lib/blurb/campaign.rb

@@ -1,29 +1,34 @@
 module Blurb
   class Campaign < BaseResource
-    def self.retrieve(campaign_id)
-      get_request("/v1/campaigns/#{campaign_id}")
+    SPONSORED_PRODUCTS = "sp"
+    SPONSORED_BRANDS = "hsa"
+
+    def self.retrieve(campaign_id, campaign_type)
+      get_request("/v2/#{campaign_type}/campaigns/#{campaign_id}")
     end
 
-    def self.retrieve_extended(campaign_id)
-      get_request("/v1/campaigns/extended/#{campaign_id}")
+    def self.retrieve_extended(campaign_id, campaign_type)
+      get_request("/v2/#{campaign_type}/campaigns/extended/#{campaign_id}")
     end
 
-    def self.list(params = {}, opts = {})
-      get_request("/v1/campaigns?#{setup_url_params(params)}")
+    def self.list(campaign_type, params = {}, opts = {})
+      get_request("/v2/#{campaign_type}/campaigns?#{setup_url_params(params)}")
     end
 
-    def self.create(params = {}, opts = {})
+    def self.create(campaign_type, params = {}, opts = {})
       # required argument checks
-      if !params["name"] && !params["campaignType"] && !params["targetingType"] && !params["state"] && !params["dailyBudget"] && !params["startDate"]
-        raise ArgumentError.new("params hash must contain name, campaignType, targetingType, state, dailyBudget and startDate")
+      if !params["name"] && !params["targetingType"] && !params["state"] && !params["dailyBudget"] && !params["startDate"]
+        raise ArgumentError.new("params hash must contain name, targetingType, state, dailyBudget and startDate")
       end
+      raise ArgumentError.new("Only sponsored product campaigns can be created through the api.  Sponsored Brands campaigns must be created through the user interface") unless campaign_type = SPONSORED_PRODUCTS
 
-      post_request("/v1/campaigns", [params])
+      post_request("/v2/#{campaign_type}/campaigns", [params])
     end
 
-    def self.create_bulk(campaign_array, opts = {})
-      post_request("/v1/campaigns", campaign_array)
-    end
+    # Deprecated in v2
+    # def self.create_bulk(campaign_array, opts = {})
+    #   post_request("/v1/campaigns", campaign_array)
+    # end
 
     private
 
@@ -36,11 +41,6 @@ module Blurb
         url_params += "count=#{params['count']}"
       end
 
-      if params['campaignType']
-        url_params += "&" if url_params.size > 0
-        url_params += "campaignType=#{params['campaignType']}"
-      end
-
       if params['stateFilter']
         url_params += "&" if url_params.size > 0
         url_params += "stateFilter=#{params['stateFilter']}"

data/lib/blurb/profile.rb

@@ -2,11 +2,11 @@ module Blurb
   class Profile < BaseResource
 
     def self.list()
-      profile_request("/v1/profiles")
+      profile_request("/v2/profiles")
     end
 
     def self.retrieve(profile_id)
-      profile_request("/v1/profiles/#{profile_id}")
+      profile_request("/v2/profiles/#{profile_id}")
     end
   end
 end

data/lib/blurb/report.rb

@@ -4,29 +4,213 @@ module Blurb
     AD_GROUPS = "adGroups"
     KEYWORDS = "keywords"
     PRODUCT_ADS = "productAds"
+    SPONSORED_PRODUCTS = "sp"
+    SPONSORED_BRANDS = "hsa"
 
     def self.create(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain a recordType") unless params["recordType"]
 
+      # If no metrics are passed in, use the default metrics
+      metrics = params["metrics"] || get_default_metrics(params["recordType"],params["campaignType"])
+
       api_params = {
-        "campaignType" => "sponsoredProducts",
         "reportDate" => params["reportDate"],
-        "metrics" => params["metrics"]
+        "metrics" => metrics
       }
 
       api_params["segment"] = params["segment"] if params["segment"]
 
-      post_request("/v1/#{params["recordType"]}/report", api_params)
+      post_request("/v2/#{params["campaignType"]}/#{params["recordType"]}/report", api_params)
     end
 
     def self.status(report_id, opts = {})
-      get_request("/v1/reports/#{report_id}")
+      get_request("/v2/reports/#{report_id}")
     end
 
     def self.download(location, opts = {})
       opts.merge!({:full_path => true, :gzip => true, :no_token => true})
       get_request(location, opts)
     end
+
+    private
+
+    def self.get_default_metrics(record_type, campaign_type)
+      if campaign_type == SPONSORED_BRANDS
+        return [
+          "campaignName",
+          "campaignId",
+          "campaignStatus",
+          "campaignBudget",
+          "campaignBudgetType",
+          "impressions",
+          "clicks",
+          "cost",
+          "attributedSales14d",
+          "attributedSales14dSameSKU",
+          "attributedConversions14d",
+          "attributedConversions14dSameSKU"
+        ].join(",") if record_type == CAMPAIGNS
+        return [
+          "adGroupId",
+          "adGroupName",
+          "campaignName",
+          "campaignId",
+          "campaignStatus",
+          "campaignBudget",
+          "campaignBudgetType",
+          "impressions",
+          "clicks",
+          "cost",
+          "attributedSales14d",
+          "attributedSales14dSameSKU",
+          "attributedConversions14d",
+          "attributedConversions14dSameSKU"
+        ].join(",") if record_type == AD_GROUPS
+        return [
+          "keywordId",
+          "keywordStatus",
+          "keywordBid",
+          "keywordText",
+          "matchType",
+          "adGroupId",
+          "adGroupName",
+          "campaignName",
+          "campaignId",
+          "campaignStatus",
+          "campaignBudget",
+          "campaignBudgetType",
+          "impressions",
+          "clicks",
+          "cost",
+          "attributedSales14d",
+          "attributedSales14dSameSKU",
+          "attributedConversions14d",
+          "attributedConversions14dSameSKU"
+        ].join(",") if record_type == KEYWORDS
+      elsif campaign_type == SPONSORED_PRODUCTS
+        return [
+          "bidPlus",
+          "campaignName",
+          "campaignId",
+          "campaignStatus",
+          "campaignBudget",
+          "impressions",
+          "clicks",
+          "cost",
+          "attributedConversions1d",
+          "attributedConversions7d",
+          "attributedConversions14d",
+          "attributedConversions30d",
+          "attributedConversions1dSameSKU",
+          "attributedConversions7dSameSKU",
+          "attributedConversions14dSameSKU",
+          "attributedConversions30dSameSKU",
+          "attributedUnitsOrdered1d",
+          "attributedUnitsOrdered7d",
+          "attributedUnitsOrdered14d",
+          "attributedUnitsOrdered30d",
+          "attributedSales1d",
+          "attributedSales7d",
+          "attributedSales14d",
+          "attributedSales30d",
+          "attributedSales1dSameSKU",
+          "attributedSales7dSameSKU",
+          "attributedSales14dSameSKU",
+          "attributedSales30dSameSKU"
+        ].join(",") if record_type == CAMPAIGNS
+        return [
+          "campaignName",
+          "campaignId",
+          "adGroupName",
+          "adGroupId",
+          "impressions",
+          "clicks",
+          "cost",
+          "attributedConversions1d",
+          "attributedConversions7d",
+          "attributedConversions14d",
+          "attributedConversions30d",
+          "attributedConversions1dSameSKU",
+          "attributedConversions7dSameSKU",
+          "attributedConversions14dSameSKU",
+          "attributedConversions30dSameSKU",
+          "attributedUnitsOrdered1d",
+          "attributedUnitsOrdered7d",
+          "attributedUnitsOrdered14d",
+          "attributedUnitsOrdered30d",
+          "attributedSales1d",
+          "attributedSales7d",
+          "attributedSales14d",
+          "attributedSales30d",
+          "attributedSales1dSameSKU",
+          "attributedSales7dSameSKU",
+          "attributedSales14dSameSKU",
+          "attributedSales30dSameSKU"
+        ].join(",") if record_type == AD_GROUPS
+        return [
+          "campaignName",
+          "campaignId",
+          "keywordId",
+          "keywordText",
+          "matchType",
+          "impressions",
+          "clicks",
+          "cost",
+          "attributedConversions1d",
+          "attributedConversions7d",
+          "attributedConversions14d",
+          "attributedConversions30d",
+          "attributedConversions1dSameSKU",
+          "attributedConversions7dSameSKU",
+          "attributedConversions14dSameSKU",
+          "attributedConversions30dSameSKU",
+          "attributedUnitsOrdered1d",
+          "attributedUnitsOrdered7d",
+          "attributedUnitsOrdered14d",
+          "attributedUnitsOrdered30d",
+          "attributedSales1d",
+          "attributedSales7d",
+          "attributedSales14d",
+          "attributedSales30d",
+          "attributedSales1dSameSKU",
+          "attributedSales7dSameSKU",
+          "attributedSales14dSameSKU",
+          "attributedSales30dSameSKU"
+        ].join(",") if record_type == KEYWORDS
+        return [
+          "campaignName",
+          "campaignId",
+          "adGroupName",
+          "adGroupId",
+          "impressions",
+          "clicks",
+          "cost",
+          "currency",
+          "asin",
+          "sku",
+          "attributedConversions1d",
+          "attributedConversions7d",
+          "attributedConversions14d",
+          "attributedConversions30d",
+          "attributedConversions1dSameSKU",
+          "attributedConversions7dSameSKU",
+          "attributedConversions14dSameSKU",
+          "attributedConversions30dSameSKU",
+          "attributedUnitsOrdered1d",
+          "attributedUnitsOrdered7d",
+          "attributedUnitsOrdered14d",
+          "attributedUnitsOrdered30d",
+          "attributedSales1d",
+          "attributedSales7d",
+          "attributedSales14d",
+          "attributedSales30d",
+          "attributedSales1dSameSKU",
+          "attributedSales7dSameSKU",
+          "attributedSales14dSameSKU",
+          "attributedSales30dSameSKU"
+        ].join(",") if record_type == PRODUCT_ADS
+      end
+    end
   end
 end

data/lib/blurb/snapshot.rb

@@ -11,14 +11,14 @@ module Blurb
       # required argument checks
       raise ArgumentError.new("params hash must contain a recordType") unless params["recordType"]
 
-      post_request("/v1/#{params["recordType"]}/snapshot", {
+      post_request("/v2/#{params["recordType"]}/snapshot", {
         "campaignType" => "sponsoredProducts",
         "stateFilter" => params["stateFilter"]
       })
     end
 
     def self.status(snapshot_id, opts = {})
-      get_request("/v1/snapshots/#{snapshot_id}")
+      get_request("/v2/snapshots/#{snapshot_id}")
     end
 
     def self.download(location, opts = {})

data/lib/blurb/suggested_keyword.rb

@@ -4,21 +4,21 @@ module Blurb
       # required argument checks
       raise ArgumentError.new("params hash must contain an adGroupId") unless params["adGroupId"]
 
-      get_request("/v1/adGroups/#{params["adGroupId"]}/suggested/keywords?#{setup_url_params(params)}")
+      get_request("/v2/adGroups/#{params["adGroupId"]}/suggested/keywords?#{setup_url_params(params)}")
     end
 
     def self.ad_group_extended_suggestions(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an adGroupId") unless params["adGroupId"]
 
-      get_request("/v1/adGroups/#{params["adGroupId"]}/suggested/keywords/extended?#{setup_url_params(params)}")
+      get_request("/v2/adGroups/#{params["adGroupId"]}/suggested/keywords/extended?#{setup_url_params(params)}")
     end
 
     def self.asin_suggestions(params = {}, opts = {})
       # required argument checks
       raise ArgumentError.new("params hash must contain an asinValue") unless params["asinValue"]
 
-      get_request("/v1/asins/#{params["asinValue"]}/suggested/keywords?#{setup_url_params(params)}")
+      get_request("/v2/asins/#{params["asinValue"]}/suggested/keywords?#{setup_url_params(params)}")
     end
 
     def self.bulk_asin_suggestions(params = {}, opts = {})
@@ -27,8 +27,8 @@ module Blurb
 
       maxNumSuggestions = 100
       maxNumSuggestions = params["maxNumSuggestions"] if params["maxNumSuggestions"]
-      
-      post_request("/v1/asins/suggested/keywords", {
+
+      post_request("/v2/asins/suggested/keywords", {
         "asins" => params["asins"],
         "maxNumSuggestions" => maxNumSuggestions
       })

data/lib/blurb/version.rb

@@ -1,3 +1,3 @@
 module Blurb
-  VERSION = "0.1.2".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blurb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - dlbunker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2018-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler