google-adwords-api 0.8.2 → 0.9.0

data/examples/v201206/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 = :v201206
-
-  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/v201206/basic_operations/add_ad_groups.rb

@@ -1,136 +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 ad groups. To get a list of existing
-# campaigns run get_campaigns.rb.
-#
-# Tags: AdGroupService.mutate
-
-require 'adwords_api'
-
-def add_ad_groups(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')
-
-  ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
-
-  ad_groups = [
-    {
-      :name => "Earth to Mars Cruises #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'ENABLED',
-      :campaign_id => campaign_id,
-      :bids => {
-        # 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 => 'ManualCPCAdGroupBids',
-        :keyword_max_cpc => {
-          :amount => {
-            :micro_amount => 10000000
-          }
-        },
-        # Optional field.
-        :keyword_content_max_cpc => {:amount => {:micro_amount => 2000000}}
-      },
-      :settings => [
-        # Targetting restriction settings - these setting only affect serving
-        # for the Display Network.
-        {
-          :xsi_type => 'TargetingSetting',
-          :details => [
-            # Restricting to serve ads that match your ad group placements.
-            {
-              :xsi_type => 'TargetingSettingDetail',
-              :criterion_type_group => 'PLACEMENT',
-              :target_all => true
-            },
-            # Using your ad group verticals only for bidding.
-            {
-              :xsi_type => 'TargetingSettingDetail',
-              :criterion_type_group => 'VERTICAL',
-              :target_all => false
-            }
-          ]
-        }
-      ]
-    },
-    {
-      :name => 'Earth to Pluto Cruises #%d' % (Time.new.to_f * 1000).to_i,
-      :status => 'ENABLED',
-      :campaign_id => campaign_id,
-      :bids => {
-        # 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 => 'ManualCPCAdGroupBids',
-        :keyword_max_cpc => {
-          :amount => {
-            :micro_amount => 10000000
-          }
-        }
-      }
-    }
-  ]
-
-  # Prepare operations for adding ad groups.
-  operations = ad_groups.map do |ad_group|
-    {:operator => 'ADD', :operand => ad_group}
-  end
-
-  # Add ad groups.
-  response = ad_group_srv.mutate(operations)
-  if response and response[:value]
-    response[:value].each do |ad_group|
-      puts "Ad group ID %d was successfully added." % ad_group[:id]
-    end
-  else
-    raise StandardError, 'No ad group was added'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-
-  begin
-    # Campaign ID to add ad group to.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-    add_ad_groups(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/add_campaigns.rb

@@ -1,151 +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 campaigns.
-#
-# Tags: CampaignService.mutate
-
-require 'adwords_api'
-require 'date'
-
-def add_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)
-
-  campaigns = [
-    {
-      :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'
-      },
-      # Set the campaign network options to Search and Search Network.
-      :network_setting => {
-        :target_google_search => true,
-        :target_search_network => true,
-        :target_content_network => true
-      },
-      # Optional fields:
-      :start_date =>
-          DateTime.parse((Date.today + 1).to_s).strftime('%Y%m%d'),
-      :ad_serving_optimization_status => 'ROTATE',
-      :settings => [
-        # Display network targeting settings (optional).
-        # It can only be enabled, shown only for demonstration purposes.
-        # If not set this setting is enabled by default on ADD operations.
-        {
-          :xsi_type => 'TargetRestrictSetting',
-          :use_ad_group => true
-        },
-        {
-          :xsi_type => 'GeoTargetTypeSetting',
-          :positive_geo_target_type => 'DONT_CARE',
-          :negative_geo_target_type => 'DONT_CARE'
-        },
-        {
-          :xsi_type => 'KeywordMatchSetting',
-          :opt_in => true
-        }
-      ],
-      :frequency_cap => {
-        :impressions => '5',
-        :time_unit => 'DAY',
-        :level => 'ADGROUP'
-      }
-    },
-    {
-      :name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'PAUSED',
-      :bidding_strategy => {
-        :xsi_type => 'ManualCPM'
-      },
-      :budget => {
-        :period => 'DAILY',
-        :amount => {:micro_amount => 150000000},
-        :delivery_method => 'STANDARD'
-      },
-      :settings => [
-        {
-          :xsi_type => 'KeywordMatchSetting',
-          :opt_in => true
-        }
-      ],
-      :network_setting => {
-        :target_google_search => false,
-        :target_search_network => false,
-        :target_content_network => true
-      }
-    }
-  ]
-
-  # Prepare for adding campaign.
-  operations = campaigns.map do |campaign|
-    {:operator => 'ADD', :operand => campaign}
-  end
-
-  # Add campaign.
-  response = 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 = :v201206
-
-  begin
-    add_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/v201206/basic_operations/add_keywords.rb

@@ -1,108 +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 add multiple keywords to a given ad group. To
-# create an ad group, run add_ad_group.rb.
-#
-# Tags: AdGroupCriterionService.mutate
-
-require 'adwords_api'
-
-def add_keywords(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_criterion_srv =
-      adwords.service(:AdGroupCriterionService, API_VERSION)
-
-  # Create keywords.
-  # 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.
-  keywords = [
-    {:xsi_type => 'BiddableAdGroupCriterion',
-     :ad_group_id => ad_group_id,
-     :criterion => {
-       :xsi_type => 'Keyword',
-       :text => 'mars cruise',
-       :match_type => 'BROAD'
-     },
-     # Optional fields:
-     :user_status => 'PAUSED',
-     :destination_url => 'http://example.com/mars'
-    },
-    {:xsi_type => 'BiddableAdGroupCriterion',
-     :ad_group_id => ad_group_id,
-     :criterion => {
-       :xsi_type => 'Keyword',
-       :text => 'space hotel',
-       :match_type => 'BROAD'}}
-  ]
-
-  # Create 'ADD' operations.
-  operations = keywords.map do |keyword|
-    {:operator => 'ADD', :operand => keyword}
-  end
-
-  # Add keywords.
-  response = ad_group_criterion_srv.mutate(operations)
-  if response and response[:value]
-    ad_group_criteria = response[:value]
-    puts "Added %d keywords to ad group ID %d:" %
-        [ad_group_criteria.length, ad_group_id]
-    ad_group_criteria.each do |ad_group_criterion|
-      puts "\tKeyword ID is %d and type is '%s'" %
-          [ad_group_criterion[:criterion][:id],
-           ad_group_criterion[:criterion][:type]]
-    end
-  else
-    raise StandardError, 'No keywords were added.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-
-  begin
-    # Ad group ID to add keywords to.
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    add_keywords(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