bing_ads_ruby_sdk 1.5.0 → 1.5.2

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

@@ -1,235 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../examples"
-
-RSpec.describe "AdExtension methods" do
-  include_context "use api"
-
-  def create_add_ad_extensions
-    Examples.build_api.campaign_management.add_ad_extensions(
-      account_id: Examples.account_id,
-      ad_extensions: [
-        {
-          call_ad_extension: {
-            country_code: "NZ",
-            is_call_only: false,
-            phone_number: SecureRandom.random_number(999_999_999)
-          }
-        },
-        {
-          callout_ad_extension: {
-            text: Examples.random[0..11]
-          }
-        },
-        {
-          sitelink_ad_extension: {
-            description_1: "Description 1 - #{Examples.random}"[0..34],
-            description_2: "Description 2 - #{Examples.random}"[0..34],
-            display_text: "Display Text #{Examples.random}"[0..24],
-            final_mobile_urls: [{string: "http://mobile.example.com"}],
-            final_urls: [{string: "http://www.example.com"}],
-            tracking_url_template: "{lpurl}"
-          }
-        }
-      ]
-    )
-  end
-
-  def set_ad_extensions_associations(ad_extension_ids)
-    Examples.build_api.campaign_management.set_ad_extensions_associations(
-      account_id: Examples.account_id,
-      ad_extension_id_to_entity_id_associations: ad_extension_ids.map do |id|
-        {
-          ad_extension_id_to_entity_id_association: {
-            ad_extension_id: id,
-            entity_id: Examples.campaign_id
-          }
-        }
-      end,
-      association_type: "Campaign"
-    )
-  end
-
-  def ad_extension_ids(creation_response)
-    creation_response[:ad_extension_identities][:ad_extension_identity].map do |ext|
-      ext[:id].to_i
-    end
-  end
-
-  def get_ad_extensions_associations
-    api.campaign_management.get_ad_extensions_associations(
-      account_id: Examples.account_id,
-      ad_extension_type: "CallAdExtension SitelinkAdExtension CalloutAdExtension",
-      association_type: "Campaign",
-      entity_ids: [{long: Examples.campaign_id}]
-    )
-  end
-
-  context "with shared ad extensions" do
-    before(:all) do
-      @created_ad_extension_response = create_add_ad_extensions
-      set_ad_extensions_associations(ad_extension_ids(@created_ad_extension_response))
-    end
-
-    describe "#add_ad_extensions" do
-      it "returns AdExtension ids" do
-        expect(@created_ad_extension_response).to include(
-          ad_extension_identities: {
-            ad_extension_identity: [
-              {id: a_kind_of(String), version: "1"},
-              {id: a_kind_of(String), version: "1"},
-              {id: a_kind_of(String), version: "1"}
-            ]
-          },
-          nested_partial_errors: ""
-        )
-      end
-    end
-
-    describe "#get_ad_extensions_associations" do
-      let(:call_ad_extension) do
-        {
-          ad_extension: {
-            device_preference: nil,
-            forward_compatibility_map: "",
-            id: match(/[0-9]*/),
-            scheduling: nil,
-            status: a_kind_of(String),
-            type: "CallAdExtension",
-            version: match(/[0-9]*/),
-            country_code: a_kind_of(String),
-            is_call_only: "false",
-            is_call_tracking_enabled: "false",
-            phone_number: match(/[0-9]*/),
-            require_toll_free_tracking_number: nil
-          },
-          association_type: "Campaign",
-          editorial_status: a_kind_of(String),
-          entity_id: Examples.campaign_id.to_s
-        }
-      end
-
-      let(:callout_ad_extension) do
-        {
-          ad_extension: {
-            device_preference: nil,
-            forward_compatibility_map: "",
-            id: match(/[0-9]*/),
-            scheduling: nil,
-            status: a_kind_of(String),
-            type: "CalloutAdExtension",
-            version: match(/[0-9]*/),
-            text: a_kind_of(String)
-          },
-          association_type: "Campaign",
-          editorial_status: a_kind_of(String),
-          entity_id: Examples.campaign_id.to_s
-        }
-      end
-
-      let(:sitelink_ad_extension) do
-        {
-          ad_extension: {
-            device_preference: nil,
-            forward_compatibility_map: "",
-            id: match(/[0-9]*/),
-            status: a_kind_of(String),
-            type: "SitelinkAdExtension",
-            version: match(/[0-9]*/),
-            description1: a_kind_of(String),
-            description2: a_kind_of(String),
-            destination_url: nil,
-            display_text: a_kind_of(String),
-            final_app_urls: nil,
-            final_url_suffix: nil,
-            final_mobile_urls: {
-              string: a_kind_of(String)
-            },
-            final_urls: {
-              string: a_kind_of(String)
-            },
-            scheduling: nil,
-            tracking_url_template: a_kind_of(String),
-            url_custom_parameters: nil
-          },
-          association_type: "Campaign",
-          editorial_status: "Active",
-          entity_id: Examples.campaign_id.to_s
-        }
-      end
-
-      def get_association(associations, type)
-        associations.find { |record| record[:ad_extension][:type] == type }
-      end
-
-      it "returns a list of Associations" do
-        fetched_associations = get_ad_extensions_associations
-
-        # These are split apart to make it easier to figure out which one is missing
-        expect(get_association(fetched_associations, "CallAdExtension"))
-          .to include(call_ad_extension)
-
-        expect(get_association(fetched_associations, "CalloutAdExtension"))
-          .to include(callout_ad_extension)
-
-        expect(get_association(fetched_associations, "SitelinkAdExtension"))
-          .to include(sitelink_ad_extension)
-      end
-    end
-
-    describe "#get_ad_extension_ids_by_account_id" do
-      it "returns a list of IDs" do
-        fetched_ad_extension_ids = api.campaign_management.get_ad_extension_ids_by_account_id(
-          account_id: Examples.account_id,
-          ad_extension_type: "SitelinkAdExtension CallAdExtension CalloutAdExtension"
-        )
-        ad_extension_ids(@created_ad_extension_response).each do |id|
-          expect(fetched_ad_extension_ids).to include id
-        end
-      end
-    end
-
-    describe "#get_ad_extensions_by_ids" do
-      it "returns AdExtensions" do
-        extensions = api.campaign_management.get_ad_extensions_by_ids(
-          account_id: Examples.account_id,
-          ad_extension_ids: ad_extension_ids(@created_ad_extension_response).map { |id| {long: id} },
-          ad_extension_type: "SitelinkAdExtension CallAdExtension CalloutAdExtension"
-        )
-        expect(extensions).to be_an(Array)
-      end
-    end
-  end
-
-  describe "#delete_ad_extensions" do
-    let(:response) { create_add_ad_extensions }
-
-    it "returns no errors" do
-      expect(api.campaign_management.call(:delete_ad_extensions,
-        account_id: Examples.account_id,
-        ad_extension_ids: [{long: ad_extension_ids(response).first}])).to eq(partial_errors: "")
-    end
-  end
-
-  describe "#delete_ad_extensions_associations" do
-    before do
-      response = create_add_ad_extensions
-      set_ad_extensions_associations(ad_extension_ids(response))
-    end
-    let(:ad_extension_id) do
-      get_ad_extensions_associations.first[:ad_extension][:id]
-    end
-
-    it "currently raises an error" do
-      expect(api.campaign_management.call(:delete_ad_extensions_associations,
-        account_id: Examples.account_id,
-        ad_extension_id_to_entity_id_associations: [
-          ad_extension_id_to_entity_id_association: {
-            ad_extension_id: ad_extension_id,
-            entity_id: Examples.campaign_id
-          }
-        ],
-        association_type: "Campaign")).to eq(partial_errors: "")
-    end
-  end
-end

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

@@ -1,34 +0,0 @@
-require_relative "../examples"
-
-RSpec.describe "AdGroup methods" do
-  include_context "use api"
-
-  describe "#add_ad_groups" do
-    it "returns created AdGroup ids" do
-      ad_groups = api.campaign_management.call(:add_ad_groups,
-        campaign_id: Examples.campaign_id,
-        ad_groups: {
-          ad_group: {
-            name: "AcceptanceTestAdGroup - #{random}",
-            language: "French",
-            start_date: {
-              day: "1",
-              month: "1",
-              year: "2049"
-            },
-            end_date: {
-              day: "1",
-              month: "2",
-              year: "2049"
-            }
-          }
-        })
-      expect(ad_groups).to include(
-        ad_group_ids: [a_kind_of(Integer)],
-        partial_errors: ""
-      )
-
-      puts "Please fill in examples.rb with ad_group_id: #{ad_groups[:ad_group_ids].first}"
-    end
-  end
-end

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

@@ -1,72 +0,0 @@
-require_relative "../examples"
-
-RSpec.describe "CampaignCriterion methods" do
-  include_context "use api"
-
-  def add_campaign_criterions(location_id)
-    api.campaign_management.call(:add_campaign_criterions,
-      campaign_criterions: [
-        {
-          negative_campaign_criterion: {
-            campaign_id: Examples.campaign_id,
-            location_criterion: {
-              location_id: location_id
-            }
-          }
-        }
-      ],
-      criterion_type: "Targets")
-  end
-
-  describe "#add_campaign_criterions" do
-    it "returns CampaignCriterion ids" do
-      expect(add_campaign_criterions(190)).to include(
-        campaign_criterion_ids: [a_kind_of(Integer)],
-        nested_partial_errors: ""
-      )
-    end
-  end
-
-  describe "#delete_campaign_criterions" do
-    it "returns no errors" do
-      response = add_campaign_criterions(191)
-
-      expect(api.campaign_management.call(:delete_campaign_criterions,
-        campaign_criterion_ids: [
-          {long: response[:campaign_criterion_ids].first}
-        ],
-        campaign_id: Examples.campaign_id,
-        criterion_type: "Targets")).to eq(
-          partial_errors: ""
-        )
-    end
-  end
-
-  describe "#get_campaign_criterions_by_ids" do
-    it "returns CampaignCriterions" do
-      response = add_campaign_criterions(193)
-      criterion_id = response[:campaign_criterion_ids].first.to_s
-
-      criterions = api.campaign_management.get_campaign_criterions_by_ids(
-        campaign_criterion_ids: [{long: criterion_id}],
-        campaign_id: Examples.campaign_id,
-        criterion_type: "Age DayTime Device Gender Location LocationIntent Radius"
-      )
-
-      expect(criterions).to include(
-        campaign_id: Examples.campaign_id.to_s,
-        criterion: {
-          type: "LocationCriterion",
-          display_name: a_kind_of(String),
-          enclosed_location_ids: nil,
-          location_id: "193",
-          location_type: a_kind_of(String)
-        },
-        forward_compatibility_map: nil,
-        id: criterion_id,
-        status: a_kind_of(String),
-        type: "NegativeCampaignCriterion"
-      )
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-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

@@ -1,70 +0,0 @@
-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

@@ -1,110 +0,0 @@
-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

@@ -1,105 +0,0 @@
-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