Update Keywords in Ruby

The following example shows how to update a keyword using the Campaign Management UpdateKeywords service operation.

This example has been developed and run within the environment described in Getting Started Using Ruby with Bing Ads Services.

System_CLiX_note Note

This example uses the UserName and Password elements for authentication. For Managing User Authentication with OAuth, replace the UserName and Password elements with the AuthenticationToken, which is your OAuth access token.


# This example modifies the ExactMatchBid element of an existing keyword. Nothing 
# else about the keyword is changed. The keywordId parameter specifies the 
# keyword to modify. The newBid parameter contains the new bid value.

require 'soap/wsdlDriver'
require 'soap/header/simplehandler'
require 'soap/baseData'

NS_SHARED = "https://adcenter.microsoft.com/v8"

# This is a helper class that is used
# to construct the request header.
class RequestHeader < SOAP::Header::SimpleHandler
    def initialize (element, value)
        super(XSD::QName.new(NS_SHARED, element))
        @element = element
        @value   = value
    end

    def on_simple_outbound
        @value
    end
end

# This is a helper class that constructs
# a Bid data object for a keyword.
class Bid
    def initialize(bidAmount)
    {
        @Amount => bidAmount
    }
    end

    def on_simple_outbound
        @Amount
    end
end

# This is a helper class that is used 
# to construct a Keyword data object.
class Keyword
    attr_accessor :Text, :BroadMatchBid, 
        :ContentMatchBid, :EditorialStatus, :ExactMatchBid, 
        :Id, :NegativeKeywords, :Param1, 
        :Param2, :Param3, :PhraseMatchBid, :Status
end

def ModifyKeyword(
    username, 
    password,
    appToken, 
    devToken,
    customerAccountId, 
    customerId,
    adGroupId,
    keywordId,
    newBid)

    # Create the WSDL driver reference to access the Web service.
    wsdl = SOAP::WSDLDriverFactory.new("https://sandboxapi.adcenter.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementService.svc?wsdl")

    # Create an instance of the CampaignManagement Web service.
    service = wsdl.create_rpc_driver

    # For SOAP debugging information,
    # uncomment the following statement.
    # service.wiredump_dev = STDERR

    # Set the header information.
    service.headerhandler << RequestHeader.new('ApplicationToken',
        "#{appToken}")
    service.headerhandler << RequestHeader.new('CustomerAccountId',
        "#{customerAccountId}")
    service.headerhandler << RequestHeader.new('CustomerId',
        "#{customerId}")
    service.headerhandler << RequestHeader.new('DeveloperToken',
        "#{devToken}")
    service.headerhandler << RequestHeader.new('UserName',
        "#{username}")
    service.headerhandler << RequestHeader.new('Password',
        "#{password}")

    keywords                     = Array.new

    keywords[0]                  = Keyword.new

    keywords[0].Id               = "#{keywordId}"
    keywords[0].ExactMatchBid    = Bid.new("#{newBid}")
    keywords[0].EditorialStatus  = SOAP::SOAPNil.new
    keywords[0].Status           = SOAP::SOAPNil.new

    request = 
    {
        :AdGroupId => "#{adGroupId}",
        :Keywords  => keywords
    }

    begin
        # Perform the service operation.
        response = service.UpdateKeywords(request)

    # Exception handling.
    rescue SOAP::FaultError => fault
        detail = fault.detail

        # Capture any generic errors.
        if detail.respond_to?('adApiFaultDetail')

            # Get the AdApiFaultDetail object.
            adApiErrors = detail.adApiFaultDetail.errors.adApiError

            if !adApiErrors.respond_to?('each')
                adApiErrors = [adApiErrors]
            end

            adApiErrors.each do |error|
                print "Ad API error" \
                    " '#{error.message}' (#{error.code}) encountered.\n"
            end

        # Capture API exceptions.
        elsif detail.respond_to?('apiFaultDetail')
            detail = detail.apiFaultDetail

            # Display any service operation errors.
            if detail.operationErrors.respond_to?('operationError')
                operationErrors = detail.operationErrors.operationError

                if !operationErrors.respond_to?('each')
                    operationErrors = [operationErrors]
                end
                
                operationErrors.each do |opError|
                    print "Operation error" \
                        " '#{opError.message}' (#{opError.code}) encountered.\n"
                end
            end

            # Display any batch errors.
            if detail.batchErrors.respond_to?('batchError')
                batchErrors = detail.batchErrors.batchError

                if !batchErrors.respond_to?('each')
                    batchErrors = [batchErrors]
                end

                batchErrors.each do |batchError|
                    print "Batch error" \
                        " '#{batchError.message}' (#{batchError.code})" \
                        " encountered for item" \
                        " #{keywords[Integer("#{batchError.index}")].Text}.\n"
                end
            end

        # Capture any generic SOAP exceptions.
        else
            print "Generic SOAP fault" \
                " '#{detail.exceptionDetail.message}' encountered.\n"
        end

    # Capture exceptions on the client that are unrelated to
    # the Bing Ads API. An example would be an 
    # out-of-memory condition on the client.
    rescue Exception => e
        puts "Error '#{e.exception.message}' encountered."
    end
end

Community Additions

Show: