bing-ads-api 0.1.0

data/test/campaign_management_test.rb

@@ -0,0 +1,463 @@
+# -*- encoding : utf-8 -*-
+require 'test_helper'
+
+# Public : Test case for Campaign Management services 
+# 
+# Author:: jlopezn@neonline.cl 
+class CampaignManagementTest < ActiveSupport::TestCase
+
+	def setup
+		
+		@config = BingAdsApi::Config.instance
+		@options = {
+			:environment => :sandbox,
+			:username => "desarrollo_neonline",
+			:password => "neonline2013",
+			:developer_token => "BBD37VB98",
+			:customer_id => "21021746",
+			:account_id => "5978083"
+		}
+		@service = BingAdsApi::CampaignManagement.new(@options)
+
+	end
+
+	test "truth" do
+		assert_kind_of Module, BingAdsApi
+	end
+	
+	test "initialize" do
+		@service = BingAdsApi::CampaignManagement.new(@options)
+		assert !@service.nil?, "CampaignManagement service not instantiated"
+	end
+
+	test "get campaigns by account" do
+		response = @service.get_campaigns_by_account_id(@options[:account_id])
+		assert !response.nil?, "No response received"
+		assert response.is_a?(Array), "No Array as response received"
+	end
+
+	test "add campaign" do
+		
+		name = "Test Campaign #{DateTime.now.strftime("%Y-%m-%d %H:%M:%S")}"
+		campaigns = [
+			BingAdsApi::Campaign.new(
+			:budget_type => BingAdsApi::Campaign::DAILY_BUDGET_STANDARD, 
+			:conversion_tracking_enabled => "false",
+			:daily_budget => 2000,
+			:daylight_saving => "false",
+			:description => name + " description",
+			:monthly_budget => 5400,
+			:name => name + " name",
+			:status => BingAdsApi::Campaign::PAUSED,
+			:time_zone => BingAdsApi::Campaign::SANTIAGO),
+		]
+		response = @service.add_campaigns(@options[:account_id], campaigns)
+		
+		puts "response[:campaign_ids][:long]"
+		puts response[:campaign_ids][:long]
+		assert !response[:campaign_ids][:long].nil?, "No campaigns id received"
+	end
+
+	test "add campaigns" do
+		name = "Test Campaign #{DateTime.now.strftime("%Y-%m-%d %H:%M:%S")}"
+		campaigns = [
+			BingAdsApi::Campaign.new(
+				:budget_type => BingAdsApi::Campaign::DAILY_BUDGET_STANDARD, 
+				:conversion_tracking_enabled => "false",
+				:daily_budget => 2000,
+				:daylight_saving => "false",
+				:description => name + " first description",
+				:monthly_budget => 5400,
+				:name => name + " first name",
+				:status => BingAdsApi::Campaign::PAUSED,
+				:time_zone => BingAdsApi::Campaign::SANTIAGO),
+
+			BingAdsApi::Campaign.new(
+				:budget_type => BingAdsApi::Campaign::DAILY_BUDGET_STANDARD, 
+				:conversion_tracking_enabled => "false",
+				:daily_budget => 2500,
+				:daylight_saving => "false",
+				:description => name + " second description",
+				:monthly_budget => 7800,
+				:name => name + " second name",
+				:status => BingAdsApi::Campaign::PAUSED,
+				:time_zone => BingAdsApi::Campaign::SANTIAGO),
+
+		]
+		response = @service.add_campaigns(@options[:account_id], campaigns)
+		puts "response.inspect"
+		puts response.inspect
+
+		puts "response[:campaign_ids][:long]"
+		puts response[:campaign_ids][:long]
+		assert !response[:campaign_ids][:long].nil?, "No campaigns ids received"
+		assert response[:campaign_ids][:long].is_a?(Array), "No array with campaign ids received"
+		assert response[:campaign_ids][:long].size == campaigns.size, "expected campaign_ids: #{campaigns.size}. Received: #{response[:campaign_ids][:long].size}"
+
+	end
+
+
+	test "update campaigns" do
+
+		campaigns = @service.get_campaigns_by_account_id(@options[:account_id])
+		assert !campaigns.nil?, "No campaigns received"
+
+		campaigns.each do |campaign|
+			campaign.description = campaign.description + " updated #{DateTime.now.strftime("%Y-%m-%d %H:%M:%S")}"
+			campaign.status = nil
+		end 
+
+		response = @service.update_campaigns(@options[:account_id], campaigns)
+
+		puts "UpdateCampaigns response"
+		puts response.inspect
+		assert !response.nil?, "No response received"
+
+	end
+
+
+	test "get ad groups by campaign" do
+		campaigns = @service.get_campaigns_by_account_id(@options[:account_id])
+		assert !campaigns.empty?, "No campaigns received for account id #{@options[:account_id]}" 
+		campaign_id = campaigns.first.id
+
+		response = @service.get_ad_groups_by_campaign_id(campaign_id)
+
+		puts "GetAdGroupsByCampaignId response :"
+		puts response.inspect
+		
+		assert !response.empty?, "No ad groups received from campaign #{campaign_id}"
+		assert response.is_a?(Array), "No array response received"
+	end
+
+
+	test "get ad groups by ids" do
+		campaigns = @service.get_campaigns_by_account_id(@options[:account_id])
+		assert !campaigns.empty?, "No campaigns received for account id #{@options[:account_id]}" 
+		campaign_id = campaigns.first.id
+
+		groups = @service.get_ad_groups_by_campaign_id(campaign_id)
+		
+		ad_group_ids = groups.map{ |gr| gr.id }
+		response = @service.get_ad_groups_by_ids(campaign_id, ad_group_ids)
+
+		puts "GetAdGroupsByIds response :"
+		puts response.inspect
+		
+		assert !response.nil?, "No ad groups received in campaign #{campaign_id} where ad_group_ids #{ad_group_ids}"
+		assert response.size == ad_group_ids.size, "Excpected #{ad_group_ids.size} ad groups. Received #{response.size}"
+
+	end
+
+	test "add ad group" do
+
+		campaigns = @service.get_campaigns_by_account_id(@options[:account_id])
+		assert !campaigns.empty?, "No campaigns received for account id #{@options[:account_id]}" 
+		campaign_id = campaigns.first.id
+		
+		name = "Ad Group #{DateTime.now.strftime("%Y-%m-%d %H:%M:%S")}"
+		ad_groups = [
+			BingAdsApi::AdGroup.new(
+			:ad_distribution => BingAdsApi::AdGroup::SEARCH,
+			:language => BingAdsApi::AdGroup::SPANISH,
+			:name => name + " name",
+			:pricing_model => BingAdsApi::AdGroup::CPC,
+			:bidding_model => BingAdsApi::AdGroup::KEYWORD)
+		]
+		response = @service.add_ad_groups(campaign_id, ad_groups)
+		
+		puts "AddAdGroups response[:ad_group_ids][:long]"
+		puts response[:ad_group_ids][:long]
+		assert !response[:ad_group_ids][:long].nil?, "No ad groups id received"
+
+	end
+
+
+	test "add ad groups" do
+		
+		campaigns = @service.get_campaigns_by_account_id(@options[:account_id])
+		assert !campaigns.empty?, "No campaigns received for account id #{@options[:account_id]}" 
+		campaign_id = campaigns.first.id
+		
+		name = "Ad Group #{DateTime.now.strftime("%Y-%m-%d %H:%M:%S")}"
+		ad_groups = [
+			BingAdsApi::AdGroup.new(
+			:ad_distribution => BingAdsApi::AdGroup::SEARCH,
+			:language => BingAdsApi::AdGroup::SPANISH,
+			:name => name + " name",
+			:pricing_model => BingAdsApi::AdGroup::CPC,
+			:bidding_model => BingAdsApi::AdGroup::KEYWORD),
+
+			BingAdsApi::AdGroup.new(
+			:ad_distribution => BingAdsApi::AdGroup::SEARCH,
+			:language => BingAdsApi::AdGroup::SPANISH,
+			:name => name + " second name",
+			:pricing_model => BingAdsApi::AdGroup::CPC,
+			:bidding_model => BingAdsApi::AdGroup::KEYWORD)
+
+		]
+		response = @service.add_ad_groups(campaign_id, ad_groups)
+		
+		puts "AddAdGroups response[:ad_group_ids][:long]"
+		puts response[:ad_group_ids][:long]
+		assert !response[:ad_group_ids][:long].nil?, "No ad groups id received"
+		assert response[:ad_group_ids][:long].is_a?(Array), "No array with ad group ids received"
+		assert response[:ad_group_ids][:long].size == ad_groups.size, "expected ad_group_ids: #{ad_groups.size}. Received: #{response[:ad_group_ids][:long].size}"
+
+	end
+
+
+	test "update ad groups" do
+		campaigns = @service.get_campaigns_by_account_id(@options[:account_id])
+		assert !campaigns.empty?, "No campaigns received for account id #{@options[:account_id]}" 
+		campaign_id = campaigns.first.id
+		
+		ad_groups = @service.get_ad_groups_by_campaign_id(campaign_id)
+		
+		ad_groups_to_update = ad_groups.map do |ad_group|
+			BingAdsApi::AdGroup.new(
+				:id => ad_group.id, 
+				:name => ad_group.name + " updated #{DateTime.now.strftime("%Y-%m-%d %H:%M:%S")}" )
+		end
+		
+		response = @service.update_ad_groups(campaign_id, ad_groups_to_update)
+		
+		puts "UpdateAdGroups response"
+		puts response
+		assert !response.nil?, "No response received"
+
+	end
+	
+	
+	test "add ads" do
+		
+		ad_group_id = 1980939070
+		
+		date = DateTime.now.strftime("%Y-%m-%d %H:%M:%S")
+
+		# TextAds
+		text_ads = [
+			BingAdsApi::TextAd.new(
+				:type => BingAdsApi::Ad::TEXT,
+				:status => BingAdsApi::Ad::INACTIVE,
+				:destination_url => "http://www.adxion.com",
+				:display_url => "AdXion.com",
+				:text => "TextAd #{date}",
+				:title => "TextAd"),
+
+			BingAdsApi::TextAd.new(
+				:type => BingAdsApi::Ad::TEXT,
+				:status => BingAdsApi::Ad::INACTIVE,
+				:destination_url => "http://www.adxion.com",
+				:display_url => "AdXion.com",
+				:text => "TextAd 2 #{date}",
+				:title => "TextAd 2")
+		]
+		response = @service.add_ads(ad_group_id, text_ads)
+		assert !response.nil? , "No response received adding text ads"
+
+		assert response[:partial_errors].nil?, "TextAds response with partial errors"
+
+		puts "Text: AddAds response[:ad_ids][:long]"
+		puts response[:ad_ids][:long]
+		assert !response[:ad_ids][:long].nil?, "No ad ids received for TextAds"
+
+
+		mobile_ads = [
+			BingAdsApi::MobileAd.new(
+				:bussines_name => "Bussiness 1",
+				:destination_url => "http://www.adxion.com",
+				:display_url => "AdXion.com",
+				:phone_number => "555555555",
+				:text => "Publish with us",
+				:title => "MobileAd"),
+
+			BingAdsApi::MobileAd.new(
+				:bussines_name => "Bussiness 2",
+				:destination_url => "http://www.adxion.com",
+				:display_url => "AdXion.com",
+				:phone_number => "555555555",
+				:text => "Keep publishing",
+				:title => "MobileAd 2")
+		]
+		response = @service.add_ads(ad_group_id, mobile_ads)
+		assert !response.nil? , "No response received adding mobile ads"
+
+		puts response[:partial_errors] if !response[:partial_errors].nil?
+		assert response[:partial_errors].nil?, "MobileAds response with partial errors"
+		
+		puts "Mobile: AddAds response[:ad_ids][:long]"
+		puts response[:ad_ids][:long]
+		assert !response[:ad_ids][:long].nil?, "No ad ids received for MobileAds"
+
+		# product_ads = [
+			# BingAdsApi::MobileAd.new(
+				# :promotional_text => "My Promotional text #{date}"),
+# 
+			# BingAdsApi::MobileAd.new(
+				# :promotional_text => "My Promotional text 2 #{date}")
+		# ]
+		# response = @service.add_ads(ad_group_id, product_ads)
+		# assert !response.nil? , "No response received adding product ads"
+
+	end
+	
+	
+	test "add ad" do
+
+		ad_group_id = 1980939070
+		
+		date = DateTime.now.strftime("%Y-%m-%d %H:%M:%S")
+
+		# TextAd
+		text_ad = BingAdsApi::TextAd.new(
+				:type => BingAdsApi::Ad::TEXT,
+				:status => BingAdsApi::Ad::INACTIVE,
+				:destination_url => "http://www.adxion.com",
+				:display_url => "AdXion.com",
+				:text => "Text Ad #{date}",
+				:title => "Text Ad")
+		
+		response = @service.add_ads(ad_group_id, text_ad)
+		assert !response.nil? , "No response received adding text ad"
+
+		assert response[:partial_errors].nil?, "TextAd response with partial errors"
+
+		puts "Text: AddAds response[:ad_ids][:long]"
+		puts response[:ad_ids][:long]
+		assert !response[:ad_ids][:long].nil?, "No ad ids received for TextAd"
+
+		
+		# MobileAd
+		mobile_ad = BingAdsApi::MobileAd.new(
+				:bussines_name => "Bussiness",
+				:destination_url => "http://www.adxion.com",
+				:display_url => "adxion.com",
+				:phone_number => "555555555",
+				:text => "Publish with us",
+				:title => "Mobile Ad")
+		
+		response = @service.add_ads(ad_group_id, mobile_ad)
+		assert !response.nil? , "No response received adding mobile ad"
+
+		puts response[:partial_errors] if !response[:partial_errors].nil?
+		assert response[:partial_errors].nil?, "MobileAd response with partial errors"
+		
+		puts "Mobile: AddAds response[:ad_ids][:long]"
+		puts response[:ad_ids][:long]
+		assert !response[:ad_ids][:long].nil?, "No ad ids received for MobileAd"
+
+
+		# ProductAd
+		# product_ad = BingAdsApi::ProductAd.new(
+				# :promotional_text => "Promotion #{date}")
+		# response = @service.add_ads(ad_group_id, product_ad)
+		# assert !response.nil? , "No response received adding product ad"
+# 
+		# puts response[:partial_errors] if !response[:partial_errors].nil?
+		# assert response[:partial_errors].nil?, "ProductAd response with partial errors"
+# 		
+		# puts "Product: AddAds response[:ad_ids][:long]"
+		# puts response[:ad_ids][:long]
+		# assert !response[:ad_ids][:long].nil?, "No ad ids received for ProductAd"
+
+	end
+
+	test "add ad with partial errors" do
+
+		ad_group_id = 1980939070
+		
+		date = DateTime.now.strftime("%Y-%m-%d %H:%M:%S")
+		text_ad = BingAdsApi::TextAd.new(
+				:type => BingAdsApi::Ad::TEXT,
+				:status => BingAdsApi::Ad::INACTIVE,
+				:destination_url => "http://www.adxion.com",
+				:display_url => "http://www.adxion.com",
+				:text => "Test Text Ad #{date}",
+				:title => "Test Text Ad #{date}")
+		
+		response = @service.add_ads(ad_group_id, text_ad)
+		assert !response.nil? , "No response received adding text ad"
+
+		puts response[:partial_errors]
+		assert !response[:partial_errors].nil?, "response should have partial errors"
+	end
+	
+	
+	test "get ads by group id" do
+		campaigns = @service.get_campaigns_by_account_id(@options[:account_id])
+		assert !campaigns.empty?, "No campaigns received for account id #{@options[:account_id]}" 
+		campaign_id = campaigns.first.id
+		
+		ad_group = @service.get_ad_groups_by_campaign_id(campaign_id).first
+		
+		ads = @service.get_ads_by_ad_group_id(ad_group.id)
+		assert !ads.empty?, "No ads received for ad group #{ad_group.id}"
+		ads.each do |ad|
+			assert ad.is_a?(BingAdsApi::Ad), "Object received is not an ad"
+		end 
+	end
+	
+	
+	test "get ads by ids" do
+		# campaigns = @service.get_campaigns_by_account_id(@options[:account_id])
+		# assert !campaigns.empty?, "No campaigns received for account id #{@options[:account_id]}" 
+		# campaign_id = campaigns.first.id
+		# ad_group = @service.get_ad_groups_by_campaign_id(campaign_id).first
+		# ads = @service.get_ads_by_ad_group_id(ad_group.id)
+		ad_group_id = 1980939070
+		ads = @service.get_ads_by_ad_group_id(ad_group_id)
+		assert !ads.nil?, "No ads by ad group response received" 
+		assert !ads.empty?, "No ads received for ad group #{ad_group_id}"
+
+		# Get 2 ads
+		ad_ids = [ads[0].id, ads[1].id]
+		ads_by_ids = @service.get_ads_by_ids(ad_group_id, ad_ids) 
+		assert !ads_by_ids.nil?, "No response received" 
+		assert !ads_by_ids.empty?, "No ads received for ad group #{ad_group_id} and ad ids #{ad_ids}"
+		assert ad_ids.size == ads_by_ids.size, "Expetected ads #{ad_ids.size}. Received #{ads_by_ids.size}"
+		ads.each do |ad|
+			assert ad.is_a?(BingAdsApi::Ad), "Object received is not an ad"
+		end 
+
+		# Get specific ad
+		ad_ids = [ads[0].id]
+		ads_by_ids = @service.get_ads_by_ids(ad_group_id, ad_ids) 
+		assert !ads_by_ids.nil?, "No response received" 
+		assert !ads.empty?, "No ads received for ad group #{ad_group_id} and ad ids #{ad_ids}"
+		assert ad_ids.size == ads_by_ids.size, "Expetected one ad. Received #{ads_by_ids.size}"
+
+	end
+	
+	
+	test "update ads" do
+		
+		ad_group_id = 1980939070
+		# One TextAd and one MobileAd
+		ad_ids = [4560003693, 4560003694]
+		
+		ads = @service.get_ads_by_ids(ad_group_id, ad_ids)
+		
+		# Loop to modify something in the adds
+		ads.each do |ad|
+			case ad.type
+			when "Text"
+				ad.text = ad.text + " updated"
+			when "Mobile"
+				ad.phone_number = 1234567890
+			when "Product"
+				ad.promotional_text = ad.promotional_text + " edit"
+			end
+			ad.status = nil
+			ad.editorial_status = nil
+		end 
+		
+		response = @service.update_ads(ad_group_id, ads)
+		assert !response.nil? , "No response received updateing ads"
+
+		assert response[:partial_errors].nil?, "response with partial errors when updating ads"
+
+	end
+	
+	
+end