google-adx-buyer-api 0.2.0 → 0.4.0

data/examples/{v201101/delete_experiment.rb → v201109/delete_ad_group.rb}

@@ -17,49 +17,48 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example deletes an experiment. To get experiments, run
-# get_all_experiments.rb. To add an experiment, run add_experiment.rb.
+# This example deletes an ad group by setting the status to 'DELETED'.
+# To get ad groups, run get_all_ad_groups.rb.
 #
-# Tags: ExperimentService.mutate
+# Tags: AdGroupService.mutate
 
 require 'rubygems'
 gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201109
 
-def delete_experiment()
+def delete_ad_group()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
-  experiment_srv = adwords.service(:ExperimentService, API_VERSION)
 
-  experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
+  # 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')
 
-  # Prepare for deleting experiment.
+  ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
+
+  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+
+  # Prepare for deleting ad group.
   operation = {
     :operator => 'SET',
     :operand => {
-      :id => experiment_id,
-      :status => 'DELETED'
+      :status => 'DELETED',
+      :id => ad_group_id
     }
   }
 
-  # Delete experiment.
-  response = experiment_srv.mutate([operation])
-  experiment = response[:value].first
-  puts 'Experiment with name "%s" and id %d was deleted.' %
-      [experiment[:name], experiment[:id]]
+  # Delete ad group.
+  response = ad_group_srv.mutate([operation])
+  ad_group = response[:value].first
+  puts 'Ad group id %d was successfully deleted.' % ad_group[:id]
 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
-    delete_experiment()
+    delete_ad_group()
 
   # Connection error. Likely transitory.
   rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e

data/examples/v201109/delete_ad_group_criterion.rb

@@ -0,0 +1,95 @@
+#!/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 deletes an ad group criterion using the 'REMOVE' operator. To
+# get ad group criteria, run get_all_ad_group_criteria.rb.
+#
+# Tags: AdGroupCriterionService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def delete_ad_group_criterion()
+  # 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')
+
+  ad_group_criterion_srv =
+      adwords.service(:AdGroupCriterionService, API_VERSION)
+
+  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+
+  # Prepare for deleting ad group criterion.
+  operation = {
+    :operator => 'REMOVE',
+    :operand => {
+      # The 'xsi_type' field allows you to specify the xsi:type of the object
+      # being created. It's only necessary when you must provide an explicit
+      # type that the client library can't infer.
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :id => criterion_id
+      }
+    }
+  }
+
+  # Delete criterion.
+  response = ad_group_criterion_srv.mutate([operation])
+  ad_group_criterion = response[:value].first
+  puts 'Criterion id %d was successfully deleted.' %
+      ad_group_criterion[:criterion][:id]
+end
+
+if __FILE__ == $0
+  begin
+    delete_ad_group_criterion()
+
+  # 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/v201109/delete_bulk_mutate_job.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/ruby
+#
+# Author:: sgomes@google.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 deletes a bulk mutate job using the 'REMOVE' operator. Jobs may
+# only deleted if they are in the 'PENDING' state and have not yet recieved
+# all of their request parts. To get bulk mutate jobs, run
+# get_all_bulk_mutate_jobs.rb.
+#
+# Tags: BulkMutateJobService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def delete_bulk_mutate_job()
+  # 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')
+
+  bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
+
+  job_id = 'INSERT_BULK_MUTATE_JOB_ID_HERE'
+
+  # Create operation.
+  operation = {
+    :operator => 'REMOVE',
+    :operand => {
+      # The 'xsi_type' field allows you to specify the xsi:type of the object
+      # being created. It's only necessary when you must provide an explicit
+      # type that the client library can't infer.
+      :xsi_type => 'BulkMutateJob',
+      :id => job_id
+    }
+  }
+
+  # Delete job.
+  response = bulk_mutate_job_srv.mutate(operation)
+  if response and response[:value]
+    job = response[:value].first
+    puts 'Job id %d was successfully deleted.' % job[:id]
+  else
+    puts 'No jobs were deleted.'
+  end
+
+end
+
+if __FILE__ == $0
+  begin
+    delete_bulk_mutate_job()
+
+  # 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/delete_experiment.rb → v201109/delete_campaign.rb}

@@ -17,49 +17,49 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example deletes an experiment. To get experiments, run
-# get_all_experiments.rb. To add an experiment, run add_experiment.rb.
+# This example deletes a campaign by setting the status to 'DELETED'. To get
+# campaigns, run get_all_campaigns.rb.
 #
-# Tags: ExperimentService.mutate
+# Tags: CampaignService.mutate
 
 require 'rubygems'
 gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201008
+API_VERSION = :v201109
 
-def delete_experiment()
+def delete_campaign()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
-  experiment_srv = adwords.service(:ExperimentService, API_VERSION)
 
-  experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
+  # 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')
 
-  # Prepare for deleting experiment.
+  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+
+  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+  # Prepare for deleting campaign.
   operation = {
     :operator => 'SET',
     :operand => {
-      :id => experiment_id,
-      :status => 'DELETED'
+      :id => campaign_id,
+      :status => 'DELETED',
     }
   }
 
-  # Delete experiment.
-  response = experiment_srv.mutate([operation])
-  experiment = response[:value].first
-  puts 'Experiment with name "%s" and id %d was deleted.' %
-      [experiment[:name], experiment[:id]]
+  # Delete campaign.
+  response = campaign_srv.mutate([operation])
+  campaign = response[:value].first
+  puts 'Campaign with name "%s" and id %d was deleted.' %
+      [campaign[:name], campaign[:id]]
 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
-    delete_experiment()
+    delete_campaign()
 
   # Connection error. Likely transitory.
   rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e

data/examples/{v201008/promote_experiment.rb → v201109/delete_user_list.rb}

@@ -17,50 +17,49 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example promotes an experiment, which permanently applies all the
-# experiment changes made to its related ad groups, criteria and ads. To get
-# experiments, run get_all_experiments.rb.
+# This example deletes a user list by setting the status to 'CLOSED'. To get
+# user lists, run get_all_user_lists.rb.
 #
-# Tags: ExperimentService.mutate
+# Tags: UserListService.mutate
 
 require 'rubygems'
 gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201008
+API_VERSION = :v201109
 
-def promote_experiment()
+def delete_user_list()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
-  experiment_srv = adwords.service(:ExperimentService, API_VERSION)
 
-  experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
+  # 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')
 
-  # Prepare for updating experiment.
+  user_list_srv = adwords.service(:UserListService, API_VERSION)
+
+  user_list_id = 'INSERT_USER_LIST_ID_HERE'.to_i
+
+  # Prepare for deleting remarketing user list.
   operation = {
     :operator => 'SET',
     :operand => {
-      :id => experiment_id,
-      :status => 'PROMOTED',
+      :id => user_list_id,
+      :status => 'CLOSED'
     }
   }
 
-  # Update experiment.
-  response = experiment_srv.mutate([operation])
-  experiment = response[:value].first
-  puts 'Experiment with name "%s" and id %d was promoted.' %
-      [experiment[:name], experiment[:id]]
+  # Delete user list.
+  response = user_list_srv.mutate([operation])
+  user_list = response[:value].first
+  puts 'User list with name "%s" and id %d was deleted (closed).' %
+      [user_list[:name], user_list[:id]]
 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
-    promote_experiment()
+    delete_user_list()
 
   # Connection error. Likely transitory.
   rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e

data/examples/v201109/download_adhoc_report.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/ruby
+#
+# 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 and downloads an Ad Hoc report from a XML report definition.
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def download_adhoc_report()
+  # 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')
+
+  # Get report utilities for the version.
+  report_utils = adwords.report_utils(API_VERSION)
+
+  # File name to write report to. To retrieve the report as return value, use
+  # "download_report" method.
+  file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
+
+  # Define report definition. You can also pass your own XML text as a string.
+  report_definition = {
+    :selector => {
+        :fields => ['CampaignId', 'Id', 'Impressions', 'Clicks', 'Cost'],
+        # Predicates are optional.
+        :predicates => {
+          :field => 'Status',
+          :operator => 'IN',
+          :values => ['ENABLED', 'PAUSED']
+        }
+      },
+      :report_name => 'Custom ADGROUP_PERFORMANCE_REPORT',
+      :report_type => 'ADGROUP_PERFORMANCE_REPORT',
+      :download_format => 'CSV',
+      :date_range_type => 'LAST_7_DAYS',
+      # Enable to get rows with zero impressions.
+      :include_zero_impressions => false
+  }
+
+  # Download report, using "download_report_as_file" utility method.
+  report_utils.download_report_as_file(report_definition, file_name)
+  puts "Report was downloaded to '%s'." % file_name
+end
+
+if __FILE__ == $0
+  begin
+    download_adhoc_report()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::Errors::ReportError => e
+    puts "Reporting Error: %s" % e.message
+  end
+end