Wrapper class for the v200909 AdParam service. This class is automatically generated.

Methods
G
M
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::V200909::AdParamService::ClassName

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

Class Public methods
new(driver, api)

Constructor for AdParamServiceWrapper.

Args:

  • driver: SOAP::RPC::Driver object with the remote SOAP methods for this service
  • api: the AdWords::API object to which the wrapper belongs
# File lib/adwords4r/v200909/AdParamServiceWrapper.rb, line 34
        def initialize(driver, api)
          @driver = driver
          @api = api
          @module = AdWords::V200909::AdParamService
        end
Instance Public methods
get(selector)

Calls the get method of the AdParam service. Check the online documentation for this method.

Args:

Returns:

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

# File lib/adwords4r/v200909/AdParamServiceWrapper.rb, line 52
        def get(selector)
          begin
            AdWords::Service.validate_param('selector',
                selector, AdWords::V200909::AdParamService::AdParamSelector)
            # Construct request object and make API call
            obj = AdWords::V200909::AdParamService::Get.new(selector)
            return @driver.get(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "get Call Failed: " + fault.faultstring.to_s, caller)
          end
        end
mutate(operations)

Calls the mutate method of the AdParam service. Check the online documentation for this method.

Args:

Returns:

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

# File lib/adwords4r/v200909/AdParamServiceWrapper.rb, line 77
        def mutate(operations)
          begin
            AdWords::Service.validate_param('operations',
                operations, SOAP::SOAPArray)
            # Construct request object and make API call
            obj = AdWords::V200909::AdParamService::Mutate.new(operations)
            return @driver.mutate(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "mutate Call Failed: " + fault.faultstring.to_s, caller)
          end
        end