google-adwords-api 0.1.0

data/examples/v201008/get_all_report_definitions.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 report definitions. To add a report definition, run
+# add_keywords_performance_report.rb.
+#
+# Tags: ReportDefinitionService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201008
+
+def get_all_report_definitions()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
+
+  # Get all the report definitions.
+  selector = {}
+  response = report_def_srv.get(selector)
+  if response and response[:entries]
+    entries = response[:entries]
+    puts "#{entries.length} report definition(s) found."
+    entries.each do |entry|
+      puts "  Report definition id is #{entry[:id]} and name is " +
+          "\"#{entry[:report_name]}\"."
+    end
+  else
+    puts "No report definitions found."
+  end
+end
+
+if __FILE__ == $0
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  begin
+    get_all_report_definitions()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  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 '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
+      end
+    end
+  end
+end

data/examples/v201008/get_all_user_lists.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 user lists for an account.
+#
+# Tags: UserListService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201008
+
+def get_all_user_lists()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  user_list_srv = adwords.service(:UserListService, API_VERSION)
+
+  # Get all the user lists for this account.
+  selector = {}
+  response = user_list_srv.get(selector)
+
+  if response and response[:entries]
+    user_lists = response[:entries]
+    user_lists.each do |user_list|
+      puts "User list name is \"#{user_list[:name]}\", id is " +
+          "#{user_list[:id]}, status is \"#{user_list[:status]}\" and number " +
+          "of users is #{user_list[:size]}."
+    end
+  else
+    puts "No user lists were found."
+  end
+end
+
+if __FILE__ == $0
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  begin
+    get_all_user_lists()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  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 '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
+      end
+    end
+  end
+end

data/examples/v201008/get_all_videos.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 videos. To upload video, see
+# http://adwords.google.com/support/aw/bin/answer.py?hl=en&answer=39454
+#
+# Tags: MediaService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201008
+
+def get_all_videos()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  media_srv = adwords.service(:MediaService, API_VERSION)
+
+  # Get all the videos.
+  selector = {
+    :media_type => 'VIDEO'
+  }
+  response = media_srv.get(selector)
+  if response and response[:entries]
+    videos = response[:entries]
+    puts "#{videos.length} video(s) found."
+    videos.each do |video|
+      puts "  Video id is #{video[:media_id]} and name is \"#{video[:name]}\"."
+    end
+  else
+    puts "No videos found."
+  end
+end
+
+if __FILE__ == $0
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  begin
+    get_all_videos()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  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 '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
+      end
+    end
+  end
+end

data/examples/v201008/get_bulk_mutate_job.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 a bulk mutate job and prints out its stats information.
+# To add a bulk mutate job, run perform_bulk_mutate_job.rb.
+#
+# Tags: BulkMutateJobService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201008
+
+def get_all_bulk_mutate_jobs()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
+
+  # Replace with valid values of your account.
+  bulk_mutate_job_id = "INSERT_BULK_MUTATE_JOB_ID_HERE"
+
+  # Get all the bulk mutate jobs.
+  selector = {
+    :include_stats => true,
+    :job_ids => [bulk_mutate_job_id]
+  }
+  jobs = bulk_mutate_job_srv.get(selector)
+
+  if jobs
+    jobs.each do |job|
+      puts "Bulk mutate job with id %d and status '%s' was found." %
+          [job[:id], job[:status]]
+
+      case job[:status]
+      when 'PENDING'
+        puts "  Total parts: %d, parts received: %d." %
+            [job[:num_request_parts], job[:num_request_parts_received]]
+      when 'PROCESSING'
+        if job[:stats]
+          puts "  Percent complete: %d." % job[:stats][:progress_percent]
+        end
+      when 'COMPLETED'
+        if job[:stats]
+          puts "  Total operations: %d, failed: %d, unprocessed %d." %
+              [job[:stats][:num_operations],
+               job[:stats][:num_failed_operations],
+               job[:stats][:num_unprocessed_operations]]
+        end
+      end
+    end
+  else
+    puts "No bulk mutate jobs were found."
+  end
+end
+
+if __FILE__ == $0
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'true'
+
+  begin
+    get_all_bulk_mutate_jobs()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  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 '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
+      end
+    end
+  end
+end

data/examples/v201008/get_campaign_alerts.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 code example illustrates how to retrieve campaign alerts for a user.
+# The alerts are restricted to a maximum of 10 entries.
+#
+# Tags: AlertService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201008
+
+def get_campaign_alerts()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  alert_srv = adwords.service(:AlertService, API_VERSION)
+
+  # Create the selector.
+  selector = {
+    :query => {
+      :filter_spec => 'ALL',
+      :client_spec => 'ALL',
+      :trigger_time_spec => 'ALL_TIME',
+      :severities => ['GREEN', 'YELLOW', 'RED'],
+      :types => ['CAMPAIGN_ENDING', 'CAMPAIGN_ENDED']
+    },
+    :paging => {
+      :start_index => 0,
+      :number_results => 10
+    }
+  }
+
+  # Get alerts.
+  response = alert_srv.get(selector)
+
+  if response and response[:entries]
+    alerts = response[:entries]
+    alerts.each_with_index do |alert, index|
+      puts "{index}) Customer Id is " +
+          "#{AdwordsApi::Utils.format_id(alert[:client_customer_id])}, " +
+          "alert type is '#{alert[:alert_type]}', severity is " +
+          "#{alert[:alert_severity]}."
+      alert[:details].each do |detail|
+        puts "  - triggered at #{detail[:trigger_time]}"
+      end
+    end
+  else
+    puts "No alerts were found."
+  end
+end
+
+if __FILE__ == $0
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  begin
+    get_campaign_alerts()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  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 '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
+      end
+    end
+  end
+end