google-adx-buyer-api 0.4.0 → 0.4.1

data/examples/v201008/delete_bulk_mutate_job.rb

@@ -1,96 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: sgomes@google.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'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-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()
-
-  # 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/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 = :v201008
-
-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

data/examples/v201008/delete_user_list.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 user list by setting the status to 'CLOSED'. To get
-# user lists, run get_all_user_lists.rb.
-#
-# Tags: UserListService.mutate
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def delete_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 deleting remarketing user list.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => user_list_id,
-      :status => 'CLOSED'
-    }
-  }
-
-  # Delete user list.
-  response = user_list_srv.mutate([operation])
-  user_list = response[:value].first
-  puts 'User list with name "%s" and id %d was deleted (closed).' %
-      [user_list[:name], user_list[:id]]
-end
-
-if __FILE__ == $0
-  begin
-    delete_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/get_all_account_changes.rb

@@ -1,144 +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 gets all account changes between the two dates specified, for
-# all campaigns.
-#
-# Tags: CustomerSyncService.get
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-require 'pp'
-
-API_VERSION = :v201008
-
-def get_all_account_changes()
-  # 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)
-  customer_sync_srv = adwords.service(:CustomerSyncService, API_VERSION)
-
-  today_at_midnight = DateTime.parse(Date.today.to_s)
-  yesterday_at_midnight = DateTime.parse((Date.today - 1).to_s)
-  min_date_time = yesterday_at_midnight.strftime("%Y%m%d %H%M%S")
-  max_date_time = today_at_midnight.strftime("%Y%m%d %H%M%S")
-
-  # Get all the campaigns for this account.
-  selector = {}
-  response = campaign_srv.get(selector)
-
-  campaign_ids = []
-
-  if response and response[:entries]
-    campaigns = response[:entries]
-    campaign_ids = campaigns.map { |campaign| campaign[:id] }
-  else
-    puts "No campaigns were found."
-    return
-  end
-
-  # Create selector for CustomerSyncService.
-  selector = {
-    :campaign_ids => campaign_ids,
-    :date_time_range => {
-      :min => min_date_time,
-      :max => max_date_time
-    }
-  }
-
-  # Get all account changes for campaigns.
-  campaign_changes = customer_sync_srv.get(selector)
-
-  # Display changes.
-  if campaign_changes
-    puts "Most recent change: #{campaign_changes[:last_change_timestamp]}"
-    campaign_changes[:changed_campaigns].each do |campaign|
-      puts "Campaign with id #{campaign[:campaign_id]} was changed:"
-      puts "  Campaign changed status: #{campaign[:campaign_change_status]}"
-      if campaign[:campaign_change_status] != 'NEW'
-        puts "  Added ad extensions: %s" %
-            campaign[:added_ad_extensions].pretty_inspect
-        puts "  Added campaign criteria: %s" %
-            campaign[:added_campaign_criteria].pretty_inspect
-        puts "  Added campaign targeting: %s" %
-            campaign[:campaign_targeting_changed].pretty_inspect
-        puts "  Deleted ad extensions: %s" %
-            campaign[:deleted_ad_extensions].pretty_inspect
-        puts "  Deleted campaign criteria: %s" %
-            campaign[:deleted_campaign_criteria].pretty_inspect
-
-        if campaign[:changed_ad_groups]
-          campaign[:changed_ad_groups].each do |ad_group|
-            puts "  Ad group with id #{ad_group[:ad_group_id]} was changed:"
-            puts "    Ad group changed status: " +
-                "#{ad_group[:ad_group_change_status]}"
-            if ad_group[:ad_group_change_status] != 'NEW'
-              puts "    Ads changed: %s" % ad_group[:changed_ads].pretty_inspect
-              puts "    Criteria changed: %s" %
-                  ad_group[:changed_criteria].pretty_inspect
-              puts "    Criteria deleted: %s" %
-                  ad_group[:deleted_criteria].pretty_inspect
-            end
-          end
-        end
-      end
-      puts ''
-    end
-  else
-    puts "No account changes were found."
-  end
-
-
-end
-
-if __FILE__ == $0
-  begin
-    get_all_account_changes()
-
-  # 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/get_all_active_ad_group_criteria.rb

@@ -1,93 +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 retrieve all the active criteria for an ad
-# group. To add criteria to an existing ad group, run add_ad_group_criteria.rb.
-#
-# Tags: AdGroupCriterionService.get
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def get_all_active_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
-
-  # Get all the active criteria for this ad group
-  selector = {
-    :id_filters => [{
-      :ad_group_id => ad_group_id
-    }],
-    :user_statuses => ['ACTIVE']
-  }
-  response = ad_group_criterion_srv.get(selector)
-  if response and response[:entries]
-    ad_group_criteria = response[:entries]
-    puts "Ad group ##{ad_group_id} has #{ad_group_criteria.length} active " +
-        "criteria."
-    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 active criteria found for ad group ##{ad_group_id}."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_active_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