google-adwords-api 0.5.0 → 0.5.1

data/examples/v201109/optimization/get_keyword_opportunities.rb

@@ -1,96 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
-#
-# 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 reads all the keyword opportunities for the customer.
-#
-# Tags: BulkOpportunityService.get
-
-require 'rubygems'
-require 'adwords_api'
-require 'adwords_api/utils'
-
-API_VERSION = :v201109
-PAGE_SIZE = 20
-
-def get_keyword_opportunities()
-  # 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')
-
-  bulk_opportunity_srv = adwords.service(:BulkOpportunityService, API_VERSION)
-
-  # Construct selector object.
-  selector = {
-    :requested_attribute_types => ['KEYWORD', 'IDEA_TYPE'],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Perform request.
-  ideas = []
-  index = 0
-  begin
-    page = bulk_opportunity_srv.get(selector)
-    if page and page[:entries]
-      page[:entries].each do |entry|
-        ideas += entry[:opportunity_ideas] if entry[:opportunity_ideas]
-      end
-    end
-    break if page[:total_num_entries] <= index
-    index += PAGE_SIZE
-    selector[:paging][:start_index] = index
-  end while page[:total_num_entries] > index
-
-  # Display results.
-  ideas.each do |idea|
-    data = AdwordsApi::Utils.map(idea[:data])
-    keyword = data['KEYWORD'][:value][:text]
-    idea_type = data['IDEA_TYPE'][:value]
-    puts " Found opportunity idea of type \"%s\": \"%s\"" % [idea_type, keyword]
-  end
-  puts "Total opportunity ideas: %d." % [ideas.length]
-end
-
-if __FILE__ == $0
-  begin
-    get_keyword_opportunities()
-
-  # 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/v201109/bulk_opportunity_service.rb

@@ -1,34 +0,0 @@
-# Encoding: utf-8
-#
-# This is auto-generated code, changes will be overwritten.
-#
-# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
-# License:: Licensed under the Apache License, Version 2.0.
-#
-# Code generated by AdsCommon library 0.6.2 on 2012-01-23 14:06:11.
-
-require 'ads_common/savon_service'
-require 'adwords_api/v201109/bulk_opportunity_service_registry'
-
-module AdwordsApi; module V201109; module BulkOpportunityService
-  class BulkOpportunityService < AdsCommon::SavonService
-    def initialize(api, endpoint)
-      namespace = 'https://adwords.google.com/api/adwords/o/v201109'
-      super(api, endpoint, namespace, :v201109)
-    end
-
-    def get(*args, &block)
-      return execute_action('get', args, &block)
-    end
-
-    private
-
-    def get_service_registry()
-      return BulkOpportunityServiceRegistry
-    end
-
-    def get_module()
-      return AdwordsApi::V201109::BulkOpportunityService
-    end
-  end
-end; end; end

data/lib/adwords_api/v201109/bulk_opportunity_service_registry.rb

@@ -1,46 +0,0 @@
-# Encoding: utf-8
-#
-# This is auto-generated code, changes will be overwritten.
-#
-# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
-# License:: Licensed under the Apache License, Version 2.0.
-#
-# Code generated by AdsCommon library 0.6.2 on 2012-01-23 14:06:11.
-
-require 'adwords_api/errors'
-
-module AdwordsApi; module V201109; module BulkOpportunityService
-  class BulkOpportunityServiceRegistry
-    BULKOPPORTUNITYSERVICE_METHODS = {:get=>{:input=>[{:type=>"BulkOpportunitySelector", :min_occurs=>0, :max_occurs=>1, :name=>:selector}], :output=>{:fields=>[{:type=>"BulkOpportunityPage", :min_occurs=>0, :max_occurs=>1, :name=>:rval}], :name=>"get_response"}}}
-    BULKOPPORTUNITYSERVICE_TYPES = {:OpportunityIdeaType=>{:fields=>[]}, :OpportunityAttributeType=>{:fields=>[]}, :MoneyAttribute=>{:fields=>[{:type=>"Money", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :InStreamAdInfoAttribute=>{:fields=>[{:type=>"InStreamAdInfo", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :SoapResponseHeader=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:request_id}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:service_name}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:method_name}, {:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:operations}, {:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:response_time}, {:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:units}], :ns=>0}, :Product=>{:fields=>[{:type=>"ProductCondition", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:conditions}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:text}], :base=>"Criterion", :ns=>0}, :Paging=>{:fields=>[{:type=>"int", :min_occurs=>0, :max_occurs=>1, :name=>:start_index}, {:type=>"int", :min_occurs=>0, :max_occurs=>1, :name=>:number_results}], :ns=>0}, :"BidLandscape.LandscapePoint"=>{:fields=>[{:type=>"Money", :min_occurs=>0, :max_occurs=>1, :name=>:bid}, {:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:clicks}, {:type=>"Money", :min_occurs=>0, :max_occurs=>1, :name=>:cost}, {:type=>"Money", :min_occurs=>0, :max_occurs=>1, :name=>:marginal_cpc}, {:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:impressions}], :ns=>0}, :BulkOpportunitySelector=>{:fields=>[{:type=>"OpportunityIdeaType", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:idea_types}, {:type=>"OpportunityAttributeType", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:requested_attribute_types}, {:type=>"Paging", :min_occurs=>0, :max_occurs=>1, :name=>:paging}]}, :WebpageDescriptor=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:url}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:title}]}, :ProductConditionOperand=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:operand}], :ns=>0}, :StringAttribute=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :MonthlySearchVolume=>{:fields=>[{:type=>"int", :min_occurs=>0, :max_occurs=>1, :name=>:year}, {:type=>"int", :min_occurs=>0, :max_occurs=>1, :name=>:month}, {:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:count}]}, :DataEntry=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:data_entry_type}], :ns=>0, :abstract=>true}, :Criterion=>{:fields=>[{:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:id}, {:type=>"Criterion.Type", :min_occurs=>0, :max_occurs=>1, :name=>:type}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:criterion_type}], :ns=>0}, :"SiteConstants.PlacementType"=>{:fields=>[]}, :OpportunityAttribute_AttributeMapEntry=>{:fields=>[{:type=>"OpportunityAttributeType", :min_occurs=>0, :max_occurs=>1, :name=>:key}, {:type=>"Attribute", :min_occurs=>0, :max_occurs=>1, :name=>:value}]}, :WebpageDescriptorAttribute=>{:fields=>[{:type=>"WebpageDescriptor", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :"CriterionUserList.MembershipStatus"=>{:fields=>[], :ns=>0}, :CriterionUserInterest=>{:fields=>[{:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:user_interest_id}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:user_interest_name}], :base=>"Criterion", :ns=>0}, :NumberValue=>{:fields=>[], :base=>"ComparableValue", :ns=>0, :abstract=>true}, :BidLandscape=>{:fields=>[{:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:campaign_id}, {:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:ad_group_id}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:start_date}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:end_date}, {:type=>"BidLandscape.LandscapePoint", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:landscape_points}], :base=>"DataEntry", :ns=>0, :abstract=>true}, :CriterionAttribute=>{:fields=>[{:type=>"Criterion", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :MonthlySearchVolumeAttribute=>{:fields=>[{:type=>"MonthlySearchVolume", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:value}], :base=>"Attribute"}, :IntegerAttribute=>{:fields=>[{:type=>"int", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :Keyword=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:text}, {:type=>"KeywordMatchType", :min_occurs=>0, :max_occurs=>1, :name=>:match_type}], :base=>"Criterion", :ns=>0}, :ComparableValue=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:comparable_value_type}], :ns=>0, :abstract=>true}, :OpportunityIdea=>{:fields=>[{:type=>"OpportunityAttribute_AttributeMapEntry", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:data}]}, :LongAttribute=>{:fields=>[{:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :CriterionUserList=>{:fields=>[{:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:user_list_id}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:user_list_name}, {:type=>"CriterionUserList.MembershipStatus", :min_occurs=>0, :max_occurs=>1, :name=>:user_list_membership_status}], :base=>"Criterion", :ns=>0}, :Attribute=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:attribute_type}], :abstract=>true}, :Range=>{:fields=>[{:type=>"ComparableValue", :min_occurs=>0, :max_occurs=>1, :name=>:min}, {:type=>"ComparableValue", :min_occurs=>0, :max_occurs=>1, :name=>:max}]}, :OpportunityIdeaTypeAttribute=>{:fields=>[{:type=>"OpportunityIdeaType", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :IntegerSetAttribute=>{:fields=>[{:type=>"int", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:value}], :base=>"Attribute"}, :KeywordMatchType=>{:fields=>[], :ns=>0}, :DoubleValue=>{:fields=>[{:type=>"double", :min_occurs=>0, :max_occurs=>1, :name=>:number}], :base=>"NumberValue", :ns=>0}, :Opportunity=>{:fields=>[{:type=>"OpportunityIdea", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:opportunity_ideas}]}, :BidLandscapeAttribute=>{:fields=>[{:type=>"BidLandscape", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :IdeaTypeAttribute=>{:fields=>[{:type=>"IdeaType", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :Vertical=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:path}], :base=>"Criterion", :ns=>0}, :CriterionBidLandscape=>{:fields=>[{:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:criterion_id}], :base=>"BidLandscape", :ns=>0}, :PlacementAttribute=>{:fields=>[{:type=>"Placement", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :KeywordAttribute=>{:fields=>[{:type=>"Keyword", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :DoubleAttribute=>{:fields=>[{:type=>"double", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :AdFormatSpec=>{:fields=>[{:type=>"SiteConstants.AdFormat", :min_occurs=>0, :max_occurs=>1, :name=>:format}]}, :IdeaType=>{:fields=>[]}, :BulkOpportunityPage=>{:fields=>[{:type=>"Opportunity", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:entries}, {:type=>"int", :min_occurs=>0, :max_occurs=>1, :name=>:total_num_entries}]}, :LongRangeAttribute=>{:fields=>[{:type=>"Range", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :InStreamAdInfo=>{:fields=>[{:type=>"int", :min_occurs=>0, :max_occurs=>1, :name=>:max_ad_duration}, {:type=>"int", :min_occurs=>0, :max_occurs=>1, :name=>:min_ad_duration}, {:type=>"int", :min_occurs=>0, :max_occurs=>1, :name=>:median_ad_duration}, {:type=>"double", :min_occurs=>0, :max_occurs=>1, :name=>:pre_roll_percent}, {:type=>"double", :min_occurs=>0, :max_occurs=>1, :name=>:mid_roll_percent}, {:type=>"double", :min_occurs=>0, :max_occurs=>1, :name=>:post_roll_percent}]}, :BooleanAttribute=>{:fields=>[{:type=>"boolean", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :SoapHeader=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:auth_token}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:client_customer_id}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:developer_token}, {:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:user_agent}, {:type=>"boolean", :min_occurs=>0, :max_occurs=>1, :name=>:validate_only}, {:type=>"boolean", :min_occurs=>0, :max_occurs=>1, :name=>:partial_failure}], :ns=>0}, :ProductCondition=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:argument}, {:type=>"ProductConditionOperand", :min_occurs=>0, :max_occurs=>1, :name=>:operand}], :ns=>0}, :Money=>{:fields=>[{:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:micro_amount}], :base=>"ComparableValue", :ns=>0}, :"SiteConstants.AdFormat"=>{:fields=>[]}, :PlacementTypeAttribute=>{:fields=>[{:type=>"SiteConstants.PlacementType", :min_occurs=>0, :max_occurs=>1, :name=>:value}], :base=>"Attribute"}, :AdFormatSpecListAttribute=>{:fields=>[{:type=>"AdFormatSpec", :min_occurs=>0, :max_occurs=>:unbounded, :name=>:value}], :base=>"Attribute"}, :"Criterion.Type"=>{:fields=>[], :ns=>0}, :"AdGroupBidLandscape.Type"=>{:fields=>[], :ns=>0}, :Placement=>{:fields=>[{:type=>"string", :min_occurs=>0, :max_occurs=>1, :name=>:url}], :base=>"Criterion", :ns=>0}, :LongValue=>{:fields=>[{:type=>"long", :min_occurs=>0, :max_occurs=>1, :name=>:number}], :base=>"NumberValue", :ns=>0}, :AdGroupBidLandscape=>{:fields=>[{:type=>"AdGroupBidLandscape.Type", :min_occurs=>0, :max_occurs=>1, :name=>:type}, {:type=>"boolean", :min_occurs=>0, :max_occurs=>1, :name=>:landscape_current}], :base=>"BidLandscape", :ns=>0}}
-    BULKOPPORTUNITYSERVICE_NAMESPACES = ["https://adwords.google.com/api/adwords/cm/v201109"]
-
-    def self.get_method_signature(method_name)
-      return BULKOPPORTUNITYSERVICE_METHODS[method_name.to_sym]
-    end
-
-    def self.get_type_signature(type_name)
-      return BULKOPPORTUNITYSERVICE_TYPES[type_name.to_sym]
-    end
-
-    def self.get_namespace(index)
-      return BULKOPPORTUNITYSERVICE_NAMESPACES[index]
-    end
-  end
-
-  # Base class for exceptions.
-  class ApplicationException < AdwordsApi::Errors::ApiException
-    attr_reader :message  # string
-    attr_reader :application_exception_type  # string
-  end
-
-  # Exception class for holding a list of service errors.
-  class ApiException < ApplicationException
-    attr_reader :errors  # ApiError
-    def initialize(exception_fault)
-      @array_fields ||= []
-      @array_fields << 'errors'
-      super(exception_fault)
-    end
-  end
-end; end; end