blurb 0.4.8 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92ab9498ffa51bc559bac7ee7b4294bef3b0f8f106c5375531af20f8ae026649
-  data.tar.gz: b7709d612fecbeb4bbd634a716fae4b259ea9d77a0bf4701125856cf90b5726b
+  metadata.gz: cc759e7143938c4b655af1c4ea8b72af388933f065d84230c0353451c6ffc9f2
+  data.tar.gz: 3e300e444044b62ef1dcb07dcbe2c29e03ff0d0973ec3afa25b1666f5a08510e
 SHA512:
-  metadata.gz: 4e0e4ac917c156469d58b9bc9a33fa63f94cf88e79cbaf90bd999536a89773cf47ba460acb8e538fb180e583e0a6f7e52240623aec120a39aa9f3d3fc69cbc49
-  data.tar.gz: e9d09bbc20847bfe92d177e87cfb689bc5a6c59e89fd7d0928e4b27051574b656639027236130d24c71c57e28e906cdd898a5f138bf86805a0936347ba45661e
+  metadata.gz: 06dc8e873b618c4ba50ffa6bf3c889841c2e1816d06dccbf1b538d74f0442f8895b68172bb656f020cf91bd86c9264b027c64722fb22d3b2f129494b09ccbc07
+  data.tar.gz: 2ec363459a1f8751cc0dbe79abcbc06699bac1b90804520627886b72e358b544d93fa55b5c097a7d3725db6e49cd476cdb02be14082d9acbbe6e7f37dbc4be61

data/blurb.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "blurb"
-  spec.version       = "0.4.8"
+  spec.version       = "0.5.2"
   spec.authors       = ["dlbunker", "eamigo13", "smithworx"]
   spec.email         = ["evan@pattern.com"]
 

data/lib/blurb/base_class.rb

@@ -2,7 +2,8 @@ class Blurb
   class BaseClass
     CAMPAIGN_TYPE_CODES = {
       sp: 'sp',
-      sb: 'hsa'
+      sb: 'hsa',
+      sd: 'sd'
     }.freeze
   end
 end 

data/lib/blurb/campaign_requests.rb

@@ -0,0 +1,24 @@
+require 'blurb/request_collection_with_campaign_type'
+
+class Blurb
+  class CampaignRequests < RequestCollectionWithCampaignType
+    def create_bulk(create_array)
+      create_array = map_campaign_payload(create_array)
+      super(create_array)
+    end
+
+    def update_bulk(update_array)
+      update_array = map_campaign_payload(update_array)
+      super(update_array)
+    end
+
+    private
+
+      def map_campaign_payload(payload)
+        campaign_type_string = "sponsoredProducts" if @campaign_type == CAMPAIGN_TYPE_CODES[:sp]
+        campaign_type_string = "sponsoredBrands" if @campaign_type == CAMPAIGN_TYPE_CODES[:sb]
+        campaign_type_string = "sponsoredDisplays" if @campaign_type == CAMPAIGN_TYPE_CODES[:sd]
+        payload.each{ |p| p[:campaign_type] = campaign_type_string }
+      end
+  end
+end

data/lib/blurb/history_request.rb

@@ -0,0 +1,54 @@
+require 'blurb/request_collection'
+
+class Blurb
+  class HistoryRequest < RequestCollection
+    FROM_DATE = (DateTime.now - 30).strftime('%Q')
+    TO_DATE = DateTime.now.strftime('%Q')
+    MAX_COUNT = 200.freeze
+    MIN_COUNT = 50.freeze
+    FILTERS = []
+    PARENT_CAMPAIGN_ID = nil
+
+    def initialize(base_url:, headers:)
+      @base_url = base_url
+      @headers = headers
+    end
+
+    def retrieve(
+      from_date: FROM_DATE,
+      to_date: TO_DATE,
+      campaign_ids:,
+      filters: FILTERS,
+      parent_campaign_id: PARENT_CAMPAIGN_ID,
+      count: MAX_COUNT
+    )
+
+      count = MIN_COUNT if count < MIN_COUNT
+      count = MAX_COUNT if count > MAX_COUNT
+
+      payload = {
+        sort: {
+          key: 'DATE',
+          direction: 'ASC'
+        },
+        fromDate: from_date.to_i,
+        toDate: to_date.to_i,
+        eventTypes: {
+          CAMPAIGN: {
+            eventTypeIds: campaign_ids
+          }
+        },
+        count: count
+      }
+
+      payload[:eventTypes][:CAMPAIGN].merge!({ filters: filters }) if filters.present?
+      payload[:eventTypes][:CAMPAIGN].merge!({ parents: [{ campaignId: parent_campaign_id }] }) if parent_campaign_id.present?
+
+      execute_request(
+        api_path: "/history",
+        request_type: :post,
+        payload: payload
+      )
+    end
+  end
+end

data/lib/blurb/profile.rb

@@ -1,9 +1,11 @@
 require "blurb/account"
+require "blurb/campaign_requests"
 require "blurb/snapshot_requests"
 require "blurb/report_requests"
 require "blurb/request_collection"
 require "blurb/request_collection_with_campaign_type"
 require "blurb/suggested_keyword_requests"
+require "blurb/history_request"
 
 class Blurb
   class Profile < BaseClass
@@ -11,29 +13,40 @@ class Blurb
     attr_accessor(
       :account,
       :ad_groups,
+      :sd_ad_groups,
       :campaign_negative_keywords,
       :portfolios,
       :product_ads,
+      :sd_product_ads,
       :profile_id,
       :suggested_keywords,
-      :targets
+      :targets,
+      :history
     )
 
     def initialize(profile_id:, account:)
       @profile_id = profile_id
       @account = account
 
-      @sp_campaigns = RequestCollectionWithCampaignType.new(
+      @sp_campaigns = CampaignRequests.new(
         headers: headers_hash,
         base_url: @account.api_url,
         resource: "campaigns",
         campaign_type: CAMPAIGN_TYPE_CODES[:sp]
       )
-      @sb_campaigns = RequestCollectionWithCampaignType.new(
+      @sb_campaigns = CampaignRequests.new(
         headers: headers_hash,
         base_url: @account.api_url,
         resource: "campaigns",
-        campaign_type: CAMPAIGN_TYPE_CODES[:sb]
+        campaign_type: CAMPAIGN_TYPE_CODES[:sb],
+        bulk_api_limit: 10
+      )
+      @sd_campaigns = CampaignRequests.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        resource: "campaigns",
+        campaign_type: CAMPAIGN_TYPE_CODES[:sd],
+        bulk_api_limit: 10
       )
       @sp_keywords = RequestCollectionWithCampaignType.new(
         headers: headers_hash,
@@ -62,6 +75,11 @@ class Blurb
         base_url: @account.api_url,
         campaign_type: CAMPAIGN_TYPE_CODES[:sp]
       )
+      @sd_reports = ReportRequests.new(
+        headers: headers_hash,
+        base_url: @account.api_url,
+        campaign_type: CAMPAIGN_TYPE_CODES[:sd]
+      )
       @sb_reports = ReportRequests.new(
         headers: headers_hash,
         base_url: @account.api_url,
@@ -71,10 +89,18 @@ class Blurb
         headers: headers_hash,
         base_url: "#{@account.api_url}/v2/sp/adGroups"
       )
+      @sd_ad_groups = RequestCollection.new(
+        headers: headers_hash,
+        base_url: "#{@account.api_url}/sd/adGroups"
+      )
       @product_ads = RequestCollection.new(
         headers: headers_hash,
         base_url: "#{account.api_url}/v2/sp/productAds"
       )
+      @sd_product_ads = RequestCollection.new(
+        headers: headers_hash,
+        base_url: "#{account.api_url}/sd/productAds"
+      )
       @sp_negative_keywords = RequestCollectionWithCampaignType.new(
         headers: headers_hash,
         base_url: @account.api_url,
@@ -103,11 +129,16 @@ class Blurb
         headers: headers_hash,
         base_url: "#{@account.api_url}/v2/sp"
       )
+      @history = HistoryRequest.new(
+        headers: headers_hash,
+        base_url: @account.api_url
+      )
     end
 
     def campaigns(campaign_type)
       return @sp_campaigns if campaign_type == :sp
       return @sb_campaigns if campaign_type == :sb || campaign_type == :hsa
+      return @sd_campaigns if campaign_type == :sd
     end
 
     def keywords(campaign_type)
@@ -128,6 +159,7 @@ class Blurb
     def reports(campaign_type)
       return @sp_reports if campaign_type == :sp
       return @sb_reports if campaign_type == :sb || campaign_type == :hsa
+      return @sd_reports if campaign_type == :sd
     end
 
     def request(api_path: "",request_type: :get, payload: nil, url_params: nil, headers: headers_hash)

data/lib/blurb/report_requests.rb

@@ -2,6 +2,8 @@ require 'blurb/request_collection_with_campaign_type'
 
 class Blurb
   class ReportRequests < RequestCollectionWithCampaignType
+    SD_TACTIC = 'T00020'.freeze
+
     def initialize(campaign_type:, base_url:, headers:)
       @campaign_type = campaign_type
       @base_url = "#{base_url}/v2/#{@campaign_type}"
@@ -15,12 +17,13 @@ class Blurb
       segment: nil
     )
       # create payload
-      metrics = get_default_metrics(record_type.to_s.underscore.to_sym) if metrics.nil?
+      metrics = get_default_metrics(record_type.to_s.underscore.to_sym, segment) if metrics.nil?
       payload = {
         metrics: metrics.map{ |m| m.to_s.camelize(:lower) }.join(","),
         report_date: report_date
       }
       payload[:segment] = segment if segment
+      payload[:tactic] = SD_TACTIC if @campaign_type.to_sym == :sd
 
       execute_request(
         api_path: "/#{record_type.to_s.camelize(:lower)}/report",
@@ -45,7 +48,7 @@ class Blurb
 
     private
 
-    def get_default_metrics(record_type)
+    def get_default_metrics(record_type, segment = nil)
       if @campaign_type == CAMPAIGN_TYPE_CODES[:sb]
         return [
           "campaignId",
@@ -79,7 +82,16 @@ class Blurb
           "attributedSales14dSameSKU",
           "attributedConversions14d",
           "attributedConversions14dSameSKU"
-        ] if record_type == :keywords
+        ] if record_type == :keywords && segment.nil?
+        return [
+          "adGroupId",
+          "campaignId",
+          "impressions",
+          "clicks",
+          "cost",
+          "attributedSales14d",
+          "attributedConversions14d",
+        ] if record_type == :keywords && segment.present?
       elsif @campaign_type == CAMPAIGN_TYPE_CODES[:sp]
         return [
           "campaignId",
@@ -242,6 +254,118 @@ class Blurb
           "attributedSales14dSameSKU",
           "attributedSales30dSameSKU"
         ] if record_type == :portfolios
+      elsif @campaign_type == CAMPAIGN_TYPE_CODES[:sd]
+        return [
+          "campaignId",
+          "impressions",
+          "clicks",
+          "cost",
+          "currency",
+          "attributedConversions1d",
+          "attributedConversions7d",
+          "attributedConversions14d",
+          "attributedConversions30d",
+          "attributedConversions1dSameSKU",
+          "attributedConversions7dSameSKU",
+          "attributedConversions14dSameSKU",
+          "attributedConversions30dSameSKU",
+          "attributedUnitsOrdered1d",
+          "attributedUnitsOrdered7d",
+          "attributedUnitsOrdered14d",
+          "attributedUnitsOrdered30d",
+          "attributedSales1d",
+          "attributedSales7d",
+          "attributedSales14d",
+          "attributedSales30d",
+          "attributedSales1dSameSKU",
+          "attributedSales7dSameSKU",
+          "attributedSales14dSameSKU",
+          "attributedSales30dSameSKU"
+        ] if record_type == :campaigns
+        return [
+          "campaignId",
+          "adGroupId",
+          "impressions",
+          "clicks",
+          "cost",
+          "currency",
+          "attributedConversions1d",
+          "attributedConversions7d",
+          "attributedConversions14d",
+          "attributedConversions30d",
+          "attributedConversions1dSameSKU",
+          "attributedConversions7dSameSKU",
+          "attributedConversions14dSameSKU",
+          "attributedConversions30dSameSKU",
+          "attributedUnitsOrdered1d",
+          "attributedUnitsOrdered7d",
+          "attributedUnitsOrdered14d",
+          "attributedUnitsOrdered30d",
+          "attributedSales1d",
+          "attributedSales7d",
+          "attributedSales14d",
+          "attributedSales30d",
+          "attributedSales1dSameSKU",
+          "attributedSales7dSameSKU",
+          "attributedSales14dSameSKU",
+          "attributedSales30dSameSKU"
+        ] if record_type == :ad_groups
+        return [
+          "campaignId",
+          "adGroupId",
+          "impressions",
+          "clicks",
+          "cost",
+          "currency",
+          "attributedConversions1d",
+          "attributedConversions7d",
+          "attributedConversions14d",
+          "attributedConversions30d",
+          "attributedConversions1dSameSKU",
+          "attributedConversions7dSameSKU",
+          "attributedConversions14dSameSKU",
+          "attributedConversions30dSameSKU",
+          "attributedUnitsOrdered1d",
+          "attributedUnitsOrdered7d",
+          "attributedUnitsOrdered14d",
+          "attributedUnitsOrdered30d",
+          "attributedSales1d",
+          "attributedSales7d",
+          "attributedSales14d",
+          "attributedSales30d",
+          "attributedSales1dSameSKU",
+          "attributedSales7dSameSKU",
+          "attributedSales14dSameSKU",
+          "attributedSales30dSameSKU"
+        ] if record_type == :product_ads
+        return [
+          "campaignId",
+          "targetId",
+          "impressions",
+          "clicks",
+          "cost",
+          "currency",
+          "attributedConversions1d",
+          "attributedConversions7d",
+          "attributedConversions14d",
+          "attributedConversions30d",
+          "attributedConversions1dSameSKU",
+          "attributedConversions7dSameSKU",
+          "attributedConversions14dSameSKU",
+          "attributedConversions30dSameSKU",
+          "attributedUnitsOrdered1d",
+          "attributedUnitsOrdered7d",
+          "attributedUnitsOrdered14d",
+          "attributedUnitsOrdered30d",
+          "attributedSales1d",
+          "attributedSales7d",
+          "attributedSales14d",
+          "attributedSales30d",
+          "attributedSales1dSameSKU",
+          "attributedSales7dSameSKU",
+          "attributedSales14dSameSKU",
+          "attributedSales30dSameSKU"
+        ] if record_type == :targets
       end
     end
   end

data/lib/blurb/request.rb

@@ -83,6 +83,7 @@ class Blurb
       end
 
       def camelcase_key(k)
+        return k if k.to_s == k.to_s.upcase
         k.to_s.camelize(:lower)
       end
 

data/lib/blurb/request_collection.rb

@@ -4,9 +4,10 @@ require "blurb/base_class"
 class Blurb
   class RequestCollection < BaseClass
 
-    def initialize(headers:, base_url:)
+    def initialize(headers:, base_url:, bulk_api_limit: 100)
       @base_url = base_url
       @headers = headers
+      @api_limit = bulk_api_limit
     end
 
     def list(url_params=nil)
@@ -46,7 +47,6 @@ class Blurb
       execute_bulk_request(
         request_type: :post,
         payload: create_array,
-        api_limit: 100
       )
     end
 
@@ -58,7 +58,6 @@ class Blurb
       execute_bulk_request(
         request_type: :put,
         payload: update_array,
-        api_limit: 100
       )
     end
 
@@ -73,6 +72,7 @@ class Blurb
 
       def execute_request(api_path: "", request_type:, payload: nil, url_params: nil)
         url = "#{@base_url}#{api_path}"
+        url.sub!('/sd/', '/') if request_type == :get && url.include?('sd/reports') && url_params.nil?
 
         request = Request.new(
           url: url,
@@ -86,9 +86,9 @@ class Blurb
       end
 
       # Split up bulk requests to match the api limit
-      def execute_bulk_request(api_limit:, **execute_request_params)
+      def execute_bulk_request(**execute_request_params)
         results = []
-        payloads = execute_request_params[:payload].each_slice(api_limit).to_a
+        payloads = execute_request_params[:payload].each_slice(@api_limit).to_a
         payloads.each do |p|
           execute_request_params[:payload] = p
           results << execute_request(execute_request_params)

data/lib/blurb/request_collection_with_campaign_type.rb

@@ -3,10 +3,12 @@ require 'blurb/request_collection'
 class Blurb
   class RequestCollectionWithCampaignType < RequestCollection
 
-    def initialize(campaign_type:, resource:, base_url:, headers:)
+    def initialize(campaign_type:, resource:, base_url:, headers:, bulk_api_limit: 100)
       @campaign_type = campaign_type
-      @base_url = "#{base_url}/v2/#{@campaign_type}/#{resource}"
+      base_url = campaign_type.to_s == 'sd' ? base_url : "#{base_url}/v2"
+      @base_url = "#{base_url}/#{@campaign_type}/#{resource}"
       @headers = headers
+      @api_limit = bulk_api_limit
     end
   end
-end 
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blurb
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.5.2
 platform: ruby
 authors:
 - dlbunker
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -175,10 +175,12 @@ files:
 - lib/blurb.rb
 - lib/blurb/account.rb
 - lib/blurb/base_class.rb
+- lib/blurb/campaign_requests.rb
 - lib/blurb/client.rb
 - lib/blurb/errors/failed_request.rb
 - lib/blurb/errors/invalid_report_request.rb
 - lib/blurb/errors/request_throttled.rb
+- lib/blurb/history_request.rb
 - lib/blurb/profile.rb
 - lib/blurb/report_requests.rb
 - lib/blurb/request.rb