google-adwords-api 0.4.5 → 0.5.0

data/examples/v200909/add_campaign_ad_extension.rb

@@ -1,121 +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 create a campaign ad extension for an existing
-# campaign. To create a campaign, run add_campaign.rb.
-#
-# Tags: GeoLocationService.get, CampaignAdExtensionService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v200909
-
-def add_campaign_ad_extension()
-  # 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_ad_ext_srv =
-      adwords.service(:CampaignAdExtensionService, API_VERSION)
-  geo_location_srv = adwords.service(:GeoLocationService, API_VERSION)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  selector = {
-    :addresses => [
-      {
-        :street_address => '1600 Amphitheatre Parkway',
-        :city_name => 'Mountain View',
-        :province_code => 'CA',
-        :postal_code => '94043',
-        :country_code => 'US'
-      },
-      {
-        :street_address => "38 Avenue de l'Opéra",
-        :city_name => 'Paris',
-        :postal_code => '75002',
-        :country_code => 'FR'
-      }
-    ]
-  }
-
-  # Get the geo location info for the various addresses and build the operations
-  # with that information.
-  locations = geo_location_srv.get(selector)
-  if locations
-    operations = []
-    locations.each do |location|
-      operation = {
-        :operator => 'ADD',
-        :operand => {
-          :campaign_id => campaign_id,
-          :status => 'ACTIVE',
-          :ad_extension => {
-            # The 'xsi_type' field allows you to specify the xsi:type of the
-            # object being created. It's only necessary when you must provide an
-            # explicit type that the client library can't infer.
-            :xsi_type => 'LocationExtension',
-            :address => location[:address],
-            :geo_point => location[:geo_point],
-            :encoded_location => location[:encoded_location],
-            :source => 'ADWORDS_FRONTEND'
-          }
-        }
-      }
-      operations << operation
-    end
-  else
-    puts "Unable to retrieve geo locations."
-    exit
-  end
-
-  # Add campaign ad extensions.
-  response = campaign_ad_ext_srv.mutate(operations)
-  extensions = response[:value]
-  extensions.each do |extension|
-    puts "Campaign extension id #{extension[:ad_extension][:id]} and status " +
-        "#{extension[:status]} successfully added."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    add_campaign_ad_extension()
-
-  # 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/v200909/add_negative_campaign_criterion.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 illustrates how to create a negative campaign criterion for a
-# given campaign. To create a campaign, run add_campaign.rb.
-#
-# Tags: CampaignCriterionService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v200909
-
-def add_negative_campaign_criterion()
-  # 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)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Prepare for adding criterion.
-  operation = {
-    :operator => 'ADD',
-    :operand => {
-      # The 'xsi_type' field allows you to specify the xsi:type of the object
-      # being created. It's only necessary when you must provide an explicit
-      # type that the client library can't infer.
-      :xsi_type => 'NegativeCampaignCriterion',
-      :campaign_id => campaign_id,
-      :criterion => {
-        :xsi_type => 'Keyword',
-        :text => 'jupiter cruise',
-        :match_type => 'BROAD'
-      }
-    }
-  }
-
-  # Add criterion.
-  response = campaign_criterion_srv.mutate([operation])
-  campaign_criterion = response[:value].first
-  puts 'Campaign criterion id %d was successfully added.' %
-      campaign_criterion[:criterion][:id]
-end
-
-if __FILE__ == $0
-  begin
-    add_negative_campaign_criterion()
-
-  # 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/v200909/check_campaigns.rb

@@ -1,123 +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 shows how to use the 'validate only' header. No objects will be
-# created, but exceptions will still be thrown.
-#
-# Tags: CampaignService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v200909
-
-def check_campaigns()
-  # 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)
-
-  # Enable 'validate only'
-  adwords.validate_only = true
-
-  # Prepare for adding campaign.
-  operation = {
-    :operator => 'ADD',
-    :operand => {
-      :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'PAUSED',
-      :bidding_strategy => {
-        # The 'xsi_type' field allows you to specify the xsi:type of the object
-        # being created. It's only necessary when you must provide an explicit
-        # type that the client library can't infer.
-        :xsi_type => 'ManualCPC'
-      },
-      :budget => {
-        :period => 'DAILY',
-        :amount => {
-          :micro_amount => 50000000
-        },
-        :delivery_method => 'STANDARD'
-      }
-    }
-  }
-
-  # Validate campaign add operation.
-  response = campaign_srv.mutate([operation])
-  if response and response[:value]
-    campaigns = response[:value]
-    campaigns.each do |campaign|
-      puts "Unexpected campaign creation! Name '#{campaign[:name]}', ID " +
-          "#{campaign[:id]} and status is '#{campaign[:status]}'."
-    end
-  else
-    puts 'No campaigns created.'
-  end
-
-  # Provide an invalid bidding strategy that will cause an exception during
-  # validation.
-  operation = {
-    :operator => 'ADD',
-    :operand => {
-      :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'PAUSED',
-      :bidding_strategy => nil,
-      :budget => {
-        :period => 'DAILY',
-        :amount => {
-          :micro_amount => 50000000
-        },
-        :delivery_method => 'STANDARD'
-      }
-    }
-  }
-
-  # Validate campaign add operation.
-  begin
-    response = campaign_srv.mutate([operation])
-  rescue AdwordsApi::Errors::ApiException => e
-    puts "Validation correctly failed: #{e.message}"
-  end
-end
-
-if __FILE__ == $0
-  begin
-    check_campaigns()
-
-  # 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/v200909/delete_ad.rb

@@ -1,85 +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 an ad using the 'REMOVE' operator. To get ads,
-# run get_all_ads.rb.
-#
-# Tags: AdGroupAdService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v200909
-
-def delete_ad()
-  # 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_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
-
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-  ad_id = 'INSERT_AD_ID_HERE'.to_i
-
-  # Prepare for deleting ad.
-  operation = {
-    :operator => 'REMOVE',
-    :operand => {
-      :ad_group_id => ad_group_id,
-      :ad => {
-        :xsi_type => 'Ad',
-        :id => ad_id
-      }
-    }
-  }
-
-  # Delete ad.
-  response = ad_group_ad_srv.mutate([operation])
-  if response and response[:value]
-    ad = response[:value].first
-    puts 'Ad id %d was successfully deleted.' % ad[:ad][:id]
-  else
-    puts 'No ads were deleted.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    delete_ad()
-
-  # 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/v200909/delete_ad_group.rb

@@ -1,77 +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 an ad group by setting the status to 'DELETED'.
-# To get ad groups, run get_all_ad_groups.rb.
-#
-# Tags: AdGroupService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v200909
-
-def delete_ad_group()
-  # 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_srv = adwords.service(:AdGroupService, API_VERSION)
-
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
-  # Prepare for deleting ad group.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :status => 'DELETED',
-      :id => ad_group_id
-    }
-  }
-
-  # Delete ad group.
-  response = ad_group_srv.mutate([operation])
-  ad_group = response[:value].first
-  puts 'Ad group id %d was successfully deleted.' % ad_group[:id]
-end
-
-if __FILE__ == $0
-  begin
-    delete_ad_group()
-
-  # 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