google-adwords-api 0.4.5 → 0.5.0

data/examples/v201008/add_keywords_performance_report_definition.rb

@@ -1,99 +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 keywords 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'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def add_keywords_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', 'KeywordText', 'KeywordMatchType',
-                    'Impressions', 'Clicks', 'Cost'],
-        :predicates => [{
-          :operator => 'EQUALS',
-          :field => 'AdGroupId',
-          :values => [ad_group_id]
-        }],
-        :date_range => {
-          :min => start_date,
-          :max => end_date
-        }
-      },
-      :report_name => "Keywords performance report #%d" %
-          (Time.new.to_f * 1000).to_i,
-      :report_type => 'KEYWORDS_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 %d was added." %
-          [report_definition[:report_name], report_definition[:id]]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    add_keywords_performance_report_definition()
-
-  # 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/v201008/add_negative_campaign_criterion.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 illustrates how to create a negative campaign criterion for a
-# given campaign. To create a campaign, run add_campaign.rb.
-#
-# Tags: CampaignCriterionService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def add_negative_campaign_criterion()
-  # 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_criterion_srv =
-      adwords.service(:CampaignCriterionService, API_VERSION)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Prepare for adding criterion.
-  operation = {
-    :operator => 'ADD',
-    :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 => 'NegativeCampaignCriterion',
-      :campaign_id => campaign_id,
-      :criterion => {
-        :xsi_type => 'Keyword',
-        :text => 'jupiter cruise',
-        :match_type => 'BROAD'
-      }
-    }
-  }
-
-  # Add criterion.
-  response = campaign_criterion_srv.mutate([operation])
-  campaign_criterion = response[:value].first
-  puts 'Campaign criterion id %d was successfully added.' %
-      campaign_criterion[:criterion][:id]
-end
-
-if __FILE__ == $0
-  begin
-    add_negative_campaign_criterion()
-
-  # 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/v201008/add_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 illustrates how to create a user list.
-#
-# Tags: UserListService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def add_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)
-
-  # Prepare for adding remarketing user list.
-  name = "Mars cruise customers #%d" % (Time.new.to_f * 1000).to_i
-  operation = {
-    :operator => 'ADD',
-    :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 => 'RemarketingUserList',
-      :name => name,
-      :description => 'A list of mars cruise customers in the last year',
-      :status => 'OPEN',
-      :membership_life_span => 365,
-      :conversion_types => [{:name => name}]
-    }
-  }
-
-  # Add user list.
-  response = user_list_srv.mutate([operation])
-  if response and response[:value]
-    user_list = response[:value].first
-    puts "User list with name '%s' and ID %d was added." %
-        [user_list[:name], user_list[:id]]
-  else
-    puts 'No user lists were added.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    add_user_list()
-
-  # 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/v201008/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 = :v201008
-
-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 AdwordsApi::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/v201008/delete_ad.rb

@@ -1,85 +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'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-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()
-
-  # 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