google-adx-buyer-api 0.4.0 → 0.4.1

data/examples/v201101/delete_campaign.rb

@@ -1,87 +0,0 @@
-#!/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 a campaign by setting the status to 'DELETED'. To get
-# campaigns, run get_all_campaigns.rb.
-#
-# Tags: CampaignService.mutate
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-def delete_campaign()
-  # 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)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Prepare for deleting campaign.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => campaign_id,
-      :status => 'DELETED',
-    }
-  }
-
-  # 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
-  begin
-    delete_campaign()
-
-  # 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/v201101/delete_user_list.rb

@@ -1,87 +0,0 @@
-#!/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 a user list by setting the status to 'CLOSED'. To get
-# user lists, run get_all_user_lists.rb.
-#
-# Tags: UserListService.mutate
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-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
-
-  # 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')
-
-  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 => user_list_id,
-      :status => 'CLOSED'
-    }
-  }
-
-  # 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
-  begin
-    delete_user_list()
-
-  # 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/v201101/download_report.rb

@@ -1,76 +0,0 @@
-#!/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 and downloads a report from a report definition. To get a
-# report definition, run add_keywords_performance_report_definition.rb.
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-def download_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')
-
-  report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
-
-  report_definition_id = 'INSERT_REPORT_DEFINITION_ID'.to_i
-  file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
-
-  # Download report, using "download_report_as_file" extension method.
-  report_def_srv.download_report_as_file(report_definition_id, file_name)
-  puts 'Report with definition id %d was downloaded to \'%s\'.' %
-      [report_definition_id, file_name]
-end
-
-if __FILE__ == $0
-  begin
-    download_report()
-
-  # 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/v201101/get_ad_group_bid_landscape.rb

@@ -1,103 +0,0 @@
-#!/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 bid landscapes for an ad group. To get ad groups,
-# run get_all_ad_groups.rb.
-#
-# Tags: DataService.getAdGroupBidLandscape
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-def get_ad_group_bid_landscapes()
-  # 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')
-
-  data_srv = adwords.service(:DataService, API_VERSION)
-
-  ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
-  # Get bid landscape for ad group.
-  selector = {
-    :fields => ["AdGroupId", "LandscapeType", "LandscapeCurrent", "StartDate",
-                "EndDate", "Bid", "LocalClicks", "LocalCost", "MarginalCpc",
-                "LocalImpressions"],
-    :predicates => [
-      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]}
-    ]
-  }
-  page = data_srv.get_criterion_bid_landscape(selector)
-  if page and page[:entries]
-    puts "#{page[:entries].length} bid landscape(s) retrieved."
-    page[:entries].each do |bid_landscape|
-      puts "Found ad group bid landscape with ad group id " +
-          "'#{bid_landscape[:ad_group_id]}', type " +
-          "'#{bid_landscape[:type]}', current " +
-          "'#{bid_landscape[:landscape_current]}', start date " +
-          "'#{bid_landscape[:start_date]}', end date "+
-          "'#{bid_landscape[:end_date]}', with landscape points:"
-      bid_landscape[:landscape_points].each do |point|
-        puts "  #{point[:bid][:micro_amount]} => clicks: #{point.clicks}, " +
-            "cost: #{point[:cost][:micro_amount]}, marginalCpc: " +
-            "#{point[:marginal_cpc][:micro_amount]}, impressions: " +
-            "#{point[:impressions]}"
-      end
-    end
-  else
-    puts "No ad group bid landscapes retrieved."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_ad_group_bid_landscapes()
-
-  # 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/v201101/get_all_account_changes.rb

@@ -1,146 +0,0 @@
-#!/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 account changes between the two dates specified, for
-# all campaigns.
-#
-# Tags: CustomerSyncService.get
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-require 'pp'
-
-API_VERSION = :v201101
-
-def get_all_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]
-    campaigns = response[:entries]
-    campaign_ids = campaigns.map { |campaign| campaign[:id] }
-  else
-    puts "No campaigns were found."
-    return
-  end
-
-  # Create selector for CustomerSyncService.
-  selector = {
-    :campaign_ids => campaign_ids,
-    :date_time_range => {
-      :min => min_date_time,
-      :max => max_date_time
-    }
-  }
-
-  # Get all account changes for campaigns.
-  campaign_changes = customer_sync_srv.get(selector)
-
-  # Display changes.
-  if campaign_changes
-    puts "Most recent change: #{campaign_changes[:last_change_timestamp]}"
-    campaign_changes[:changed_campaigns].each do |campaign|
-      puts "Campaign with id #{campaign[:campaign_id]} was changed:"
-      puts "  Campaign changed status: #{campaign[:campaign_change_status]}"
-      if campaign[:campaign_change_status] != 'NEW'
-        puts "  Added ad extensions: %s" %
-            campaign[:added_ad_extensions].pretty_inspect
-        puts "  Added campaign criteria: %s" %
-            campaign[:added_campaign_criteria].pretty_inspect
-        puts "  Added campaign targeting: %s" %
-            campaign[:campaign_targeting_changed].pretty_inspect
-        puts "  Deleted ad extensions: %s" %
-            campaign[:deleted_ad_extensions].pretty_inspect
-        puts "  Deleted campaign criteria: %s" %
-            campaign[:deleted_campaign_criteria].pretty_inspect
-
-        if campaign[:changed_ad_groups]
-          campaign[:changed_ad_groups].each do |ad_group|
-            puts "  Ad group with id #{ad_group[:ad_group_id]} was changed:"
-            puts "    Ad group changed status: " +
-                "#{ad_group[:ad_group_change_status]}"
-            if ad_group[:ad_group_change_status] != 'NEW'
-              puts "    Ads changed: %s" % ad_group[:changed_ads].pretty_inspect
-              puts "    Criteria changed: %s" %
-                  ad_group[:changed_criteria].pretty_inspect
-              puts "    Criteria deleted: %s" %
-                  ad_group[:deleted_criteria].pretty_inspect
-            end
-          end
-        end
-      end
-      puts ''
-    end
-  else
-    puts "No account changes were found."
-  end
-
-
-end
-
-if __FILE__ == $0
-  begin
-    get_all_account_changes()
-
-  # 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