google-adwords-api 0.10.0 → 0.11.0

data/test/examples/v201302/test_targeting.rb

@@ -1,68 +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.
-#
-# Tests the targeting examples.
-
-require 'test/unit'
-
-require 'targeting/add_campaign_targeting_criteria'
-require 'targeting/add_demographic_targeting_criteria'
-require 'targeting/get_campaign_targeting_criteria'
-require 'targeting/get_targetable_languages_and_carriers'
-require 'targeting/lookup_location'
-
-class TestTargetingV201302 < Test::Unit::TestCase
-  def setup
-    @logger = Logger.new(STDOUT)
-    @logger.level = Logger::ERROR
-    @adwords = AdwordsApi::Api.new
-    @adwords.logger = @logger
-    @utils = UtilsV201302.new(@adwords)
-  end
-
-  def test_add_campaign_targeting_criteria
-    campaign = @utils.get_campaign()
-    assert_not_nil(campaign)
-    assert_not_nil(campaign[:id])
-    add_campaign_targeting_criteria(campaign[:id])
-  end
-
-  def test_add_demographic_targeting_criteria
-    ad_group = @utils.get_ad_group()
-    assert_not_nil(ad_group)
-    assert_not_nil(ad_group[:id])
-    add_demographic_targeting_criteria(ad_group[:id])
-  end
-
-  def test_get_campaign_targeting_criteria
-    campaign = @utils.get_campaign()
-    assert_not_nil(campaign)
-    assert_not_nil(campaign[:id])
-    get_campaign_targeting_criteria(campaign[:id])
-  end
-
-  def test_get_targetable_languages_and_carriers
-    get_targetable_languages_and_carriers()
-  end
-
-  def test_lookup_location
-    lookup_location()
-  end
-end

data/test/examples/v201302/utils.rb

@@ -1,267 +0,0 @@
-# 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.
-#
-# Utilities and constants for example tests.
-
-API_VERSION = :v201302
-PAGE_SIZE = 500
-
-class UtilsV201302
-  def initialize(adwords)
-    @adwords = adwords
-  end
-
-  def get_budget
-    @budget ||= create_budget()
-    return @budget
-  end
-
-  def get_campaign
-    @campaign ||= create_campaign()
-    return @campaign
-  end
-
-  def get_ad_group
-    @ad_group ||= create_ad_group()
-    return @ad_group
-  end
-
-  def get_ad
-    @ad ||= create_ad(get_ad_group()[:id])
-    return @ad
-  end
-
-  def get_keyword
-    @keyword ||= create_keyword(get_ad_group()[:id])
-    return @keyword
-  end
-
-  def get_location_extension
-    @location_extension ||= create_location_extension(get_campaign()[:id])
-    return @location_extension
-  end
-
-  def get_experiment
-    @experiment ||= create_experiment(
-        get_campaign()[:id], get_ad_group()[:id], get_keyword[:criterion][:id])
-    return @experiment
-  end
-
-  private
-
-  def create_campaign()
-    budget = get_budget()
-    budget_id = budget[:budget_id]
-
-    campaign_srv = @adwords.service(:CampaignService, API_VERSION)
-    campaign = {
-      :name => "Example tests campaign #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'PAUSED',
-      :bidding_strategy_configuration => {
-        :bidding_strategy_type => 'MANUAL_CPC'
-      },
-      :budget => {:budget_id => budget_id},
-      :network_setting => {
-        :target_google_search => true,
-        :target_search_network => true,
-        :target_content_network => true
-      },
-      :settings => [
-        {
-          :xsi_type => 'KeywordMatchSetting',
-          :opt_in => true
-        }
-      ]
-    }
-    operation = {:operator => 'ADD', :operand => campaign}
-    response = campaign_srv.mutate([operation])
-    return response[:value].first
-  end
-
-  def create_budget()
-    budget_srv = @adwords.service(:BudgetService, API_VERSION)
-    budget = {
-      :name => 'Example tests budget #%d' % (Time.new.to_f * 1000).to_i,
-      :amount => {:micro_amount => 50000000},
-      :delivery_method => 'STANDARD',
-      :period => 'DAILY'
-    }
-    operation = {:operator => 'ADD', :operand => budget}
-    response = budget_srv.mutate([operation])
-    return response[:value].first
-  end
-
-  def create_ad_group()
-    campaign = get_campaign()
-    ad_group_srv = @adwords.service(:AdGroupService, API_VERSION)
-    ad_group = {
-      :name => "Example tests ad group #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'ENABLED',
-      :campaign_id => campaign[:id],
-      :bidding_strategy_configuration => {
-        :bids => [
-          {
-            :xsi_type => 'CpcBid',
-            :bid => {:micro_amount => 10000000}
-          }
-        ]
-      }
-    }
-    operation = {:operator => 'ADD', :operand => ad_group}
-    response = ad_group_srv.mutate([operation])
-    return response[:value].first
-  end
-
-  def create_ad(ad_group_id)
-    ad_group_ad_srv = @adwords.service(:AdGroupAdService, API_VERSION)
-    text_ad = {
-      :xsi_type => 'TextAd',
-      :headline => 'Examples test ad %d' % (Time.new.to_f * 1000).to_i,
-      :description1 => 'testing ruby examples',
-      :description2 => 'all your base are belong to us',
-      :url => 'http://www.example.com',
-      :display_url => 'www.example.com'
-    }
-    operation = {:operator => 'ADD',
-                 :operand => {:ad_group_id => ad_group_id, :ad => text_ad}}
-    response = ad_group_ad_srv.mutate([operation])
-    return response[:value].first
-  end
-
-  def create_keyword(ad_group_id)
-    ad_group_criterion_srv =
-        @adwords.service(:AdGroupCriterionService, API_VERSION)
-    keyword = {
-      :xsi_type => 'BiddableAdGroupCriterion',
-      :ad_group_id => ad_group_id,
-      :criterion => {
-        :xsi_type => 'Keyword',
-        :text => 'mars cruise',
-        :match_type => 'BROAD'
-      }
-    }
-    operation = {:operator => 'ADD', :operand => keyword}
-    response = ad_group_criterion_srv.mutate([operation])
-    return response[:value].first
-  end
-
-  def create_location_extension(campaign_id)
-    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'
-        }
-      ]
-    }
-
-    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 => {
-            :xsi_type => 'LocationExtension',
-            :address => location[:address],
-            :geo_point => location[:geo_point],
-            :encoded_location => location[:encoded_location],
-            :source => 'ADWORDS_FRONTEND'
-          }
-        }
-      }
-    end
-
-    response = campaign_ad_ext_srv.mutate(operations)
-    extension = response[:value].first
-    return extension
-  end
-
-  def create_experiment(campaign_id, ad_group_id, criterion_id)
-    experiment_srv = @adwords.service(:ExperimentService, API_VERSION)
-    ad_group_srv = @adwords.service(:AdGroupService, API_VERSION)
-    ad_group_criterion_srv =
-        @adwords.service(:AdGroupCriterionService, API_VERSION)
-
-    operation = {
-      :operator => 'ADD',
-      :operand => {
-        :campaign_id => campaign_id,
-        :name => "Examples test experiment #%d" % (Time.new.to_f * 1000).to_i,
-        :query_percentage => 10,
-        :start_date_time => Time.now.strftime('%Y%m%d %H%M%S'),
-      }
-    }
-    response = experiment_srv.mutate([operation])
-    experiment = response[:value].first
-
-    raise StandardError, 'Failed to create experiment' if experiment.nil?
-
-    ad_group = {
-      :id => ad_group_id,
-      :experiment_data => {
-        :experiment_id => experiment[:id],
-        :experiment_delta_status => 'MODIFIED',
-        :experiment_bid_multipliers => {
-          :xsi_type => 'ManualCPCAdGroupExperimentBidMultipliers',
-          :max_cpc_multiplier => {:multiplier => 1.5}
-        }
-      }
-    }
-
-    operation = {:operator => 'SET', :operand => ad_group}
-    response = ad_group_srv.mutate([operation])
-    ad_group = response[:value].first
-
-    raise StandardError, 'Failed to assign experiment' if ad_group.nil?
-
-    ad_group_criterion = {
-      :xsi_type => 'BiddableAdGroupCriterion',
-      :ad_group_id => ad_group_id,
-      :criterion => {:id => criterion_id},
-      :experiment_data => {
-        :xsi_type => 'BiddableAdGroupCriterionExperimentData',
-        :experiment_id => experiment[:id],
-        :experiment_delta_status => 'MODIFIED',
-        :experiment_bid_multiplier => {
-          :xsi_type => 'ManualCPCAdGroupCriterionExperimentBidMultiplier',
-          :max_cpc_multiplier => {:multiplier => 1.5}
-        }
-      }
-    }
-
-    operation = {:operator => 'SET', :operand => ad_group_criterion}
-    response = ad_group_criterion_srv.mutate([operation])
-    criterion = response[:value].first
-
-    raise StandardError, 'Failed to assign criterion' if criterion.nil?
-
-    return experiment
-  end
-end

data/test/suite_exampletests_v201302.rb

@@ -1,37 +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.
-#
-# Test suite for v201302 example tests.
-
-require 'test/unit'
-
-$:.unshift File.expand_path('../../lib/', __FILE__)
-$:.unshift File.expand_path('../../', __FILE__)
-
-version = 'v201302'
-
-examples_path =
-    File.expand_path(File.join('..', '..', 'examples', version), __FILE__)
-$:.unshift(examples_path)
-
-tests_path = File.join(File.dirname(__FILE__), 'examples', version)
-require File.join(tests_path, 'utils.rb')
-tests_mask = File.join(tests_path, 'test_*.rb')
-Dir.glob(tests_mask).each {|file| require file}

data/test/templates/v201302/basic_operations_get_campaigns.def

@@ -1,114 +0,0 @@
-def setup_mocks()
-  $api_config = {
-    :service => {:environment => 'PRODUCTION'},
-    :authentication => {
-      :method => 'ClientLogin',
-      :email => 'noreply@google.com',
-      :password => 'noreply_password',
-      :developer_token => 'dev_token123',
-      :client_customer_id => '123-456-7890',
-      :user_agent => 'ruby-tests'
-    }
-  }
-
-  stub_request(:post, "https://www.google.com/accounts/ClientLogin").
-    with(:body => {"Email"=>"noreply@google.com", "Passwd"=>"noreply_password", "accountType"=>"GOOGLE", "service"=>"adwords"}).
-    to_return(:status => 200, :body => "SID=abcSIDbcd\nLSID=abcLSIDbcd\nAuth=abcAuthbcd\n", :headers => {})
-
-  stub_request(:post, "https://adwords.google.com/api/adwords/cm/v201302/CampaignService").
-    with(
-      :body =>
-      # autogenerated code
-        {"env:Envelope"=>
-          {"env:Header"=>
-            {"wsdl:RequestHeader"=>
-              {"userAgent"=>"ruby-tests (AwApi-Ruby/0.10.0, Common-Ruby/0.9.5, Savon/1.2.0, ruby/1.9.3, HTTPI/1.1.1, net_http)",
-               "developerToken"=>"dev_token123",
-               "clientCustomerId"=>"123-456-7890",
-               "authToken"=>"abcAuthbcd",
-               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201302"}},
-           "env:Body"=>
-            {"get"=>
-              {"serviceSelector"=>
-                {"fields"=>["Id", "Name", "Status"],
-                 "ordering"=>{"field"=>"Name", "sortOrder"=>"ASCENDING"},
-                 "paging"=>{"startIndex"=>"0", "numberResults"=>"5"}},
-               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201302"}},
-           "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
-           "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
-           "xmlns:wsdl"=>"https://adwords.google.com/api/adwords/cm/v201302",
-           "xmlns:env"=>"http://schemas.xmlsoap.org/soap/envelope/"}},
-      # end of auto-generated code.
-      :headers => {
-        'SOAPAction' => '"get"',
-        'Content-Type' => 'text/xml;charset=UTF-8'
-      }
-    ).
-    to_return(
-      :status => 200,
-      :body => '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
-                <soap:Header>
-                  <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v201302">
-                    <requestId>0004c</requestId>
-                    <serviceName>CampaignService</serviceName>
-                    <methodName>get</methodName>
-                    <operations>42</operations>
-                    <responseTime>84</responseTime>
-                    <units>42</units>
-                  </ResponseHeader>
-                </soap:Header>
-                <soap:Body>
-                  <getResponse xmlns="https://adwords.google.com/api/adwords/cm/v201302">
-                    <rval>
-                      <totalNumEntries>2</totalNumEntries>
-                      <Page.Type>CampaignPage</Page.Type>
-                      <totalBudget>
-                        <period>DAILY</period><amount><ComparableValue.Type>Money</ComparableValue.Type>
-                        <microAmount>0</microAmount></amount>
-                      </totalBudget>
-                      <entries>
-                        <id>15</id><name>Campaign name 1</name><status>PAUSED</status><campaignStats><network>ALL</network>
-                        <Stats.Type>CampaignStats</Stats.Type></campaignStats><frequencyCap><impressions>0</impressions></frequencyCap>
-                      </entries>
-                      <entries>
-                        <id>16</id><name>Campaign name 2</name><status>ACTIVE</status><campaignStats><network>ALL</network>
-                        <Stats.Type>CampaignStats</Stats.Type></campaignStats><frequencyCap><impressions>150</impressions></frequencyCap>
-                      </entries>
-                    </rval>
-                  </getResponse>
-                </soap:Body>
-                </soap:Envelope>',
-      :headers => {'content-type' => 'text/xml;'}
-    )
-end
-
-def run_asserts()
-  assert_equal(2, $latest_result[:total_num_entries])
-  assert_equal('CampaignPage', $latest_result[:page_type])
-  entries = $latest_result[:entries]
-  assert_equal(2, entries.size)
-
-  if entries[0][:id] == 15
-    assert_campaign_15(entries[0])
-    assert_campaign_16(entries[1])
-  else
-    assert_campaign_15(entries[1])
-    assert_campaign_16(entries[0])
-  end
-end
-
-def assert_campaign_15(entry)
-  assert_equal(15, entry[:id])
-  assert_equal('Campaign name 1', entry[:name])
-  assert_equal('PAUSED', entry[:status])
-  assert_equal({:network=>"ALL", :stats_type=>"CampaignStats"}, entry[:campaign_stats])
-  assert_equal({:impressions=>0}, entry[:frequency_cap])
-end
-
-def assert_campaign_16(entry)
-  assert_equal(16, entry[:id])
-  assert_equal('Campaign name 2', entry[:name])
-  assert_equal('ACTIVE', entry[:status])
-  assert_equal({:network=>"ALL", :stats_type=>"CampaignStats"}, entry[:campaign_stats])
-  assert_equal({:impressions=>150}, entry[:frequency_cap])
-end