Wrapper class for the v13 KeywordTool service. This class is automatically generated.

Methods
G
N
Attributes
[R] api

Holds the AdWords::API object to which the wrapper belongs.

[R] module

Holds a shortcut to the parent module. Use this to avoid typing the full class name when creating classes belonging to this service, e.g. 

 service_object.module::ClassName

instead of 

 AdWords::V13::KeywordToolService::ClassName

This will make it easier to migrate your code between API versions.

Class Public methods
new(driver, api)

Constructor for KeywordToolServiceWrapper.

Args:

  • driver: SOAP::RPC::Driver object with the remote SOAP methods for this service
  • api: the AdWords::API object to which the wrapper belongs

Source: show 

# File lib/adwords4r/v13/KeywordToolServiceWrapper.rb, line 34
        def initialize(driver, api)
          @driver = driver
          @api = api
          @module = AdWords::V13::KeywordToolService
        end
Instance Public methods
getKeywordVariations(seedKeywords, useSynonyms, languages, countries)

Calls the getKeywordVariations method of the KeywordTool service. Check the online documentation for this method.

Args:

Returns:

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

Source: show 

# File lib/adwords4r/v13/KeywordToolServiceWrapper.rb, line 55
        def getKeywordVariations(seedKeywords, useSynonyms, languages, countries)
          begin
            AdWords::Service.validate_param('seedKeywords',
                seedKeywords, SOAP::SOAPArray)
            AdWords::Service.validate_param('useSynonyms',
                useSynonyms, SOAP::SOAPBoolean)
            AdWords::Service.validate_param('languages',
                languages, SOAP::SOAPArray)
            AdWords::Service.validate_param('countries',
                countries, SOAP::SOAPArray)
            # Construct request object and make API call
            obj = AdWords::V13::KeywordToolService::GetKeywordVariations.new(seedKeywords, useSynonyms, languages, countries)
            return @driver.getKeywordVariations(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "getKeywordVariations Call Failed: " + fault.faultstring.to_s, caller)
          end
        end
getKeywordsFromSite(url, includeLinkedPages, languages, countries)

Calls the getKeywordsFromSite method of the KeywordTool service. Check the online documentation for this method.

Args:

  • url: SOAP::SOAPString
  • includeLinkedPages: SOAP::SOAPBoolean
  • languages: SOAP::SOAPArray of SOAP::SOAPString
  • countries: SOAP::SOAPArray of SOAP::SOAPString

Returns:

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

Source: show 

# File lib/adwords4r/v13/KeywordToolServiceWrapper.rb, line 89
        def getKeywordsFromSite(url, includeLinkedPages, languages, countries)
          begin
            AdWords::Service.validate_param('url',
                url, SOAP::SOAPString)
            AdWords::Service.validate_param('includeLinkedPages',
                includeLinkedPages, SOAP::SOAPBoolean)
            AdWords::Service.validate_param('languages',
                languages, SOAP::SOAPArray)
            AdWords::Service.validate_param('countries',
                countries, SOAP::SOAPArray)
            # Construct request object and make API call
            obj = AdWords::V13::KeywordToolService::GetKeywordsFromSite.new(url, includeLinkedPages, languages, countries)
            return @driver.getKeywordsFromSite(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "getKeywordsFromSite Call Failed: " + fault.faultstring.to_s, caller)
          end
        end