google-adwords-api 0.9.1 → 0.9.2

data/examples/v201302/adwords_for_video/get_targeting_groups.rb

@@ -0,0 +1,93 @@
+#!/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 show how to retrieve all targeting groups for an account.
+#
+# Note: AdWords for Video API is a Beta feature.
+#
+# Tags: VideoTargetingGroupService.get
+
+require 'adwords_api'
+
+def get_targeting_groups()
+  # 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_targeting_group_srv =
+      adwords.service(:VideoTargetingGroupService, API_VERSION)
+
+  # Get all targeting groups for this account.
+  selector = {
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = video_targeting_group_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |group|
+        puts "Targeting group ID %d, campaign ID %d and name '%s'" %
+            [group[:id], group[:campaign_id], group[:name]]
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+
+  if page.include?(:total_num_entries)
+    puts "\tTotal number of targeting groups found: %d." %
+        [page[:total_num_entries]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+  PAGE_SIZE = 500
+
+  begin
+    get_targeting_groups()
+
+  # 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/adwords_for_video/get_video_campaign_criteria.rb

@@ -0,0 +1,99 @@
+#!/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 retrieve all campaign-level criteria.
+#
+# Note: AdWords for Video API is a Beta feature.
+#
+# Tags: VideoCampaignCriterionService.get
+
+require 'adwords_api'
+
+def get_video_campaign_criteria(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')
+
+  vtgc_srv =
+      adwords.service(:VideoCampaignCriterionService, API_VERSION)
+
+  # Get all criteria for the campaign.
+  selector = {
+    :campaign_ids => [campaign_id],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = vtgc_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |criterion|
+        negative_str =
+            (criterion[:xsi_type] == 'NegativeVideoCampaignCriterion') ?
+            ' negative' : ''
+        puts "Video%s criterion ID %d or type '%s'" % [negative_str,
+            criterion[:criterion][:id], criterion[:criterion][:xsi_type]]
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+
+  if page.include?(:total_num_entries)
+    puts "\tTotal number of criteria found: %d." % [page[:total_num_entries]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+  PAGE_SIZE = 500
+
+  begin
+    # Campaign ID to get criteria for.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+    get_video_campaign_criteria(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/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 = :v201302
+  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/v201302/adwords_for_video/get_video_campaigns.rb

@@ -0,0 +1,94 @@
+#!/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 all non-deleted video campaigns for
+# an account.
+#
+# Note: AdWords for Video API is a Beta feature.
+#
+# Tags: VideoCampaignService.get
+
+require 'adwords_api'
+require 'date'
+
+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
+
+  # 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)
+
+  # Get all active and paused campaigns for this account.
+  selector = {
+    :campaign_statuses => ['ACTIVE', 'PAUSED'],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = video_campaign_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |campaign|
+        puts "Campaign ID %d, name '%s' and status '%s'" %
+            [campaign[:id], campaign[:name], campaign[:status]]
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+
+  if page.include?(:total_num_entries)
+    puts "\tTotal number of campaigns found: %d." % [page[:total_num_entries]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+  PAGE_SIZE = 500
+
+  begin
+    get_video_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/lib/adwords_api.rb

@@ -61,15 +61,15 @@ module AdwordsApi
     # - SOAP header handler
     #
     def soap_header_handler(auth_handler, version, header_ns, default_ns)
-      auth_method = @config.read('authentication.method', :CLIENTLOGIN)
+      auth_method = @config.read('authentication.method', :OAUTH2)
       handler_class = case auth_method
         when :CLIENTLOGIN
-            AdwordsApi::ClientLoginHeaderHandler
+          AdwordsApi::ClientLoginHeaderHandler
         when :OAUTH2, :OAUTH2_JWT
-            AdsCommon::SavonHeaders::OAuthHeaderHandler
+          AdsCommon::SavonHeaders::OAuthHeaderHandler
         else
-            raise AdsCommon::Errors::AuthError,
-                "Unknown auth method: %s" % auth_method
+          raise AdsCommon::Errors::AuthError,
+              "Unknown auth method: %s" % auth_method
         end
       return handler_class.new(@credential_handler, auth_handler, header_ns,
                                   default_ns, version)

data/lib/adwords_api/api_config.rb

@@ -117,7 +117,14 @@ module AdwordsApi
           :SharedSetService,
           :TargetingIdeaService,
           :TrafficEstimatorService,
-          :UserListService
+          :UserListService,
+          # AdWords for Video API Beta services.
+          :VideoAdService,
+          :VideoCampaignCriterionService,
+          :VideoCampaignService,
+          :VideoService,
+          :VideoTargetingGroupCriterionService,
+          :VideoTargetingGroupService
       ]
     }
 
@@ -205,7 +212,14 @@ module AdwordsApi
       [:v201302, :UserListService] => 'cm/',
       [:v201302, :ManagedCustomerService] => 'mcm/',
       [:v201302, :CustomerService] => 'mcm/',
-      [:v201302, :BudgetService] => 'cm/'
+      [:v201302, :BudgetService] => 'cm/',
+      # AdWords for Video API Beta services.
+      [:v201302, :VideoAdService] => 'video/',
+      [:v201302, :VideoCampaignCriterionService] => 'video/',
+      [:v201302, :VideoCampaignService] => 'video/',
+      [:v201302, :VideoService] => 'video/',
+      [:v201302, :VideoTargetingGroupCriterionService] => 'video/',
+      [:v201302, :VideoTargetingGroupService] => 'video/'
     }
 
     # Auth constants for ClientLogin method.