google-adwords-api 0.9.3 → 0.10.0

data/examples/v201209/account_management/get_client_customer_id.rb

@@ -1,88 +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 find a client customer ID for a client email.
-# We recommend to use this script as a one off to convert your identifiers to
-# IDs and store them for future use.
-#
-# Note: This code example uses MCC-level calls and won't work with Test
-# Accounts, see: https://developers.google.com/adwords/api/docs/test-accounts
-#
-# Tags: InfoService.get
-
-require 'adwords_api'
-require 'adwords_api/utils'
-
-def get_client_customer_id(client_email)
-  # 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')
-
-  info_srv = adwords.service(:InfoService, API_VERSION)
-
-  today = Time.new.strftime('%Y%m%d')
-  selector = {
-    :client_emails => [client_email],
-    :api_usage_type => 'UNIT_COUNT_FOR_CLIENTS',
-    :include_sub_accounts => true,
-    :date_range => {:min => today, :max => today}
-  }
-
-  # Get the information for client email address.
-  info = adwords.use_mcc() {info_srv.get(selector)}
-
-  if info and info[:api_usage_records]
-    api_usage_records = info[:api_usage_records]
-    api_usage_records.each do |record|
-      puts "Found record with client email '%s' and ID %s." %
-          [record[:client_email],
-           AdwordsApi::Utils.format_id(record[:client_customer_id])]
-    end
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201209
-
-  begin
-    # Email address to find ID for.
-    client_email = 'INSERT_EMAIL_ADDRESS_HERE'
-    get_client_customer_id(client_email)
-
-  # 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/v201209/account_management/get_client_unit_usage.rb

@@ -1,90 +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 retrieve the number of API units usage for a
-# client account for the current month.
-#
-# Note: This code example uses MCC-level calls and won't work with Test
-# Accounts, see: https://developers.google.com/adwords/api/docs/test-accounts
-#
-# Tags: InfoService.get
-
-require 'adwords_api'
-
-def get_client_unit_usage(client_customer_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')
-
-  info_srv = adwords.service(:InfoService, API_VERSION)
-
-  start_date = Time.now.strftime('%Y%m01')
-  end_date = Time.now.strftime('%Y%m%d')
-
-  selector = {
-    :api_usage_type => 'UNIT_COUNT_FOR_CLIENTS',
-    :client_customer_ids => [client_customer_id],
-    # Set to true to navigate your entire accounts tree.
-    :include_sub_accounts => 1,
-    :date_range => {
-      :min => start_date,
-      :max => end_date
-    }
-  }
-
-  # Force to use the MCC credentials.
-  adwords.use_mcc do
-    # Get the unit info.
-    info_srv.get(selector) do |header, response|
-      puts "Total number of units consumed from %s to %s is %d." %
-          [start_date, end_date, response[:cost]]
-      puts "Number of units consumed by this request is %d" % header[:units]
-    end
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201209
-
-  begin
-    # Specify client customer ID for the account to get usage for.
-    client_customer_id = 'INSERT_CLIENT_CUSTOMER_ID_HERE'.to_i
-    get_client_unit_usage(client_customer_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/v201209/adwords_for_video/add_video_campaign.rb

@@ -1,103 +0,0 @@
-#!/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 create a video campaign.
-#
-# Note: AdWords for Video API is a Beta feature.
-#
-# Tags: VideoCampaignService.mutate, BudgetService.mutate
-
-require 'adwords_api'
-require 'date'
-
-def add_video_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')
-
-  budget_srv = adwords.service(:BudgetService, API_VERSION)
-  video_campaign_srv = adwords.service(:VideoCampaignService, API_VERSION)
-
-  # Create a budget, which can be shared by multiple campaigns.
-  budget = {
-    :name => 'Video budget #%d' % (Time.new.to_f * 1000).to_i,
-    :amount => {:micro_amount => 50000000},
-    :delivery_method => 'STANDARD',
-    :period => 'DAILY'
-  }
-  budget_operation = {:operator => 'ADD', :operand => budget}
-
-  # Add budget.
-  return_budget = budget_srv.mutate([budget_operation])
-  budget_id = return_budget[:value].first[:budget_id]
-
-  # Create video campaign.
-  campaigns = [{
-    :name => "Interplanetary Video #%d" % (Time.new.to_f * 1000).to_i,
-    :status => 'PAUSED',
-    :budget_id => budget_id,
-    # Optional fields:
-    :start_date =>
-        DateTime.parse((Date.today + 1).to_s).strftime('%Y%m%d'),
-  }]
-
-  # Prepare for adding campaign.
-  operations = campaigns.map do |campaign|
-    {:operator => 'ADD', :operand => campaign}
-  end
-
-  # Add video campaign.
-  response = video_campaign_srv.mutate(operations)
-  if response and response[:value]
-    response[:value].each do |campaign|
-      puts "Campaign with name '%s' and ID %d was added." %
-          [campaign[:name], campaign[:id]]
-    end
-  else
-    raise new StandardError, 'No campaigns were added.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201209
-
-  begin
-    add_video_campaign()
-
-  # 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/v201209/adwords_for_video/find_videos.rb

@@ -1,92 +0,0 @@
-#!/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 find YouTube videos by a search string. It
-# retrieve details for the first 100 matching videos.
-#
-# Note: AdWords for Video API is a Beta feature.
-#
-# Tags: VideoService.search
-
-require 'adwords_api'
-
-def find_videos()
-  # 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_srv = adwords.service(:VideoService, API_VERSION)
-
-  # Search string to use.
-  query_str = 'AdWords API with Ruby'
-
-  # Create a selector.
-  selector = {
-    :search_type => 'VIDEO',
-    :query => query_str,
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Run the query.
-  page = video_srv.search(selector)
-
-  if page[:entries]
-    page[:entries].each do |video|
-      puts "YouTube video ID '%s' with title '%s' found." %
-          [video[:id], video[:title]]
-    end
-    if page.include?(:total_num_entries)
-      puts "\tTotal number of matching videos: %d." % [page[:total_num_entries]]
-    end
-  else
-    puts "No videos matching '%s' were found." % query_str
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201209
-  PAGE_SIZE = 100
-
-  begin
-    find_videos()
-
-  # 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/v201209/adwords_for_video/get_keyword_criteria.rb

@@ -1,101 +0,0 @@
-#!/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 keywords for a video campaign. To get
-# a list with all campaigns, run get_video_campaigns.rb.
-#
-# Note: AdWords for Video API is a Beta feature.
-#
-# Tags: VideoTargetingGroupCriterionService.get
-
-require 'adwords_api'
-
-def get_keyword_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(:VideoTargetingGroupCriterionService, API_VERSION)
-
-  # Get all the keywords for the campaign.
-  selector = {
-    :campaign_ids => [campaign_id],
-    :criterion_types => ['SEARCH_KEYWORD'],
-    :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 |keyword|
-        negative_string =
-            ('NegativeTargetingGroupCriterion'.eql?(keyword[:xsi_type])) ?
-            ' (negative)' : ''
-        puts "Criterion%s ID %d, targeting group ID %d and text '%s'" %
-            [negative_string, keyword[:criterion][:id],
-             keyword[:targeting_group_id], keyword[:criterion][:text]]
-      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 keywords found: %d." % [page[:total_num_entries]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201209
-  PAGE_SIZE = 500
-
-  begin
-    # Campaign ID to get criteria for.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-    get_keyword_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