bing_ads_ruby_sdk 1.0.0 → 1.3.2

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

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

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

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

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

@@ -0,0 +1,238 @@
+# 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
+      # we use a global var to create ad extensions once, its enough
+      $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.select { |record| record[:ad_extension][:type] == type }.first
+      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

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

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