bing_ads_ruby_sdk 1.5.0 → 1.5.2

data/spec/examples/2_with_customer/budget_spec.rb

@@ -1,52 +0,0 @@
-require_relative "../examples"
-
-RSpec.describe "Budget methods" do
-  include_context "use api"
-
-  let(:budget_id) { add_budget[:budget_ids].first }
-
-  let(:add_budget) do
-    api.campaign_management.call(:add_budgets,
-      budgets: [
-        budget: {
-          amount: "10",
-          budget_type: "DailyBudgetStandard",
-          name: "test_budget #{random}"
-        }
-      ])
-  end
-
-  describe "#add_budget" do
-    it "returns budget ids for created Budgets" do
-      expect(add_budget).to include(
-        budget_ids: [a_kind_of(Integer)],
-        partial_errors: ""
-      )
-    end
-  end
-
-  describe "#get_budgets_by_ids" do
-    before { add_budget }
-
-    it "returns a list of budgets" do
-      expect(api.campaign_management.get_budgets_by_ids(
-        budget_ids: [long: budget_id]
-      )).to include({
-        amount: "10.00",
-        association_count: "0",
-        budget_type: "DailyBudgetStandard",
-        id: a_kind_of(String),
-        name: a_string_starting_with("test_budget")
-      })
-    end
-  end
-
-  describe "#delete_budgets" do
-    before { add_budget }
-
-    it "returns no errors" do
-      expect(api.campaign_management.call(:delete_budgets,
-        budget_ids: [{long: budget_id}])).to eq(partial_errors: "")
-    end
-  end
-end

data/spec/examples/2_with_customer/campaigns_spec.rb

@@ -1,26 +0,0 @@
-require_relative "../examples"
-
-RSpec.describe "CampaignManagement service" do
-  include_context "use api"
-
-  describe "Campaign methods" do
-    it "returns campaign ids" do
-      campaigns = api.campaign_management.call(:add_campaigns,
-        account_id: Examples.account_id,
-        campaigns: {
-          campaign:
-            {
-              name: "Acceptance Test Campaign #{random}",
-              daily_budget: 10,
-              budget_type: "DailyBudgetStandard",
-              time_zone: "BrusselsCopenhagenMadridParis"
-            }
-        })
-      expect(campaigns).to include(
-        partial_errors: "",
-        campaign_ids: [a_kind_of(Integer)]
-      )
-      puts "You can now fill in examples.rb with campaign_id: #{campaigns[:campaign_ids].first}"
-    end
-  end
-end

data/spec/examples/2_with_customer/customer_management_spec.rb

@@ -1,188 +0,0 @@
-require_relative "../examples"
-
-RSpec.describe "CustomerManagement service" do
-  include_context "use api"
-
-  let(:get_customer) do
-    api.customer_management.call(:get_customer, customer_id: Examples.customer_id)
-  end
-
-  let(:get_account) do
-    api.customer_management.get_account(account_id: Examples.account_id)
-  end
-
-  describe "Account methods" do
-    describe "#find_accounts" do
-      subject do
-        api.customer_management.call(:find_accounts,
-          account_filter: "",
-          customer_id: Examples.customer_id,
-          top_n: 1)
-      end
-
-      it "returns a list of basic account information" do
-        is_expected.to include(
-          accounts_info: {
-            account_info: [
-              {
-                id: a_kind_of(String),
-                name: a_kind_of(String),
-                number: a_kind_of(String),
-                account_life_cycle_status: a_kind_of(String),
-                pause_reason: nil
-              }
-            ]
-          }
-        )
-      end
-    end
-
-    describe "#find_accounts_or_customers_info" do
-      subject do
-        api.customer_management.find_accounts_or_customers_info(
-          filter: "",
-          top_n: 1
-        )
-      end
-
-      it "returns a list of records containing account / customer pairs" do
-        is_expected.to contain_exactly(
-          {
-            customer_id: a_kind_of(String),
-            customer_name: a_kind_of(String),
-            account_id: a_kind_of(String),
-            account_name: a_kind_of(String),
-            account_number: a_kind_of(String),
-            account_life_cycle_status: a_kind_of(String), # e.g. 'Active'
-            pause_reason: nil
-          }
-        )
-      end
-    end
-
-    describe "#get_account" do
-      it "returns information about the current account" do
-        expect(get_account).to include(
-          account: {
-            bill_to_customer_id: a_kind_of(String),
-            currency_code: "USD",
-            account_financial_status: "ClearFinancialStatus",
-            id: a_kind_of(String),
-            language: "English",
-            last_modified_by_user_id: a_kind_of(String),
-            last_modified_time: a_kind_of(String),
-            name: a_string_starting_with("Test Account"),
-            number: a_kind_of(String),
-            parent_customer_id: a_kind_of(String),
-            payment_method_id: a_kind_of(String),
-            payment_method_type: nil,
-            primary_user_id: a_kind_of(String),
-            account_life_cycle_status: "Active",
-            time_stamp: a_kind_of(String),
-            time_zone: a_kind_of(String),
-            pause_reason: nil,
-            forward_compatibility_map: nil,
-            linked_agencies: {
-              customer_info: [
-                {
-                  id: a_kind_of(String),
-                  name: a_kind_of(String)
-                }
-              ]
-            },
-            sales_house_customer_id: nil,
-            tax_information: "",
-            back_up_payment_instrument_id: nil,
-            billing_threshold_amount: nil,
-            business_address: nil,
-            auto_tag_type: "Inactive",
-            sold_to_payment_instrument_id: nil
-          }
-        )
-      end
-    end
-
-    describe "#update_account" do
-      let(:account) { get_account[:account] }
-      subject do
-        api.customer_management.update_account(
-          account: {
-            "@type" => "AdvertiserAccount",
-            :id => account[:id],
-            :time_stamp => account[:time_stamp],
-            :name => "Test Account #{Time.now} - updated"
-          }
-        )
-      end
-
-      it "returns the last modified time" do
-        is_expected.to include(last_modified_time: a_kind_of(String))
-      end
-    end
-  end
-
-  describe "Customer methods" do
-    describe "get_customer" do
-      it "returns customer data" do
-        expect(get_customer).to include(
-          customer: {
-            customer_financial_status: "ClearFinancialStatus",
-            id: a_kind_of(String),
-            industry: "Entertainment",
-            last_modified_by_user_id: a_kind_of(String),
-            last_modified_time: a_kind_of(String),
-            market_country: "US",
-            forward_compatibility_map: a_kind_of(Hash),
-            market_language: "English",
-            name: a_string_starting_with("Test Customer"),
-            service_level: "SelfServe",
-            customer_life_cycle_status: "Active",
-            time_stamp: a_kind_of(String),
-            number: a_kind_of(String),
-            customer_address: a_kind_of(Hash)
-          }
-        )
-      end
-    end
-
-    describe "#get_customers_info" do
-      subject do
-        api.customer_management.call(:get_customers_info,
-          customer_name_filter: "",
-          top_n: 1)
-      end
-
-      it "returns a list of simple customer information" do
-        is_expected.to include(
-          customers_info: {
-            customer_info: a_collection_including(
-              {
-                id: a_kind_of(String),
-                name: a_kind_of(String)
-              }
-            )
-          }
-        )
-      end
-    end
-
-    describe "#update_customer" do
-      let(:original_customer) { get_customer }
-
-      subject do
-        api.customer_management.call(:update_customer, {
-          customer: {
-            name: "Test Customer - #{Time.now}",
-            id: Examples.customer_id,
-            time_stamp: original_customer[:customer][:time_stamp],
-            industry: original_customer[:customer][:industry]
-          }
-        })
-      end
-
-      it "returns the update timestamp" do
-        is_expected.to include(last_modified_time: a_kind_of(String))
-      end
-    end
-  end
-end

data/spec/examples/2_with_customer/uet_tags_spec.rb

@@ -1,42 +0,0 @@
-require_relative "../examples"
-
-RSpec.describe "CampaignManagement service" do
-  include_context "use api"
-
-  describe "UET methods" do
-    subject(:add_uet_tags) do
-      api.campaign_management.add_uet_tags(
-        uet_tags: [
-          uet_tag: {
-            description: "UET Tag Description",
-            name: "Acceptance Test UET Tag #{random}"
-          }
-        ]
-      )
-    end
-
-    describe "#add_uet_tags" do
-      it "returns a list of newly created UET tags" do
-        uet_tags = add_uet_tags
-        expect(uet_tags).to include(
-          uet_tags: {
-            uet_tag: [
-              {
-                description: "UET Tag Description",
-                id: a_kind_of(String),
-                name: a_string_starting_with("Acceptance Test UET Tag"),
-                tracking_no_script: a_string_starting_with("<img src=\"//bat.bing.com/action/"),
-                tracking_script: a_string_starting_with("<script>(function(w,d,t,r,u)"),
-                tracking_status: "Unverified",
-                customer_share: nil
-              }
-            ]
-          },
-          partial_errors: ""
-        )
-
-        puts "Please fill in examples.rb with uet_tag_id: #{uet_tags[:uet_tags][:uet_tag].first[:id]}"
-      end
-    end
-  end
-end

data/spec/examples/3_with_uet_tag/conversion_goal_spec.rb

@@ -1,40 +0,0 @@
-require_relative "../examples"
-
-RSpec.describe "Conversion goals methods" do
-  include_context "use api"
-
-  it "returns a list of Conversion goal Ids" do
-    conversion_goals = api.campaign_management.add_conversion_goals(
-      conversion_goals: {
-        event_goal: {
-          conversion_window_in_minutes: 43_200, # 30days
-          count_type: "All",
-          name: "Acceptance Test Conversion goal #{random}",
-          revenue: {
-            currency_code: "EUR",
-            type: "FixedValue",
-            value: 5.20
-          },
-          scope: "Account",
-          status: "Active",
-          tag_id: Examples.uet_tag_id,
-          action_operator: "Equals",
-          action_expression: "display_phone",
-          category_operator: "Equals",
-          category_expression: "contact_form",
-          label_operator: "Equals",
-          label_expression: "lower_button",
-          value_operator: "Equals",
-          value: "1"
-        }
-      }
-    )
-
-    expect(conversion_goals).to include(
-      conversion_goal_ids: [a_kind_of(Integer)],
-      partial_errors: ""
-    )
-
-    puts "Please fill in examples.rb with conversion_goal_id: #{conversion_goals[:conversion_goal_ids].first}"
-  end
-end

data/spec/examples/3_with_uet_tag/uet_tags_spec.rb

@@ -1,56 +0,0 @@
-require_relative "../examples"
-
-RSpec.describe "CampaignManagement service" do
-  include_context "use api"
-
-  describe "UET methods" do
-    let(:get_uet_tags_by_ids) do
-      api.campaign_management.get_uet_tags_by_ids(
-        tag_ids: [
-          {long: Examples.uet_tag_id}
-        ]
-      )
-    end
-
-    describe "#get_uet_tags_by_ids" do
-      it "returns a list of UET tags" do
-        expect(get_uet_tags_by_ids).to contain_exactly(
-          {
-            description: a_kind_of(String),
-            id: a_kind_of(String),
-            name: a_string_starting_with("Acceptance Test UET Tag"),
-            tracking_no_script: a_string_starting_with("<img src=\"//bat.bing.com/action/"),
-            tracking_script: a_string_starting_with("<script>(function(w,d,t,r,u)"),
-            tracking_status: "Unverified",
-            customer_share: nil
-          }
-        )
-      end
-    end
-
-    describe "#update_uet_tags" do
-      subject do
-        api.campaign_management.update_uet_tags({
-          uet_tags: [
-            {
-              uet_tag: {
-                name: "Acceptance Test UET Tag - #{random}",
-                id: Examples.uet_tag_id,
-                description: "UET Tag Description - #{random}"
-              }
-            }
-          ]
-        })
-      end
-
-      it "updates the UET tag fields" do
-        is_expected.to eq(partial_errors: "")
-
-        expect(get_uet_tags_by_ids.first).to include(
-          name: "Acceptance Test UET Tag - #{random}",
-          description: "UET Tag Description - #{random}"
-        )
-      end
-    end
-  end
-end

data/spec/examples/4_with_conversion_goal/conversion_goals_spec.rb

@@ -1,76 +0,0 @@
-require_relative "../examples"
-
-RSpec.describe "Conversion goals methods" do
-  include_context "use api"
-
-  let(:a_conversion_goal) do
-    {
-      conversion_window_in_minutes: a_kind_of(String),
-      count_type: a_kind_of(String),
-      id: a_kind_of(String),
-      name: a_string_starting_with("Acceptance Test Conversion goal"),
-      revenue: a_kind_of(Hash),
-      scope: a_kind_of(String),
-      status: a_kind_of(String),
-      tag_id: Examples.uet_tag_id.to_s,
-      tracking_status: a_kind_of(String),
-      type: "Event",
-      action_expression: a_kind_of(String),
-      action_operator: a_kind_of(String),
-      category_expression: a_kind_of(String),
-      category_operator: a_kind_of(String),
-      label_expression: a_kind_of(String),
-      label_operator: a_kind_of(String),
-      value: a_kind_of(String),
-      value_operator: a_kind_of(String),
-      exclude_from_bidding: nil
-    }
-  end
-
-  describe "#get_conversion_goals_by_ids" do
-    it "returns a list of conversion goals" do
-      expect(api.campaign_management.get_conversion_goals_by_ids(
-        conversion_goal_types: "Event",
-        conversion_goal_ids: [{long: Examples.conversion_goal_id}]
-      )).to contain_exactly(a_conversion_goal)
-    end
-  end
-
-  describe "#get_conversion_goals_by_tag_ids" do
-    it "returns a list of conversion_goals" do
-      expect(api.campaign_management.call(:get_conversion_goals_by_tag_ids, {
-        conversion_goal_types: "Event",
-        tag_ids: [long: Examples.uet_tag_id]
-      })).to include(
-        conversion_goals: {
-          conversion_goal: a_collection_including(a_conversion_goal)
-        },
-        partial_errors: ""
-      )
-    end
-  end
-
-  describe "#update_conversion_goals" do
-    it "updates the conversion goals" do
-      expect(
-        api.campaign_management.update_conversion_goals(
-          conversion_goals: {
-            event_goal: {
-              id: Examples.conversion_goal_id,
-              name: "Acceptance Test Conversion goal #{random}"
-            }
-          }
-        )
-      ).to eq(partial_errors: "")
-
-      updated_conversion = api.campaign_management.get_conversion_goals_by_ids(
-        conversion_goal_types: "Event",
-        conversion_goal_ids: [{long: Examples.conversion_goal_id}]
-      ).first
-
-      expect(updated_conversion).to include(
-        name: "Acceptance Test Conversion goal #{random}"
-      )
-    end
-  end
-end