google-adwords-api 0.11.1 → 0.12.0

data/examples/v201306/targeting/add_demographic_targeting_criteria.rb

@@ -1,116 +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 adds demographic criteria to an ad group. To get ad groups list,
-# run get_ad_groups.rb.
-#
-# Tags: AdGroupCriterionService.mutate
-
-require 'adwords_api'
-
-def add_demographic_targeting_criteria(ad_group_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_group_criterion_srv =
-      adwords.service(:AdGroupCriterionService, API_VERSION)
-
-  # Create ad group criteria.
-  ad_group_criteria = [
-    # Targeting criterion.
-    {
-      :xsi_type => 'BiddableAdGroupCriterion',
-      :ad_group_id => ad_group_id,
-      :criterion => {
-        :xsi_type => 'Gender',
-        # See system codes section for IDs:
-        # https://developers.google.com/adwords/api/docs/appendix/genders
-        :id => 11
-      }
-    },
-    # Exclusion criterion.
-    {
-      :xsi_type => 'NegativeAdGroupCriterion',
-      :ad_group_id => ad_group_id,
-      :criterion => {
-        :xsi_type => 'AgeRange',
-        # See system codes section for IDs:
-        # https://developers.google.com/adwords/api/docs/appendix/ages
-        :id => 503999
-      }
-    }
-  ]
-
-  # Create operations.
-  operations = ad_group_criteria.map do |criterion|
-    {:operator => 'ADD', :operand => criterion}
-  end
-
-  response = ad_group_criterion_srv.mutate(operations)
-
-  if response and response[:value]
-    criteria = response[:value]
-    criteria.each do |ad_group_criterion|
-      criterion = ad_group_criterion[:criterion]
-      puts ("Ad group criterion with ad group ID %d, criterion ID %d and " +
-          "type '%s' was added.") % [ad_group_criterion[:ad_group_id],
-          criterion[:id], criterion[:criterion_type]]
-    end
-  else
-    puts 'No criteria were returned.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201306
-
-  begin
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'
-    add_demographic_targeting_criteria(ad_group_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/v201306/targeting/get_campaign_targeting_criteria.rb

@@ -1,110 +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 the campaign targets. To set
-# campaign targets, run add_campaign_targeting_criteria.rb.
-#
-# Tags: CampaignCriterionService.get
-
-require 'adwords_api'
-
-def get_campaign_targeting_criteria(campaign_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')
-
-  campaign_criterion_srv =
-      adwords.service(:CampaignCriterionService, API_VERSION)
-
-  # Selector to get all the targeting for this campaign.
-  selector = {
-    :fields => ['Id', 'CriteriaType', 'KeywordText'],
-    :predicates => [
-      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
-    ],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = campaign_criterion_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |typed_criterion|
-        negative = typed_criterion[:xsi_type] == 'NegativeCampaignCriterion' ?
-           ' (negative)' : ''
-        criterion = typed_criterion[:criterion]
-        puts ("Campaign criterion%s with ID %d, type '%s' and text '%s'" +
-            " was found.") %
-            [negative, criterion[:id], criterion[:type], criterion[:text]]
-      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 "\tCampaign ID %d has %d criteria." %
-        [campaign_id, page[:total_num_entries]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201306
-  PAGE_SIZE = 500
-
-  begin
-    # Specify campaign ID to get targeting for.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-    get_campaign_targeting_criteria(campaign_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/v201306/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 = :v201306
-
-  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/v201306/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 = :v201306
-
-  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/v201402/advanced_operations/add_places_location_extensions.rb~

@@ -1,159 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.mcloonan@gmail.com (Michael Cloonan)
-#
-# Copyright:: Copyright 2014, 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 adds a feed that syncs feed items from a Google Places account
-# and associates the feed with a customer.
-#
-# Tags: CustomerFeedService.mutate, FeedItemService.mutate
-# Tags: FeedMappingService.mutate, FeedService.mutate
-
-require 'adwords_api'
-require 'date'
-
-def add_places_location_extensions(places_email_address, places_access_token)
-  # 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')
-
-  feed_srv = adwords.service(:FeedService, API_VERSION)
-  customer_feed_srv = adwords.service(:CustomerFeedService, API_VERSION)
-
-  places_feed = {
-    :name => "Places feed #%d" % (Time.new.to_f * 1000).to_i,
-    :system_feed_generation_data => {
-      :xsi_type => 'PlacesLocationFeedData',
-      :o_auth_info => {
-        :http_method => 'GET',
-        :http_request_url => 'https://www.google.com/local/add',
-        :http_authorization_header => "Bearer %s" % places_access_token
-      },
-      :email_address => places_email_address
-    },
-    # Since this feed's feed items will be managed by AdWords, you must set
-    # its origin to ADWORDS.
-    :origin => 'ADWORDS'
-  }
-
-  places_operation = {
-    :operator => 'ADD',
-    :operand => places_feed
-  }
-
-  result = feed_srv.mutate([places_operation])
-  added_feed = result[:value].first
-  puts "Added places feed with ID %d" % added_feed[:id]
-
-  # Add a CustomerFeed that associates the feed with this customer for the
-  # LOCATION placeholder type.
-  customer_feed = {
-    :feed_id => added_feed[:id],
-    :placeholder_types => PLACEHOLDER_TYPE_LOCATION,
-    :matching_function => {
-      :operator => 'IDENTITY',
-      :lhsOperand => {
-        :xsi_type => 'FunctionArgumentOperand',
-        :type => 'BOOLEAN',
-        :boolean_value => true
-      }
-    }
-  }
-
-  customer_feed_operation = {
-    :xsi_type => 'CustomerFeedOperation',
-    :operator => 'ADD',
-    :operand => customer_feed
-  }
-
-  added_customer_feed = nil
-  number_of_attempts = 0
-  while i < MAX_CUSTOMER_FEED_ADD_ATTEMPTS && !added_customer_feed
-    number_of_attempts += 1
-    begin
-      result = customer_feed_srv.mutate([customer_feed_operation])
-      added_customer_feed = result[:value].first
-      puts "Attempt #%d to add the CustomerFeed was successful" % 
-          number_of_attempts
-    rescue
-      sleep_seconds = 5 * (2 ** number_of_attempts)
-      puts ("Attempt #%d to add the CustomerFeed was not succeessful. " +
-          "Waiting %d seconds before trying again.") %
-          [number_of_attempts, sleep_seconds]
-      sleep(sleep_seconds)
-    end
-  end
-
-  unless added_customer_feed
-    raise StandardError, ("Could not create the CustomerFeed after %d " +
-        "attempts. Please retry the CustomerFeed ADD operation later.") %
-        MAX_CUSTOMER_FEED_ADD_ATTEMPTS
-  end
-
-  puts "Added CustomerFeed for feed ID %d and placeholder type %d" %
-      [added_customer_feed[:id], added_customer_feed[:placeholder_types].first]
-
-  # OPTIONAL: Create a CampaignFeed to specify which FeedItems to use at the
-  # Campaign level. This will be similar to the CampaignFeed in the
-  # add_site_links example, except you can filter based on the business name
-  # and category of each FeedItem by using a FeedAttributeOperand in your
-  # matching function.
-
-  # OPTIONAL: Create an AdGroupFeed for even more fine grained control over
-  # which feed items are used at the AdGroup level.
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201402
-  PLACEHOLDER_TYPE_LOCATION = 7
-  MAX_CUSTOMER_FEED_ADD_ATTEMPTS = 10
-
-  begin
-    places_email_address = 'INSERT_PLACES_EMAIL_ADDRESS_HERE'
-    places_access_token = 'INSERT_PLACES_ACCESS_TOKEN_HERE'
-
-    add_places_location_extensions(places_email_address, places_access_token)
-
-  # 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