adapi 0.0.8 → 0.0.9

data/.gitignore

@@ -5,6 +5,6 @@ pkg/*
 doc/*
 coverage/*
 .yardoc/*
-adapi.yml
+./adapi.yml
 .rvmrc
 .idea/

data/README.markdown

@@ -423,4 +423,5 @@ Example of logger configuration:
 
 ## Author ##
 
-2011-2012 Lukas Stejskal
+2011-2012 Lukas Stejskal, Ataxo Interactive, a.s.
+

data/adapi.gemspec

@@ -18,26 +18,26 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # Requires google-adwords-api gem, which provides low-level interface to
-  # AdWords API, and its dependecy, google-ads-common gem.
+  # google-adwords-api gem provides low-level interface to AdWords API
   #
-  # * versions of both gems should be freezed
-  # * ads-common should be required before adwords-api
-  #  
-  # PS: versions are freezed because both of these gems change a lot and
+  # its core dependency, google-ads-common gem, is also required
+  # (before google-adwords-api gem, so the clash of our version
+  # with version required by google-adwords api is less probable)
+  #
+  # versions of both gems are freezed, because both gems change a lot and
   # automatic updates through '~>' can (and already did) break something
   #
-  s.add_dependency "google-ads-common", "0.7.0"
-  s.add_dependency "google-adwords-api", "0.6.0"
+  s.add_dependency "google-ads-common", "0.7.3"
+  s.add_dependency "google-adwords-api", "0.6.2"
 
-  s.add_dependency "activemodel", "~> 3.1"
-  s.add_dependency "activesupport", "~> 3.1"
+  s.add_dependency "activemodel", "~> 3.0"
+  s.add_dependency "activesupport", "~> 3.0"
   s.add_dependency "rake", "~> 0.9.2"
   s.add_dependency "curb", "~> 0.8.0"
 
   s.add_development_dependency "yard", "~> 0.7"
   s.add_development_dependency "rcov", "~> 0.9"
-  s.add_development_dependency "turn", "0.8.2" # PS: 0.8.3 is broken
+  s.add_development_dependency "turn", "~> 0.9.6"
   s.add_development_dependency "shoulda"
   s.add_development_dependency "fakeweb"
   s.add_development_dependency "factory_girl", "~> 3.3.0"

data/examples/add_bare_ad_group.rb

@@ -14,7 +14,9 @@ $ad_group_data = {
   :status => 'ENABLED',
   :bids => {
     :xsi_type => 'BudgetOptimizerAdGroupBids',
-    :proxy_keyword_max_cpc => 10
+    # FIXME this probably can't be set
+    :proxy_keyword_max_cpc => 15,
+    :proxy_site_max_cpc => 30
   }
 }
  

data/examples/add_bare_campaign.rb

@@ -8,15 +8,17 @@ require 'adapi'
 $campaign_data = {
   :name => "Campaign #%d" % (Time.new.to_f * 1000).to_i,
   :status => 'PAUSED',
-  # :bidding_strategy => 'ManualCPC',
-  :bidding_strategy => { :xsi_type => 'BudgetOptimizer', :bid_ceiling => 55 },
+  :bidding_strategy => { 
+    :xsi_type => 'BudgetOptimizer', 
+    :bid_ceiling => 20 
+  },
   :budget => 50,
-
   :network_setting => {
     :target_google_search => true,
     :target_search_network => true,
     :target_content_network => false,
-    :target_content_contextual => false
+    :target_content_contextual => false,
+    :target_partner_search_network => false
   }
 }
  

data/examples/add_campaign.rb

@@ -20,7 +20,7 @@ campaign_data = {
   },
 
   # PS: :targets key is obsolete, this should be named :criteria, but it still works
-  :targets => {
+  :criteria => {
     :language => [ :en, :cs ],
     # TODO test together with city target
     :geo => { :proximity => { :geo_point => '38.89859,-77.035971', :radius => '10 km' } }
@@ -49,5 +49,12 @@ campaign_data = {
  
 $campaign = Adapi::Campaign.create(campaign_data)
 
-p "Created campaign ID #{$campaign.id}"
-p $campaign.attributes
+$campaign = Adapi::Campaign.find($campaign.id)
+
+p "\nCAMPAIGN #{$campaign.id} DATA:"
+pp $campaign.attributes
+
+$campaign_criterion = Adapi::CampaignCriterion.find( :campaign_id => $campaign.id )
+
+p "\nCAMPAIGN CRITERIA:"
+pp $campaign_criterion

data/examples/add_campaign_criteria.rb

@@ -6,14 +6,14 @@ require 'adapi'
 require_relative 'add_bare_campaign'
 
 $campaign_criterion = Adapi::CampaignCriterion.new(
-  :campaign_id => $campaign[:id],
+  :campaign_id => $campaign.id,
   :targets => { #  obsolete, use :criteria instead
     :language => %w{ en cs },
 
     :location => { 
-      :id => 21137
+      # :id => 21137
       # :name => { :city => 'Prague', :region => 'CZ-PR', :country => 'CZ' }
-      # :proximity => { :geo_point => '50.083333,14.366667', :radius => '50 km' }
+      :proximity => { :geo_point => '50.083333,14.366667', :radius => '50 km' }
     },
 
     # add custom platform criteria
@@ -23,5 +23,5 @@ $campaign_criterion = Adapi::CampaignCriterion.new(
 
 $campaign_criterion.create
 
-p $campaign_criterion.attributes
-
+$campaign_criterion = Adapi::CampaignCriterion.find( :campaign_id => $campaign.id)
+pp $campaign_criterion

data/examples/add_invalid_ad_group.rb

@@ -4,11 +4,8 @@
 
 require 'adapi'
 
-# create campaign
 require_relative 'add_bare_campaign'
 
-# create ad group
-
 ad_group_data = {
   :name => "AdGroup #%d" % (Time.new.to_f * 1000).to_i,
   :status => 'ENABLED',
@@ -31,8 +28,9 @@ ad_group_data = {
 $ad_group = Adapi::AdGroup.create(ad_group_data)
 
 if $ad_group.errors.empty?
-  p $ad_group.data
+  puts "OK"
+  pp $ad_group.attributes
 else
-  p "ERRORS:"
-  p $ad_group.errors.to_a
+  puts "ERROR:"
+  puts $ad_group.errors.full_messages.join("\n")
 end

data/examples/add_invalid_keywords.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'adapi'
+
+# Errors will appear only in production, not in sandbox
+#
+#Adapi::Config.load_settings
+#Adapi::Config.set(:production_settings)
+#
+#pp "Running in #{Adapi::Config.read[:service][:environment]}"
+
+# create ad group
+require_relative 'add_bare_ad_group'
+
+$keywords = Adapi::Keyword.new(
+  :ad_group_id => $ad_group[:id],
+  :keywords => [ 'lékárna', 'lekarna', 'leky' ]
+)
+
+$result = $keywords.create
+
+if $keywords.errors.empty?
+  puts "OK"
+
+  # get array of keywords from Keyword instance
+  $google_keywords = Adapi::Keyword.find(:all, :ad_group_id => $ad_group[:id]).keywords
+
+  $params_keywords = Adapi::Keyword.parameterized($google_keywords)
+
+  $short_keywords = Adapi::Keyword.shortened($google_keywords)
+
+  puts "PARAMS:"
+  pp $params_keywords
+
+  puts "\nSHORT:"
+  pp $short_keywords
+else
+  puts "ERROR"
+  puts $keywords.errors.full_messages.join("\n")
+end

data/examples/add_invalid_text_ad.rb

@@ -1,14 +1,13 @@
 
 require 'adapi'
 
-# PolicyViolations will appread only in production, not in sandbox
+# PolicyViolations will appear only in production, not in sandbox
 #
 #Adapi::Config.load_settings
 #Adapi::Config.set(:production_settings)
 #
 #pp "Running in #{Adapi::Config.read[:service][:environment]}"
 
-# create ad group
 require_relative 'add_bare_ad_group'
 
 $ad = Adapi::Ad::TextAd.create(
@@ -22,9 +21,10 @@ $ad = Adapi::Ad::TextAd.create(
 )
 
 if $ad.errors.empty?
-  p "OK"
-  p $ad.data
+  puts "OK"
+  $fresh_ad = Adapi::Ad::TextAd.find(:first, :id => $ad.id, :ad_group_id => $ad_group[:id])
+  pp $fresh_ad.attributes
 else
-  p "ERROR"
-  p $ad.errors.messages
+  puts "ERROR"
+  puts $ad.errors.full_messages.join("\n")
 end

data/examples/add_text_ad.rb

@@ -1,10 +1,9 @@
 
 require 'adapi'
 
-# create ad group
 require_relative 'add_bare_ad_group'
 
-ad = Adapi::Ad::TextAd.create(
+$ad = Adapi::Ad::TextAd.create(
   :ad_group_id => $ad_group[:id],
   :headline => "Code like Neo",
   :description1 => 'Need mad coding skills?',
@@ -14,10 +13,7 @@ ad = Adapi::Ad::TextAd.create(
   :status => 'PAUSED'
 )
 
-if ad
-  p "OK"
-  p ad.data
-else
-  p "ERROR"
-  p ad.errors.messages
-end
+$ad = Adapi::Ad::TextAd.find(:first, :ad_group_id => $ad_group.id, :id => $ad.id )
+
+puts "\nCREATED (AND RELOADED) AD:"
+pp $ad.attributes

data/examples/custom_settings.yml

@@ -9,6 +9,10 @@
     :user_agent: My Adwords API Client
   :service:
     :environment: PRODUCTION
+  :library:
+    :log_level: WARN
+    :log_path: /tmp/adapi_production.log
+#   :log_pretty_format is set to :false by default
 
 :sandbox:
   :authentication:
@@ -20,3 +24,7 @@
     :user_agent: Adwords API Test
   :service:
     :environment: SANDBOX
+  :library:
+    :log_level: DEBUG
+    :log_path: /tmp/adapi_sandbox.log
+    :log_pretty_format: true

data/examples/delete_ad_group.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'adapi'
+
+require_relative 'add_bare_ad_group'
+
+$ad_group.delete
+
+$ad_group = Adapi::AdGroup.find(:first, :id => $ad_group.id, :campaign_id => $campaign.id)
+
+puts "AdGroup status is now set to: " + $ad_group.status

data/examples/delete_text_ad.rb

@@ -0,0 +1,13 @@
+
+require 'adapi'
+
+# create ad group
+require_relative 'add_text_ad'
+
+$ad_id = $ad.id
+
+puts "\nDELETED AD #{$ad_id}: " + ($ad.destroy ? "true" : "false")
+
+$ad = Adapi::Ad::TextAd.find(:first, :ad_group_id => $ad_group.id, :id => $ad_id )
+
+puts "TRYING TO FIND IT: " + ($ad.present? ? $ad.attributes : "nil")

data/examples/find_ad_group.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'adapi'
+
+require_relative 'add_bare_ad_group'
+
+$ad_group = Adapi::AdGroup.find(:first, :campaign_id => $ad_group.campaign_id)
+
+pp "\nAD GROUP DATA:"
+pp $ad_group.attributes

data/examples/find_bare_campaign.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'adapi'
+
+# create campaign
+require_relative 'add_bare_campaign'
+
+$campaign = Adapi::Campaign.find($campaign.id)
+
+puts "Campaign data:"
+%w{ id name status serving_status ad_serving_optimization_status start_date end_date }.each do |param_name|
+  puts "  %s: %s" % [ param_name.to_s.humanize, $campaign[param_name] ]
+end
+
+puts "\nBudget:"
+%w{ amount period delivery_method }.each do |param_name|
+  puts "  %s: %s" % [ param_name.to_s.humanize, $campaign[:budget][param_name.to_sym] ]
+end
+
+puts "\nBidding strategy:"
+%w{ xsi_type bid_ceiling enhanced_cpc_enabled }.each do |param_name|
+  next unless $campaign[:bidding_strategy].has_key?(param_name.to_sym)
+  puts "  %s: %s" % [ param_name.to_s.humanize, $campaign[:bidding_strategy][param_name.to_sym] ]
+end
+
+puts "\nCampaign stats:"
+%w{ clicks impressions cost ctr }.each do |param_name|
+  puts "  %s: %s" % [ param_name.to_s.humanize, $campaign[:campaign_stats][param_name.to_sym] ]
+end
+
+puts "\nNetwork setting:"
+Adapi::Campaign::NETWORK_SETTING_KEYS.each do |param_name|
+  puts "  %s: %s" % [ param_name.to_s.humanize, $campaign[:network_setting][param_name.to_sym] ]
+end

data/examples/update_ad_group.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+require 'adapi'
+
+# create campaign
+require_relative 'add_bare_campaign'
+
+$campaign_id = $campaign.id
+
+$ad_group = Adapi::AdGroup.create(
+  :campaign_id => $campaign_id,
+  :name => "AdGroup #%d" % (Time.new.to_f * 1000).to_i,
+  :status => 'PAUSED',
+
+  :keywords => [ 'dem codez', 'trinity', 'morpheus', '"top coder"', "[-code]" ],
+
+  :ads => [
+    {
+      :headline => "Code like Trinity",
+      :description1 => 'The power of awesomeness?',
+      :description2 => 'Check out my new blog!',
+      :url => 'http://www.demcodez.com',
+      :display_url => 'http://www.demcodez.com'
+    },
+
+    {
+      :headline => "Code like Morpheus",
+      :description1 => 'Unleash the power of Matrix',
+      :description2 => 'Check out my new blog',
+      :url => 'http://www.demcodez.com',
+      :display_url => 'http://www.demcodez.com'
+    }        
+  ]
+)
+
+$ad_group_id = $ad_group.id
+
+# fetch ids of ad_group and ads
+$ad_group = Adapi::AdGroup.find(:first, :id => $ad_group_id, :campaign_id => $campaign_id)
+
+p "CREATED ad_group #{$ad_group.id} for campaign #{$ad_group.campaign_id}"
+pp $ad_group.attributes
+
+result = $ad_group.update(
+  :name => "UPDATED #{$ad_group.name}",
+  :status => 'ENABLED',
+
+  :keywords => ['dem updatez', '"neo coder"', '[-trinity]', '[-morpheus]' ],
+
+  :ads => [
+    {
+      :headline => "Code like Neo",
+      :description1 => 'Need mad coding skills?',
+      :description2 => 'Check out my new blog!',
+      :url => 'http://www.demcodez.com',
+      :display_url => 'http://www.demcodez.com'
+    }
+  ]
+)
+
+unless result
+  puts "ERRORS:"
+  puts $ad_group.errors.full_messages.join("\n")
+else
+  # fetch ids of ad_group and ads
+  $ad_group = Adapi::AdGroup.find(:first, :id => $ad_group_id, :campaign_id => $campaign_id)
+
+  p "UPDATED ad_group #{$ad_group.id} for campaign #{$ad_group.campaign_id}"
+  pp $ad_group.attributes
+end

data/examples/update_campaign.rb

@@ -1,22 +1,47 @@
 require 'adapi'
 
-# create campaign
-require_relative 'add_bare_campaign'
+# create campaign with criteria
+require_relative 'add_campaign'
 
-p "ORIGINAL CAMPAIGN:"
-pp $campaign.attributes
-
-$updated_campaign = Adapi::Campaign.update(
-  :id => $campaign[:id],
+$campaign = Adapi::Campaign.update(
+  :id => $campaign.id,
   :status => 'ACTIVE',
   :name => "UPDATED_#{$campaign[:name]}",
+  :bidding_strategy => 'ManualCPC',
+  :budget => 75,
   :network_setting => {
     :target_google_search => false,
     :target_search_network => false,
     :target_content_network => true,
     :target_content_contextual => true
+    # FIXME returns error which is not trapped:
+    # TargetError.CANNOT_TARGET_PARTNER_SEARCH_NETWORK 
+    # :target_partner_search_network => true
+  },
+
+  # deletes all criteria (except :platform) and create these new ones
+  :criteria => {
+    :language => [ :sk ],
   }
 )
 
-p "UPDATED CAMPAIGN:"
-pp $updated_campaign.attributes
+unless $campaign.errors.empty?
+
+  puts "ERROR WHEN UPDATING CAMPAIGN #{$campaign.id}:"
+  pp $campaign.errors.full_messages
+
+else
+
+  puts "\nUPDATED CAMPAIGN #{$campaign.id}\n"
+
+  $campaign = Adapi::Campaign.find($campaign.id)
+
+  puts "\nCAMPAIGN DATA:"
+  pp $campaign.attributes
+
+  $campaign_criteria = Adapi::CampaignCriterion.find( :campaign_id => $campaign.id )
+
+  puts "\nCRITERIA:"
+  pp $campaign_criteria
+
+end

data/examples/update_campaign_ad_groups.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+
+require 'adapi'
+
+# create campaign by single command, with campaing targets, with ad_groups
+# including keywords and ads
+
+$ad_group_names = [
+  "AdGroup 01 #%d" % (Time.new.to_f * 1000).to_i,
+  "AdGroup 02 #%d" % (Time.new.to_f * 1000).to_i
+]
+
+campaign_data = {
+  :name => "Campaign #%d" % (Time.new.to_f * 1000).to_i,
+  :status => 'PAUSED',
+  :bidding_strategy => 'ManualCPC',
+  :budget => 50,
+
+  :ad_groups => [
+    {
+      :name => $ad_group_names[0],
+      :status => 'ENABLED',
+
+      :keywords => [ 'neo', 'dem codez', '"top coder"', "[-code]" ],
+
+      :ads => [
+        {
+          :headline => "Code like Neo",
+          :description1 => 'Need mad coding skills?',
+          :description2 => 'Check out my new blog!',
+          :url => 'http://www.demcodez.com',
+          :display_url => 'http://www.demcodez.com'
+        }
+      ]
+    },
+
+    {
+      :name => $ad_group_names[1],
+      :status => 'PAUSED',
+
+      :keywords => [ 'dem codez', 'trinity', 'morpheus', '"top coder"', "[-code]" ],
+
+      :ads => [
+        {
+          :headline => "Code like Trinity",
+          :description1 => 'The power of awesomeness?',
+          :description2 => 'Check out my new blog!',
+          :url => 'http://www.demcodez.com',
+          :display_url => 'http://www.demcodez.com'
+        },
+
+        {
+          :headline => "Code like Morpheus",
+          :description1 => 'Unleash the power of Matrix',
+          :description2 => 'Check out my new blog',
+          :url => 'http://www.demcodez.com',
+          :display_url => 'http://www.demcodez.com'
+        }        
+      ]
+    }    
+  ]
+
+}
+ 
+$campaign = Adapi::Campaign.create(campaign_data)
+p "Created campaign ID #{$campaign.id}"
+
+# PS: changes in ad_groups:
+# * delete first ad_group
+# * change second ad_group
+# * add new ad_group
+
+$campaign.update_ad_groups!( [
+  # no match here for $ad_group_names[0], so it's going to be deleted
+
+  # this ad_group will be created
+  {
+    :name => "UPDATED " + $ad_group_names[0],
+    :status => 'ENABLED',
+
+    :keywords => [ 'neo update', 'dem codezzz', '"top coder"' ],
+
+    :ads => [
+      {
+        :headline => "Update like Neo",
+        :description1 => 'Need mad coding skills?',
+        :description2 => 'Check out my new blog!',
+        :url => 'http://www.demcodez.com',
+        :display_url => 'http://www.demcodez.com'
+      }
+    ]
+  },
+
+  # this ad_group is going to be updated
+  {
+    :name =>  $ad_group_names[1],
+    :status => 'ENABLED', # from PAUSED
+
+    :keywords => [ 'dem updatez', 'update trinity', 'update morpheus' ],
+
+    :ads => [
+      {
+        :headline => "Update like Trinity",
+        :description1 => 'The power of updates?',
+        :description2 => 'Check out my new blog!',
+        :url => 'http://www.demcodez.com',
+        :display_url => 'http://www.demcodez.com'
+      },
+
+      {
+        :headline => "Update like Morpheus",
+        :description1 => 'Unleash the power of updates',
+        :description2 => 'Check out my new blog',
+        :url => 'http://www.demcodez.com',
+        :display_url => 'http://www.demcodez.com'
+      }        
+    ]
+  }    
+] )
+
+unless $campaign.errors.empty?
+
+  puts "ERROR WHEN UPDATING AD GROUPS:"
+  puts $campaign.errors.full_messages.join("\n")
+
+else
+  # reload ad groups
+  $ad_groups = Adapi::AdGroup.find(:all, :campaign_id => $campaign[:id])
+
+  puts "\nAD GROUPS UPDATED\n"
+
+  puts "\nAD GROUPS (#{$ad_groups.size}):"
+  $ad_groups.each_with_index do |ad_group, i| 
+    puts "\nAD GROUP #{i + 1}:\n"
+    pp ad_group.attributes
+  end
+end