bing-ads 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2089287da01bbb3bae3202c1f09f59d1b0c278c4
-  data.tar.gz: 487814f5d5585592fef4743e279fa12ddbc406c9
+  metadata.gz: 07de1d1b77a390e2dbcf751a26ebd3d19ef24967
+  data.tar.gz: 209b2b9ad7bf5ff642140d5e95751ee98e63c873
 SHA512:
-  metadata.gz: 710a7812ad2196d8c5e64494388c47fc3ae9387f3b6fdb23eba7019069f3039f3a0eb660e93ba9ec69506c4214f5d8cf1448fdb144d3900852ae6628a120fba8
-  data.tar.gz: 197888a9dfd693655cd154315108ca7418c7298e1f4a2f07d80813bf6631049aefe7449b7e2eaf644e3c6351b797c48395a1527783c8afd20de32fdfd1e9d14d
+  metadata.gz: df9e01c278b7ef1c8ae34bd81370651f33179f33f779cb8db04322654b248cf527cddf6db8c13eb91f979a0dba265a2022fdd11def50937fa11ca79a21f583f9
+  data.tar.gz: 75a678422263eb8e8b8a5065e1eade82c9e4cbaad6f2b92e1374fcd4967cb56fe8f1d2d538190228f4d434283200d6865a1b9571f1f8f2c0454b8c229b782d45

data/README.md

@@ -1,4 +1,5 @@
 [![Gem Version](https://img.shields.io/gem/v/bing-ads.svg)](https://rubygems.org/gems/bing-ads)
+[![Build Status](https://travis-ci.org/FindHotel/bing-ads.svg?branch=master)](https://travis-ci.org/FindHotel/bing-ads)
 
 # Bing::Ads
 
@@ -22,6 +23,28 @@ Or install it yourself as:
 
 ## Usage
 
+### Customer Management Service
+#### Initialization
+```ruby
+# Authentication token is not supported in sandbox, use `username` and `password` instead
+# https://msdn.microsoft.com/en-us/library/dn277356.aspx
+
+options = {
+  environment: :sandbox,
+  authentication_token: '39b290146bea6ce975c37cfc23',
+  developer_token: 'BBD37VB98',
+  customer_id: '21027149',
+  # client_settings: { logger: LOGGER::STDOUT }
+}
+
+service = Bing::Ads::API::V11::Services::CustomerManagement.new(options)
+```
+
+#### Getting accounts info
+```ruby
+response = service.get_accounts_info
+```
+
 ### Campaign Management Service
 #### Initialization
 ```ruby
@@ -52,7 +75,6 @@ account_id = 5278183
 campaigns = [
   {
     budget_type: Bing::Ads::API::V11.constants.campaign_management.budget_limit_type.daily_budget_standard,
-    conversion_tracking_enabled: "false",
     daily_budget: 2000,
     description: 'Amsterdam-based global campaign',
     name: '51 - Global - Chain - Mixed - N -en- Amsterdam - 100 - 26479',
@@ -72,12 +94,10 @@ campaigns = [
   {
     id: 813721838,
     budget_type: Bing::Ads::API::V11.constants.campaign_management.budget_limit_type.daily_budget_standard,
-    conversion_tracking_enabled: "false",
   },
   {
     id: 813721849,
     budget_type: Bing::Ads::API::V11.constants.campaign_management.budget_limit_type.daily_budget_standard,
-    conversion_tracking_enabled: "false",
   },
   # ...
 ]
@@ -287,12 +307,15 @@ response = service.delete_keywords(ad_group_id, keyword_ids_to_delete)
 ### Bulk Service
 Not yet supported
 
-### Customer Management Service
-Not yet supported
-
 ### Reporting Service
 Not yet supported. Use: https://github.com/FindHotel/bing-ads-reporting
 
+### Errors raised
+* `Bing::Ads::API::Errors::AuthenticationParamsMissing`
+No username/password or authentication_token.
+* `Bing::Ads::API::Errors::AuthenticationTokenExpired` Authentication token needs to be refreshed.
+* `Bing::Ads::API::Errors::LimitError` An API limit has been exceeded on a specific request. Check message for details.
+
 ## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 To install this gem onto your local machine, run `bundle exec rake install`.

data/lib/bing/ads/api/v11/constants/wsdl.yml

@@ -1,6 +1,8 @@
 sandbox:
+  customer_management: https://clientcenter.api.sandbox.bingads.microsoft.com/Api/CustomerManagement/v11/CustomerManagementService.svc?singleWsdl
   campaign_management: "https://campaign.api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/V11/CampaignManagementService.svc?singleWsdl"
   reporting: "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/Reporting/V11/ReportingService.svc?singleWsdl"
 production:
+  customer_management: https://clientcenter.api.bingads.microsoft.com/Api/CustomerManagement/v11/CustomerManagementService.svc?singleWsdl
   campaign_management: "https://campaign.api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/V11/CampaignManagementService.svc?singleWsdl"
   reporting: "https://api.bingads.microsoft.com/Api/Advertiser/Reporting/V11/ReportingService.svc?singleWsdl"

data/lib/bing/ads/api/v11/services.rb

@@ -1,2 +1,3 @@
 require_relative './services/base'
 require_relative './services/campaign_management'
+require_relative './services/customer_management'

data/lib/bing/ads/api/v11/services/base.rb

@@ -23,6 +23,7 @@ module Bing
               @environment = options.delete(:environment)
               @retry_attempts = options.delete(:retry_attempts) || 0
               @account_id = options[:account_id]
+              @customer_id = options[:customer_id]
               raise 'You must set the service environment' unless @environment
               options[:wsdl_url] = service_wsdl_url
               options[:namespace_identifier] = Bing::Ads::API::V11::NAMESPACE_IDENTIFIER

data/lib/bing/ads/api/v11/services/customer_management.rb

@@ -0,0 +1,34 @@
+module Bing
+  module Ads
+    module API
+      module V11
+        module Services
+          # Bing::Ads::API::V11::Services::CustomerManagement
+          class CustomerManagement < Base
+            def initialize(options = {})
+              super(options)
+            end
+
+            def get_accounts_info(customer_id = @customer_id, only_parent_accounts = false)
+              payload = {
+                customer_id: customer_id,
+                only_parent_accounts: only_parent_accounts
+              }
+              response = call(:get_accounts_info, payload.compact)
+              response_body = response_body(response, __method__)
+              response_body[:accounts_info][:account_info]
+            end
+
+            # TODO operations: https://msdn.microsoft.com/en-us/library/bing-ads-customer-management-service-operations.aspx
+
+            private
+
+            def service_name
+              'customer_management'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bing/ads/version.rb

@@ -1,5 +1,5 @@
 module Bing
   module Ads
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bing-ads
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - oss92
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -128,6 +128,7 @@ files:
 - lib/bing/ads/api/v11/services.rb
 - lib/bing/ads/api/v11/services/base.rb
 - lib/bing/ads/api/v11/services/campaign_management.rb
+- lib/bing/ads/api/v11/services/customer_management.rb
 - lib/bing/ads/utils.rb
 - lib/bing/ads/version.rb
 homepage: https://github.com/FindHotel/bing-ads