google-adwords-api 0.8.2 → 0.9.0

data/examples/v201209/adwords_for_video/get_video_campaign_stats.rb

@@ -0,0 +1,126 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2013, 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 stats for a video campaign.
+#
+# Note: AdWords for Video API is a Beta feature.
+#
+# Tags: VideoCampaignService.get
+
+require 'adwords_api'
+require 'date'
+
+def get_campaign_stats(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')
+
+  video_campaign_srv = adwords.service(:VideoCampaignService, API_VERSION)
+
+  # Preparing dates to get stats for this year.
+  today = Date.today
+  min_date_time = today.strftime("%Y0101")
+  max_date_time = today.strftime("%Y%m%d")
+
+  # Get stats for the campaign for given dates.
+  selector = {
+    :ids => [campaign_id],
+    :stats_selector => {
+      :date_range => {:min => min_date_time, :max => max_date_time},
+      :segmentation_dimensions => ['DATE_MONTH'],
+      :metrics => ['VIEWS', 'COST', 'AVERAGE_CPV'],
+      :summary_types => ['ALL'],
+      :segmented_summary_type => 'ALL'
+    },
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  page = video_campaign_srv.get(selector)
+  if page[:entries]
+    campaign = page[:entries].first
+    puts "Campaign ID %d, name '%s' and status '%s'" %
+        [campaign[:id], campaign[:name], campaign[:status]]
+    if campaign[:stats]
+      puts "\tCampaign stats:"
+      puts "\t\t" + format_stats(campaign[:stats])
+    end
+    if campaign[:segmented_stats]
+      campaign[:segmented_stats].each do |stats|
+        segment_key_str = stats[:segment_key][:date_key][:date]
+        puts "\tCampaign segmented stat for month of %s" % segment_key_str
+        puts "\t\t" + format_stats(stats)
+      end
+    end
+  end
+  if page[:summary_stats]
+    page[:summary_stats].each do |stats|
+      puts "\tSummary of type %s" % stats[:summary_type]
+      puts "\t\t" + format_stats(stats)
+    end
+  end
+end
+
+def format_stats(stats)
+ return ("Views: %s, Cost: %s, Avg. CPC: %s, Avg. CPV: %s, " +
+         "Avg. CPM: %s, 25%%: %s, 50%%: %s, 75%%: %s, 100%%: %s") % [
+     stats[:views].nil? ? '--' : stats[:views],
+     stats[:cost].nil? ? '--' : stats[:cost][:micro_amount],
+     stats[:average_cpc].nil? ? '--' : stats[:average_cpc][:micro_amount],
+     stats[:average_cpv].nil? ? '--' : stats[:average_cpv][:micro_amount],
+     stats[:average_cpm].nil? ? '--' : stats[:average_cpm][:micro_amount],
+     stats[:quartile25_percents].nil? ? '--' : stats[:quartile25_percents],
+     stats[:quartile50_percents].nil? ? '--' : stats[:quartile50_percents],
+     stats[:quartile75_percents].nil? ? '--' : stats[:quartile75_percents],
+     stats[:quartile100_percents].nil? ? '--' : stats[:quartile100_percents]
+ ]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+  PAGE_SIZE = 500
+
+  begin
+    # Campaign ID to get stats for.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    get_campaign_stats(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/basic_operations/get_campaigns.rb → v201209/adwords_for_video/get_video_campaigns.rb}

@@ -3,7 +3,7 @@
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2013, 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.
@@ -18,13 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to retrieve all the campaigns for an account.
+# This example illustrates how to retrieve all non-deleted video campaigns for
+# an account.
 #
-# Tags: CampaignService.get
+# Note: AdWords for Video API is a Beta feature.
+#
+# Tags: VideoCampaignService.get
 
 require 'adwords_api'
+require 'date'
 
-def get_campaigns()
+def get_video_campaigns()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -33,14 +37,11 @@ def get_campaigns()
   # the configuration file or provide your own logger:
   # adwords.logger = Logger.new('adwords_xml.log')
 
-  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+  video_campaign_srv = adwords.service(:VideoCampaignService, API_VERSION)
 
-  # Get all the campaigns for this account.
+  # Get all active and paused campaigns for this account.
   selector = {
-    :fields => ['Id', 'Name', 'Status'],
-    :ordering => [
-      {:field => 'Name', :sort_order => 'ASCENDING'}
-    ],
+    :campaign_statuses => ['ACTIVE', 'PAUSED'],
     :paging => {
       :start_index => 0,
       :number_results => PAGE_SIZE
@@ -51,7 +52,7 @@ def get_campaigns()
   offset, page = 0, {}
 
   begin
-    page = campaign_srv.get(selector)
+    page = video_campaign_srv.get(selector)
     if page[:entries]
       page[:entries].each do |campaign|
         puts "Campaign ID %d, name '%s' and status '%s'" %
@@ -69,19 +70,19 @@ def get_campaigns()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201209
   PAGE_SIZE = 500
 
   begin
-    get_campaigns()
+    get_video_campaigns()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
+    puts 'HTTP Error: %s' % e
 
   # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
+    puts 'Message: %s' % e.message
     puts 'Errors:'
     e.errors.each_with_index do |error, index|
       puts "\tError [%d]:" % (index + 1)

data/examples/v201302/advanced_operations/create_and_attach_shared_keyword_set.rb

@@ -0,0 +1,139 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2013, 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 creates a shared list of negative broad match keywords, it then
+# attaches them to a campaign.
+#
+# Note: Shared sets is a Beta feature.
+#
+# Tags: SharedSetService.mutate, CampaignSharedSetService.mutate
+
+require 'adwords_api'
+require 'date'
+
+def create_and_attach_shared_keyword_set(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')
+
+  shared_set_srv = adwords.service(:SharedSetService, API_VERSION)
+  shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
+  campaign_shared_set_srv =
+      adwords.service(:CampaignSharedSetService, API_VERSION)
+
+  # Keywords to create a shared set of.
+  keywords = ['mars cruise', 'mars hotels']
+
+  # Create shared negative keyword set.
+  shared_set = {
+    :name => 'API Negative keyword list - %d' % (Time.new.to_f * 1000).to_i,
+    :type => 'NEGATIVE_KEYWORDS'
+  }
+
+  # Add shared set.
+  response = shared_set_srv.mutate([
+      {:operator => 'ADD', :operand => shared_set}
+  ])
+
+  if response and response[:value]
+    shared_set = response[:value].first
+    shared_set_id = shared_set[:shared_set_id]
+    puts "Shared set with ID %d and name '%s' was successfully added." %
+        [shared_set_id, shared_set[:name]]
+  else
+    raise StandardError, 'No shared set was added'
+  end
+
+  # Add negative keywords to shared set.
+  shared_criteria = keywords.map do |keyword|
+    {
+      :criterion => {
+        :xsi_type => 'Keyword',
+        :text => keyword,
+        :match_type => 'BROAD'
+      },
+      :negative => true,
+      :shared_set_id => shared_set_id
+    }
+  end
+
+  operations = shared_criteria.map do |criterion|
+    {:operator => 'ADD', :operand => criterion}
+  end
+
+  response = shared_criterion_srv.mutate(operations)
+  if response and response[:value]
+    response[:value].each do |shared_criterion|
+      puts "Added shared criterion ID %d '%s' to shared set with ID %d." %
+          [shared_criterion[:criterion][:id],
+           shared_criterion[:criterion][:text],
+           shared_criterion[:shared_set_id]]
+    end
+  else
+    raise StandardError, 'No shared keyword was added'
+  end
+
+  # Attach the articles to the campaign.
+  campaign_set = {
+    :campaign_id => campaign_id,
+    :shared_set_id => shared_set_id
+  }
+
+  response = campaign_shared_set_srv.mutate([
+    {:operator => 'ADD', :operand => campaign_set}
+  ])
+  if response and response[:value]
+    campaign_shared_set = response[:value].first
+    puts 'Shared set ID %d was attached to campaign ID %d' %
+        [campaign_shared_set[:shared_set_id], campaign_shared_set[:campaign_id]]
+  else
+    raise StandardError, 'No campaign shared set was added'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+
+  begin
+    # Campaign ID to attach shared keyword set to.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+    create_and_attach_shared_keyword_set(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/v201302/advanced_operations/find_and_remove_criteria_from_shared_set.rb

@@ -0,0 +1,173 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2013, 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 demonstrates how to find shared sets, shared set criterions and
+# how to remove them.
+#
+# Note: Shared sets is a Beta feature.
+#
+# Tags: CampaignSharedSetService.get
+# Tags: SharedCriterionService.get, SharedCriterionService.mutate
+
+require 'adwords_api'
+
+def find_and_remove_criteria_from_shared_set(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_shared_set_srv =
+      adwords.service(:CampaignSharedSetService, API_VERSION)
+  shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
+
+  shared_set_ids = []
+  criterion_ids = []
+
+  # First, retrieve all shared sets associated with the campaign.
+
+  # Create selector for shared sets to:
+  # - filter by campaign ID,
+  # - filter by shared set type.
+  selector = {
+    :fields => ['SharedSetId', 'CampaignId', 'SharedSetName', 'SharedSetType',
+        'Status'],
+    :predicates => [
+      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]},
+      {:field => 'SharedSetType', :operator => 'IN', :values =>
+          ['NEGATIVE_KEYWORDS', 'NEGATIVE_PLACEMENTS']}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = campaign_shared_set_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |shared_set|
+        puts "Campaign shared set ID %d and name '%s'" %
+            [shared_set[:shared_set_id], shared_set[:shared_set_name]]
+        shared_set_ids << shared_set[:shared_set_id]
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+
+  # Next, Retrieve criterion IDs for all found shared sets.
+  selector = {
+    :fields => ['SharedSetId', 'Id', 'KeywordText', 'KeywordMatchType',
+        'PlacementUrl'],
+    :predicates => [
+      {:field => 'SharedSetId', :operator => 'IN', :values => shared_set_ids}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = shared_criterion_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |shared_criterion|
+        if shared_criterion[:criterion][:type] == 'KEYWORD'
+          puts "Shared negative keyword with ID %d and text '%s' was found." %
+            [shared_criterion[:criterion][:id],
+             shared_criterion[:criterion][:text]]
+        elsif shared_criterion[:criterion][:type] == 'PLACEMENT'
+          puts "Shared negative placement with ID %d and url '%s' was found." %
+            [shared_criterion[:criterion][:id],
+             shared_criterion[:criterion][:url]]
+        else
+          puts 'Shared criterion with ID %d was found.' %
+            [shared_criterion[:criterion][:id]]
+        end
+        criterion_ids << {
+           :shared_set_id => shared_criterion[:shared_set_id],
+           :criterion_id => shared_criterion[:criterion][:id]
+        }
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+
+  # Finally, remove the criteria.
+  operations = criterion_ids.map do |criterion|
+    {
+      :operator => 'REMOVE',
+      :operand => {
+        :criterion => {:id => criterion[:criterion_id]},
+        :shared_set_id => criterion[:shared_set_id]
+      }
+    }
+  end
+
+  response = shared_criterion_srv.mutate(operations)
+  if response and response[:value]
+    response[:value].each do |criterion|
+      puts "Criterion ID %d was successfully removed from shared set ID %d." %
+          [criterion[:criterion][:id], criterion[:shared_set_id]]
+    end
+  else
+    puts 'No shared criteria were removed.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+  PAGE_SIZE = 500
+
+  begin
+    # ID of a campaign to remove shared criteria from.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+    find_and_remove_criteria_from_shared_set(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