google-adwords-api 0.8.2 → 0.9.0

data/examples/v201206/campaign_management/add_location_extension.rb

@@ -1,117 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# 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 location ad extension for an existing
-# campaign. To create a campaign, run add_campaign.rb.
-#
-# Tags: GeoLocationService.get, CampaignAdExtensionService.mutate
-
-require 'adwords_api'
-
-def add_location_extension(campaign_id)
-  # 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_ad_ext_srv =
-      adwords.service(:CampaignAdExtensionService, API_VERSION)
-  geo_location_srv = adwords.service(:GeoLocationService, API_VERSION)
-
-  selector = {
-    :addresses => [
-      {
-        :street_address => '1600 Amphitheatre Parkway',
-        :city_name => 'Mountain View',
-        :province_code => 'CA',
-        :postal_code => '94043',
-        :country_code => 'US'
-      },
-      {
-        :street_address => "38 Avenue de l'Opéra",
-        :city_name => 'Paris',
-        :postal_code => '75002',
-        :country_code => 'FR'
-      }
-    ]
-  }
-
-  # Get the geo location info for the various addresses and build a list of
-  # operations with that information.
-  locations = geo_location_srv.get(selector)
-  raise StandardError, 'Unable to retrieve geo locations.' if locations.nil?
-
-  operations = locations.map do |location|
-    {:operator => 'ADD',
-     :operand => {
-       :campaign_id => campaign_id,
-       :status => 'ACTIVE',
-       :ad_extension => {
-         # 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 => 'LocationExtension',
-         :address => location[:address],
-         :geo_point => location[:geo_point],
-         :encoded_location => location[:encoded_location],
-         :source => 'ADWORDS_FRONTEND',
-         # Optional fields:
-         #:company_name => 'ACME Inc.',
-         #:phone_number => '+1-650-253-0000'
-       }
-     }
-    }
-  end
-
-  # Add location ad extensions.
-  response = campaign_ad_ext_srv.mutate(operations)
-  response[:value].each do |extension|
-    puts "Location extension ID %d and status '%s' successfully added." %
-        [extension[:ad_extension][:id], extension[:status]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-
-  begin
-    # ID of campaign to add location extension to.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-    add_location_extension(campaign_id)
-
-  # 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/v201206/campaign_management/add_location_extension_override.rb

@@ -1,83 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# 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 override an ad extension for a specific ad, by
-# creating a location extension override. To create a campaign, run
-# add_campaign.rb, to create an ad, run add_text_ads.rb.
-#
-# Tags: AdExtensionOverrideService.mutate
-
-require 'adwords_api'
-
-def add_location_extension_override(ad_id, location_extension_id)
-  # 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_ext_override_srv =
-      adwords.service(:AdExtensionOverrideService, API_VERSION)
-
-  # Create operation.
-  operation = {
-    :operator => 'ADD',
-    :operand => {
-      :ad_id => ad_id,
-      :ad_extension => {
-        :id => location_extension_id
-      }
-    }
-  }
-
-  # Add override.
-  response = ad_ext_override_srv.mutate([operation])
-  location_extension_override = response[:value].first
-  puts "Location extension override with ID %d was successfully added." %
-      location_extension_override[:ad_extension][:id]
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-
-  begin
-    # IDs of ad and location extension override to add.
-    ad_id = 'INSERT_AD_ID_HERE'.to_i
-    location_extension_id = 'INSERT_LOCATION_EXTENSION_ID_HERE'.to_i
-    add_location_extension_override(ad_id, location_extension_id)
-
-  # 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/v201206/campaign_management/get_all_disapproved_ads.rb

@@ -1,93 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 disapproved ads in a given
-# ad group. To add ads, run add_text_ads.rb.
-#
-# Tags: AdGroupAdService.get
-
-require 'adwords_api'
-
-def get_all_disapproved_ads(ad_group_id)
-  # 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)
-
-  # Get all the disapproved ads for this campaign.
-  selector = {
-    :fields => ['Id', 'DisapprovalReasons'],
-    :ordering => [{:field => 'Id', :sort_order => 'ASCENDING'}],
-    :predicates => [
-      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
-      {
-        :field => 'CreativeApprovalStatus',
-        :operator => 'IN',
-        :values => ['DISAPPROVED']
-      }
-    ]
-  }
-  response = ad_group_ad_srv.get(selector)
-  if response and response[:entries]
-    ad_group_ads = response[:entries]
-    puts "Ad group ##{ad_group_id} has #{ad_group_ads.length} " +
-        "disapproved ad(s)."
-    ad_group_ads.each do |ad_group_ad|
-      puts "  Ad with id #{ad_group_ad[:ad][:id]} and type " +
-          "#{ad_group_ad[:ad][:xsi_type]} was disapproved for the following " +
-          "reasons:"
-      ad_group_ad[:ad][:disapproval_reasons].each do |reason|
-        puts "    #{reason}"
-      end
-    end
-  else
-    puts "No disapproved ads found for ad group ##{ad_group_id}."
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-
-  begin
-    # ID of an ad group to get disapproved ads for.
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    get_all_disapproved_ads(ad_group_id)
-
-  # 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/v201206/campaign_management/get_all_disapproved_ads_with_awql.rb

@@ -1,84 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2012, 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 disapproved ads in a given
-# ad group with AWQL. To add ads, run add_text_ads.rb.
-#
-# Tags: AdGroupAdService.query
-
-require 'adwords_api'
-
-def get_all_disapproved_ads_with_awql(ad_group_id)
-  # 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)
-
-  # Get all the disapproved ads for this campaign.
-  query = ('SELECT Id, DisapprovalReasons ' +
-      'WHERE AdGroupId = %d AND CreativeApprovalStatus = DISAPPROVED ' +
-      'ORDER BY Id') % ad_group_id
-
-  response = ad_group_ad_srv.query(query)
-  if response and response[:entries]
-    ad_group_ads = response[:entries]
-    puts 'Ad group ID %d has %d disapproved ad(s).' %
-        [ad_group_id, ad_group_ads.length]
-    ad_group_ads.each do |ad_group_ad|
-      puts ("\tAd with ID %d and type '%s' was disapproved for the following " +
-          + 'reasons:') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:xsi_type]]
-      ad_group_ad[:ad][:disapproval_reasons].each do |reason|
-        puts "\t\t%s" % reason
-      end
-    end
-  else
-    puts 'No disapproved ads found for ad group ID %d.' % ad_group_id
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-
-  begin
-    # ID of an ad group to get disapproved ads for.
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    get_all_disapproved_ads_with_awql(ad_group_id)
-
-  # 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/v201206/campaign_management/promote_experiment.rb

@@ -1,77 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 promotes an experiment, which permanently applies all the
-# experiment changes made to its related ad groups, criteria and ads.
-#
-# Tags: ExperimentService.mutate
-
-require 'adwords_api'
-
-def promote_experiment(experiment_id)
-  # 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')
-
-  experiment_srv = adwords.service(:ExperimentService, API_VERSION)
-
-  # Prepare for updating experiment.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => experiment_id,
-      :status => 'PROMOTED',
-    }
-  }
-
-  # Update experiment.
-  response = experiment_srv.mutate([operation])
-  experiment = response[:value].first
-  puts "Experiment with name '%s' and ID %d was promoted." %
-      [experiment[:name], experiment[:id]]
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-
-  begin
-    experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
-    promote_experiment(experiment_id)
-
-  # 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