adapi 0.0.4 → 0.0.5

data/examples/add_text_ad.rb

@@ -2,7 +2,7 @@
 require 'adapi'
 
 # create ad group
-require File.join(File.dirname(__FILE__), 'add_bare_ad_group')
+require_relative 'add_bare_ad_group'
 
 ad = Adapi::Ad::TextAd.create(
   :ad_group_id => $ad_group[:id],

data/examples/customize_configuration.rb

@@ -5,7 +5,7 @@ require 'adapi'
 # this example shows how to load custom settings
 
 Adapi::Config.load_settings(
-  :path => File.expand_path(File.dirname(__FILE__)),
+  :dir => File.expand_path(File.dirname(__FILE__)),
   :filename => 'custom_settings.yml'
 )
 
@@ -16,4 +16,3 @@ p Adapi::Config.read[:authentication][:email]
 Adapi::Config.set(:sandbox)
 p "Set :sandbox account:"
 p Adapi::Config.read[:authentication][:email]
-

data/examples/delete_keyword.rb

@@ -3,7 +3,7 @@
 require 'adapi'
 
 # create ad group
-require File.join(File.dirname(__FILE__), 'add_bare_ad_group')
+require_relative 'add_bare_ad_group'
 
 $keywords = Adapi::Keyword.new(
   :ad_group_id => $ad_group[:id],

data/examples/find_campaign.rb

@@ -3,7 +3,7 @@
 require 'adapi'
 
 # create campaign
-require File.join(File.dirname(__FILE__), 'add_campaign')
+require_relative 'add_campaign'
 
 $campaign = Adapi::Campaign.find_complete($campaign.id).to_hash
 
@@ -18,10 +18,10 @@ puts "Budget period: %s" % $campaign[:budget][:period]
 puts "\nBidding strategy type: %s" % $campaign[:bidding_strategy][:xsi_type]
 # TODO bidding_strategy.bid_ceiling
 
-puts "\nTargets:"
-$campaign[:targets].each do |target|
-  p target[:xsi_type]
-  p target
+puts "\nCriteria:"
+$campaign[:criteria].each do |criterion|
+  p criterion[:xsi_type]
+  p criterion
 end
 
 puts "\nAd groups (#{$campaign[:ad_groups].size} in total):"

data/examples/find_campaign_ad_groups.rb

@@ -3,7 +3,7 @@
 require 'adapi'
 
 # create campaign
-require File.join(File.dirname(__FILE__), 'add_bare_ad_group')
+require_relative 'add_bare_ad_group'
 
 # find all ad_groups for campaign
  

data/examples/find_campaign_criteria.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example illustrates how to retrieve all the campaign targets. To set
+# campaign targets, run add_campaign_targeting_criteria.rb.
+#
+# Tags: CampaignCriterionService.get
+
+require 'adwords_api'
+
+API_VERSION = :v201109
+PAGE_SIZE = 500
+
+def get_campaign_targeting_criteria()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  campaign_criterion_srv =
+      adwords.service(:CampaignCriterionService, API_VERSION)
+
+  # Specify campaign ID to get targeting for.
+  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+  # Selector to get all the targeting for this campaign.
+  selector = {
+    :fields => ['Id', 'CriteriaType', 'KeywordText'],
+    :predicates => [
+      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = campaign_criterion_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |typed_criterion|
+        negative = typed_criterion[:xsi_type] == 'NegativeCampaignCriterion' ?
+           ' (negative)' : ''
+        criterion = typed_criterion[:criterion]
+        puts ("Campaign criterion%s with ID %d, type '%s' and text '%s'" +
+            " was found.") %
+            [negative, criterion[:id], criterion[:type], criterion[:text]]
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+
+  if page.include?(:total_num_entries)
+    puts "\tCampaign ID %d has %d criteria." %
+        [campaign_id, page[:total_num_entries]]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_campaign_targeting_criteria()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/find_locations.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'adapi'
+
+# find location by LocationService
+
+$search_params = [
+  { :country => 'CZ' },
+  { :country => 'CZ', :province => 'Prague' },
+  { :country => 'CZ', :province => 'Prague', :city => 'Prague' },
+  { :province => 'Prague' },
+  { :city => 'Prague' }
+]
+ 
+$search_params.each do |params| 
+  $location = Adapi::Location.find(params)
+
+  puts "\nSearched for: " + params.inspect
+  # puts "Found Location ID: #{Adapi::Location.location_tree($location)}"
+  puts "Found Location ID: #{$location[:id]}"
+end

data/examples/rollback_campaign.rb

@@ -2,8 +2,11 @@
 
 require 'adapi'
 
-# create campaign by single command, with campaing targets, with ad_groups
-# including keywords and ads
+# This test tries to create a complete campaign and fails because ad is
+# intentionally left without url. The point is to test how create_campaign
+# fails: campaign status should be set to DELETED and name changed (so the
+# name isn't blocked and another campaign can be created with the same name
+# eventually)
 
 campaign_data = {
   :name => "Campaign #%d" % (Time.new.to_f * 1000).to_i,
@@ -19,9 +22,8 @@ campaign_data = {
     :target_content_contextual => false
   },
 
-  :targets => {
+  :criteria => {
     :language => [ 'en', 'cs' ],
-    # TODO test together with city target
     :geo => { :proximity => { :geo_point => '38.89859,-77.035971', :radius => '10 km' } }
   },
 
@@ -37,7 +39,7 @@ campaign_data = {
           :headline => "Code like Neo",
           :description1 => 'Need mad coding skills?',
           :description2 => 'Check out my new blog!',
-          :url => '', # THIS FAILS
+          :url => '', # THIS SHOULD FAIL
           :display_url => 'http://www.demcodez.com'
         }
       ]
@@ -54,4 +56,3 @@ pp $campaign.attributes
 
 p "with errors:"
 pp $campaign.errors.to_a
-

data/examples/update_campaign.rb

@@ -1,7 +1,7 @@
 require 'adapi'
 
 # create campaign
-require File.join(File.dirname(__FILE__), 'add_bare_campaign')
+require_relative 'add_bare_campaign'
 
 p "ORIGINAL CAMPAIGN:"
 pp $campaign.attributes

data/examples/update_campaign_status.rb

@@ -2,7 +2,7 @@
 require 'adapi'
 
 # create campaign
-require File.join(File.dirname(__FILE__), 'add_bare_campaign')
+require_relative 'add_bare_campaign'
 
 p "ORIGINAL STATUS: %s" % $campaign.status
 

data/lib/adapi.rb

@@ -2,38 +2,40 @@
 
 require 'rubygems'
 require 'adwords_api'
+# require 'logger'
 require 'yaml'
 require 'pp'
 
 require 'active_model'
-# require only ActiveSupport parts that we actually use
+# TODO require only ActiveSupport parts that we actually use
 require 'active_support/all'
 
 require 'adapi/version'
 require 'adapi/config'
 require 'adapi/api'
 require 'adapi/campaign'
+require 'adapi/campaign_criterion'
 require 'adapi/campaign_target'
 require 'adapi/ad_group'
 require 'adapi/ad_group_criterion'
 require 'adapi/keyword'
 require 'adapi/ad'
 require 'adapi/ad/text_ad'
+require 'adapi/ad_param'
+require 'adapi/constant_data'
+require 'adapi/constant_data/language'
+require 'adapi/location'
 
-# monkeypatch HTTPI
+# monkeypatch HTTPI - important, check the file!
 require 'httpi_request_monkeypatch'
 
 HTTPI.adapter = :curb
-# supress HTTPI output
-# HTTPI.log = false
+HTTPI.log = false # supress HTTPI output
 
 module Adapi
-  API_VERSION = :v201101  
+  API_VERSION = :v201109  
 end
 
-# check ruby version, should be 1.9
-# FIXME there's gotta be more elegant way to do this
-`ruby -v`.to_s =~ /^ruby (\d\.\d)\./
-if $1.to_f < 1.9
+if RUBY_VERSION < '1.9'
   puts "WARNING: please use ruby 1.9, adapi gem won't work properly in 1.8 and earlier versions"
 end

data/lib/adapi/ad/text_ad.rb

@@ -101,7 +101,8 @@ module Adapi
       # supported condition parameters: ad_group_id and id
       predicates = [ :ad_group_id, :id ].map do |param_name|
         if params[param_name]
-          {:field => param_name.to_s.camelcase, :operator => 'EQUALS', :values => params[param_name] }
+          value = Array.try_convert(params[param_name]) ? params_param_name : [params[param_name]]
+          {:field => param_name.to_s.camelcase, :operator => 'IN', :values => value }
         end
       end.compact
 

data/lib/adapi/ad_group.rb

@@ -24,19 +24,22 @@ module Adapi
       # convert bids to GoogleApi format
       #
       # can be either string (just xsi_type) or hash (xsi_type with params)
-      # althogh I'm not sure if just string makes sense in this case
+      # although I'm not sure if just string makes sense in this case
       #
       if @bids
         unless @bids.is_a?(Hash)
           @bids = { :xsi_type => @bids }
         end
-  
-        if @bids[:keyword_max_cpc] and not @bids[:keyword_max_cpc].is_a?(Hash)
-          @bids[:keyword_max_cpc] = {
-            :amount => {
-              :micro_amount => Api.to_micro_units(@bids[:keyword_max_cpc])
+    
+        # convert bid amounts to micro_amounts
+        [ :proxy_keyword_max_cpc, :proxy_site_max_cpc ].each do |k|          
+          if @bids[k] and not @bids[k].is_a?(Hash)
+            @bids[k] = {
+              :amount => {
+                :micro_amount => Api.to_micro_units(@bids[k])
+              }
             }
-          }
+          end
         end
       end
 
@@ -93,10 +96,11 @@ module Adapi
       first_only = (amount.to_sym == :first)
 
       raise "Campaign ID is required" unless params[:campaign_id]
-
+      
       predicates = [ :campaign_id, :id ].map do |param_name|
         if params[param_name]
-          {:field => param_name.to_s.camelcase, :operator => 'EQUALS', :values => params[param_name] }
+          value = Array.try_convert(params[param_name]) ? params_param_name : [params[param_name]]
+          {:field => param_name.to_s.camelcase, :operator => 'IN', :values => value }
         end
       end.compact
 

data/lib/adapi/ad_param.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+module Adapi
+  class AdParam < Api
+    attr_accessor :ad_group_id, :criterion_id, :insertion_text, :param_index
+
+    validates_presence_of :ad_group_id, :criterion_id
+
+    def attributes
+      super.merge(
+        'ad_group_id' => ad_group_id, 'criterion_id' => criterion_id,
+        'insertion_text' => insertion_text, 'param_index' => param_index
+      )
+    end
+
+    def initialize(params = {})
+      params[:service_name] = :AdParamService
+
+      %w{ ad_group_id criterion_id insertion_text param_index }.each do |param_name|
+        self.send "#{param_name}=", params[param_name.to_sym]
+      end
+
+      super(params)
+    end
+
+    def create
+      operation = {
+        :operator => 'SET',
+        :operand => serializable_hash
+      }
+
+      begin
+        response = @service.mutate([operation])
+
+      #rescue AdsCommon::Errors::HttpError => e
+        #self.errors.add(:base, e.message)
+
+      ## traps any exceptions raised by AdWords API
+      #rescue AdwordsApi::Errors::ApiException => e
+      #  # return PolicyViolations so they can be sent again
+      #  e.errors.each do |error|
+      #    if (error[:api_error_type] == 'PolicyViolationError') && error[:is_exemptable]
+      #      self.errors.add(error[:api_error_type], error[:key])
+      #    else
+      #      # otherwise, just report the errors
+      #      self.errors.add( "[#{self.xsi_type.underscore}]", "#{error[:error_string]} @ #{error[:field_path]}")
+      #    end
+      #  end
+      end
+
+      response
+    end
+
+    def self.find(params = {})
+      params.symbolize_keys!
+
+      predicates = [ :ad_group_id, :criterion_id ].map do |param_name|
+        if params[param_name]
+          value = Array.try_convert(params[param_name]) ? params_param_name : [params[param_name]]
+          {:field => param_name.to_s.camelcase, :operator => 'IN', :values => value }
+        end
+      end.compact
+
+      selector = {
+        :fields => ['AdGroupId', 'CriterionId', 'InsertionText', 'ParamIndex'],
+        :predicates => predicates
+      }
+
+      response = AdParam.new.service.get(selector)
+
+      response = (response and response[:entries]) ? response[:entries] : []
+
+      response.map! do |ad_params_data|
+        AdParam.new(ad_params_data)
+      end
+
+      response
+    end
+
+    def serializable_hash
+      {
+        :ad_group_id    => ad_group_id,
+        :criterion_id   => criterion_id,
+        :param_index    => param_index,
+        :insertion_text => insertion_text
+      }
+    end
+  end
+end