google-adwords-api 0.7.2 → 0.8.0

data/examples/v201109/targeting/get_targetable_languages_and_carriers.rb

@@ -1,86 +0,0 @@
-#!/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 illustrates how to retrieve all languages and carriers available
-# for targeting.
-#
-# Tags: ConstantDataService.getLanguageCriterion
-# Tags: ConstantDataService.getCarrierCriterion
-
-require 'adwords_api'
-
-def get_targetable_languages_and_carriers()
-  # 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')
-
-  constant_data_srv = adwords.service(:ConstantDataService, API_VERSION)
-
-  # Get all languages from ConstantDataService.
-  languages = constant_data_srv.get_language_criterion()
-
-  if languages
-    languages.each do |language|
-      puts "Language name is '%s', ID is %d and code is '%s'." %
-          [language[:name], language[:id], language[:code]]
-    end
-  else
-    puts 'No languages were found.'
-  end
-
-  # Get all carriers from ConstantDataService.
-  carriers = constant_data_srv.get_carrier_criterion()
-
-  if carriers
-    carriers.each do |carrier|
-      puts "Carrier name is '%s', ID is %d and country code is '%s'." %
-          [carrier[:name], carrier[:id], carrier[:country_code]]
-    end
-  else
-    puts 'No carriers were retrieved.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109
-
-  begin
-    get_targetable_languages_and_carriers()
-
-  # 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/v201109/targeting/lookup_location.rb

@@ -1,103 +0,0 @@
-#!/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 location criteria by name.
-#
-# Tags: LocationCriterionService.get
-
-require 'adwords_api'
-
-def lookup_location()
-  # 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')
-
-  location_criterion_srv =
-      adwords.service(:LocationCriterionService, API_VERSION)
-
-  # List of locations to look up.
-  location_names = ['Paris', 'Quebec', 'Spain', 'Deutschland']
-  # Locale to retrieve names in.
-  locale = 'en'
-
-  # Get the criteria by names.
-  selector = {
-      :fields => ['Id', 'LocationName', 'CanonicalName', 'DisplayType',
-          'ParentLocations', 'Reach'],
-      :predicates => [
-          # Location names must match exactly, only EQUALS and IN are supported.
-          {:field => 'LocationName',
-           :operator => 'IN',
-           :values => location_names},
-          # Set the locale of the returned location names.
-          {:field => 'Locale', :operator => 'EQUALS', :values => [locale]}
-    ]
-  }
-  criteria = location_criterion_srv.get(selector)
-
-  if criteria
-    criteria.each do |criterion|
-      # Extract all parent location names as one comma-separated string.
-      parent_location = if criterion[:location][:parent_locations] and
-          !criterion[:location][:parent_locations].empty?
-        locations_array = criterion[:location][:parent_locations].map do |loc|
-          loc[:location_name]
-        end
-        locations_array.join(', ')
-      else
-        'N/A'
-      end
-      puts ("The search term '%s' returned the location '%s' of type '%s' " +
-          "with ID %d, parent locations '%s' and reach %d") %
-          [criterion[:search_term], criterion[:location][:location_name],
-           criterion[:location][:criterion_type], criterion[:location][:id],
-           parent_location, criterion[:reach]]
-    end
-  else
-    puts 'No criteria were returned.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109
-
-  begin
-    lookup_location()
-
-  # 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/v201109_1/account_management/create_account.rb

@@ -1,80 +0,0 @@
-#!/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 illustrates how to create an account. Note by default this
-# account will only be accessible via parent MCC.
-#
-# Tags: CreateAccountService.mutate
-
-require 'adwords_api'
-require 'adwords_api/utils'
-
-def create_account()
-  # 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')
-
-  create_account_srv = adwords.service(:CreateAccountService, API_VERSION)
-
-  # Prepare operation to create an account.
-  operation = {
-      :operator => 'ADD',
-      :operand => {
-          :currency_code => 'EUR',
-          :date_time_zone => 'Europe/London'
-      },
-      :descriptive_name => 'Account created with CreateAccountService'
-  }
-
-  # Create the account. It is possible to create multiple accounts with one
-  # request by sending an array of operations.
-  response = create_account_srv.mutate([operation])
-
-  new_account = response.first
-  puts "Account with customer ID '%s' was successfully created." %
-      AdwordsApi::Utils.format_id(new_account[:customer_id])
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-
-  begin
-    create_account()
-
-  # 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/v201109_1/account_management/get_account_alerts.rb

@@ -1,111 +0,0 @@
-#!/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 alerts for all clients of an MCC account. The effective
-# user (clientCustomerId, or authToken) must be an MCC user to get results.
-#
-# Tags: AlertService.get
-
-require 'adwords_api'
-require 'adwords_api/utils'
-
-def get_account_alerts()
-  # 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')
-
-  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 => [
-        'ACCOUNT_BUDGET_BURN_RATE', 'ACCOUNT_BUDGET_ENDING',
-        'ACCOUNT_ON_TARGET', 'CAMPAIGN_ENDED', 'CAMPAIGN_ENDING',
-        'CREDIT_CARD_EXPIRING', 'DECLINED_PAYMENT', 'MANAGER_LINK_PENDING',
-        'MISSING_BANK_REFERENCE_NUMBER', 'PAYMENT_NOT_ENTERED',
-        'TV_ACCOUNT_BUDGET_ENDING', 'TV_ACCOUNT_ON_TARGET',
-        'TV_ZERO_DAILY_SPENDING_LIMIT', 'USER_INVITE_ACCEPTED',
-        'USER_INVITE_PENDING', 'ZERO_DAILY_SPENDING_LIMIT'
-      ]
-    },
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  # Get alerts.
-  begin
-    page = alert_srv.get(selector)
-    if page[:entries]
-      page[:entries].each_with_index do |alert, index|
-        puts "%d) Customer ID is '%s', alert type is '%s', severity is '%s'."
-            [AdwordsApi::Utils.format_id(alert[:client_customer_id]),
-             alert[:alert_type], alert[:alert_severity]]
-        alert[:details].each do |detail|
-          puts "\t- triggered at %s" % detail[:trigger_time]
-        end
-      end
-      # Increment values to request the next page.
-      offset += PAGE_SIZE
-      selector[:paging][:start_index] = offset
-    end
-  end while page[:total_num_entries] > offset
-
-  if page.include?(:total_num_entries)
-    puts "\tTotal number of alerts: %d." % page[:total_num_entries]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-  PAGE_SIZE = 500
-
-  begin
-    get_account_alerts()
-
-  # 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/v201109_1/account_management/get_account_changes.rb

@@ -1,137 +0,0 @@
-#!/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_1
-
-  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