Submit an Ad Group for Approval in Ruby

The following example shows how to submit an ad group for editorial approval using the Campaign Management SubmitAdGroupForApproval 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.

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

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

def SubmitAdGroupForApprovalLib(
    username,
    password,
    devToken,
    customerId,
    accountId,
    adgroupId)

    # Create the WSDL driver reference to access the Web service.
    wsdl = SOAP::WSDLDriverFactory.new("https://api.sandbox.bingads.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementService.svc?wsdl")
    
    service = wsdl.create_rpc_driver
    
    # For SOAP debugging information,
    # uncomment the following statement.
    # service.wiredump_dev = STDERR

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

    # Create a string literal that contains the SOAP request body.
    submitadgroupforapprovalrequest = %{
        <SubmitAdGroupForApprovalRequest xmlns="https://adcenter.microsoft.com/v8">
          <AdGroupId>#{adgroupId}</AdGroupId>
        </SubmitAdGroupForApprovalRequest>

    }

    begin
        # Convert the string literal that contains
        # the SOAP request body to an XML document.
        request = REXML::Document.new(submitadgroupforapprovalrequest)
        
        response = service.SubmitAdGroupForApproval(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 any service operation exceptions.
        elsif detail.respond_to?('apiFaultDetail')
            operationErrors = \
                detail.apiFaultDetail.operationErrors.operationError
            if !operationErrors.respond_to?('each')
                operationErrors = [operationErrors]
            end

            # Display service operation error information.
            operationErrors.each do |opError|
                print "Operation error" \
                    " '#{opError.message}' (#{opError.code}) encountered.\n"
            end

        # Capture any generic SOAP exceptions.
        else
            print "Generic SOAP fault" \
                " '#{detail}' encountered."
        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
        print "Error '#{e.exception.message}' encountered."
    end
end

begin
    SubmitAdGroupForApprovalLib(
    "<usernamegoeshere>",
    "<passwordgoeshere>",
    "<devtokengoeshere>",
    <customeridgoeshere>,
    <accountidgoeshere>,
    <adgroupidgoeshere>)
end

Community Additions

Show: