soapy_bing 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75bb3e63ec854d756a3d216b9ddcd0ad8742aa80
-  data.tar.gz: 596a7c5f4d3c5f1f15611d7e98fbea0b0498d985
+  metadata.gz: ea5a6965e864eb014503ddafecb249e2effd9195
+  data.tar.gz: 50ea9e0645a6625676e7516abe118e72f9d05c06
 SHA512:
-  metadata.gz: 44998a329b39fda44bff367952ee29ca0e0f5a1df9ee15b38fe8ded6137a98e3b152273cefe8c87c453ff9fd118f7716abe627c2ef94ed44708888f770ace2f1
-  data.tar.gz: 11fe49b2c467a48dacfdc2d9b68cb296fc00759fefa4c867425fa531a0a19476220a661a10503439398adf0bbd125abdec78cab37733e8c88e6900ed5047673e
+  metadata.gz: 219d83ed3736b437e9840b5ad91dfda4e307ca282097ebfd0d37a4d5e4823036e6a1c4be81be73a75c0a632a463dd170695e0671e3b8b2e89b68eebcb24bf42e
+  data.tar.gz: 831a248fc27408938e8cbe7d22e91b4e1f7bb4ebb86dea0fb27493872757ae34b8c439a5f54bb9ec7dca9f92c16645f522822729b19384aded7264e64e634ff6

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 
 .env.local
 .env.development
+.bundle

data/README.md

@@ -55,6 +55,25 @@ SoapyBing::Ads.new(
 )
 ```
 
+### Generate a refresh token
+
+First go to the following url using your Client Id and Redirect Url.
+
+    https://login.live.com/oauth20_authorize.srf?client_id=<YOUR_CLIENT_ID>&scope=bingads.manage&response_type=code&redirect_uri=<YOUR_REDIRECT_URL>&state=ClientStateGoesHere
+
+Make a note of the code parameter that is present in the redirect url. Execute the following curl command to get a new Refresh token.
+
+```sh
+curl -v -XPOST \
+  -d client_id=<YOUR_CLIENT_ID> \
+  -d code=<THE_CODE_FROM_THE_FIRST_CALL>
+  -d grant_type=authorization_code \
+  -d redirect_uri=<YOUR_REDIRECT_URL> \
+  -d client_secret=<YOUR_CLIENT_SECRET> \
+  -H "Content-Type: application/x-www-form-urlencoded" \
+  https://login.live.com/oauth20_token.srf
+```
+
 ## Links
 * MS Live Applications [https://account.live.com/developers/applications](https://account.live.com/developers/applications)
 * Bing Ads User Authentication with OAuth [https://msdn.microsoft.com/en-us/library/bing-ads-user-authentication-oauth-guide.aspx](https://msdn.microsoft.com/en-us/library/bing-ads-user-authentication-oauth-guide.aspx)

data/lib/soapy_bing/ads/reports/base.rb

@@ -17,7 +17,7 @@ module SoapyBing
           language:    'English',
           name:        'MyReport',
           aggregation: 'HourOfDay',
-          columns:     %w(TimePeriod CampaignName Impressions Clicks Spend)
+          columns:     %w(TimePeriod CampaignName Impressions Clicks Spend CampaignId)
         }.freeze
 
         attr_reader :oauth_credentials, :account, :settings

data/lib/soapy_bing/ads.rb

@@ -19,5 +19,28 @@ module SoapyBing
         settings: settings
       )
     end
+
+    def get_ad_groups_by_campaign_id(campaign_id)
+      do_request(Soap::Request::GetAdGroupsByCampaignIdRequest, campaign_id: campaign_id)
+    end
+
+    def get_ads_by_ad_group_id(ad_group_id)
+      do_request(Soap::Request::GetAdsByAdGroupIdRequest, ad_group_id: ad_group_id)
+    end
+
+    def get_targets_by_campaign_ids(campaign_ids)
+      do_request(Soap::Request::GetTargetsByCampaignIdsRequest, campaign_ids: campaign_ids)
+    end
+
+    private
+
+    def do_request(klass, options)
+      klass.new(context: {
+        account: account,
+        authentication_token: oauth_credentials.access_token
+      }.merge(options))
+        .perform
+        .payload
+    end
   end
 end

data/lib/soapy_bing/soap/request/get_ad_groups_by_campaign_id_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module SoapyBing
+  module Soap
+    module Request
+      class GetAdGroupsByCampaignIdRequest < Base
+        API_BASE_URL = 'https://campaign.api.bingads.microsoft.com'
+        API_VERSION = 10
+        API_ENDPOINT = "#{API_BASE_URL}/Api/Advertiser/CampaignManagement/" \
+          "V#{API_VERSION}/CampaignManagementService.svc"
+
+        def perform
+          Response::GetAdGroupsByCampaignIdResponse.new(post(API_ENDPOINT))
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/soap/request/get_ads_by_ad_group_id_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module SoapyBing
+  module Soap
+    module Request
+      class GetAdsByAdGroupIdRequest < Base
+        API_BASE_URL = 'https://campaign.api.bingads.microsoft.com'
+        API_VERSION = 10
+        API_ENDPOINT = "#{API_BASE_URL}/Api/Advertiser/CampaignManagement/" \
+          "V#{API_VERSION}/CampaignManagementService.svc"
+
+        def perform
+          Response::GetAdsByAdGroupIdResponse.new(post(API_ENDPOINT))
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/soap/request/get_targets_by_campaign_ids_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module SoapyBing
+  module Soap
+    module Request
+      class GetTargetsByCampaignIdsRequest < Base
+        API_BASE_URL = 'https://campaign.api.bingads.microsoft.com'
+        API_VERSION = 10
+        API_ENDPOINT = "#{API_BASE_URL}/Api/Advertiser/CampaignManagement/" \
+          "V#{API_VERSION}/CampaignManagementService.svc"
+
+        def perform
+          Response::GetTargetsByCampaignIdsResponse.new(post(API_ENDPOINT))
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/soap/request.rb

@@ -2,3 +2,6 @@
 require 'soapy_bing/soap/request/base'
 require 'soapy_bing/soap/request/submit_generate_report_request'
 require 'soapy_bing/soap/request/poll_generate_report_request'
+require 'soapy_bing/soap/request/get_ad_groups_by_campaign_id_request'
+require 'soapy_bing/soap/request/get_ads_by_ad_group_id_request'
+require 'soapy_bing/soap/request/get_targets_by_campaign_ids_request'

data/lib/soapy_bing/soap/response/get_ad_groups_by_campaign_id_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module SoapyBing
+  module Soap
+    module Response
+      class GetAdGroupsByCampaignIdResponse < Base
+        def extract_payload
+          Array.wrap(body['Envelope']['Body'][class_name]['AdGroups']['AdGroup'])
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/soap/response/get_ads_by_ad_group_id_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module SoapyBing
+  module Soap
+    module Response
+      class GetAdsByAdGroupIdResponse < Base
+        def extract_payload
+          Array.wrap(body['Envelope']['Body'][class_name]['Ads']['Ad'])
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/soap/response/get_targets_by_campaign_ids_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module SoapyBing
+  module Soap
+    module Response
+      class GetTargetsByCampaignIdsResponse < Base
+        def extract_payload
+          Array.wrap(body['Envelope']['Body'][class_name]['Targets']['Target']).first
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/soap/response.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
+require 'active_support/core_ext/array/wrap'
+
 require 'soapy_bing/soap/response/payload'
 require 'soapy_bing/soap/response/report_status'
 require 'soapy_bing/soap/response/base'
 require 'soapy_bing/soap/response/submit_generate_report_response'
 require 'soapy_bing/soap/response/poll_generate_report_response'
+require 'soapy_bing/soap/response/get_ad_groups_by_campaign_id_response'
+require 'soapy_bing/soap/response/get_ads_by_ad_group_id_response'
+require 'soapy_bing/soap/response/get_targets_by_campaign_ids_response'

data/lib/soapy_bing/soap/templates/get_ad_groups_by_campaign_id.erb.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<env:Envelope xmlns:tns="https://bingads.microsoft.com/CampaignManagement/v10"
+              xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+    <env:Header>
+        <tns:CustomerAccountId><%= account.account_id %></tns:CustomerAccountId>
+        <tns:CustomerId><%= account.customer_id %></tns:CustomerId>
+        <tns:DeveloperToken><%= account.developer_token %></tns:DeveloperToken>
+        <tns:AuthenticationToken><%= authentication_token %></tns:AuthenticationToken>
+    </env:Header>
+    <env:Body>
+        <tns:GetAdGroupsByCampaignIdRequest>
+            <tns:CampaignId><%= campaign_id %></tns:CampaignId>
+        </tns:GetAdGroupsByCampaignIdRequest>
+    </env:Body>
+</env:Envelope>

data/lib/soapy_bing/soap/templates/get_ads_by_ad_group_id.erb.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<env:Envelope xmlns:tns="https://bingads.microsoft.com/CampaignManagement/v10"
+              xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+    <env:Header>
+        <tns:CustomerAccountId><%= account.account_id %></tns:CustomerAccountId>
+        <tns:CustomerId><%= account.customer_id %></tns:CustomerId>
+        <tns:DeveloperToken><%= account.developer_token %></tns:DeveloperToken>
+        <tns:AuthenticationToken><%= authentication_token %></tns:AuthenticationToken>
+    </env:Header>
+    <env:Body>
+        <tns:GetAdsByAdGroupIdRequest>
+          <tns:AdGroupId><%= ad_group_id %></tns:AdGroupId>
+        </tns:GetAdsByAdGroupIdRequest>
+    </env:Body>
+</env:Envelope>

data/lib/soapy_bing/soap/templates/get_targets_by_campaign_ids.erb.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<env:Envelope xmlns:tns="https://bingads.microsoft.com/CampaignManagement/v10"
+              xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
+              xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
+    <env:Header>
+        <tns:CustomerAccountId><%= account.account_id %></tns:CustomerAccountId>
+        <tns:CustomerId><%= account.customer_id %></tns:CustomerId>
+        <tns:DeveloperToken><%= account.developer_token %></tns:DeveloperToken>
+        <tns:AuthenticationToken><%= authentication_token %></tns:AuthenticationToken>
+    </env:Header>
+    <env:Body>
+        <tns:GetTargetsByCampaignIdsRequest>
+            <tns:CampaignIds>
+              <% campaign_ids.each do |campaign_id| %>
+                <arr:long><%= campaign_id %></arr:long>
+              <% end %>
+            </tns:CampaignIds>
+        </tns:GetTargetsByCampaignIdsRequest>
+    </env:Body>
+</env:Envelope>

data/lib/soapy_bing/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SoapyBing
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end