google-adwords-api 0.10.0 → 0.11.0

data/examples/v201302/targeting/get_targetable_languages_and_carriers.rb

@@ -1,94 +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 = :v201302
-
-  begin
-    get_targetable_languages_and_carriers()
-
-  # Authorization error.
-  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
-        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
-        "to retrieve and store OAuth2 tokens."
-    puts "See this wiki page for more details:\n\n  " +
-        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
-
-  # 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/v201302/targeting/lookup_location.rb

@@ -1,112 +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', 'TargetingStatus'],
-      :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 (%s)") %
-          [criterion[:search_term], criterion[:location][:location_name],
-           criterion[:location][:criterion_type], criterion[:location][:id],
-           parent_location, criterion[:reach],
-           criterion[:location][:targeting_status]]
-    end
-  else
-    puts 'No criteria were returned.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201302
-
-  begin
-    lookup_location()
-
-  # Authorization error.
-  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
-        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
-        "to retrieve and store OAuth2 tokens."
-    puts "See this wiki page for more details:\n\n  " +
-        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
-
-  # 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/v201309/campaign_management/add_location_extension_override.rb

@@ -1,91 +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 override an ad extension for a specific ad, by
-# creating a location extension override. To create a campaign, run
-# add_campaign.rb, to create an ad, run add_text_ads.rb.
-#
-# Tags: AdExtensionOverrideService.mutate
-
-require 'adwords_api'
-
-def add_location_extension_override(ad_id, location_extension_id)
-  # 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)
-
-  # Create operation.
-  operation = {
-    :operator => 'ADD',
-    :operand => {
-      :ad_id => ad_id,
-      :ad_extension => {
-        :id => location_extension_id
-      }
-    }
-  }
-
-  # Add override.
-  response = ad_ext_override_srv.mutate([operation])
-  location_extension_override = response[:value].first
-  puts "Location extension override with ID %d was successfully added." %
-      location_extension_override[:ad_extension][:id]
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201309
-
-  begin
-    # IDs of ad and location extension override to add.
-    ad_id = 'INSERT_AD_ID_HERE'.to_i
-    location_extension_id = 'INSERT_LOCATION_EXTENSION_ID_HERE'.to_i
-    add_location_extension_override(ad_id, location_extension_id)
-
-  # Authorization error.
-  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
-        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
-        "to retrieve and store OAuth2 tokens."
-    puts "See this wiki page for more details:\n\n  " +
-        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
-
-  # 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/v201309/reporting/get_campaign_stats.rb

@@ -1,113 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2012, 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 various statistics for campaigns that received at least one
-# impression during the last week. To get campaigns, run get_campaigns.rb.
-#
-# Tags: CampaignService.get
-
-require 'adwords_api'
-require 'date'
-
-def get_campaign_stats()
-  # 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)
-
-  # Prepare start and end date for the last week.
-  start_date = DateTime.parse((Date.today - 7).to_s).strftime("%Y%m%d")
-  end_date = DateTime.parse((Date.today - 1).to_s).strftime("%Y%m%d")
-
-  # Get all the campaigns for this account.
-  selector = {
-    :fields => ['Id', 'Name', 'Impressions', 'Clicks', 'Cost', 'Ctr'],
-    :predicates => [
-      {:field => 'Impressions', :operator => 'GREATER_THAN', :values => [0]}
-    ],
-    :date_range => {:min => start_date, :max => end_date},
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = campaign_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |campaign|
-        puts ("Campaign with ID %d, name '%s' had the following stats during" +
-            " the last week: ") % [campaign[:id], campaign[:name]]
-        stats = campaign[:campaign_stats]
-        puts "\tImpressions: %d" % stats[:impressions]
-        puts "\tClicks:      %d" % stats[:clicks]
-        puts "\tCost:        %.2f" % (stats[:cost][:micro_amount] / 1000000)
-        puts "\tCTR:         %.2f%%" % (stats[:ctr] * 100)
-      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 "Total number of campaigns found: %d." % [page[:total_num_entries]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201309
-  PAGE_SIZE = 500
-
-  begin
-    get_campaign_stats()
-
-  # Authorization error.
-  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
-        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
-        "to retrieve and store OAuth2 tokens."
-    puts "See this wiki page for more details:\n\n  " +
-        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
-
-  # 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/lib/adwords_api/v201302/ad_extension_override_service.rb

@@ -1,38 +0,0 @@
-# Encoding: utf-8
-#
-# This is auto-generated code, changes will be overwritten.
-#
-# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
-# License:: Licensed under the Apache License, Version 2.0.
-#
-# Code generated by AdsCommon library 0.9.3 on 2013-03-05 13:30:12.
-
-require 'ads_common/savon_service'
-require 'adwords_api/v201302/ad_extension_override_service_registry'
-
-module AdwordsApi; module V201302; module AdExtensionOverrideService
-  class AdExtensionOverrideService < AdsCommon::SavonService
-    def initialize(config, endpoint)
-      namespace = 'https://adwords.google.com/api/adwords/cm/v201302'
-      super(config, endpoint, namespace, :v201302)
-    end
-
-    def get(*args, &block)
-      return execute_action('get', args, &block)
-    end
-
-    def mutate(*args, &block)
-      return execute_action('mutate', args, &block)
-    end
-
-    private
-
-    def get_service_registry()
-      return AdExtensionOverrideServiceRegistry
-    end
-
-    def get_module()
-      return AdwordsApi::V201302::AdExtensionOverrideService
-    end
-  end
-end; end; end