bing_ads_ruby_sdk 1.0.0 → 1.3.2

data/spec/examples/5_with_campaign/campaign_spec.rb

@@ -0,0 +1,71 @@
+require_relative '../examples'
+
+RSpec.describe 'CampaignManagement service' do
+  include_context 'use api'
+
+  describe 'Campaign methods' do
+    let(:a_campaign_hash) do
+      a_hash_including(
+        audience_ads_bid_adjustment: a_kind_of(String),
+        bidding_scheme: a_kind_of(Hash),
+        budget_type: a_kind_of(String),
+        daily_budget: a_kind_of(String),
+        forward_compatibility_map: '',
+        id: Examples.campaign_id.to_s,
+        name: a_string_starting_with('Acceptance Test Campaign'),
+        status: a_kind_of(String),
+        time_zone: a_kind_of(String),
+        tracking_url_template: nil,
+        url_custom_parameters: nil,
+        campaign_type: a_kind_of(String),
+        settings: nil,
+        budget_id: nil,
+        languages: nil,
+        experiment_id: nil,
+        final_url_suffix: nil,
+        sub_type: nil,
+      )
+    end
+
+    describe '#get_campaigns_by_account_id' do
+      it 'returns a list of campaigns' do
+        expect(api.campaign_management.get_campaigns_by_account_id(
+          account_id: Examples.account_id
+        )).to include(a_campaign_hash)
+      end
+    end
+
+    describe '#get_campaigns_by_ids' do
+      it 'returns a list of campaigns' do
+        expect(api.campaign_management.get_campaigns_by_ids(
+          account_id: Examples.account_id,
+          campaign_ids: [{ long: Examples.campaign_id }]
+        )).to include(a_campaign_hash)
+      end
+    end
+
+    describe '#update_campaigns' do
+      subject do
+        api.campaign_management.call(:update_campaigns,
+          account_id: Examples.account_id,
+          campaigns: {
+            campaign: [
+              id: Examples.campaign_id,
+              name: "Acceptance Test Campaign - #{random}"
+            ]
+          }
+        )
+      end
+
+      it 'returns no errors' do
+        is_expected.to eq(partial_errors: '')
+        updated_campaign = api.campaign_management.get_campaigns_by_ids(
+          account_id: Examples.account_id,
+          campaign_ids: [{ long: Examples.campaign_id }]
+        ).first
+
+        expect(updated_campaign).to include(name: "Acceptance Test Campaign - #{random}")
+      end
+    end
+  end
+end

data/spec/examples/6_with_ad_group/ad_group_spec.rb

@@ -0,0 +1,71 @@
+require_relative '../examples'
+
+RSpec.describe 'AdGroup methods' do
+  include_context 'use api'
+
+  let(:ad_group_record) do
+    a_hash_including(
+      ad_rotation: nil,
+      bidding_scheme: a_kind_of(Hash),
+      cpc_bid: a_kind_of(Hash),
+      id: a_kind_of(String),
+      language: a_kind_of(String),
+      name: a_kind_of(String),
+      network: a_kind_of(String),
+      settings: nil,
+      start_date: {
+        day: '1',
+        month: '1',
+        year: '2049',
+      },
+      end_date: {
+        day: '1',
+        month: '2',
+        year: '2049',
+      },
+      status: a_kind_of(String),
+      tracking_url_template: nil,
+      url_custom_parameters: nil,
+    )
+  end
+
+  describe '#get_ad_groups_by_ids' do
+    it 'returns AdGroups' do
+      expect(api.campaign_management.get_ad_groups_by_ids(
+        campaign_id: Examples.campaign_id,
+        ad_group_ids: [ { long: Examples.ad_group_id } ]
+      )).to include(ad_group_record)
+    end
+  end
+
+  describe '#get_ad_groups_by_campaign_id' do
+    it 'returns AdGroups' do
+      expect(api.campaign_management.get_ad_groups_by_campaign_id(
+        campaign_id: Examples.campaign_id
+      )).to include(ad_group_record)
+    end
+  end
+
+  describe '#update_ad_groups' do
+    it 'updates the ad' do
+      expect(api.campaign_management.call(:update_ad_groups,
+        campaign_id: Examples.campaign_id,
+        ad_groups: {
+          ad_group: [{
+            id: Examples.ad_group_id,
+            name: "AcceptanceTestAdGroup - #{random}"
+          }]
+        }
+      )).to eq(partial_errors: '', inherited_bid_strategy_types: nil)
+
+      ad_group = api.campaign_management.get_ad_groups_by_ids(
+        campaign_id: Examples.campaign_id,
+        ad_group_ids: [ { long: Examples.ad_group_id } ]
+      ).first
+
+      expect(ad_group).to include(
+        name: "AcceptanceTestAdGroup - #{random}"
+      )
+    end
+  end
+end

data/spec/examples/6_with_ad_group/ads_spec.rb

@@ -0,0 +1,113 @@
+require_relative '../examples'
+
+RSpec.describe 'Ad methods' do
+  include_context 'use api'
+
+  def add_ads
+    api.campaign_management.call(:add_ads,
+      ad_group_id: Examples.ad_group_id,
+      ads: [
+        {
+          expanded_text_ad: {
+            ad_format_preference: 'All',
+            domain: 'https://www.example.com/',
+            final_urls: [string: 'http://www.contoso.com/'],
+            path_1: 'subdirectory1',
+            path_2: 'su§bdirectory2',
+            text: 'Ad text goes here',
+            title_part_1: 'Title goes here',
+            title_part_2: 'Title 2 goes here',
+            status: 'Paused',
+            tracking_url_template: '{lpurl}',
+          },
+        },
+      ]
+    )
+  end
+
+  def get_ads
+    api.campaign_management.get_ads_by_ad_group_id(
+      ad_group_id: Examples.ad_group_id,
+      ad_types: [
+        { ad_type: 'Text' },
+        { ad_type: 'Image' },
+        { ad_type: 'Product' },
+        { ad_type: 'AppInstall' },
+        { ad_type: 'ExpandedText' },
+        { ad_type: 'DynamicSearch' },
+      ]
+    )
+  end
+
+  describe '#add_ads' do
+    it 'returns created Ad ids' do
+      expect(add_ads).to include(
+        ad_ids: [a_kind_of(Integer)],
+        partial_errors: ''
+      )
+    end
+  end
+
+  describe '#get_ads_by_ad_group_id' do
+    before { add_ads }
+
+    it 'returns a list of ads' do
+      expect(get_ads).to include(
+        {
+          ad_format_preference: a_kind_of(String),
+          device_preference: a_kind_of(String),
+          editorial_status: a_kind_of(String),
+          final_app_urls: nil,
+          final_mobile_urls: nil,
+          final_urls: a_kind_of(Hash),
+          final_url_suffix: nil,
+          forward_compatibility_map: "",
+          id: a_kind_of(String),
+          status: a_kind_of(String),
+          tracking_url_template: a_kind_of(String),
+          type: "ExpandedText",
+          url_custom_parameters: nil,
+          domain: a_kind_of(String),
+          path1: a_kind_of(String),
+          path2: a_kind_of(String),
+          text: a_kind_of(String),
+          text_part2: '',
+          title_part1: a_kind_of(String),
+          title_part2: a_kind_of(String),
+          title_part3: ''
+        }
+      )
+    end
+  end
+
+  describe '#update_ads' do
+    before { add_ads }
+
+    it 'updates the Ad' do
+      expect(api.campaign_management.call(:update_ads,
+        ad_group_id: Examples.ad_group_id,
+        ads: {
+          expanded_text_ad: [{
+            id: get_ads.first[:id],
+            text: "Ad text goes here - #{random}"
+          }],
+        }
+      )).to eq(partial_errors: '')
+
+      expect(get_ads.first).to include( text: "Ad text goes here - #{random}")
+    end
+  end
+
+  describe 'test_delete_ads' do
+    let(:ad_id) { add_ads[:ad_ids].first }
+
+    it 'returns no errors' do
+      expect(api.campaign_management.call(:delete_ads,
+        ad_group_id: Examples.ad_group_id,
+        ad_ids: [long: ad_id]
+      )).to eq(partial_errors: '')
+
+      expect(get_ads.map{|h| h[:id]}).not_to include ad_id.to_s
+    end
+  end
+end

data/spec/examples/6_with_ad_group/keywords_spec.rb

@@ -0,0 +1,108 @@
+require_relative '../examples'
+
+RSpec.describe 'Keyword methods' do
+  include_context 'use api'
+
+  describe 'Keyword methods' do
+    let(:a_keyword) do
+      {
+        bid: a_kind_of(Hash),
+        bidding_scheme: a_kind_of(Hash),
+        destination_url: a_kind_of(String),
+        editorial_status: a_kind_of(String),
+        final_app_urls: nil,
+        final_mobile_urls: nil,
+        final_url_suffix: nil,
+        final_urls: nil,
+        forward_compatibility_map: a_kind_of(String),
+        id: a_kind_of(String),
+        match_type: a_kind_of(String),
+        param1: a_kind_of(String),
+        param2: a_kind_of(String),
+        param3: a_kind_of(String),
+        status: a_kind_of(String),
+        text: a_kind_of(String),
+        tracking_url_template: nil,
+        url_custom_parameters: nil,
+      }
+    end
+
+    let(:keyword_id) { add_keywords[:keyword_ids].first }
+    let(:add_keywords) do
+      api.campaign_management.call(:add_keywords,
+        ad_group_id: Examples.ad_group_id,
+        keywords: { keyword: {
+          bid: { amount: 0.05 },
+          match_type: 'Exact',
+          text: "AcceptanceTestKeyword - #{random}",
+        } }
+      )
+    end
+
+    describe '#add_keywords' do
+      it 'returns created Keyword ids' do
+        expect(add_keywords).to include(
+          keyword_ids: [a_kind_of(Integer)],
+          partial_errors: ''
+        )
+      end
+    end
+
+    describe '#get_keywords_by_ad_group_id' do
+      before { add_keywords }
+
+      it 'returns a list of keywords' do
+        expect(api.campaign_management.get_keywords_by_ad_group_id(
+          ad_group_id: Examples.ad_group_id
+        )).to include(a_keyword)
+      end
+    end
+
+    describe '#get_keywords_by_editorial_status' do
+      before { add_keywords }
+
+      it 'returns a list of Keywords' do
+        expect(api.campaign_management.get_keywords_by_editorial_status(
+          ad_group_id: Examples.ad_group_id,
+          editorial_status: 'Active'
+        )).to include(a_keyword)
+      end
+    end
+
+    describe '#get_keywords_by_ids' do
+      before { add_keywords }
+
+      it 'returns a list of Keywords' do
+        expect(api.campaign_management.get_keywords_by_ids(
+          ad_group_id: Examples.ad_group_id,
+          keyword_ids: [{ long: keyword_id }]
+        )).to include(a_keyword)
+      end
+    end
+
+    describe '#update_keywords' do
+      before { add_keywords }
+
+      it 'updates the keyword' do
+        expect(api.campaign_management.call(:update_keywords,
+          ad_group_id: Examples.ad_group_id,
+          keywords: { keyword: [
+            id: keyword_id,
+            bid: { amount: 0.50 },
+          ] }
+        )).to include(partial_errors: '')
+      end
+    end
+
+    describe '#delete_keywords' do
+      before { add_keywords }
+
+      it 'returns no errors' do
+        expect(api.campaign_management.call(:delete_keywords,
+          ad_group_id: Examples.ad_group_id,
+          keyword_ids: [{ long: keyword_id }]
+        )).to eq(partial_errors: '')
+      end
+    end
+  end
+end

data/spec/examples/examples.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Examples
+  class << self
+
+    def random
+      SecureRandom.hex
+    end
+
+    def build_api
+      BingAdsRubySdk::Api.new(
+        developer_token: developer_token,
+        client_id: client_id,
+        oauth_store: store
+      ).tap do |api|
+        if account_id && customer_id
+          api.set_customer(
+            customer_id: customer_id,
+            account_id: account_id
+          )
+        end
+      end
+    end
+
+    def client_id
+      # you have to fill this in with data from bing
+    end
+
+    def developer_token
+      # you have to fill this in with data from bing
+    end
+
+    def parent_customer_id
+      # you have to fill this in with data from bing
+    end
+
+    def customer_id
+      # you have to fill this in with data you get after running 1_customer folder
+    end
+
+    def account_id
+      # you have to fill this in with data you get after running 1_customer folder
+    end
+
+    def uet_tag_id
+      # you have to fill this in with data you get after running 2_with_customer folder
+    end
+
+    def campaign_id
+      # you have to fill this in with data you get after running 2_with_customer folder
+    end
+
+    def conversion_goal_id
+      # you have to fill this in with data you get after running 3_with_uet_tag folder
+    end
+
+    def ad_group_id
+      # you have to fill this in with data you get after running 5_with_campaign folder
+    end
+
+    def store
+      ::BingAdsRubySdk::OAuth2::FsStore.new(store_filename)
+    end
+
+    def store_filename
+      ENV.fetch('BING_STORE_FILENAME')
+    end
+  end
+end
+
+RSpec.shared_context 'use api' do
+  let(:random) { Examples.random }
+  let(:api) { Examples.build_api }
+end

data/spec/fixtures/bulk/download_campaigns_by_account_ids/standard.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soap:Envelope xmlns:ns0="https://bingads.microsoft.com/CampaignManagement/v13" xmlns:ns1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:ns2="https://adapi.microsoft.com" xmlns:ns3="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns:ns4="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Header>
+    <ns0:AuthenticationToken>***FILTERED***</ns0:AuthenticationToken>
+    <ns0:DeveloperToken>***FILTERED***</ns0:DeveloperToken>
+    <ns0:CustomerId>***FILTERED***</ns0:CustomerId>
+    <ns0:CustomerAccountId>***FILTERED***</ns0:CustomerAccountId>
+  </soap:Header>
+  <soap:Body>
+    <ns0:DownloadCampaignsByAccountIdsRequest>
+      <ns0:AccountIds>
+        <ns1:long>150168726</ns1:long>
+      </ns0:AccountIds>
+      <ns0:CompressionType>Zip</ns0:CompressionType>
+      <ns0:DataScope>EntityData</ns0:DataScope>
+      <ns0:DownloadEntities>
+        <ns0:DownloadEntity>Campaigns</ns0:DownloadEntity>
+      </ns0:DownloadEntities>
+      <ns0:DownloadFileType>Csv</ns0:DownloadFileType>
+      <ns0:FormatVersion>6.0</ns0:FormatVersion>
+    </ns0:DownloadCampaignsByAccountIdsRequest>
+  </soap:Body>
+</soap:Envelope>