google-adx-buyer-api 0.4.0 → 0.4.1

data/examples/v201008/update_user_list.rb

@@ -1,91 +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 update a user list, setting its description.
-# To create a user list, run add_user_list.rb.
-#
-# Tags: UserListService.mutate
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def update_user_list()
-  # 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')
-
-  user_list_srv = adwords.service(:UserListService, API_VERSION)
-
-  user_list_id = 'INSERT_USER_LIST_ID_HERE'.to_i
-
-  # Prepare for updating remarketing user list.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => user_list_id,
-      :description => 'Last updated at %s' % Time.now.to_s
-    }
-  }
-
-  # Update user list.
-  response = user_list_srv.mutate([operation])
-  if response and response[:value]
-    user_list = response[:value].first
-    puts 'User list id %d was successfully updated, description set to "%s."' %
-        [user_list[:id], user_list[:description]]
-  else
-    puts 'No user lists were updated.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_user_list()
-
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
-
-  # API Error.
-  rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
-    puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
-      end
-    end
-  end
-end

data/examples/v201008/upload_image.rb

@@ -1,97 +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'
-gem 'google-adwords-api'
-require 'adwords_api'
-require 'base64'
-
-API_VERSION = :v201008
-
-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 = 'https://sandbox.google.com/sandboximages/image.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()
-
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
-
-  # API Error.
-  rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
-    puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
-      end
-    end
-  end
-end

data/examples/v201101/add_ad_group.rb

@@ -1,98 +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 an ad group. To create a campaign, run
-# add_campaign.rb.
-#
-# Tags: AdGroupService.mutate
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-def add_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)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Prepare for adding ad group.
-  operation = {
-    :operator => 'ADD',
-    :operand => {
-      :name => 'Earth to Mars Cruises #%s' % (Time.new.to_f * 1000).to_i,
-      :status => 'ENABLED',
-      :campaign_id => campaign_id,
-      :bids => {
-        # 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 => 'ManualCPMAdGroupBids',
-        :max_cpc => {
-          :amount => {
-            :micro_amount => 10000000
-          }
-        }
-      },
-    }
-  }
-
-  # Add ad group.
-  response = ad_group_srv.mutate([operation])
-  ad_group = response[:value].first
-  puts 'Ad group id %d was successfully added.' % ad_group[:id]
-end
-
-if __FILE__ == $0
-  begin
-    add_ad_group()
-
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
-
-  # API Error.
-  rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
-    puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
-      end
-    end
-  end
-end

data/examples/v201101/add_ad_group_criteria.rb

@@ -1,100 +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 criterion to a given ad group. To create
-# an ad group, run add_ad_group.rb.
-#
-# Tags: AdGroupCriterionService.mutate
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-def add_ad_group_criteria()
-  # 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)
-
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
-  # Create placement.
-  plc_operation = {
-    :operator => 'ADD',
-    :operand => {
-      :xsi_type => 'BiddableAdGroupCriterion',
-      :ad_group_id => ad_group_id,
-      :criterion => {
-        :xsi_type => 'Placement',
-        :url => 'http://mars.google.com'
-      }
-    }
-  }
-
-  # Add criteria.
-  response = ad_group_criterion_srv.mutate([plc_operation])
-  if response and response[:value]
-    ad_group_criteria = response[:value]
-    puts "Added #{ad_group_criteria.length} criteria to ad group " +
-        "#{ad_group_id}."
-    ad_group_criteria.each do |ad_group_criterion|
-      puts "  Criterion id is #{ad_group_criterion[:criterion][:id]} and " +
-          "type is #{ad_group_criterion[:criterion][:xsi_type]}."
-    end
-  else
-    puts "No criteria were added."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    add_ad_group_criteria()
-
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
-
-  # API Error.
-  rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
-    puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
-      end
-    end
-  end
-end

data/examples/v201101/add_ads.rb

@@ -1,110 +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 image ad to a given ad group. To create
-# an ad group, run add_ad_group.rb.
-#
-# Tags: AdGroupAdService.mutate
-
-require 'rubygems'
-gem 'google-adwords-api'
-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
-
-  # Retrieve image and encode it.
-  image_url = 'https://sandbox.google.com/sandboximages/image.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 #%s' % (Time.new.to_f * 1000).to_i,
-        :url => 'http://www.example.com',
-        :display_url => 'www.example.com',
-        :image => {
-          :data => base64_image_data
-        }
-      }
-    }
-  }
-
-  # Add ad.
-  response = ad_group_ad_srv.mutate([image_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()
-
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
-
-  # API Error.
-  rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
-    puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
-      end
-    end
-  end
-end