bing-ads 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9d2c1ad3927817aea14d5e9fbca74bc0fe8e215
+  data.tar.gz: 4164a03a0cc8d5c7b66cf617f9bed9199746f7ff
+SHA512:
+  metadata.gz: ee7c3c7677cb20105428728338d5cb5aab2e2fbc6362dca244566f9b02d05b50e178f4e7c7e9d190f2714e1d63baaf34bef4195c5bd7bdf487dcea992205b511
+  data.tar.gz: 984bd0bcd26fbe5372c03cf49f10aae4199142aea929872a4ef01f3a4e59933b094771d113cd98170562cde3722cb4b9e4cea947bd8e21d0f8e911ae7109e1d1

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# built gem files
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+bing-ads

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bing-ads.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Mohamed Osama Elnagdy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,280 @@
+# Bing::Ads
+
+A Ruby client for Bing Ads API that includes a proxy to all Bing Ads API web services and abstracts low level details of authentication with OAuth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bing-ads'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bing-ads
+
+## Usage
+
+### Campaign 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',
+  account_id: '5278183',
+  # client_settings: { logger: LOGGER::STDOUT }
+}
+
+service = Bing::Ads::API::V11::Services::CampaignManagement.new(options)
+```
+
+#### Getting campaigns in account
+```ruby
+account_id = 5278183
+response = service.get_campaigns_by_account_id(account_id)
+```
+
+#### Adding campaigns
+```ruby
+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',
+    status: Bing::Ads::API::V11.constants.campaign_management.campaign_status.paused,
+    time_zone: Bing::Ads::API::V11.constants.time_zones.amsterdam_berlin_bern_rome_stockholm_vienna
+  },
+  # ...
+]
+
+response = service.add_campaigns(account_id, campaigns)
+```
+
+#### Updating campaigns
+```ruby
+account_id = 5278183
+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",
+  },
+  # ...
+]
+
+response = service.update_campaigns(account_id, campaigns)
+```
+
+#### Deleting campaigns
+```ruby
+account_id = 5278183
+campaign_ids_to_delete = [813721838, 813721813, 813721911]
+response = service.delete_campaigns(account_id, campaign_ids_to_delete)
+```
+
+---
+
+#### Getting ad groups in campaign
+```ruby
+campaign_id = 813721838
+response = service.get_ad_groups_by_campaign_id(campaign_id)
+```
+
+#### Getting ad groups in campaign by ids
+```ruby
+campaign_id = 813721838
+ad_group_ids = [9866221838, 9866221813, 9866221911]
+response = service.get_ad_groups_by_ids(campaign_id, ad_group_ids)
+```
+
+#### Adding ad groups to campaign
+```ruby
+# You can add a maximum of 1,000 ad groups in a single call.
+# Each campaign can have up to 20,000 ad groups.
+campaign_id = 813721838
+ad_groups = [
+  {
+    ad_distribution: Bing::Ads::API::V11.constants.campaign_management.ad_distribution.search, # required
+    ad_rotation: Bing::Ads::API::V11.constants.campaign_management.ad_rotation.optimize_for_clicks, # optional
+    bidding_scheme: Bing::Ads::API::V11.constants.campaign_management.bidding_scheme.inherit_from_parent, # optional
+    content_match_bid: 100, # optional
+    end_date: '31/12/2020',
+    status: Bing::Ads::API::V11.constants.campaign_management.ad_group_status.paused,
+    language: Bing::Ads::API::V11.constants.languages.english,
+    name: 'H=WHotelAmsterdam&AG=1723812002',
+    native_bid_adjustment: -50, # optional (-100 to 900)
+    remarketing_targeting_setting: Bing::Ads::API::V11.constants.campaign_management.remarketing_target_setting.bid_only, # optional
+    search_bid: 100, # optional
+    start_date: '5/7/2017',
+  },
+  # ...
+  # https://msdn.microsoft.com/en-us/library/bing-ads-campaign-management-adgroup.aspx
+]
+
+response = service.add_ad_groups(campaign_id, ad_groups)
+```
+
+#### Updating ad groups in campaign
+```ruby
+# You can add a maximum of 1,000 ad groups in a single call.
+# Each campaign can have up to 20,000 ad groups.
+campaign_id = 813721838
+ad_groups = [
+  {
+    id: 9866221838,
+    status: Bing::Ads::API::V11.constants.campaign_management.ad_group_status.active
+  },
+  # ...
+]
+
+response = service.update_ad_groups(campaign_id, ad_groups)
+```
+
+---
+
+#### Getting ads in ad group
+```ruby
+ad_group_id = 9866221838
+response = service.get_ads_by_ad_group_id(ad_group_id)
+```
+
+#### Getting ads in ad group by ids
+```ruby
+ad_group_id = 9866221838
+ad_ids = [454873284248, 454873284249, 454873284250]
+response = service.get_ads_by_ids(ad_group_id, ad_ids)
+```
+
+#### Adding ads to ad group
+```ruby
+# You can add a maximum of 50 ads in an ad group.
+ad_group_id = 9866221838
+expanded_text_ads = [
+  {
+    type: Bing::Ads::API::V11.constants.campaign_management.ad_types.expanded_text_ad, # ExpandedTextAd
+    path_1: 'Amsterdam',
+    path_2: 'Hotels',
+    text: 'Compare over 150 booking sites! Find guaranteed low hotel rates.',
+    title_part_1: 'Hotels in Amsterdam',
+    title_part_2: 'Best Deals. Book now',
+    final_urls: [
+      'http://www.findhotel.net/Places/Amsterdam.htm'
+    ]
+  },
+  # ...
+  # Expanded text ads
+  # https://msdn.microsoft.com/en-us/library/bing-ads-campaign-management-expandedtextad.aspx
+  # For other ad types:
+  # https://msdn.microsoft.com/en-us/library/bing-ads-campaign-management-ad.aspx
+]
+
+# Returns IDs of ads added to ad group
+# { ad_ids: [], partial_errors: [] }
+response = service.add_ads(ad_group_id, expanded_text_ads)
+```
+
+#### Updating ads in ad group
+```ruby
+ad_group_id = 9866221838
+updated_expanded_text_ads = [
+  {
+    id: 454873284248,
+    final_urls: [
+      'https://www.findhotel.net/Places/Amsterdam.htm'
+    ]
+  },
+  # ...
+]
+
+response = service.update_ads(ad_group_id, updated_expanded_text_ads)
+```
+
+---
+
+#### Getting keywords in ad group
+```ruby
+ad_group_id = 9866221838
+response = service.get_keywords_by_ad_group_id(ad_group_id)
+```
+
+#### Getting keywords in ad group by ids
+```ruby
+ad_group_id = 9866221838
+keyword_ids = [234873284248, 234873284249, 234873284250]
+response = service.get_keywords_by_ids(ad_group_id, keyword_ids)
+```
+
+#### Adding keywords to ad group
+```ruby
+ad_group_id = 9866221838
+keywords = [
+  {
+    bidding_scheme: Bing::Ads::API::V11.constants.campaign_management.bidding_scheme.inherit_from_parent,
+    bid: 5,
+    # optional, ad final urls used if this is not set
+    final_urls: [
+      'https://www.findhotel.net/Places/Amsterdam.htm?attrs=pet-friendly'
+    ],
+    match_type: Bing::Ads::API::V11.constants.campaign_management.match_types.exact, # also broad, content, phrase
+    status: Bing::Ads::API::V11.constants.campaign_management.keyword_statuses.active,
+    text: 'Pet-friendly Hotels in Amsterdam'
+  },
+  # ...
+  # https://msdn.microsoft.com/en-us/library/bing-ads-campaign-management-keyword.aspx
+  # https://msdn.microsoft.com/en-us/library/bing-ads-campaign-management-addkeywords.aspx
+]
+
+# Returns IDs of keywords added to ad group
+# { keyword_ids: [], partial_errors: [] }
+response = service.add_keywords(ad_group_id, keywords)
+```
+
+#### Updating keywords in ad group
+```ruby
+ad_group_id = 9866221838
+updated_keywords = [
+  {
+    id: 234873284248,
+    # updated attributes
+  },
+  # ...
+]
+
+response = service.update_keywords(ad_group_id, updated_keywords)
+```
+
+### Bulk Service
+Not yet supported
+
+### Customer Management Service
+Not yet supported
+
+### Reporting Service
+Not yet supported. Use: https://github.com/FindHotel/bing-ads-reporting
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/FindHotel/bing-ads.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bing/ads"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bing-ads.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bing/ads/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bing-ads"
+  spec.version       = Bing::Ads::VERSION
+  spec.authors       = ["oss92"]
+  spec.email         = ["mohamed.o.alnagdy@gmail.com", "oss@findhotel.net"]
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{Enhances the experience of developing Bing Ads applications with Ruby}
+  spec.description   = %q{A Ruby client for Bing Ads API that includes a proxy to all Bing Ads API web services and abstracts low level details of authentication with OAuth2.}
+  spec.homepage      = "https://github.com/FindHotel/bing-ads"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'savon', '~> 2.11'
+  spec.add_dependency 'activesupport', '~> 5.0'
+  spec.add_dependency 'persey', '~> 0.0.11'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/bing/ads.rb

@@ -0,0 +1,23 @@
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/hash'
+require 'active_support/hash_with_indifferent_access'
+require 'date'
+require 'persey'
+require 'savon'
+
+require 'bing/ads/api/errors'
+require 'bing/ads/api/soap_client'
+require 'bing/ads/api/v11'
+require 'bing/ads/api/v11/constants'
+require 'bing/ads/api/v11/services'
+
+require 'bing/ads/utils'
+require 'bing/ads/version'
+
+module Bing
+  module Ads
+    # A Ruby client for Bing Ads API that includes a proxy to all
+    # Bing Ads API web services and abstracts low level details of
+    # authentication with OAuth.
+  end
+end

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

@@ -0,0 +1,20 @@
+module Bing
+  module Ads
+    module API
+      module Errors
+        # Bing::Ads::API::Errors::AuthenticationParamsMissing
+        class AuthenticationParamsMissing < RuntimeError; end;
+
+        # Bing::Ads::API::Errors::AuthenticationTokenExpired
+        class AuthenticationTokenExpired < RuntimeError; end;
+
+        # Bing::Ads::API::Errors::LimitError
+        class LimitError < RuntimeError
+          def initialize(operation, limit, type)
+            super("can not #{operation} more than #{limit} #{type.to_s.humanize.downcase.pluralize} in a single call")
+          end
+        end
+      end
+    end
+  end
+end