google-adwords-api 0.4.5 → 0.5.0

data/examples/v201008/download_report.rb

@@ -1,67 +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'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-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()
-
-  # 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/get_account_hierarchy.rb

@@ -1,101 +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 illustrates how to retrieve the account hierarchy under an
-# account.
-#
-# Tags: ServicedAccountService.get
-
-require 'rubygems'
-require 'adwords_api'
-require 'adwords_api/utils'
-
-API_VERSION = :v201008
-
-def get_account_hierarchy()
-  # 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')
-
-  serviced_account_srv = adwords.service(:ServicedAccountService, API_VERSION)
-
-  # Create selector to get all accounts with no paging.
-  selector = {:enable_paging => false}
-
-  graph = nil
-
-  # Run with MCC account.
-  adwords.use_mcc do
-    # Get the account hierarchy for this account.
-    graph = serviced_account_srv.get(selector)
-  end
-
-  if graph
-    # Display the accounts.
-    account_number = graph[:accounts] ? graph[:accounts].size : 0
-    puts "There are %d customers under this account hierarchy." % account_number
-    if graph[:accounts]
-      graph[:accounts].each_with_index do |account, index|
-        puts "#{index + 1}) Customer id: " +
-            AdwordsApi::Utils.format_id(account[:customer_id])
-        puts "Login email: #{account[:login]}"
-        puts "Company Name: #{account[:company_name]}"
-        puts "IsMcc: #{account[:can_manage_clients]}"
-        puts ''
-      end
-
-      puts ''
-
-      # Display the links.
-      graph[:links].each do |link|
-        puts "There is a '%s' link from %s to %s" %
-            [link[:type_of_link],
-             AdwordsApi::Utils.format_id(link[:manager_id][:id]),
-             AdwordsApi::Utils.format_id(link[:client_id][:id])]
-      end
-    end
-  else
-    puts "No accounts were found."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_account_hierarchy()
-
-  # 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/get_all_account_changes.rb

@@ -1,135 +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'
-require 'adwords_api'
-require 'pp'
-
-API_VERSION = :v201008
-
-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 = {}
-  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()
-
-  # 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/get_all_active_ad_group_criteria.rb

@@ -1,84 +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 illustrates how to retrieve all the active criteria for an ad
-# group. To add criteria to an existing ad group, run add_ad_group_criteria.rb.
-#
-# Tags: AdGroupCriterionService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def get_all_active_ad_group_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')
-
-  ad_group_criterion_srv =
-      adwords.service(:AdGroupCriterionService, API_VERSION)
-
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
-  # Get all the active criteria for this ad group
-  selector = {
-    :id_filters => [{
-      :ad_group_id => ad_group_id
-    }],
-    :user_statuses => ['ACTIVE']
-  }
-  response = ad_group_criterion_srv.get(selector)
-  if response and response[:entries]
-    ad_group_criteria = response[:entries]
-    puts "Ad group ##{ad_group_id} has #{ad_group_criteria.length} active " +
-        "criteria."
-    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 active criteria found for ad group ##{ad_group_id}."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_active_ad_group_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/v201008/get_all_ad_extension_overrides.rb

@@ -1,82 +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 illustrates how to retrieve all the ad extension overrides
-# for an existing campaign. To create an ad extension override run
-# add_ad_extension_override.rb.
-#
-# Tags: AdExtensionOverrideService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def get_all_ad_extension_overrides()
-  # 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_ext_override_srv =
-      adwords.service(:AdExtensionOverrideService, API_VERSION)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Get all the ad extension overrides for this campaign.
-  selector = {
-    :campaign_ids => [campaign_id]
-  }
-  response = ad_ext_override_srv.get(selector)
-  if response and response[:entries]
-    ext_overrides = response[:entries]
-    puts "Campaign ##{campaign_id} has #{ext_overrides.size} ad extension " +
-        "override(s)."
-    ext_overrides.each do |ext_override|
-      puts "  Ad extension override for ad ##{ext_override[:ad_id]} " +
-          "and ad extension ##{ext_override[:ad_extension][:id]}."
-    end
-  else
-    puts "No ad extension overrides found for campaign ##{campaign_id}."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_ad_extension_overrides()
-
-  # 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