google-adwords-api 0.4.5 → 0.5.0

data/examples/v201101/add_ads.rb

@@ -1,174 +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 add a text ad, an image ad and template (Click
-# to Play Video) ad to a given ad group. To create an ad group, run
-# add_ad_group.rb. To get all videos, run get_all_videos.rb. To upload video,
-# see http://adwords.google.com/support/aw/bin/answer.py?hl=en&answer=39454 .
-#
-# Tags: AdGroupAdService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-require 'base64'
-
-API_VERSION = :v201101
-
-def add_ads()
-  # 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
-  video_media_id = 'INSERT_VIDEO_MEDIA_ID_HERE'.to_i
-
-  # Create text ad.
-  text_ad_operation = {
-    :operator => 'ADD',
-    :operand => {
-      :ad_group_id => ad_group_id,
-      :ad => {
-        # 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 => 'TextAd',
-        :headline => 'Luxury Cruise to Mars',
-        :description1 => 'Visit the Red Planet in style.',
-        :description2 => 'Low-gravity fun for everyone!',
-        :url => 'http://www.example.com',
-        :display_url => 'www.example.com',
-      }
-    }
-  }
-
-  # Retrieve image and encode it.
-  image_url =
-      'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
-  # This utility method retrieves the contents of a URL using all of the config
-  # options provided to the Api object.
-  image_data = AdsCommon::Http.get(image_url, adwords.config)
-  base64_image_data = Base64.encode64(image_data)
-
-  # Create image ad.
-  image_ad_operation = {
-    :operator => 'ADD',
-    :operand => {
-      :ad_group_id => ad_group_id,
-      :ad => {
-        :xsi_type => 'ImageAd',
-        :name => "Cruise to mars image ad #%d" % (Time.new.to_f * 1000).to_i,
-        :url => 'http://www.example.com',
-        :display_url => 'www.example.com',
-        :image => {
-          :data => base64_image_data
-        }
-      }
-    }
-  }
-
-  # Create template ad, using the Click to Play Video template (id 9).
-  template_ad_operation = {
-    :operator => 'ADD',
-    :operand => {
-      :ad_group_id => ad_group_id,
-      :ad => {
-        :xsi_type => 'TemplateAd',
-        :template_id => 9,
-        :dimensions => {
-          :width => 300,
-          :height => 250
-        },
-        :name => "Mars cruise video ad #%d" % (Time.new.to_f * 1000).to_i,
-        :display_url => 'www.example.com',
-        :url => 'http://www.example.com',
-        :template_elements => [{
-          :unique_name => 'adData',
-          :fields => [
-            {
-              :name => 'startImage',
-              :type => 'IMAGE',
-              :field_media => {
-                :xsi_type => 'Image',
-                :type => 'IMAGE',
-                :name => 'StartingImage',
-                :data => base64_image_data  # Reusing the same image data
-              }
-            },
-            {
-              :name => 'displayUrlColor',
-              :type => 'ENUM',
-              :field_text => '#ffffff'
-            },
-            {
-              :name => 'video',
-              :type => 'VIDEO',
-              :field_media => {
-                :xsi_type => 'Video',
-                :type => 'VIDEO',
-                :name => 'video',
-                :media_id => video_media_id
-              }
-            }
-          ]
-        }]
-      }
-    }
-  }
-
-  # Add ads.
-  response = ad_group_ad_srv.mutate([text_ad_operation, image_ad_operation,
-    template_ad_operation])
-  if response and response[:value]
-    ads = response[:value]
-    puts "Added #{ads.length} ad(s) to ad group #{ad_group_id}."
-    ads.each do |ad|
-      puts "  Ad ID is #{ad[:ad][:id]}, type is '#{ad[:ad][:xsi_type]}' and " +
-          "status is '#{ad[:status]}'."
-    end
-  else
-    puts 'No ads were added.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    add_ads()
-
-  # 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/v201101/add_campaign.rb

@@ -1,99 +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.
-#
-# Tags: CampaignService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-def add_campaign()
-  # 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 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'
-      },
-      # Set the campaign network options to Search and Search Network.
-      :network_setting => {
-        :target_google_search => true,
-        :target_search_network => true,
-        :target_content_network => false,
-        :target_content_contextual => false
-      }
-    }
-  }
-
-  # Add campaign.
-  response = campaign_srv.mutate([operation])
-  if response and response[:value]
-    campaign = response[:value].first
-    puts "Campaign with name '%s' and ID %d was added." %
-        [campaign[:name], campaign[:id]]
-  else
-    puts 'No campaigns were added.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    add_campaign()
-
-  # 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/v201101/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 = :v201101
-
-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/v201101/add_conversion.rb

@@ -1,88 +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 add an AdWords conversion.
-#
-# Tags: ConversionTrackerService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-def add_conversion()
-  # 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')
-
-  conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
-
-  # Prepare for adding conversion.
-  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 => 'AdWordsConversionTracker',
-      :name => "Earth to Mars Cruises Conversion #%d" %
-          (Time.new.to_f * 1000).to_i,
-      :category => 'DEFAULT',
-      :markup_language => 'HTML',
-      :http_protocol => 'HTTP',
-      :text_format => 'HIDDEN'
-    }
-  }
-
-  # Add conversion.
-  response = conv_tracker_srv.mutate([operation])
-  if response and response[:value]
-    conversion = response[:value].first
-    puts "Conversion with ID #{conversion[:id]}, name " +
-        "'#{conversion[:name]}', status '#{conversion[:status]}' and " +
-        " category '#{conversion[:category]}' was added."
-  else
-    puts 'No conversions were added.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    add_conversion()
-
-  # 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