google-adwords-api 0.4.5 → 0.5.0

data/examples/v201101/upload_image.rb

@@ -1,90 +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 uploads an image. To get images, run get_all_images.rb.
-#
-# Tags: MediaService.upload
-
-require 'rubygems'
-require 'adwords_api'
-require 'adwords_api/utils'
-require 'base64'
-
-API_VERSION = :v201101
-
-def upload_image()
-  # 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')
-
-  media_srv = adwords.service(:MediaService, API_VERSION)
-
-  # Create image.
-  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)
-  image = {
-    # 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 => 'Image',
-    :data => base64_image_data,
-    :type => 'IMAGE'
-  }
-
-  # Upload image.
-  response = media_srv.upload([image])
-  if response and !response.empty?
-    ret_image = response.first
-    dimensions = AdwordsApi::Utils.map(ret_image[:dimensions])
-    puts "Image with id #{ret_image[:media_id]}, dimensions " +
-        "#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
-        "and MIME type \"#{ret_image[:mime_type]}\" uploaded successfully."
-  else
-    puts "No images uploaded."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    upload_image()
-
-  # 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/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 = :v201109
-
-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/v201109/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 = :v201109
-
-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 AdsCommon::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/v201109/delete_bulk_mutate_job.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 deletes a bulk mutate job using the 'REMOVE' operator. Jobs may
-# only deleted if they are in the 'PENDING' state and have not yet recieved
-# all of their request parts. To get bulk mutate jobs, run
-# get_all_bulk_mutate_jobs.rb.
-#
-# Tags: BulkMutateJobService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201109
-
-def delete_bulk_mutate_job()
-  # 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')
-
-  bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
-
-  job_id = 'INSERT_BULK_MUTATE_JOB_ID_HERE'
-
-  # Create operation.
-  operation = {
-    :operator => 'REMOVE',
-    :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 => 'BulkMutateJob',
-      :id => job_id
-    }
-  }
-
-  # Delete job.
-  response = bulk_mutate_job_srv.mutate(operation)
-  if response and response[:value]
-    job = response[:value].first
-    puts 'Job id %d was successfully deleted.' % job[:id]
-  else
-    puts 'No jobs were deleted.'
-  end
-
-end
-
-if __FILE__ == $0
-  begin
-    delete_bulk_mutate_job()
-
-  # 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