gCast SOAP API - Campaign Method

    Follow

    Purpose of the Campaign Method
    The Campaign integration method handles updating and retrieving campaign details, including creating new campaigns, editing existing campaigns, and sending campaigns. Corporate and larger clients may find this method useful where those clients prefer to manage campaigns and content outside of gCast, but use gCast to schedule and send those campaigns.

    The Campaign method operations currently available are (in alphabetical order):

    GetCampaign

    GetCampaignMemberCount

    GetCampaignStatistics

    ProcessCampaign

    ProcessCampaignResult

    SendCampaignTest

    UpdateCampaign

    UpdateCampaignMembers

    GetCampaign
    Purpose
    This operation is useful for clients who want to search for and retrieve results for one, some, or all campaigns (although we advise to use ‘all’ sparingly as the results can be verbose).
    API Requests
    API requests can be passed to gCast requesting data on all campaigns, or on specific campaigns based on an internal ID (gCast’s unique 32-character GUID), campaign external ID (your externally assigned unique identifier), or collection code (ROI-related).
    API Returns
    The API will return a list campaign details (including content) that match the request’s search parameters.

    GetCampaignMemberCount
    Purpose
    This operation is useful for clients that want to check how many members will be included in a campaign.
    API Requests
    API requests can be passed to gCast requesting a member count for one or more campaigns based on internal campaign ID (gCast’s unique 32-character GUID) or campaign external ID (your externally assigned unique identifier).
    API Returns
    The API will return a list of member counts based on the request’s search parameters.

    GetCampaignStatistics
    Purpose
    This operation is useful for clients who want to retrieve campaign send data for further external reporting. It is especially useful for multi-site clients who want to consolidate reports outside of gCast.
    API Requests
    API requests can be passed to gCast requesting send data on one or more campaigns based on internal campaign ID (gCast’s unique 32-character GUID) or campaign external ID (your externally assigned unique identifier).
    API Returns
    The API will return, on a per campaign basis, send data including sent to, read, complaints, bounces, and opt outs.

    ProcessCampaign
    Purpose
    This operation is designed to be used in conjunction with the UpdateCampaign operation. It is useful for clients that want to submit a campaign to a specified list of recipients for immediate processing in gCast. These recipients must already exist in gCast.
    API Requests
    API requests can be passed to gCast submitting a specified list of recipients, identified by user ID (gCast’s unique 32-character GUID), external ID (your externally assigned unique identifier), or username (gCast login username, if assigned) to receive a specified campaign, identified by internal campaign ID (gCast’s unique 32-character GUID) or campaign external ID (your externally assigned unique identifier).
    API Returns
    The API will return a unique batch job ID (32-character GUID) that you can use to retrieve the batch submission at a later point in time (using the ProcessCampaignResult operation). It will also return a series of messages in XML code. Each message will contain the message severity, message code, message text, record number, and reference ID:

    • Message severity - ‘Information’, ‘Warning’, or ‘Error’
    • Message code – a list of message codes can be retrieved using the Lookup method
    • Message text – a brief description of the nature of the message
    • Record number – this will correspond to the line number of the record that was passed in via the request
    • Reference ID – this will correspond to a unique identifier relevant to the record that was passed in via the request (e.g. demographic attribute reference, external ID)

    ProcessCampaignResult
    Purpose
    This operation is used for the purpose of retrieving the results of the ProcessCampaign operation. You would start calling this operation no sooner than 5 minutes after calling the ProcessCampaign operation, and probably call it every few minutes thereafter until you receive a status indicating completion or failure.
    API Requests
    API requests can be passed to gCast containing one or a list of unique IDs (per the ProcessCampaign operation).
    API Returns
    The API will return a batch status of ‘Not Found’, ‘Queued’, or ‘Processing’ up until the batch itself is no longer considered to be ‘in progress’, at which point a batch status of ‘Complete’ will be returned along with a series of messages in XML code. Each message will contain the message severity, message code, message text, record number, and reference ID:

    • Message severity - ‘Information’, ‘Warning’, or ‘Error’
    • Message code – a list of message codes can be retrieved using the Lookup method
    • Message text – a brief description of the nature of the message
    • Record number – this will correspond to the line number of the record that was passed in via the request
    • Reference ID – this will correspond to a unique identifier relevant to the record that was passed in via the request (e.g. demographic attribute reference, external ID)

    SendCampaignTest
    Purpose
    This operation is useful for clients who want to send a test campaign email (for proof-reading purposes) to a specified list of email recipients (limit of 5 recipients). In particular, clients managing campaigns and content externally to gCast would find this operation of use.
    API Requests
    API requests can be passed to gCast submitting a specified list of email addresses (max. of 5), one or more gCast users that are staff members identified by user ID (gCast’s unique 32-character GUID), external ID (your externally assigned unique identifier), or username (gCast login username, if assigned) to receive a test email for a specified campaign, identified by internal campaign ID (gCast’s unique 32-character GUID) or campaign external ID (your externally assigned unique identifier).
    API Returns
    Along with a campaign test email to the recipients’ inbox, the API will return a series of messages in XML code. Each message will contain the message severity, message code, message text, record number, and reference ID:

    • Message severity - ‘Information’, ‘Warning’, or ‘Error’
    • Message code – a list of message codes can be retrieved using the Lookup method
    • Message text – a brief description of the nature of the message
    • Record number – this will correspond to the line number of the record that was passed in via the request
    • Reference ID – this will correspond to a unique identifier relevant to the record that was passed in via the request (e.g. demographic attribute reference, external ID)

    UpdateCampaign
    Purpose
    This operation is useful for clients that administer their campaigns and content externally but want to synchronise that data into their gCast database. Campaigns updated via this operation can be sent to a nominated list of members or to all active, opted-in members. Please note that campaigns passed to gCast in this manner cannot have demographic attributes defined via the API. Demographic attributes can be defined in gCast if required.
    API Requests
    API requests can be passed to gCast requesting data on one or more campaigns based on an internal ID (gCast’s unique 32-character GUID), campaign external ID (your externally assigned unique identifier), or collection code (ROI-related).
    API Returns
    The API will return a series of messages in XML code. Each message will contain the message severity, message code, message text, record number, and reference ID:

    • Message severity - ‘Information’, ‘Warning’, or ‘Error’
    • Message code – a list of message codes can be retrieved using the Lookup method
    • Message text – a brief description of the nature of the message
    • Record number – this will correspond to the line number of the record that was passed in via the request
    • Reference ID – this will correspond to a unique identifier relevant to the record that was passed in via the request (e.g. demographic attribute reference, external ID)

    UpdateCampaignMembers
    Purpose
    This operation is used for the purpose of updating an existing campaign in gCast that is being sent to a nominated list of members. Using this operation you can add to, delete from, or replace members in an existing nominated member list.
    API Requests
    API requests can be passed to gCast submitting an action of add, delete, or replace along with a list of members, identified by user ID (gCast’s unique 32-character GUID), external ID (your externally assigned unique identifier), or username (gCast login username, if assigned) to update the nominated member list for a specified campaign, identified by internal campaign ID (gCast’s unique 32-character GUID) or campaign external ID (your externally assigned unique identifier).
    API Returns
    The API will return a series of messages in XML code. Each message will contain the message severity, message code, message text, record number, and reference ID:

    • Message severity - ‘Information’, ‘Warning’, or ‘Error’
    • Message code – a list of message codes can be retrieved using the Lookup method
    • Message text – a brief description of the nature of the message
    • Record number – this will correspond to the line number of the record that was passed in via the request
    • Reference ID – this will correspond to a unique identifier relevant to the record that was passed in via the request (e.g. demographic attribute reference, external ID)
    Was this article helpful?
    0 out of 0 found this helpful

    Comments