google-adx-buyer-api 0.2.0

data/examples/v201101/update_campaign.rb

@@ -0,0 +1,93 @@
+#!/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 campaign, setting its budget delivery
+# to 'ACCELERATED'. To create a campaign, run add_campaign.rb.
+#
+# Tags: CampaignService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def update_campaign()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+
+  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+  # Prepare for updating campaign.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :id => campaign_id,
+      :budget => {
+        :delivery_method => 'ACCELERATED'
+      }
+    }
+  }
+
+  # Update campaign.
+  response = campaign_srv.mutate([operation])
+  if response and response[:value]
+    campaign = response[:value].first
+    puts 'Campaign id %d successfully updated, delivery method set to %s.' %
+        [campaign[:id], campaign[:budget][:delivery_method]]
+  else
+    puts 'No campaigns were updated.'
+  end
+end
+
+if __FILE__ == $0
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  begin
+    update_campaign()
+
+  # 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/update_conversion.rb

@@ -0,0 +1,96 @@
+#!/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 conversion by setting its status to
+# 'DISABLED'. To get conversions, run get_all_conversions.rb.
+#
+# Tags: ConversionTrackerService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def update_conversion()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
+
+  conversion_id = 'INSERT_CONVERSION_ID_HERE'.to_i
+
+  # Prepare for updating conversion.
+  operation = {
+    :operator => 'SET',
+    :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',
+      :id => conversion_id,
+      :status => 'DISABLED'
+    }
+  }
+
+  # Update 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 disabled."
+  else
+    puts 'No conversions were updated.'
+  end
+end
+
+if __FILE__ == $0
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  begin
+    update_conversion()
+
+  # 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/update_user_list.rb

@@ -0,0 +1,91 @@
+#!/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 = :v201101
+
+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
+  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
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  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/v201101/upload_image.rb

@@ -0,0 +1,97 @@
+#!/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 = :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
+  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
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  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

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification 
+name: google-adx-buyer-api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Danial Klimkin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-24 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: google-adwords-api
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :runtime
+  version_requirements: *id001
+description: google-adx-buyer-api is a DoubleClick Ad Exchange API Buyer API client library for Ruby
+email: api.dklimkin@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- COPYING
+- ChangeLog
+files: 
+- examples/v201008/add_experiment.rb
+- examples/v201008/add_ad_group.rb
+- examples/v201008/add_ad_group_criteria.rb
+- examples/v201008/add_ads.rb
+- examples/v201008/add_campaign.rb
+- examples/v201008/add_placement_performance_report_definition.rb
+- examples/v201008/add_negative_campaign_criterion.rb
+- examples/v201008/add_user_list.rb
+- examples/v201008/check_campaigns.rb
+- examples/v201008/delete_ad.rb
+- examples/v201008/delete_ad_group.rb
+- examples/v201008/delete_ad_group_criterion.rb
+- examples/v201008/delete_bulk_mutate_job.rb
+- examples/v201008/delete_campaign.rb
+- examples/v201008/delete_user_list.rb
+- examples/v201008/download_report.rb
+- examples/v201008/get_all_account_changes.rb
+- examples/v201008/get_all_active_ad_group_criteria.rb
+- examples/v201008/get_all_ad_group_criteria.rb
+- examples/v201008/get_all_ad_groups.rb
+- examples/v201008/get_all_ads.rb
+- examples/v201008/delete_experiment.rb
+- examples/v201008/get_all_campaign_targets.rb
+- examples/v201008/get_all_campaigns.rb
+- examples/v201008/get_all_disapproved_ads.rb
+- examples/v201008/get_all_images.rb
+- examples/v201008/get_all_paused_campaigns.rb
+- examples/v201008/get_all_report_definitions.rb
+- examples/v201008/get_all_user_lists.rb
+- examples/v201008/get_criterion_bid_landscape.rb
+- examples/v201008/get_geo_location_info.rb
+- examples/v201008/get_related_placements.rb
+- examples/v201008/get_report_fields.rb
+- examples/v201008/get_bulk_mutate_job.rb
+- examples/v201008/set_campaign_targets.rb
+- examples/v201008/update_ad.rb
+- examples/v201008/update_ad_group.rb
+- examples/v201008/update_ad_group_criterion.rb
+- examples/v201008/update_campaign.rb
+- examples/v201008/update_user_list.rb
+- examples/v201008/upload_image.rb
+- examples/v201008/get_all_experiments.rb
+- examples/v201008/perform_bulk_mutate_job.rb
+- examples/v201008/get_campaign_alerts.rb
+- examples/v201008/promote_experiment.rb
+- examples/v201003/add_ad_group.rb
+- examples/v201003/add_ad_group_criteria.rb
+- examples/v201003/add_ads.rb
+- examples/v201003/add_campaign.rb
+- examples/v201003/add_negative_campaign_criterion.rb
+- examples/v201003/add_placement_performance_report_definition.rb
+- examples/v201003/check_campaigns.rb
+- examples/v201003/delete_ad.rb
+- examples/v201003/delete_ad_group.rb
+- examples/v201003/delete_ad_group_criterion.rb
+- examples/v201003/delete_campaign.rb
+- examples/v201003/download_report.rb
+- examples/v201003/get_all_active_ad_group_criteria.rb
+- examples/v201003/get_all_ad_group_criteria.rb
+- examples/v201003/get_all_ad_groups.rb
+- examples/v201003/get_all_ads.rb
+- examples/v201003/get_all_campaign_targets.rb
+- examples/v201003/get_all_campaigns.rb
+- examples/v201003/get_all_disapproved_ads.rb
+- examples/v201003/get_all_images.rb
+- examples/v201003/get_all_paused_campaigns.rb
+- examples/v201003/get_all_report_definitions.rb
+- examples/v201003/get_criterion_bid_landscape.rb
+- examples/v201003/get_geo_location_info.rb
+- examples/v201003/get_related_placements.rb
+- examples/v201003/get_report_fields.rb
+- examples/v201003/perform_bulk_mutate_job.rb
+- examples/v201003/set_campaign_targets.rb
+- examples/v201003/update_ad.rb
+- examples/v201003/update_ad_group.rb
+- examples/v201003/update_ad_group_criterion.rb
+- examples/v201003/update_campaign.rb
+- examples/v201003/upload_image.rb
+- examples/v201101/add_ad_group.rb
+- examples/v201101/add_ad_group_criteria.rb
+- examples/v201101/add_ads.rb
+- examples/v201101/add_campaign.rb
+- examples/v201101/add_conversion.rb
+- examples/v201101/add_experiment.rb
+- examples/v201101/add_negative_campaign_criterion.rb
+- examples/v201101/add_placement_performance_report_definition.rb
+- examples/v201101/add_rtb_campaign.rb
+- examples/v201101/add_user_list.rb
+- examples/v201101/check_campaigns.rb
+- examples/v201101/delete_ad.rb
+- examples/v201101/delete_ad_group.rb
+- examples/v201101/delete_ad_group_criterion.rb
+- examples/v201101/delete_bulk_mutate_job.rb
+- examples/v201101/delete_campaign.rb
+- examples/v201101/delete_experiment.rb
+- examples/v201101/delete_user_list.rb
+- examples/v201101/download_report.rb
+- examples/v201101/get_ad_group_bid_landscape.rb
+- examples/v201101/get_all_account_changes.rb
+- examples/v201101/get_all_active_ad_group_criteria.rb
+- examples/v201101/get_all_ad_group_criteria.rb
+- examples/v201101/get_all_ad_groups.rb
+- examples/v201101/get_all_ads.rb
+- examples/v201101/get_all_campaign_targets.rb
+- examples/v201101/get_all_campaigns.rb
+- examples/v201101/get_all_conversions.rb
+- examples/v201101/get_all_disapproved_ads.rb
+- examples/v201101/get_all_experiments.rb
+- examples/v201101/get_all_images.rb
+- examples/v201101/get_all_paused_campaigns.rb
+- examples/v201101/get_all_report_definitions.rb
+- examples/v201101/get_all_user_lists.rb
+- examples/v201101/get_bulk_mutate_job.rb
+- examples/v201101/get_campaign_alerts.rb
+- examples/v201101/get_criterion_bid_landscape.rb
+- examples/v201101/get_geo_location_info.rb
+- examples/v201101/get_related_placements.rb
+- examples/v201101/get_report_fields.rb
+- examples/v201101/perform_bulk_mutate_job.rb
+- examples/v201101/promote_experiment.rb
+- examples/v201101/set_campaign_targets.rb
+- examples/v201101/update_ad.rb
+- examples/v201101/update_ad_group.rb
+- examples/v201101/update_ad_group_criterion.rb
+- examples/v201101/update_campaign.rb
+- examples/v201101/update_conversion.rb
+- examples/v201101/update_user_list.rb
+- examples/v201101/upload_image.rb
+- Rakefile
+- README
+- COPYING
+- ChangeLog
+has_rdoc: true
+homepage: http://code.google.com/p/google-api-ads-ruby/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby Client libraries for DoubleClick Ad Exchange Buyer API
+test_files: []
+