public class MarketingFacadeClient extends AbstractMarketingFacadeClient
This class provides common methods that this and other utility classes of the Marketing facade can use. This class also provides a set of convenient Java APIs to represent particular Marketing operations. This set of Java APIs also include APIs for Web-based requests to transform the name value pair request into the appropriate request documents.
Constructor and Description |
---|
MarketingFacadeClient()
Creates an instance of the client to communicate with the Marketing facade.
|
MarketingFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
Creates an instance of the client to communicate with the Marketing facade.
|
Modifier and Type | Method and Description |
---|---|
AcknowledgeActivityDataAreaType | activateActivity(java.util.List activityIdList)
This method activates activities.
|
AcknowledgeActivityDataAreaType | activateActivity(java.lang.String activityId)
This method activates an activity.
|
protected ActivityType | buildActivityDataObject(java.lang.String activityId)
This method creates an activity object to use in process service calls.
|
protected CampaignType | buildCampaignDataObject(java.lang.String campaignId)
This method creates a campaign object to use in process service calls.
|
protected CampaignElementType | buildCampaignElementDataObject(java.lang.String elementName)
This method creates an campaign element object to use in process service calls.
|
protected MarketingContentType | buildMarketingContentDataObject(java.lang.String marketingContentId)
This method creates a marketing content object to use in process service calls.
|
protected MarketingEmailTemplateType | buildMarketingEmailTemplateDataObject(java.lang.String emailTemplateId)
This method creates a marketing e-mail template object to use in process service calls.
|
protected MarketingSpotType | buildMarketingSpotDataObject(java.lang.String emspotId)
This method creates a marketing spot object to use in process service calls.
|
protected ProcessActivityType | buildProcessActivityDataObject()
This method returns a new instance of the ProcessActivityType object.
|
protected ProcessCampaignType | buildProcessCampaignDataObject()
This method returns a new instance of the ProcessCampaignType object.
|
protected ProcessMarketingContentType | buildProcessMarketingContentDataObject()
This method returns a new instance of the ProcessMarketingContentType object.
|
protected ProcessMarketingEmailTemplateType | buildProcessMarketingEmailTemplateDataObject()
This method returns a new instance of the ProcessMarketingEmailTemplateType object.
|
protected ProcessMarketingSpotType | buildProcessMarketingSpotDataObject()
This method returns a new instance of the ProcessMarketingSpotType object.
|
protected ProcessMarketingTriggerType | buildProcessMarketingTriggerDataObject()
This method returns a new instance of the ProcessMarketingTriggerType object.
|
protected RespondActivityDataAreaType | changeActivity(java.util.List activityList, java.lang.String type)
This method sets up the objects to call the change activity service to change activities.
|
protected RespondActivityDataAreaType | changeActivity(java.lang.String[] actions, ActivityType[] activities, java.lang.String[] expressions)
This method changes a marketing activity.
|
protected RespondCampaignDataAreaType | changeCampaign(java.util.List campaignList, java.lang.String type)
This method sets up the objects to call the change campaign service to change campaigns.
|
protected RespondCampaignDataAreaType | changeCampaign(java.lang.String[] actions, CampaignType[] campaigns, java.lang.String[] expressions)
This method changes a campaign.
|
protected RespondActivityDataAreaType | changeElement(java.util.List elementList, java.util.List activityIdList, java.lang.String type)
This method sets up the objects to call the change activity service to change campaign elements.
|
protected RespondActivityDataAreaType | changeElementsInActivity(java.util.List elementList, java.lang.String activityId, java.lang.String type)
This method sets up the objects to call the change activity service to change campaign elements in an activity.
|
protected RespondMarketingContentDataAreaType | changeMarketingContent(java.util.List marketingContentList, java.lang.String type)
This method sets up the objects to call the change marketing content service to change marketing content.
|
protected RespondMarketingContentDataAreaType | changeMarketingContent(java.lang.String[] actions, MarketingContentType[] marketingContent, java.lang.String[] expressions)
This method changes a marketing content.
|
protected RespondMarketingContentDataAreaType | changeMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList, java.lang.String type)
This method sets up the objects to call the change marketing content service to change attachments.
|
protected RespondMarketingContentDataAreaType | changeMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList, java.lang.String type)
This method sets up the objects to call the change marketing content service to change descriptions.
|
protected RespondMarketingContentDataAreaType | changeMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList, java.lang.String type)
This method sets up the objects to call the change marketing content service to change image maps.
|
protected RespondMarketingEmailTemplateDataAreaType | changeMarketingEmailTemplate(java.util.List emailTemplateList, java.lang.String type)
This method sets up the objects to call the change marketing e-mail template service to change marketing e-mail templates.
|
protected RespondMarketingEmailTemplateDataAreaType | changeMarketingEmailTemplate(java.lang.String[] actions, MarketingEmailTemplateType[] emailTemplates, java.lang.String[] expressions)
This method changes a marketing e-mail template.
|
protected RespondMarketingSpotDataAreaType | changeMarketingSpot(java.util.List emspotList, java.lang.String type)
This method sets up the objects to call the change marketing spot service to change marketing spots.
|
protected RespondMarketingSpotDataAreaType | changeMarketingSpot(java.lang.String[] actions, MarketingSpotType[] emspots, java.lang.String[] expressions)
This method changes a marketing spot.
|
protected RespondMarketingSpotDataAreaType | changeMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList, java.lang.String type)
This method sets up the objects to call the change marketing spot service to change default content.
|
protected RespondMarketingSpotDataAreaType | changeMarketingSpotTitle(java.util.List defaultTitleList, java.util.List marketingSpotIdList, java.lang.String type)
This method sets up the objects to call the change marketing spot service to change default title.
|
AcknowledgeActivityDataAreaType | createActivity(ActivityType activity)
This method builds and sends a request to create a marketing activity.
|
AcknowledgeActivityDataAreaType | createActivity(java.util.List activityList)
This method builds and then sends a request to create activities.
|
AcknowledgeCampaignDataAreaType | createCampaign(CampaignType campaign)
This method builds and then sends a request to create a campaign.
|
AcknowledgeCampaignDataAreaType | createCampaign(java.util.List campaignList)
This method builds and then sends a request to create campaigns.
|
protected ChangeActivityType | createChangeActivityDataObject()
This method creates an instance of ChangeActivityType object.
|
protected ChangeCampaignType | createChangeCampaignDataObject()
This method creates an instance of ChangeCampaignType object.
|
protected ChangeMarketingContentType | createChangeMarketingContentDataObject()
This method creates an instance of ChangeMarketingContentType object.
|
protected ChangeMarketingEmailTemplateType | createChangeMarketingEmailTemplateDataObject()
This method creates an instance of ChangeMarketingEmailTemplateType object.
|
protected ChangeMarketingSpotType | createChangeMarketingSpotDataObject()
This method creates an instance of ChangeMarketingSpotType object.
|
RespondActivityDataAreaType | createElement(CampaignElementType element, java.lang.String activityId)
This method builds and then sends a request to create a campaign element.
|
RespondActivityDataAreaType | createElement(java.util.List elementList, java.util.List activityIdList)
This method builds and then sends a request to create campaign elements.
|
protected RespondActivityDataAreaType | createElementsInActivity(java.util.List elementList, java.lang.String activityId)
This method sets up the objects to call the change activity service to create campaign elements in an activity.
|
AcknowledgeMarketingContentDataAreaType | createMarketingContent(java.util.List marketingContentList)
This method builds and then sends a request to create marketing content.
|
AcknowledgeMarketingContentDataAreaType | createMarketingContent(MarketingContentType marketingContent)
This method builds and then sends a request to create a marketing content.
|
RespondMarketingContentDataAreaType | createMarketingContentAttachment(AttachmentReferenceType attachment, java.lang.String marketingContentId)
This method builds and then sends a request to create a marketing content attachment reference.
|
RespondMarketingContentDataAreaType | createMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList)
This method builds and then sends a request to create a marketing content attachment reference.
|
RespondMarketingContentDataAreaType | createMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList)
This method builds and then sends a request to create marketing content descriptions.
|
RespondMarketingContentDataAreaType | createMarketingContentDescription(MarketingContentDescriptionType description, java.lang.String marketingContentId)
This method builds and then sends a request to create a marketing content description.
|
RespondMarketingContentDataAreaType | createMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList)
This method builds and then sends a request to create marketing content image maps.
|
RespondMarketingContentDataAreaType | createMarketingContentImageMap(MarketingContentImageMapType imageMap, java.lang.String marketingContentId)
This method builds and then sends a request to create a marketing content image map.
|
AcknowledgeMarketingEmailTemplateDataAreaType | createMarketingEmailTemplate(java.util.List emailTemplateList)
This method builds and then sends a request to create marketing e-mail templates.
|
AcknowledgeMarketingEmailTemplateDataAreaType | createMarketingEmailTemplate(MarketingEmailTemplateType emailTemplate)
This method builds and then sends a request to create a marketing e-mail template.
|
AcknowledgeMarketingSpotDataAreaType | createMarketingSpot(java.util.List emspotList)
This method builds and then sends a request to create marketing spots.
|
AcknowledgeMarketingSpotDataAreaType | createMarketingSpot(MarketingSpotType emspot)
This method builds and then sends a request to create a marketing spot.
|
RespondMarketingSpotDataAreaType | createMarketingSpotDefaultContent(DefaultContentType defaultContent, java.lang.String marketingSpotId)
This method builds and then sends a request to create a marketing spot default content.
|
RespondMarketingSpotDataAreaType | createMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList)
This method builds and then sends a request to create marketing spot default content.
|
RespondMarketingSpotDataAreaType | createMarketingSpotTitle(DefaultMarketingSpotTitleType marketingSpotTitle, java.lang.String marketingSpotId)
This method builds and then sends a request to create a marketing spot default title.
|
RespondMarketingSpotDataAreaType | createMarketingSpotTitle(java.util.List titleList, java.util.List marketingSpotIdList)
This method builds and then sends a request to create marketing spot default title.
|
AcknowledgeActivityDataAreaType | deactivateActivity(java.util.List activityIdList)
This method deactivates activities.
|
AcknowledgeActivityDataAreaType | deactivateActivity(java.lang.String activityId)
This method deactivates an activity.
|
AcknowledgeActivityDataAreaType | deleteActivity(java.util.List activityIdList)
This method deletes activities.
|
AcknowledgeActivityDataAreaType | deleteActivity(java.lang.String activityId)
This method builds and then sends a request to delete a marketing activity.
|
AcknowledgeCampaignDataAreaType | deleteCampaign(java.util.List campaignIdList)
This method deletes campaigns.
|
AcknowledgeCampaignDataAreaType | deleteCampaign(java.lang.String campaignId)
This method builds and then sends a request to delete a campaign.
|
RespondActivityDataAreaType | deleteElement(java.util.List elementNameList, java.util.List activityIdList)
This method deletes campaign elements.
|
RespondActivityDataAreaType | deleteElement(java.lang.String elementName, java.lang.String activityId)
This method deletes a campaign element.
|
AcknowledgeMarketingContentDataAreaType | deleteMarketingContent(java.util.List marketingContentIdList)
This method builds and then sends a request to delete marketing content.
|
AcknowledgeMarketingContentDataAreaType | deleteMarketingContent(java.lang.String marketingContentId)
This method builds and then sends a request to delete a marketing content.
|
RespondMarketingContentDataAreaType | deleteMarketingContentAttachment(AttachmentReferenceType attachment, java.lang.String marketingContentId)
This method builds and then sends a request to delete a marketing content attachment reference.
|
RespondMarketingContentDataAreaType | deleteMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList)
This method builds and then sends a request to delete a marketing content attachment reference.
|
RespondMarketingContentDataAreaType | deleteMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList)
This method builds and then sends a request to delete marketing content descriptions.
|
RespondMarketingContentDataAreaType | deleteMarketingContentDescription(MarketingContentDescriptionType description, java.lang.String marketingContentId)
This method builds and then sends a request to delete a marketing content description.
|
RespondMarketingContentDataAreaType | deleteMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList)
This method builds and then sends a request to delete marketing content image maps.
|
RespondMarketingContentDataAreaType | deleteMarketingContentImageMap(MarketingContentImageMapType imageMap, java.lang.String marketingContentId)
This method builds and then sends a request to delete a marketing content image map.
|
AcknowledgeMarketingEmailTemplateDataAreaType | deleteMarketingEmailTemplate(java.util.List emailTemplateIdList)
This method builds and then sends a request to delete marketing e-mail templates.
|
AcknowledgeMarketingEmailTemplateDataAreaType | deleteMarketingEmailTemplate(java.lang.String emailTemplateId)
This method builds and then sends a request to delete a marketing e-mail template.
|
AcknowledgeMarketingSpotDataAreaType | deleteMarketingSpot(java.util.List emspotIdList)
This method deletes marketing spots.
|
AcknowledgeMarketingSpotDataAreaType | deleteMarketingSpot(java.lang.String emspotId)
This method builds and then sends a request to delete a marketing spot.
|
RespondMarketingSpotDataAreaType | deleteMarketingSpotDefaultContent(DefaultContentType defaultContent, java.lang.String marketingSpotId)
This method builds and then sends a request to delete a marketing spot default content.
|
RespondMarketingSpotDataAreaType | deleteMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList)
This method builds and then sends a request to delete marketing spot default content.
|
RespondMarketingSpotDataAreaType | deleteMarketingSpotTitle(DefaultMarketingSpotTitleType marketingSpotTitle, java.lang.String marketingSpotId)
This method builds and then sends a request to delete a marketing spot default title.
|
RespondMarketingSpotDataAreaType | deleteMarketingSpotTitle(java.util.List titleList, java.util.List marketingSpotIdList)
This method builds and then sends a request to delete marketing spot default title.
|
java.util.Map | evaluateMarketingTrigger(java.util.Map parameters)
This method processes a marketing trigger with the Evaluate action.
|
CampaignElementTemplateType | getCampaignElementTemplate(java.lang.String templateId)
This method returns a CampaignElementTemplateType object representing a campaign element template.
|
java.util.List | getContentSpotData(java.lang.String spotName, java.lang.Integer maxResults)
This method returns a list of ContentSpotData objects with the data to display to the customer in the content spot.
|
java.util.List | getMarketingSpot(java.lang.String usage, java.util.Map<java.lang.String,java.lang.String> triggerParametersMap, java.lang.String accessProfile)
This method returns a list of all MarketingSpot objects and assigned default content for the current store.
|
java.util.List | getMarketingSpotData(java.lang.String triggerParameters)
This method returns a list of MarketingSpotData objects with the data to display to the customer in the e-Marketing Spot.
|
java.util.List | getMarketingSpotData(java.lang.String eSpotName, java.lang.String usage, java.util.Map<java.lang.String,java.lang.String> triggerParametersMap, java.lang.String accessProfile)
This method returns a list of MarketingSpotData objects with the data to display to the customer in the e-Marketing Spot.
|
protected AcknowledgeActivityDataAreaType | modifyActivityState(java.util.List activityIdList, java.lang.String type)
This method modifies the state of activities.
|
protected AcknowledgeCampaignDataAreaType | modifyCampaignState(java.util.List campaignIdList, java.lang.String type)
This method modifies the state of campaigns.
|
protected AcknowledgeMarketingSpotDataAreaType | modifyMarketingSpotState(java.util.List emspotIdList, java.lang.String type)
This method modifies marketing spots.
|
protected AcknowledgeActivityDataAreaType | processActivity(java.lang.String[] actions, ActivityType[] activities, java.lang.String[] expressions)
This method processes a marketing activity.
|
AcknowledgeActivityDataAreaType | processActivityWinner(java.util.List activityIdList)
This method processes the winners of activity experiments.
|
AcknowledgeActivityDataAreaType | processActivityWinner(java.lang.String activityId)
This method processes the winner an activity experiment.
|
protected AcknowledgeCampaignDataAreaType | processCampaign(java.lang.String[] actions, CampaignType[] campaigns, java.lang.String[] expressions)
This method processes a campaign.
|
protected AcknowledgeMarketingContentDataAreaType | processMarketingContent(java.lang.String[] actions, MarketingContentType[] marketingContent, java.lang.String[] expressions)
This method processes a marketing content.
|
protected AcknowledgeMarketingEmailTemplateDataAreaType | processMarketingEmailTemplate(java.lang.String[] actions, MarketingEmailTemplateType[] emailTemplates, java.lang.String[] expressions)
This method processes a marketing e-mail template.
|
protected AcknowledgeMarketingSpotDataAreaType | processMarketingSpot(java.lang.String[] actions, MarketingSpotType[] emspots, java.lang.String[] expressions)
This method processes a marketing spot.
|
AcknowledgeMarketingTriggerDataAreaType | processMarketingTrigger(java.lang.String action, java.util.Hashtable nvps, java.lang.String triggerParameters) |
AcknowledgeMarketingTriggerDataAreaType | processMarketingTrigger(java.lang.String action, java.util.Map nvps, java.lang.String triggerParameters)
This method processes a marketing trigger.
|
protected AcknowledgeMarketingTriggerDataAreaType | processMarketingTrigger(java.lang.String action, MarketingTriggerType marketingTrigger, java.lang.String expression)
This method processes a marketing trigger.
|
RespondActivityDataAreaType | updateActivity(ActivityType activity)
This method builds and then sends a request to update a marketing activity.
|
RespondActivityDataAreaType | updateActivity(java.util.List activityList)
This method builds and then sends a request to update activities.
|
RespondCampaignDataAreaType | updateCampaign(CampaignType campaign)
This method builds and then sends a request to update a campaign.
|
RespondCampaignDataAreaType | updateCampaign(java.util.List campaignList)
This method builds and then sends a request to update campaigns.
|
RespondActivityDataAreaType | updateElement(CampaignElementType element, java.lang.String activityId)
This method builds and then sends a request to update a campaign element.
|
RespondActivityDataAreaType | updateElement(java.util.List elementList, java.util.List activityIdList)
This method builds and then sends a request to update campaign elements.
|
protected RespondActivityDataAreaType | updateElementsInActivity(java.util.List elementList, java.lang.String activityId)
This method sets up the objects to call the change activity service to update campaign elements in an activity.
|
RespondMarketingContentDataAreaType | updateMarketingContent(java.util.List marketingContentList)
This method builds and then sends a request to update marketing content.
|
RespondMarketingContentDataAreaType | updateMarketingContent(MarketingContentType marketingContent)
This method builds and sends a request to update a marketing content.
|
RespondMarketingContentDataAreaType | updateMarketingContentAttachment(AttachmentReferenceType attachment, java.lang.String marketingContentId)
This method builds and then sends a request to update a marketing content attachment reference.
|
RespondMarketingContentDataAreaType | updateMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList)
This method builds and then sends a request to update a marketing content attachment reference.
|
RespondMarketingContentDataAreaType | updateMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList)
This method builds and then sends a request to update marketing content descriptions.
|
RespondMarketingContentDataAreaType | updateMarketingContentDescription(MarketingContentDescriptionType description, java.lang.String marketingContentId)
This method builds and then sends a request to update a marketing content description.
|
RespondMarketingContentDataAreaType | updateMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList)
This method builds and then sends a request to update marketing content image maps.
|
RespondMarketingContentDataAreaType | updateMarketingContentImageMap(MarketingContentImageMapType imageMap, java.lang.String marketingContentId)
This method builds and then sends a request to update a marketing content image map.
|
RespondMarketingEmailTemplateDataAreaType | updateMarketingEmailTemplate(java.util.List emailTemplateList)
This method builds and then sends a request to update marketing e-mail templates.
|
RespondMarketingEmailTemplateDataAreaType | updateMarketingEmailTemplate(MarketingEmailTemplateType emailTemplate)
This method builds and then sends a request to update a marketing e-mail template.
|
RespondMarketingSpotDataAreaType | updateMarketingSpot(java.util.List emspotList)
This method builds and then sends a request to update marketing spots.
|
RespondMarketingSpotDataAreaType | updateMarketingSpot(MarketingSpotType emspot)
This method builds and then sends a request to update a marketing spot.
|
RespondMarketingSpotDataAreaType | updateMarketingSpotDefaultContent(DefaultContentType defaultContent, java.lang.String marketingSpotId)
This method builds and then sends a request to update a marketing spot default content.
|
RespondMarketingSpotDataAreaType | updateMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList)
This method builds and then sends a request to update marketing spot default content.
|
RespondMarketingSpotDataAreaType | updateMarketingSpotTitle(DefaultMarketingSpotTitleType title, java.lang.String marketingSpotId)
This method builds and then sends a request to update a marketing spot default title.
|
RespondMarketingSpotDataAreaType | updateMarketingSpotTitle(java.util.List titleList, java.util.List marketingSpotIdList)
This method builds and then sends a request to update marketing spot default title.
|
public MarketingFacadeClient()
public MarketingFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
protected CampaignType buildCampaignDataObject(java.lang.String campaignId)
protected ProcessCampaignType buildProcessCampaignDataObject()
protected ChangeCampaignType createChangeCampaignDataObject()
protected ActivityType buildActivityDataObject(java.lang.String activityId)
protected ProcessActivityType buildProcessActivityDataObject()
protected ChangeActivityType createChangeActivityDataObject()
protected MarketingEmailTemplateType buildMarketingEmailTemplateDataObject(java.lang.String emailTemplateId)
protected ChangeMarketingEmailTemplateType createChangeMarketingEmailTemplateDataObject()
protected ProcessMarketingEmailTemplateType buildProcessMarketingEmailTemplateDataObject()
protected MarketingContentType buildMarketingContentDataObject(java.lang.String marketingContentId)
protected ChangeMarketingContentType createChangeMarketingContentDataObject()
protected ProcessMarketingContentType buildProcessMarketingContentDataObject()
protected CampaignElementType buildCampaignElementDataObject(java.lang.String elementName)
protected ProcessMarketingTriggerType buildProcessMarketingTriggerDataObject()
protected MarketingSpotType buildMarketingSpotDataObject(java.lang.String emspotId)
protected ProcessMarketingSpotType buildProcessMarketingSpotDataObject()
protected ChangeMarketingSpotType createChangeMarketingSpotDataObject()
public java.util.List getMarketingSpotData(java.lang.String triggerParameters) throws MarketingSpotDataException
The triggerParameters string has following the name/value pair format: DM_EmsName=eMSpotName¶m1=value1¶m2=value2. The only required name/value pair is DM_EmsName, which specifies the e-Marketing Spot. Any additional information that can be used for matching with targets can be appended as additional name/value pairs.
The following name/value pairs can be specified to limit the number of items to be returned: DM_DisplayCategories, DM_DisplayProducts, and DM_DisplayContent. For example, to specify to return only one category to the StoreHomePage e-Marketing Spot, the triggerParameters string is: DM_EmsName=StoreHomePage&DM_DisplayCategories=1.
The following name/value pair is used to specify the command on the current page: DM_ReqCmd. This is used for evaluating the "current page" targets. For example, if the e-Marketing Spot is on the ProductDisplay page, then the triggerParameters string is: DM_EmsName=ProductDisplaySpot&DM_ReqCmd=ProductDisplay&productId=123456.
The following name/value pair is used to specify the referral url and referral name/value pairs: DM_RefUrl. This is used for evaluating the "referral" target. Note that there are special tags that delimit the start and end of this name/value pair. For example, if the referral url is www.ibm.com with a name/value pair of "type=software", then the triggerParameters string is: _mkt.startDM_RefUrlTriggerParameter&DM_RefUrl=www.ibm.com?type=software&_mkt.endDM_RefUrlTriggerParameter.
See the sample file samples\Snippets\web\WebServiceeMarketingSpotDisplay.jsp. This file illustrates the use of the GetMarketingSpotDataExpressionBuilder that also creates the triggerParameters string.
Note that in the actual web service call, the trigger parameters string will be formatted like this: _mkt.triggerParameters='DM_EmsName=StoreHomePage_mkt.endTriggerParameters'. However, this formatting is produced by this method and by the GetMarketingSpotDataExpressionBuilder.
The following name/value pair that identifies the user is not required, and is determined by the web service: the user's personalization ID (DM_PznId). However, in certain customizations, it may be required to override this parameter. See the method getPersonalizationId in the class MarketingServicesTaskCmd. Custom trigger parameters can be added to the service call, and that method can be overridden to use those custom parameters to retrieve the appropriate personalization ID.
public java.util.List getMarketingSpotData(java.lang.String eSpotName, java.lang.String usage, java.util.Map<java.lang.String,java.lang.String> triggerParametersMap, java.lang.String accessProfile) throws MarketingSpotDataException
public java.util.List getMarketingSpot(java.lang.String usage, java.util.Map<java.lang.String,java.lang.String> triggerParametersMap, java.lang.String accessProfile) throws MarketingSpotException
public java.util.List getContentSpotData(java.lang.String spotName, java.lang.Integer maxResults) throws com.ibm.commerce.marketing.facade.client.ContentSpotDataException
public CampaignElementTemplateType getCampaignElementTemplate(java.lang.String templateId) throws CampaignElementTemplateException
protected AcknowledgeMarketingTriggerDataAreaType processMarketingTrigger(java.lang.String action, MarketingTriggerType marketingTrigger, java.lang.String expression)
public AcknowledgeMarketingTriggerDataAreaType processMarketingTrigger(java.lang.String action, java.util.Hashtable nvps, java.lang.String triggerParameters)
public AcknowledgeMarketingTriggerDataAreaType processMarketingTrigger(java.lang.String action, java.util.Map nvps, java.lang.String triggerParameters)
The following code sample illustrates how to call the Evaluate action to let the marketing runtime know about the occurrence of a custom event:
String triggerParameters = MarketingUtilClient.createTriggerParametersString(null,
"MyCustomEvent", "a=1&b=2&c=3", null, null);
marketingFacadeClient.processMarketingTrigger(MarketingFacadeConstants.PROCESS_VERB_ACTION_EVALUATE,
null, triggerParameters);
An alternative method would be to call the method evaluateMarketingTrigger(Map).
The triggerParameters string has following the name/value pair format: param1=value1¶m2=value2. There are no required name/value pairs for processing marketing triggers.
Note that in the actual web service call, the trigger parameters string will be formatted like this: _mkt.triggerParameters='param1=value1¶m2=value2_mkt.endTriggerParameters'. However, this formatting is produced by this method.
The following name/value pair that identifies the user is not required, and is determined by the web service: the user's personalization ID (DM_PznId). However, in certain customizations, it may be required to override this parameter. See the method getPersonalizationId in the class MarketingServicesTaskCmd. Custom trigger parameters can be added to the service call, and that method can be overridden to use those custom parameters to retrieve the appropriate personalization ID.
public java.util.Map evaluateMarketingTrigger(java.util.Map parameters) throws MarketingTriggerException
The following name/value pair that identifies the user is not required, and is determined by the web service: the user's personalization ID (DM_PznId). However, in certain customizations, it may be required to override this parameter. See the method getPersonalizationId in the class MarketingServicesTaskCmd. Custom trigger parameters can be added to the service call, and that method can be overridden to use those custom parameters to retrieve the appropriate personalization ID.
protected RespondCampaignDataAreaType changeCampaign(java.lang.String[] actions, CampaignType[] campaigns, java.lang.String[] expressions) throws CampaignException
protected AcknowledgeCampaignDataAreaType processCampaign(java.lang.String[] actions, CampaignType[] campaigns, java.lang.String[] expressions) throws CampaignException
protected AcknowledgeCampaignDataAreaType modifyCampaignState(java.util.List campaignIdList, java.lang.String type) throws CampaignException
protected RespondCampaignDataAreaType changeCampaign(java.util.List campaignList, java.lang.String type) throws CampaignException
public AcknowledgeCampaignDataAreaType createCampaign(CampaignType campaign) throws CampaignException
public AcknowledgeCampaignDataAreaType createCampaign(java.util.List campaignList) throws CampaignException
public RespondCampaignDataAreaType updateCampaign(CampaignType campaign) throws CampaignException
public RespondCampaignDataAreaType updateCampaign(java.util.List campaignList) throws CampaignException
public AcknowledgeCampaignDataAreaType deleteCampaign(java.lang.String campaignId) throws CampaignException
public AcknowledgeCampaignDataAreaType deleteCampaign(java.util.List campaignIdList) throws CampaignException
protected AcknowledgeMarketingEmailTemplateDataAreaType processMarketingEmailTemplate(java.lang.String[] actions, MarketingEmailTemplateType[] emailTemplates, java.lang.String[] expressions) throws MarketingEmailTemplateException
protected RespondMarketingEmailTemplateDataAreaType changeMarketingEmailTemplate(java.lang.String[] actions, MarketingEmailTemplateType[] emailTemplates, java.lang.String[] expressions) throws MarketingEmailTemplateException
protected RespondMarketingEmailTemplateDataAreaType changeMarketingEmailTemplate(java.util.List emailTemplateList, java.lang.String type) throws MarketingEmailTemplateException
public AcknowledgeMarketingEmailTemplateDataAreaType createMarketingEmailTemplate(MarketingEmailTemplateType emailTemplate) throws MarketingEmailTemplateException
public AcknowledgeMarketingEmailTemplateDataAreaType createMarketingEmailTemplate(java.util.List emailTemplateList) throws MarketingEmailTemplateException
public RespondMarketingEmailTemplateDataAreaType updateMarketingEmailTemplate(MarketingEmailTemplateType emailTemplate) throws MarketingEmailTemplateException
public RespondMarketingEmailTemplateDataAreaType updateMarketingEmailTemplate(java.util.List emailTemplateList) throws MarketingEmailTemplateException
public AcknowledgeMarketingEmailTemplateDataAreaType deleteMarketingEmailTemplate(java.lang.String emailTemplateId) throws MarketingEmailTemplateException
public AcknowledgeMarketingEmailTemplateDataAreaType deleteMarketingEmailTemplate(java.util.List emailTemplateIdList) throws MarketingEmailTemplateException
protected RespondActivityDataAreaType changeActivity(java.lang.String[] actions, ActivityType[] activities, java.lang.String[] expressions) throws ActivityException
protected AcknowledgeActivityDataAreaType processActivity(java.lang.String[] actions, ActivityType[] activities, java.lang.String[] expressions) throws ActivityException
protected AcknowledgeActivityDataAreaType modifyActivityState(java.util.List activityIdList, java.lang.String type) throws ActivityException
protected RespondActivityDataAreaType changeActivity(java.util.List activityList, java.lang.String type) throws ActivityException
public AcknowledgeActivityDataAreaType createActivity(ActivityType activity) throws ActivityException
public AcknowledgeActivityDataAreaType createActivity(java.util.List activityList) throws ActivityException
public RespondActivityDataAreaType updateActivity(ActivityType activity) throws ActivityException
public RespondActivityDataAreaType updateActivity(java.util.List activityList) throws ActivityException
public AcknowledgeActivityDataAreaType deleteActivity(java.lang.String activityId) throws ActivityException
public AcknowledgeActivityDataAreaType deleteActivity(java.util.List activityIdList) throws ActivityException
public AcknowledgeActivityDataAreaType activateActivity(java.lang.String activityId) throws ActivityException
public AcknowledgeActivityDataAreaType activateActivity(java.util.List activityIdList) throws ActivityException
public AcknowledgeActivityDataAreaType deactivateActivity(java.lang.String activityId) throws ActivityException
public AcknowledgeActivityDataAreaType deactivateActivity(java.util.List activityIdList) throws ActivityException
public AcknowledgeActivityDataAreaType processActivityWinner(java.lang.String activityId) throws ActivityException
public AcknowledgeActivityDataAreaType processActivityWinner(java.util.List activityIdList) throws ActivityException
protected RespondActivityDataAreaType changeElementsInActivity(java.util.List elementList, java.lang.String activityId, java.lang.String type) throws ActivityException
protected RespondActivityDataAreaType changeElement(java.util.List elementList, java.util.List activityIdList, java.lang.String type) throws ActivityException
public RespondActivityDataAreaType createElement(CampaignElementType element, java.lang.String activityId) throws ActivityException
public RespondActivityDataAreaType createElement(java.util.List elementList, java.util.List activityIdList) throws ActivityException
protected RespondActivityDataAreaType createElementsInActivity(java.util.List elementList, java.lang.String activityId) throws ActivityException
public RespondActivityDataAreaType updateElement(CampaignElementType element, java.lang.String activityId) throws ActivityException
public RespondActivityDataAreaType updateElement(java.util.List elementList, java.util.List activityIdList) throws ActivityException
protected RespondActivityDataAreaType updateElementsInActivity(java.util.List elementList, java.lang.String activityId) throws ActivityException
public RespondActivityDataAreaType deleteElement(java.lang.String elementName, java.lang.String activityId) throws ActivityException
public RespondActivityDataAreaType deleteElement(java.util.List elementNameList, java.util.List activityIdList) throws ActivityException
protected AcknowledgeMarketingContentDataAreaType processMarketingContent(java.lang.String[] actions, MarketingContentType[] marketingContent, java.lang.String[] expressions) throws MarketingContentException
protected RespondMarketingContentDataAreaType changeMarketingContent(java.lang.String[] actions, MarketingContentType[] marketingContent, java.lang.String[] expressions) throws MarketingContentException
protected RespondMarketingContentDataAreaType changeMarketingContent(java.util.List marketingContentList, java.lang.String type) throws MarketingContentException
public AcknowledgeMarketingContentDataAreaType createMarketingContent(MarketingContentType marketingContent) throws MarketingContentException
public AcknowledgeMarketingContentDataAreaType createMarketingContent(java.util.List marketingContentList) throws MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContent(MarketingContentType marketingContent) throws MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContent(java.util.List marketingContentList) throws MarketingContentException
public AcknowledgeMarketingContentDataAreaType deleteMarketingContent(java.lang.String marketingContentId) throws MarketingContentException
public AcknowledgeMarketingContentDataAreaType deleteMarketingContent(java.util.List marketingContentIdList) throws MarketingContentException
protected RespondMarketingContentDataAreaType changeMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList, java.lang.String type) throws MarketingContentException
protected RespondMarketingContentDataAreaType changeMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList, java.lang.String type) throws MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentDescription(MarketingContentDescriptionType description, java.lang.String marketingContentId) throws MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentImageMap(MarketingContentImageMapType imageMap, java.lang.String marketingContentId) throws MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList) throws MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList) throws MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentDescription(MarketingContentDescriptionType description, java.lang.String marketingContentId) throws MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentImageMap(MarketingContentImageMapType imageMap, java.lang.String marketingContentId) throws MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList) throws MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList) throws MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentDescription(MarketingContentDescriptionType description, java.lang.String marketingContentId) throws MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentImageMap(MarketingContentImageMapType imageMap, java.lang.String marketingContentId) throws MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList) throws MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList) throws MarketingContentException
protected RespondMarketingContentDataAreaType changeMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList, java.lang.String type) throws MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentAttachment(AttachmentReferenceType attachment, java.lang.String marketingContentId) throws MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList) throws MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentAttachment(AttachmentReferenceType attachment, java.lang.String marketingContentId) throws MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList) throws MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentAttachment(AttachmentReferenceType attachment, java.lang.String marketingContentId) throws MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList) throws MarketingContentException
protected RespondMarketingSpotDataAreaType changeMarketingSpot(java.lang.String[] actions, MarketingSpotType[] emspots, java.lang.String[] expressions) throws MarketingSpotException
protected AcknowledgeMarketingSpotDataAreaType processMarketingSpot(java.lang.String[] actions, MarketingSpotType[] emspots, java.lang.String[] expressions) throws MarketingSpotException
protected AcknowledgeMarketingSpotDataAreaType modifyMarketingSpotState(java.util.List emspotIdList, java.lang.String type) throws MarketingSpotException
protected RespondMarketingSpotDataAreaType changeMarketingSpot(java.util.List emspotList, java.lang.String type) throws MarketingSpotException
public AcknowledgeMarketingSpotDataAreaType createMarketingSpot(MarketingSpotType emspot) throws MarketingSpotException
public AcknowledgeMarketingSpotDataAreaType createMarketingSpot(java.util.List emspotList) throws MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpot(MarketingSpotType emspot) throws MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpot(java.util.List emspotList) throws MarketingSpotException
public AcknowledgeMarketingSpotDataAreaType deleteMarketingSpot(java.lang.String emspotId) throws MarketingSpotException
public AcknowledgeMarketingSpotDataAreaType deleteMarketingSpot(java.util.List emspotIdList) throws MarketingSpotException
protected RespondMarketingSpotDataAreaType changeMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList, java.lang.String type) throws MarketingSpotException
public RespondMarketingSpotDataAreaType createMarketingSpotDefaultContent(DefaultContentType defaultContent, java.lang.String marketingSpotId) throws MarketingSpotException
public RespondMarketingSpotDataAreaType createMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList) throws MarketingSpotException
public RespondMarketingSpotDataAreaType deleteMarketingSpotDefaultContent(DefaultContentType defaultContent, java.lang.String marketingSpotId) throws MarketingSpotException
public RespondMarketingSpotDataAreaType deleteMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList) throws MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpotDefaultContent(DefaultContentType defaultContent, java.lang.String marketingSpotId) throws MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList) throws MarketingSpotException
protected RespondMarketingSpotDataAreaType changeMarketingSpotTitle(java.util.List defaultTitleList, java.util.List marketingSpotIdList, java.lang.String type) throws MarketingSpotException
public RespondMarketingSpotDataAreaType createMarketingSpotTitle(DefaultMarketingSpotTitleType marketingSpotTitle, java.lang.String marketingSpotId) throws MarketingSpotException
public RespondMarketingSpotDataAreaType createMarketingSpotTitle(java.util.List titleList, java.util.List marketingSpotIdList) throws MarketingSpotException
public RespondMarketingSpotDataAreaType deleteMarketingSpotTitle(DefaultMarketingSpotTitleType marketingSpotTitle, java.lang.String marketingSpotId) throws MarketingSpotException
public RespondMarketingSpotDataAreaType deleteMarketingSpotTitle(java.util.List titleList, java.util.List marketingSpotIdList) throws MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpotTitle(DefaultMarketingSpotTitleType title, java.lang.String marketingSpotId) throws MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpotTitle(java.util.List titleList, java.util.List marketingSpotIdList) throws MarketingSpotException