google-adx-buyer-api 0.4.0 → 0.4.1

data/ChangeLog

@@ -1,3 +1,7 @@
+0.4.1:
+  - Added .gemspec and updated packaging process.
+  - Switched to google-adwords-api-0.5.x branch.
+
 0.4.0:
   - Compatibility with google-adwords-api-0.4.1.
   - Switched to Savon backend.

data/README

@@ -6,9 +6,9 @@ AdWords and DoubleClick Ad Exchange Buyer API!
 Please note that this is an early PREVIEW of the client library, still under
 development.
 
-It contains full support for v13, v200909, v201003, v201008, v201101 and
-v201109, with full stubs, and a simplified programming interface that lets you
-handle everything in native Ruby collections.
+It contains full support for v201109, with full stubs, and a simplified
+programming interface that lets you handle everything in native Ruby
+collections.
 
 
 = Docs for Users
@@ -27,32 +27,22 @@ Buyer client library examples. You need the AdWords library in order to use it
 which is installed automatically as a dependency.
 
 The following gem libraries are required:
-  - savon v0.9.6
-  - httpclient v2.1.2 or greater
-  - google-ads-common v0.5.4 or later.
+  - savon v0.9.7
+  - google-ads-common v0.6.3 or later.
 
 
 == 2 - Using the client library:
 
-It's pretty easy to use.
-See http://docs.rubygems.org/read/chapter/3#page70 for how to set the rubygem
-environment.
-   $ export RUBYOPT=rubygems
-or
-   $ ruby -rubygems my_program_that_uses_gems
-
-If you are running Ruby 1.8 and do not use the rubygems option, you need to add
-   require 'rubygems'
-at the beginning of your programs.
-
-Then:
-   gem 'google-adwords-api'
+Include the library with 'require':
    require 'adwords_api'
 
+Then create an API instance:
    adwords = AdwordsApi::Api.new
-creates an Api object that will grant you access to all the services for all of
-the currently supported vesions of the APIs. It uses a config file in:
-ENV['HOME']/adwords_api.yml to read all of your configurations.
+
+The created API object will grant you access to all the services for all of the
+currently supported vesions of the APIs. It uses a config file in:
+  ENV['HOME']/adwords_api.yml to read all of your configurations by default.
+
 There is an example configuration file shipped with these libraries.
 
 You can also pass API a manually constructed config hash like:
@@ -86,6 +76,17 @@ please set the appropriate options in the config file or config hash. E.g.:
      :proxy => 'http://user:password@proxy_hostname:8080'
    }
 
+*Note*: if you are using Ruby 1.8 you may need to include RubyGems to be able
+to require other gems code. There are several ways to do it, the easiest one is
+to pass '-rubygems' parameter to the ruby interpreter:
+   $ ruby -rubygems my_program_that_uses_gems
+
+you can also set this up in the environment:
+   $ export RUBYOPT="rubygems"
+
+or add it to the bash configuration file:
+   $ echo 'export RUBYOPT="rubygems"' >> ~/.bashrc
+
 
 === 2.1 - Ruby names for a Ruby library:
 
@@ -156,6 +157,18 @@ This information can be obtained by passing a user block during method call:
 You can also retrieve the response body as the second block parameter:
   report_def_srv.get(selector) {|header, body| ... }
 
+=== 2.5 - GZip compression
+
+The library offers a transparent compression option which can be enabled in the
+configuration file or by the following setting:
+
+   config[:connection] = {
+     :enable_gzip => true
+   }
+
+Enabling this option will set the headers required to request the server to
+respond in gzipped format. All requests are sent uncompressed regardless.
+
 
 = Docs for Developers
 
@@ -164,8 +177,9 @@ You can also retrieve the response body as the second block parameter:
  $ rake generate
 to regenerate the stubs if needed
 
- $ rake package
-to package the gem and create a release
+ $ gem build google-adwords-api.gemspec
+ $ gem build google-adx-buyer-api.gemspec
+to build the gems
 
  $ rake test
 to run unit tests on the library
@@ -186,7 +200,7 @@ Questions can be asked on forum
 
 == Licence
 
-Copyright 2011, Google Inc. All Rights Reserved.
+Copyright 2010-2012, Google Inc. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/examples/v201109/account_management/get_account_changes.rb

@@ -0,0 +1,137 @@
+#!/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 gets all account changes that happened within the last 24 hours,
+# for all your campaigns.
+#
+# Tags: CustomerSyncService.get
+
+require 'adwords_api'
+require 'date'
+require 'pp'
+
+def get_account_changes()
+  # 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_srv = adwords.service(:CampaignService, API_VERSION)
+  customer_sync_srv = adwords.service(:CustomerSyncService, API_VERSION)
+
+  today_at_midnight = DateTime.parse(Date.today.to_s)
+  yesterday_at_midnight = DateTime.parse((Date.today - 1).to_s)
+  min_date_time = yesterday_at_midnight.strftime("%Y%m%d %H%M%S")
+  max_date_time = today_at_midnight.strftime("%Y%m%d %H%M%S")
+
+  # Get all the campaigns for this account.
+  selector = {
+    :fields => ['Id']
+  }
+  response = campaign_srv.get(selector)
+
+  campaign_ids = []
+
+  if response and response[:entries]
+    campaign_ids = response[:entries].map { |campaign| campaign[:id] }
+  else
+    raise StandardError, 'No campaigns were found.'
+  end
+
+  # Create a selector for CustomerSyncService.
+  selector = {
+    :campaign_ids => campaign_ids,
+    :date_time_range => {
+      :min => min_date_time,
+      :max => max_date_time
+    }
+  }
+
+  # Get all account changes for the campaigns.
+  campaign_changes = customer_sync_srv.get(selector)
+
+  # Display changes.
+  if campaign_changes
+    puts "Most recent change: %s" % campaign_changes[:last_change_timestamp]
+    campaign_changes[:changed_campaigns].each do |campaign|
+      puts "Campaign with ID %d was changed:" % campaign[:campaign_id]
+      puts "\tCampaign change status: '%s'" % campaign[:campaign_change_status]
+      unless ['NEW', 'FIELDS_UNCHANGED'].include?(
+          campaign[:campaign_change_status])
+        puts "\tAdded ad extensions: '%s'" %
+            campaign[:added_ad_extensions].pretty_inspect.chomp
+        puts "\tAdded campaign criteria: '%s'" %
+            campaign[:added_campaign_criteria].pretty_inspect.chomp
+        puts "\tAdded campaign targeting: '%s'" %
+            campaign[:campaign_targeting_changed].pretty_inspect.chomp
+        puts "\tDeleted ad extensions: '%s'" %
+            campaign[:deleted_ad_extensions].pretty_inspect.chomp
+        puts "\tDeleted campaign criteria: '%s'" %
+            campaign[:deleted_campaign_criteria].pretty_inspect.chomp
+
+        if campaign[:changed_ad_groups]
+          campaign[:changed_ad_groups].each do |ad_group|
+            puts "\tAd group with ID %d was changed:" % ad_group[:ad_group_id]
+            puts "\t\tAd group changed status: '%s'" %
+                ad_group[:ad_group_change_status]
+            unless ['NEW', 'FIELDS_UNCHANGED'].include?(
+                ad_group[:ad_group_change_status])
+              puts "\t\tAds changed: '%s'" %
+                  ad_group[:changed_ads].pretty_inspect.chomp
+              puts "\t\tCriteria changed: '%s'" %
+                  ad_group[:changed_criteria].pretty_inspect.chomp
+              puts "\t\tCriteria deleted: '%s'" %
+                  ad_group[:deleted_criteria].pretty_inspect.chomp
+            end
+          end
+        end
+      end
+      puts
+    end
+  else
+    puts 'No account changes were found.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201109
+
+  begin
+    get_account_changes()
+
+  # 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/{v201008 → v201109/basic_operations}/add_ad_group.rb

@@ -1,6 +1,7 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -22,13 +23,9 @@
 #
 # Tags: AdGroupService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201008
-
-def add_ad_group()
+def add_ad_group(campaign_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,8 +36,6 @@ def add_ad_group()
 
   ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
 
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
   # Prepare for adding ad group.
   operation = {
     :operator => 'ADD',
@@ -65,33 +60,28 @@ def add_ad_group()
   # Add ad group.
   response = ad_group_srv.mutate([operation])
   ad_group = response[:value].first
-  puts 'Ad group id %d was successfully added.' % ad_group[:id]
+  puts "Ad group ID %d was successfully added." % ad_group[:id]
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    add_ad_group()
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    add_ad_group(campaign_id)
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    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

data/examples/{v201003 → v201109/basic_operations}/add_campaign.rb

@@ -1,6 +1,7 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -21,12 +22,8 @@
 #
 # Tags: CampaignService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201003
-
 def add_campaign()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -56,45 +53,46 @@ def add_campaign()
           :micro_amount => 50000000
         },
         :delivery_method => 'STANDARD'
+      },
+      # Set the campaign network options to Search and Search Network.
+      :network_setting => {
+        :target_google_search => false,
+        :target_search_network => false,
+        :target_content_network => true,
+        :target_content_contextual => false
+      }
+      :settings => {
+        :xsi_type => 'RealTimeBiddingSetting',
+        :opt_in => 'true'
       }
     }
   }
 
   # Add campaign.
   response = campaign_srv.mutate([operation])
-  if response and response[:value]
-    campaign = response[:value].first
-    puts 'Campaign with name "%s" and id %d was added.' %
-        [campaign[:name], campaign[:id]]
-  else
-    puts 'No campaigns were added.'
-  end
+  campaign = response[:value].first
+  puts "Campaign with name '%s' and ID %d was added." %
+      [campaign[:name], campaign[:id]]
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
     add_campaign()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    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

data/examples/{v201008/add_ad_group_criteria.rb → v201109/basic_operations/add_placements.rb}

@@ -1,6 +1,7 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -17,18 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to add a criterion to a given ad group. To create
+# This example illustrates how to add a placement to a given ad group. To create
 # an ad group, run add_ad_group.rb.
 #
 # Tags: AdGroupCriterionService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201008
-
-def add_ad_group_criteria()
+def add_placements(ad_group_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -40,60 +37,62 @@ def add_ad_group_criteria()
   ad_group_criterion_srv =
       adwords.service(:AdGroupCriterionService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
-  # Create placement.
-  plc_operation = {
-    :operator => 'ADD',
-    :operand => {
+  # Create placements.
+  placements = [
+    {
       :xsi_type => 'BiddableAdGroupCriterion',
       :ad_group_id => ad_group_id,
       :criterion => {
         :xsi_type => 'Placement',
         :url => 'http://mars.google.com'
       }
-    }
-  }
+    },
+    {
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :xsi_type => 'Placement',
+        :url => 'http://pluto.google.com'
+      }
+    },
+  ]
 
-  # Add criteria.
-  response = ad_group_criterion_srv.mutate([plc_operation])
-  if response and response[:value]
-    ad_group_criteria = response[:value]
-    puts "Added #{ad_group_criteria.length} criteria to ad group " +
-        "#{ad_group_id}."
-    ad_group_criteria.each do |ad_group_criterion|
-      puts "  Criterion id is #{ad_group_criterion[:criterion][:id]} and " +
-          "type is #{ad_group_criterion[:criterion][:xsi_type]}."
-    end
-  else
-    puts "No criteria were added."
+  # Create operations to add placements.
+  plc_operations = placements.map do |placement|
+    {:operator => 'ADD', :operand => placement}
+  end
+
+  # Add placements.
+  response = ad_group_criterion_srv.mutate(plc_operations)
+  ad_group_criteria = response[:value]
+  puts "Added %d placements to ad group ID %d." %
+     [ad_group_criteria.length, ad_group_id]
+  ad_group_criteria.each do |ad_group_criterion|
+    puts "\tPlacement ID is %d and type is '%s'." %
+        [ad_group_criterion[:criterion][:id],
+         ad_group_criterion[:criterion][:xsi_type]]
   end
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    add_ad_group_criteria()
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    add_placements(ad_group_id)
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    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