google-adx-buyer-api 0.4.0 → 0.4.1

data/examples/v201003/add_placement_performance_report_definition.rb

@@ -1,108 +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 adds a placement performance report. To get ad groups, run
-# get_all_ad_groups.rb. To get report fields, run get_report_fields.rb.
-#
-# Tags: ReportDefinitionService.mutate
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-def add_placement_performance_report_definition()
-  # 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')
-
-  report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
-
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-  start_date = 'INSERT_START_DATE_HERE'
-  end_date = 'INSERT_END_DATE_HERE'
-
-  # Prepare for adding report definition.
-  operation = {
-    :operator => 'ADD',
-    :operand => {
-      :selector => {
-        :fields => ['AdGroupId', 'Id', 'PlacementUrl', 'Impressions', 'Clicks',
-                    'Cost'],
-        :predicates => [{
-          :operator => 'EQUALS',
-          :field => 'AdGroupId',
-          :values => [ad_group_id]
-        }],
-        :date_range => {
-          :min => start_date,
-          :max => end_date
-        }
-      },
-      :report_name => 'Placement performance report #%s' %
-          (Time.new.to_f * 1000).to_i,
-      :report_type => 'MANAGED_PLACEMENTS_PERFORMANCE_REPORT',
-      :date_range_type => 'CUSTOM_DATE',
-      :download_format => 'XML'
-    }
-  }
-
-  # Add report definition.
-  response = report_def_srv.mutate([operation])
-  if response
-    response.each do |report_definition|
-      puts 'Report definition with name \'%s\' and id \'%s\' was added' %
-          [report_definition[:report_name], report_definition[:id]]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    add_placement_performance_report_definition()
-
-  # 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/v201003/check_campaigns.rb

@@ -1,132 +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'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-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 #%s' % (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 => 'ManualCPM'
-      },
-      :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 #%s' % (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()
-
-  # 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/v201003/delete_ad.rb

@@ -1,94 +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'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-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()
-
-  # 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/v201003/delete_ad_group.rb

@@ -1,86 +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'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-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()
-
-  # 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/v201003/delete_campaign.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 campaign by setting the status to 'DELETED'. To get
-# campaigns, run get_all_campaigns.rb.
-#
-# Tags: CampaignService.mutate
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-def delete_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)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Prepare for deleting campaign.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => campaign_id,
-      :status => 'DELETED',
-    }
-  }
-
-  # Delete campaign.
-  response = campaign_srv.mutate([operation])
-  campaign = response[:value].first
-  puts 'Campaign with name "%s" and id %d was deleted.' %
-      [campaign[:name], campaign[:id]]
-end
-
-if __FILE__ == $0
-  begin
-    delete_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