The Campaign noun is used to model a marketing campaign. Campaigns serve to organize your marketing efforts. Campaigns contain any number of marketing activities, which are classified as either Web activities, or e-mail activities.
| BOD | Action Code / Access Profile | Action Expression | Service Provided | Sample XML Message | Client Library / Expression Builder |
|---|---|---|---|---|---|
| GetCampaign | IBM_Admin_Details | /Campaign[CampaignIdentifier[(UniqueID=)]] | Finds campaigns by campaign IDs. |
Request
Response |
findByUniqueIDs |
| IBM_Admin_Details | /Campaign[ActivityIdentifier[UniqueID=$activityId$]] | Finds a campaign by its associated activity ID. |
Request
Response |
findByActivityID | |
| IBM_Admin_Details | /Campaign | Finds all campaigns in a store. |
Request
Response |
findAll | |
| IBM_Admin_Details | /Campaign[search(CampaignIdentifier/ExternalIdentifier/Name='$searchText$' or Description='$searchText$')] | Finds all campaigns in a store by name or description. |
Request
Response |
findByNameOrDescription | |
| IBM_Admin_CampaignName | /Campaign[CampaignIdentifier[UniqueID=]] | Finds the name of a campaign in a store by the campaign ID. |
Request
Response |
MarketingFacadeClient.getCampaign | |
| ProcessCampaign | Add | Creates a new campaign. |
Request
Response |
MarketingFacadeClient.createCampaign | |
| Delete | Deletes an existing campaign. |
Request
Response |
MarketingFacadeClient.deleteCampaign | ||
| ChangeCampaign | Change | /Campaign | Updates an existing campaign. |
Request
Response |
MarketingFacadeClient.updateCampaign |
Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.
| Access Profile | Data Returned |
|---|---|
| IBM_Admin_Details |
|
| IBM_Admin_CampaignName |
|