bing-ads 0.1.0

data/lib/bing/ads/api/soap_client.rb

@@ -0,0 +1,67 @@
+module Bing
+  module Ads
+    module API
+      # Bing::Ads::API::SOAPClient
+      class SOAPClient
+        attr_accessor :customer_id, :account_id, :developer_token, :wsdl_url, :client_settings
+        attr_accessor :authentication_token, :username, :password, :namespace_identifier
+        attr_accessor :savon_client
+
+        def initialize(options)
+          @customer_id            = options[:customer_id]
+          @account_id             = options[:account_id]
+          @developer_token        = options[:developer_token]
+          @wsdl_url               = options[:wsdl_url]
+          @namespace_identifier   = options[:namespace_identifier]
+          @authentication_token   = options[:authentication_token]
+          @username               = options[:username]
+          @password               = options[:password]
+          @client_settings        = options[:client_settings]
+        end
+
+        def call(operation:, payload: {})
+          client(client_settings).call(operation, message: payload)
+        end
+
+        def client(settings)
+          return savon_client if savon_client
+          settings = {
+            convert_request_keys_to: :camelcase,
+            wsdl: wsdl_url,
+            namespace_identifier: namespace_identifier,
+            soap_header: soap_header,
+            log: true,
+            log_level: :debug,
+            pretty_print_xml: true
+          }
+          settings.merge!(client_settings) if client_settings
+          @savon_client = Savon.client(settings)
+        end
+
+        private
+        def soap_header
+          headers = {}
+          if authentication_token
+            headers[ns('AuthenticationToken')] = authentication_token
+            headers[ns('CustomerAccountId')] = account_id
+            headers[ns('CustomerId')] = customer_id
+            headers[ns('DeveloperToken')] = developer_token
+          elsif username && password
+            headers[ns('CustomerAccountId')] = account_id
+            headers[ns('CustomerId')] = customer_id
+            headers[ns('DeveloperToken')] = developer_token
+            headers[ns('UserName')] = username
+            headers[ns('Password')] = password
+          else
+            raise Errors::AuthenticationParamsMissing, 'no authentication params provided'
+          end
+          headers
+        end
+
+        def ns(string)
+          "#{namespace_identifier}:#{string}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Bing
+  module Ads
+    module API
+      # Bing::Ads::API::V11
+      module V11
+        NAMESPACE_IDENTIFIER = :v11
+
+        def self.constants
+          Persey.config
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Bing
+  module Ads
+    module API
+      # Bing::Ads::API::V11::Constants
+      module Constants
+        root_v11_path = File.expand_path('../', __FILE__)
+
+        campaign_management_path = File.join(root_v11_path, 'constants', 'campaign_management.yml')
+        languages_path = File.join(root_v11_path, 'constants', 'languages.yml')
+        limits_path = File.join(root_v11_path, 'constants', 'limits.yml')
+        time_zones_path = File.join(root_v11_path, 'constants', 'time_zones.yml')
+        wsdl_path = File.join(root_v11_path, 'constants', 'wsdl.yml')
+
+        Persey.init(:default) do
+          source :yaml, campaign_management_path, :campaign_management
+          source :yaml, languages_path, :languages
+          source :yaml, limits_path, :limits
+          source :yaml, time_zones_path, :time_zones
+          source :yaml, wsdl_path, :wsdl
+          env :default
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+ad_distribution:
+  search: Search
+  content: Content
+ad_rotation:
+  optimize_for_clicks: OptimizeForClicks
+  rotate_ads_evenly: RotateAdsEvenly
+ad_group_status:
+  draft: Draft
+  active: Active
+  paused: Paused
+  deleted: Deleted
+ad_editorial_status:
+  active: Active
+  disapproved: Disapproved
+  inactive: Inactive
+  active_limited: ActiveLimited
+ad_status:
+  inactive: Inactive
+  active: Active
+  paused: Paused
+  deleted: Deleted
+ad_types:
+  text_ad: TextAd
+  image_ad: ImageAd
+  product_ad: ProductAd
+  app_install_ad: AppInstallAd
+  expanded_text_ad: ExpandedTextAd
+  dynamic_search_ad: DynamicSearchAd
+ad_types_for_get:
+  text: Text
+  image: Image
+  product: Product
+  app_install: AppInstall
+  expanded_text: ExpandedText
+  dynamic_search: DynamicSearch
+bidding_model:
+  keyword: Keyword
+  site_placement: SitePlacement
+bidding_scheme:
+  manual_cpc: ManualCpcBiddingScheme
+  enhanced_cpc: EnhancedCpcBiddingScheme
+  inherit_from_parent: InheritFromParentBiddingScheme
+  max_clicks: MaxClicksBiddingScheme
+  max_conversions: MaxConversionsBiddingScheme
+  target_cpa: TargetCpaBiddingScheme
+budget_limit_type:
+  daily_budget_accelerated: DailyBudgetAccelerated
+  daily_budget_standard: DailyBudgetStandard
+campaign_status:
+  active: Active
+  paused: Paused
+  budget_paused: BudgetPaused
+  budget_and_manual_paused: BudgetAndManualPaused
+  deleted: Deleted
+pricing_model:
+  cpc: Cpc
+  cpm: Cpm
+keyword_editorial_statuses:
+  active: Active
+  disapproved: Disapproved
+  inactive: Inactive
+keyword_statuses:
+  active: Active
+  paused: Paused
+  deleted: Deleted
+  inactive: Inactive
+match_types:
+  broad: Broad
+  content: Content
+  exact: Exact
+  phrase: Phrase
+network:
+  owned_and_operated_and_syndicated_search: OwnedAndOperatedAndSyndicatedSearch
+  owned_and_operated_only: OwnedAndOperatedOnly
+  syndicated_search_only: SyndicatedSearchOnly
+remarketing_target_setting:
+  bid_only: BidOnly
+  target_and_bid: TargetAndBid

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

@@ -0,0 +1,12 @@
+danish: 'Danish'
+dutch: 'Dutch'
+english: 'English'
+finnish: 'Finnish'
+french: 'French'
+german: 'German'
+italian: 'Italian'
+norwegian: 'Norwegian'
+portuguese: 'Portuguese'
+spanish: 'Spanish'
+swedish: 'Swedish'
+traditional_chinese: 'TraditionalChinese'

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

@@ -0,0 +1,5 @@
+per_call:
+  campaign: 100
+  ad_group: 1000
+  ad: 50
+  keyword: 1000

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

@@ -0,0 +1,75 @@
+abu_dhabi_muscat: 'AbuDhabiMuscat'
+adelaide: 'Adelaide'
+alaska: 'Alaska'
+almaty_novosibirsk: 'Almaty_Novosibirsk'
+amsterdam_berlin_bern_rome_stockholm_vienna: 'AmsterdamBerlinBernRomeStockholmVienna'
+arizona: 'Arizona'
+astana_dhaka: 'AstanaDhaka'
+athens_buckarest_istanbul: 'AthensBuckarestIstanbul'
+atlantic_time_canada: 'AtlanticTimeCanada'
+auckland_wellington: 'AucklandWellington'
+azores: 'Azores'
+baghdad: 'Baghdad'
+baku_tbilisi_yerevan: 'BakuTbilisiYerevan'
+bangkok_hanoi_jakarta: 'BangkokHanoiJakarta'
+beijing_chongqing_hong_kong_urumqi: 'BeijingChongqingHongKongUrumqi'
+belgrade_bratislava_budapest_ljubljana_prague: 'BelgradeBratislavaBudapestLjubljanaPrague'
+bogota_lima_quito: 'BogotaLimaQuito'
+brasilia: 'Brasilia'
+brisbane: 'Brisbane'
+brussels_copenhagen_madrid_paris: 'BrusselsCopenhagenMadridParis'
+bucharest: 'Bucharest'
+buenos_aires_georgetown: 'BuenosAiresGeorgetown'
+cairo: 'Cairo'
+canberra_melbourne_sydney: 'CanberraMelbourneSydney'
+cape_verde_island: 'CapeVerdeIsland'
+caracas_la_paz: 'CaracasLaPaz'
+casablanca_monrovia: 'CasablancaMonrovia'
+central_america: 'CentralAmerica'
+central_time_u_s_canada: 'CentralTimeUSCanada'
+chennai_kolkata_mumbai_new_delhi: 'ChennaiKolkataMumbaiNewDelhi'
+chihuahua_la_paz_mazatlan: 'ChihuahuaLaPazMazatlan'
+darwin: 'Darwin'
+eastern_time_u_s_canada: 'EasternTimeUSCanada'
+ekaterinburg: 'Ekaterinburg'
+fiji_kamchatka_marshall_island: 'FijiKamchatkaMarshallIsland'
+greenland: 'Greenland'
+greenwich_mean_time_dublin_edinburgh_lisbon_london: 'GreenwichMeanTimeDublinEdinburghLisbonLondon'
+guadalajara_mexico_city_monterrey: 'GuadalajaraMexicoCityMonterrey'
+guam_port_moresby: 'GuamPortMoresby'
+harare_pretoria: 'HararePretoria'
+hawaii: 'Hawaii'
+helsinki_kyiv_riga_sofia_tallinn_vilnius: 'HelsinkiKyivRigaSofiaTallinnVilnius'
+hobart: 'Hobart'
+indiana_east: 'IndianaEast'
+international_date_line_west: 'InternationalDateLineWest'
+irkutsk_ulaan_bataar: 'IrkutskUlaanBataar'
+islandamabad_karachi_tashkent: 'IslandamabadKarachiTashkent'
+jerusalem: 'Jerusalem'
+kabul: 'Kabul'
+kathmandu: 'Kathmandu'
+krasnoyarsk: 'Krasnoyarsk'
+kuala_lumpur_singapore: 'KualaLumpurSingapore'
+kuwait_riyadh: 'KuwaitRiyadh'
+magadan_solomon_island_new_caledonia: 'MagadanSolomonIslandNewCaledonia'
+mid_atlantic: 'MidAtlantic'
+midway_islandand_samoa: 'MidwayIslandand_Samoa'
+moscow_st_petersburg_volgograd: 'MoscowStPetersburgVolgograd'
+mountain_time_u_s_canada: 'MountainTime_US_Canada'
+nairobi: 'Nairobi'
+newfoundland: 'Newfoundland'
+nukualofa: 'Nukualofa'
+osaka_sapporo_tokyo: 'OsakaSapporoTokyo'
+pacific_time_u_s_canada_tijuana: 'PacificTimeUSCanadaTijuana'
+perth: 'Perth'
+rangoon: 'Rangoon'
+santiago: 'Santiago'
+sarajevo_skopje_warsaw_zagreb: 'SarajevoSkopjeWarsawZagreb'
+saskatchewan: 'Saskatchewan'
+seoul: 'Seoul'
+sri_jayawardenepura: 'SriJayawardenepura'
+taipei: 'Taipei'
+tehran: 'Tehran'
+vladivostok: 'Vladivostok'
+west_central_africa: 'WestCentralAfrica'
+yakutsk: 'Yakutsk'

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

@@ -0,0 +1,6 @@
+sandbox:
+  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:
+  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

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

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

@@ -0,0 +1,121 @@
+module Bing
+  module Ads
+    module API
+      module V11
+        module Services
+          # Bing::Ads::API::V11::Base
+          class Base
+            attr_accessor :soap_client, :environment, :retry_attempts
+
+            # @param options - Hash with autentication and environment settings
+            # * environment - +:production+ or +:sandbox+
+            # * developer_token - client application's developer access token
+            # * customer_id - identifier for the customer that owns the account
+            # * account_id - identifier of the account that own the entities in the request
+            # * client_settings - Hash with any Client additional options (such as header, logger or enconding)
+            # * retry_attempts - Number of times the service must retry on failure
+            # (EITHER)
+            # * authentication_token - OAuth2 token
+            # (OR)
+            # * username - Bing Ads username
+            # * password - Bing Ads password
+            def initialize(options = {})
+              @environment = options.delete(:environment)
+              @retry_attempts = options.delete(:retry_attempts) || 0
+              @account_id = options[:account_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
+              @soap_client = Bing::Ads::API::SOAPClient.new(options)
+            end
+
+            # This is a utility wrapper for calling services into the
+            # SOAPClient. This methods handle the Savon::Client Exceptions
+            # and returns a Hash with the call response
+            #
+            # @param operation - name of the operation to be called
+            # @param payload - hash with the parameters to the operation
+            #
+            # @example
+            #   service.call(:some_operation, { key: value })
+            #   # => <Hash>
+            #
+            # @return Hash with the result of the service call
+            # @raise ServiceError if the SOAP call fails or the response is invalid
+            def call(operation, payload)
+              retries_made = 0
+              raise 'You must provide an operation' if operation.nil?
+              begin
+                response = soap_client.call(operation: operation.to_sym, payload: payload)
+                return response.hash
+              rescue Savon::SOAPFault => error
+                fault_detail = error.to_hash[:fault][:detail]
+                if fault_detail.key?(:api_fault_detail)
+                  handle_soap_fault(operation, fault_detail, :api_fault_detail)
+                elsif fault_detail.key?(:ad_api_fault_detail)
+                  handle_soap_fault(operation, fault_detail, :ad_api_fault_detail)
+                else
+                  raise
+                end
+              rescue Savon::HTTPError => error
+                raise
+              rescue Savon::InvalidResponseError => error
+                raise
+              rescue
+                if retries_made < retry_attempts
+                  sleep(2**retries_made)
+                  retries_made += 1
+                  retry
+                else
+                  raise
+                end
+              end
+            end
+
+            # Extracts the actual response from the entire response hash.
+            #
+            # @param response - The complete response hash received from a Operation call
+            # @param method - Name of the method of with the 'reponse' tag is require
+            #
+            # @example
+            #   service.response_body(Hash, 'add_campaigns')
+            #   # => Hash
+            #
+            # @return Hash with the content of the called method response hash
+            def response_body(response, method)
+              response[:envelope][:body]["#{method}_response".to_sym]
+            end
+
+            private
+
+            # Returns service name. This method must be overriden by specific services.
+            #
+            # @return String with the service name
+            # @raise exception if the specific Service class hasn't overriden this method
+            def service_name
+              raise 'Should return the a service name from config.wsdl keys'
+            end
+
+            # Gets the service WSDL URL based on the service name and environment
+            #
+            # @return String with the Service url
+            def service_wsdl_url
+              Bing::Ads::API::V11.constants.wsdl.send(environment).send(service_name)
+            end
+
+            def handle_soap_fault(operation, fault_detail, key)
+              if fault_detail[key][:errors] &&
+                 fault_detail[key][:errors][:ad_api_error] &&
+                 fault_detail[key][:errors][:ad_api_error][:error_code] == 'AuthenticationTokenExpired'
+                raise Bing::Ads::API::Errors::AuthenticationTokenExpired,
+                      'renew authentication token or obtain a new one.'
+              else
+                raise "SOAP error while calling #{operation}, #{fault_detail[key]}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,360 @@
+module Bing
+  module Ads
+    module API
+      module V11
+        module Services
+          # Bing::Ads::API::V11::Services::CampaignManagement
+          class CampaignManagement < Base
+            def initialize(options = {})
+              super(options)
+            end
+
+            def get_campaigns_by_account_id(account_id=nil)
+              account_id ||= @account_id
+              response = call(:get_campaigns_by_account_id, account_id: account_id)
+              response_body = response_body(response, __method__)
+              [response_body[:campaigns][:campaign]].flatten.compact
+            end
+
+            def add_campaigns(account_id, campaigns)
+              validate_limits!(:campaign, :add, campaigns)
+              campaigns = campaigns.map { |campaign| prepare_campaign(campaign) }
+              payload = {
+                account_id: account_id,
+                campaigns: { campaign: campaigns }
+              }
+              response = call(:add_campaigns, payload)
+              response_body(response, __method__)
+            end
+
+            def update_campaigns(account_id, campaigns)
+              validate_limits!(:campaign, :update, campaigns)
+              campaigns = campaigns.map { |campaign| prepare_campaign(campaign) }
+              payload = {
+                account_id: account_id,
+                campaigns: { campaign: campaigns }
+              }
+              response = call(:update_campaigns, payload)
+              response_body(response, __method__)
+            end
+
+            def delete_campaigns(account_id, campaign_ids)
+              payload = {
+                account_id: account_id,
+                campaign_ids: { 'ins1:long' => campaign_ids }
+              }
+              response = call(:delete_campaigns, payload)
+              response_body(response, __method__)
+            end
+
+            def get_ad_groups_by_campaign_id(campaign_id)
+              response = call(:get_ad_groups_by_campaign_id,
+                              campaign_id: campaign_id)
+              response_body = response_body(response, __method__)
+              [response_body[:ad_groups][:ad_group]].flatten.compact
+            end
+
+            def get_ad_groups_by_ids(campaign_id, ad_groups_ids)
+              payload = {
+                campaign_id: campaign_id,
+                ad_group_ids: { 'ins1:long' => ad_groups_ids }
+              }
+              response = call(:get_ad_groups_by_ids, payload)
+              response_body = response_body(response, __method__)
+              [response_body[:ad_groups][:ad_group]].flatten
+            end
+
+            def add_ad_groups(campaign_id, ad_groups)
+              validate_limits!(:ad_group, :add, ad_groups)
+              ad_groups = ad_groups.map { |ad_group| prepare_ad_group(ad_group) }
+              payload = {
+                campaign_id: campaign_id,
+                ad_groups: { ad_group: ad_groups }
+              }
+              response = call(:add_ad_groups, payload)
+              response_body(response, __method__)
+            end
+
+            def update_ad_groups(campaign_id, ad_groups)
+              validate_limits!(:ad_group, :update, ad_groups)
+              ad_groups = ad_groups.map { |ad_group| prepare_ad_group(ad_group) }
+              payload = {
+                campaign_id: campaign_id,
+                ad_groups: { ad_group: ad_groups }
+              }
+              response = call(:update_ad_groups, payload)
+              response_body(response, __method__)
+            end
+
+            def get_ads_by_ad_group_id(ad_group_id)
+              payload = {
+                ad_group_id: ad_group_id,
+                ad_types: all_ad_types
+              }
+              response = call(:get_ads_by_ad_group_id, payload)
+              response_body = response_body(response, __method__)
+              response_ads = [response_body[:ads][:ad]].flatten.compact
+              response_ads.each_with_object({}) do |ad, obj|
+                type = ad['@i:type'.to_sym]
+                obj[type] ||= []
+                obj[type] << ad
+              end
+            end
+
+            def get_ads_by_ids(ad_group_id, ad_ids)
+              # Order matters
+              payload = {
+                ad_group_id: ad_group_id,
+                ad_ids: { 'ins1:long' => ad_ids },
+                ad_types: all_ad_types
+              }
+              response = call(:get_ads_by_ids, payload)
+              response_body = response_body(response, __method__)
+              response_ads = [response_body[:ads][:ad]].flatten
+              response_ads.each_with_object({}) do |ad, obj|
+                type = ad['@i:type'.to_sym]
+                obj[type] ||= []
+                obj[type] << ad
+              end
+            end
+
+            def add_ads(ad_group_id, ads)
+              validate_limits!(:ad, :add, ads)
+              ads = ads.map { |ad| prepare_ad(ad) }
+              payload = {
+                ad_group_id: ad_group_id,
+                ads: { ad: ads }
+              }
+              response = call(:add_ads, payload)
+              response_body(response, __method__)
+            end
+
+            def update_ads(ad_group_id, ads)
+              validate_limits!(:ad, :update, ads)
+              ads = ads.map { |ad| prepare_ad(ad) }
+              payload = {
+                ad_group_id: ad_group_id,
+                ads: { ad: ads }
+              }
+              response = call(:update_ads, payload)
+              response_body(response, __method__)
+            end
+
+            def get_keywords_by_ad_group_id(ad_group_id)
+              response = call(:get_keywords_by_ad_group_id, ad_group_id: ad_group_id)
+              response_body = response_body(response, __method__)
+              [response_body[:keywords][:keyword]].flatten.compact
+            end
+
+            def get_keywords_by_ids(ad_group_id, keyword_ids)
+              payload = {
+                ad_group_id: ad_group_id,
+                keyword_ids: { 'ins1:long' => keyword_ids }
+              }
+              response = call(:get_keywords_by_ids, payload)
+              response_body = response_body(response, __method__)
+              [response_body[:keywords][:keyword]].flatten
+            end
+
+            def add_keywords(ad_group_id, keywords)
+              validate_limits!(:keyword, :add, keywords)
+              keywords = keywords.map { |keyword| prepare_keyword(keyword) }
+              payload = {
+                ad_group_id: ad_group_id,
+                keywords: { keyword: keywords }
+              }
+              response = call(:add_keywords, payload)
+              response_body(response, __method__)
+            end
+
+            def update_keywords(ad_group_id, keywords)
+              validate_limits!(:keyword, :update, keywords)
+              keywords = keywords.map { |keyword| prepare_keyword(keyword) }
+              payload = {
+                ad_group_id: ad_group_id,
+                keywords: { keyword: keywords }
+              }
+              response = call(:update_keywords, payload)
+              response_body(response, __method__)
+            end
+
+            # TODO add_ad_extensions
+            # TODO add_ad_group_criterions
+            # TODO add_audiences
+            # TODO add_budgets
+            # TODO add_campaign_criterions
+            # TODO add_conversion_goals
+            # TODO add_labels
+            # TODO add_list_items_to_shared_list
+            # TODO add_media
+            # TODO add_negative_keywords_to_entities
+            # TODO add_shared_entity
+            # TODO add_uet_tags
+            # TODO appeal_editorial_rejections
+            # TODO apply_offline_conversions
+            # TODO apply_product_partition_actions
+            # TODO delete_ad_extensions
+            # TODO delete_ad_group_criterions
+            # TODO delete_ad_groups
+            # TODO delete_ads
+            # TODO delete_audiences
+            # TODO delete_budgets
+            # TODO delete_campaign_criterions
+            # TODO delete_conversion_goals
+            # TODO delete_keywords
+            # TODO delete_labels
+            # TODO delete_list_items_to_shared_list
+            # TODO delete_media
+            # TODO delete_negative_keywords_to_entities
+            # TODO delete_shared_entity
+            # TODO delete_shared_entity_associations
+            # TODO get_account_migration_statuses
+            # TODO get_account_properties
+            # TODO get_ad_extension_ids_by_account_id
+            # TODO get_ad_extensions_associations
+            # TODO get_ad_extensions_by_ids
+            # TODO get_ad_extensions_editorial_reasons
+            # TODO get_ad_group_criterions_by_ids
+            # TODO get_ads_by_editorial_status
+            # TODO get_audiences_by_ids
+            # TODO get_bmc_stores_by_customer_id
+            # TODO get_bsc_countries
+            # TODO get_budgets_by_ids
+            # TODO get_campaign_criterions_by_ids
+            # TODO get_campaign_ids_by_budget_ids
+            # TODO get_campaigns_by_ids
+            # TODO get_campaign_sizes_by_account_id
+            # TODO get_config_value
+            # TODO get_conversion_goals_by_ids
+            # TODO get_conversion_goals_by_tag_ids
+            # TODO get_editorial_reasons_by_ids
+            # TODO get_geo_locations_file_url
+            # TODO get_keywords_by_editorial_status
+            # TODO get_label_associations_by_entity_ids
+            # TODO get_label_associations_by_label_ids
+            # TODO get_labels_by_ids
+            # TODO get_list_items_by_shared_list
+            # TODO get_media_associations
+            # TODO get_media_by_ids
+            # TODO get_media_meta_data_by_account_id
+            # TODO get_media_meta_data_by_ids
+            # TODO get_negative_keywords_by_entity_ids
+            # TODO get_negative_sites_by_ad_group_ids
+            # TODO get_negative_sites_by_campaign_ids
+            # TODO get_shared_entities_by_account_id
+            # TODO get_shared_entity_associations_by_entity_ids
+            # TODO get_shared_entity_associations_by_shared_entity_ids
+            # TODO get_uet_tags_by_ids
+            # TODO set_account_properties
+            # TODO set_ad_extensions_associations
+            # TODO set_label_associations
+            # TODO set_negative_sites_to_ad_groups
+            # TODO set_negative_sites_to_campaigns
+            # TODO set_shared_entity_associations
+            # TODO update_ad_extensions
+            # TODO update_ad_group_criterions
+            # TODO update_audiences
+            # TODO update_budgets
+            # TODO update_campaign_criterions
+            # TODO update_conversion_goals
+            # TODO update_labels
+            # TODO update_list_items_to_shared_list
+            # TODO update_media
+            # TODO update_negative_keywords_to_entities
+            # TODO update_shared_entity
+            # TODO update_uet_tags
+
+            private
+
+            def service_name
+              'campaign_management'
+            end
+
+            def prepare_campaign(campaign)
+              campaign = Bing::Ads::Utils.sort_keys(campaign)
+              if campaign[:bidding_scheme]
+                campaign[:bidding_scheme] = {
+                  # TODO support MaxClicksBiddingScheme, MaxConversionsBiddingScheme and TargetCpaBiddingScheme
+                  type: campaign[:bidding_scheme],
+                  '@xsi:type' => "#{Bing::Ads::API::V11::NAMESPACE_IDENTIFIER}:#{campaign[:bidding_scheme]}"
+                }
+              end
+              campaign[:languages] = { 'ins1:string' => campaign[:languages] } if campaign[:languages]
+              # TODO UrlCustomParameters
+              # TODO Settings
+              Bing::Ads::Utils.camelcase_keys(campaign)
+            end
+
+            def prepare_ad_group(ad_group)
+              ad_group = Bing::Ads::Utils.sort_keys(ad_group)
+              ad_group[:ad_rotation] = { type: ad_group[:ad_rotation] } if ad_group[:ad_rotation]
+              if ad_group[:bidding_scheme]
+                # TODO support MaxClicksBiddingScheme, MaxConversionsBiddingScheme and TargetCpaBiddingScheme
+                ad_group[:bidding_scheme] = {
+                  type: ad_group[:bidding_scheme],
+                  '@xsi:type' => "#{Bing::Ads::API::V11::NAMESPACE_IDENTIFIER}:#{ad_group[:bidding_scheme]}"
+                }
+              end
+              ad_group[:content_match_bid] = { amount: ad_group[:content_match_bid] } if ad_group[:content_match_bid]
+              ad_group[:end_date] = date_hash(ad_group[:end_date]) if ad_group[:end_date]
+              ad_group[:search_bid] = { amount: ad_group[:search_bid] } if ad_group[:search_bid]
+              ad_group[:start_date] = date_hash(ad_group[:start_date]) if ad_group[:start_date]
+              # TODO UrlCustomParameters
+              Bing::Ads::Utils.camelcase_keys(ad_group)
+            end
+
+            def prepare_ad(ad)
+              ad = Bing::Ads::Utils.sort_keys(ad)
+              ad['@xsi:type'] = "#{Bing::Ads::API::V11::NAMESPACE_IDENTIFIER}:#{ad[:type]}"
+              ad[:final_mobile_urls] = { 'ins1:string' => ad[:final_mobile_urls] } if ad[:final_mobile_urls]
+              ad[:final_urls] = { 'ins1:string' => ad[:final_urls] } if ad[:final_urls]
+              # TODO FinalAppUrls
+              Bing::Ads::Utils.camelcase_keys(ad)
+            end
+
+            def prepare_keyword(keyword)
+              keyword = Bing::Ads::Utils.sort_keys(keyword)
+              keyword[:bid] = { amount: keyword[:bid] } if keyword[:bid]
+              if keyword[:bidding_scheme]
+                # TODO support MaxClicksBiddingScheme, MaxConversionsBiddingScheme and TargetCpaBiddingScheme
+                keyword[:bidding_scheme] = {
+                  type: keyword[:bidding_scheme],
+                  '@xsi:type' => "#{Bing::Ads::API::V11::NAMESPACE_IDENTIFIER}:#{keyword[:bidding_scheme]}"
+                }
+              end
+              keyword[:final_mobile_urls] = { 'ins1:string' => keyword[:final_mobile_urls] } if keyword[:final_mobile_urls]
+              keyword[:final_urls] = { 'ins1:string' => keyword[:final_urls] } if keyword[:final_urls]
+              # TODO FinalAppUrls
+              # TODO UrlCustomParameters
+              Bing::Ads::Utils.camelcase_keys(keyword)
+            end
+
+            def date_hash(date)
+              date = Date.parse(date) if date.is_a?(String)
+              { day: date.day, month: date.month, year: date.year }
+            end
+
+            def validate_limits!(type, operation, array)
+              limit = Bing::Ads::API::V11.constants.limits.per_call.send(type)
+              if array.size > limit
+                raise Bing::Ads::API::Errors::LimitError.new(operation, limit, type)
+              end
+            end
+
+            def all_ad_types
+              {
+                ad_type: [
+                  Bing::Ads::API::V11.constants.campaign_management.ad_types_for_get.text,
+                  Bing::Ads::API::V11.constants.campaign_management.ad_types_for_get.expanded_text,
+                  Bing::Ads::API::V11.constants.campaign_management.ad_types_for_get.image,
+                  Bing::Ads::API::V11.constants.campaign_management.ad_types_for_get.product,
+                  Bing::Ads::API::V11.constants.campaign_management.ad_types_for_get.app_install
+                ]
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end