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.
CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE
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.
|
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.
|
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.
|
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(com.ibm.commerce.marketing.facade.datatypes.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(com.ibm.commerce.marketing.facade.datatypes.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.lang.Integer elementId,
java.lang.String activityId)
This method deletes a campaign element.
|
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(com.ibm.commerce.marketing.facade.datatypes.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(com.ibm.commerce.marketing.facade.datatypes.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. |
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.
|
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.
|
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.
|
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(com.ibm.commerce.marketing.facade.datatypes.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(com.ibm.commerce.marketing.facade.datatypes.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.
|
changeActivity, changeCampaign, changeCampaignElementTemplate, changeMarketingContent, changeMarketingEmailTemplate, changeMarketingSpot, getActivity, getActivity, getActivity, getCampaign, getCampaign, getCampaign, getCampaignElementTemplate, getCampaignElementTemplate, getCampaignElementTemplate, getContentSpotData, getContentSpotData, getContentSpotData, getMarketingContent, getMarketingContent, getMarketingContent, getMarketingEmailTemplate, getMarketingEmailTemplate, getMarketingEmailTemplate, getMarketingSpot, getMarketingSpot, getMarketingSpot, getMarketingSpotData, getMarketingSpotData, getMarketingSpotData, getMarketingTriggerFilter, getMarketingTriggerFilter, getMarketingTriggerFilter, processActivity, processCampaign, processCampaignElementTemplate, processMarketingContent, processMarketingEmailTemplate, processMarketingSpot, processMarketingTrigger
createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb
public MarketingFacadeClient()
public MarketingFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
businessContext
- The default business context to associate with the messages
when making requests.callbackHandler
- Used for authentication purposes so the controller can give
the authentication information to the transport when required.public java.util.List getMarketingSpotData(java.lang.String triggerParameters) throws MarketingSpotDataException
MarketingSpotData
objects with the data to display
to the customer in the e-Marketing Spot. The list will contain only one MarketingSpotData
object. The returned data object will contain the list of categories, catalog entries, and marketing
content to display in the e-Marketing Spot.triggerParameters
- The string representing the e-Marketing Spot, the user, and,
the user's current context information. The method MarketingUtilClient.createTriggerParametersString
can be used to assist in creating the trigger parameters string.
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.
MarketingSpotData
objects that matches the expression specified.MarketingSpotDataException
- The MarketingSpotDataException
is thrown if error
information is found in the specified AcknowledgeMarketingSpotDataDataArea
.
This means that there was a problem when the method performed the operation.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
MarketingSpotData
objects with the data to display
to the customer in the e-Marketing Spot. The list will contain only one MarketingSpotData
object. The returned data object will contain the list of categories, catalog entries, and marketing
content to display in the e-Marketing Spot.eSpotName
- The name of the e-Marketing Spot.usage
- The usage type, as defined for the EMSPOT table.triggerParametersMap
- A map of type accessProfile
- The access profile. This value can be null.MarketingSpotData
objects that matches the expression specified.MarketingSpotDataException
- The MarketingSpotDataException
is thrown if error
information is found in the specified AcknowledgeMarketingSpotDataDataArea
.
This means that there was a problem when the method performed the operation.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
MarketingSpot
objects and assigned default
content for the current store. This returned list is based on the store Id found in the business context,
the provided usage type and access profile.usage
- The usage type, as defined for the EMSPOT table.triggerParametersMap
- A map of type accessProfile
- The access profile. This value can be null.MarketingSpot
objects that matches the expression specified.MarketingSpotException
- The MarketingSpotException
is thrown if error
information is found in the specified AcknowledgeMarketingSpotDataArea
.
This means that there was a problem when the method performed the operation.public java.util.List getContentSpotData(java.lang.String spotName, java.lang.Integer maxResults) throws com.ibm.commerce.marketing.facade.client.ContentSpotDataException
ContentSpotData
objects with the data to display
to the customer in the content spot.spotName
- The name of the content spot.maxResults
- The maximum number of results to display in the content spot.ContentSpotDataException
- The ContentSpotDataException
is thrown if error
information is found in the specified AcknowledgeContentSpotDataDataArea
.
This means that there was a problem when performing the operation.public CampaignElementTemplateType getCampaignElementTemplate(java.lang.String templateId) throws CampaignElementTemplateException
CampaignElementTemplateType
object representing a
campaign element template.templateId
- The ID of the campaign element template to retrieve.CampaignElementTemplateType
object.CampaignElementTemplateException
- The MarketingTriggerFilterException
is thrown if error
information is found in the specified AcknowledgeMarketingTriggerFilterDataArea
.
This means that there was a problem when performing the operation.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)
action
- The action that should be performed on the marketing trigger. Valid values are:
PROCESS_VERB_ACTION_SEND
("Send") to send the trigger to the applicable activity. The name/value
pairs are sets of (element ID, activity ID). The occurrence of the trigger associated with the specified element
will be sent for processing to the specified activity. This action should be used when the behavior rules
have been checked, and it has been determined which element in interested in this trigger.PROCESS_VERB_ACTION_RECORD
("Record") to record the trigger information in the
user behavior data. The name/value
pairs are sets of (element ID, data). The specified data will be recorded against the specified element.
This action should be used when the behavior rules
have been checked, and it has been determined which element in interested in this trigger.PROCESS_VERB_ACTION_CLICK
("Click") to record the click of an e-Marketing Spot. The following data
should be specified:
CpgnStatsConstants.MPE_ID
(the e-Marketing Spot ID)CpgnStatsConstants.INITIATIVE_ID
(the activity ID)ExpCpgnStatsConstants.EXPERIMENT_ID
(if applicable, the experiment ID)ExpCpgnStatsConstants.TEST_ELEMENT_ID
(if applicable, the experiment test element ID)ExpCpgnStatsConstants.DATA_TYPE
(if applicable, the test element data type ID. for example, CatalogGroup, CatalogEntry, or MarketingContent)ExpCpgnStatsConstants.UNIQUE_ID
(if applicable, the unique ID of the test element data)PROCESS_VERB_ACTION_SAVE_STATISTICS
("SaveStatistics") to persist the accumulated statistics.PROCESS_VERB_ACTION_SEND_TRIGGERS
("SendTriggers") to process the ready wait triggers.PROCESS_VERB_ACTION_CLEAR_ENTIRE_CACHE
("ClearEntireCache") to clear the marketing and user behavior caches.PROCESS_VERB_ACTION_CLEAR_MARKETING_CACHE
("ClearMarketingCache") to clear the marketing cache.PROCESS_VERB_ACTION_CLEAR_USER_BEHAVIOR_CACHE
("ClearUserBehaviorCache") to clear the user behavior cache.PROCESS_VERB_ACTION_LOAD_TRIGGER_FILTERS
("LoadTriggerFilters") to load the current trigger filter rules.PROCESS_VERB_ACTION_EVALUATE_ORDER
("EvaluateOrder") to determine if the order was influenced by
any experiments in which the customer is participating. The following data
must be specified: ExpCpgnStatsConstants.ORDER_ID
(the order ID)PROCESS_VERB_ACTION_EVALUATE
("Evaluate") to check if the trigger event is applicable to
any marketing activities. The trigger will be checked against both Triggers and Targets in all active activities.
This should be used if you know that both Trigger and Target elements are interested in this trigger.
The triggerParamters
string should contain the appropriate context information for the trigger.PROCESS_VERB_ACTION_EVALUATE_FOR_TRIGGER
("EvaluateForTrigger") to check if the trigger event is applicable to
any Triggers in active marketing activities. This should be used if you know that only Trigger elements are
interested in this trigger. The triggerParamters
string should contain the appropriate context information for the
trigger.PROCESS_VERB_ACTION_EVALUATE_FOR_TARGET
("EvaluateForTarget") to check if the trigger event is applicable to
any Targets in active marketing activities. This should be used if you know that only Target elements are
interested in this trigger.
The triggerParamters
string should contain the appropriate context information for the trigger.
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)
.
nvps
- The name-value pairs containing the information associated with the trigger.triggerParameters
- The string representing the user, and the user's current context information.
This is the user who performed the action that resulting in the sending of this marketing trigger.
The method MarketingUtilClient.createTriggerParametersString
can be used to assist in creating the trigger parameters string.
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.
AcknowledgeMarketingTriggerDataAreaType
object.public java.util.Map evaluateMarketingTrigger(java.util.Map parameters) throws MarketingTriggerException
Evaluate
action. The marketing trigger is sent to the marketing
runtime to be sent to an activity flow, or record the information in the user behavior data.
This method is used by the url command mapping in struts-config-marketing-services.xml
. Some example,
usages are:
MarketingTriggerProcessServiceEvaluate?DM_ReqCmd=SocialCommerceInteraction?type=blog
AjaxMarketingTriggerProcessServiceEvaluate?DM_ReqCmd=SocialCommerceInteraction?type=product
MarketingTriggerProcessServiceEvaluate?DM_ReqCmd=MyCustomTrigger?param1=I¶m2=B¶m3=M
parameters
- The input parameters that will be set in the triggers parameters string.
The values should be specified within the following structure: String[]
.
There is one required parameter: DM_ReqCmd
.
Any other parameters provided will be included in the trigger parameters string.
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.
Map
MarketingTriggerException
public AcknowledgeCampaignDataAreaType createCampaign(CampaignType campaign) throws CampaignException
campaign
- A CampaignType
object to be created.AcknowledgeCampaignDataAreaType
object that contains the ID of the created campaign.CampaignException
public AcknowledgeCampaignDataAreaType createCampaign(java.util.List campaignList) throws CampaignException
campaignList
- A list of CampaignType
objects to be created.AcknowledgeCampaignDataAreaType
object that contains the IDs of the created campaigns.CampaignException
public RespondCampaignDataAreaType updateCampaign(CampaignType campaign) throws CampaignException
campaign
- A CampaignType
object to be updated.RespondCampaignDataAreaType
object that contains the ID of the updated campaign.CampaignException
public RespondCampaignDataAreaType updateCampaign(java.util.List campaignList) throws CampaignException
campaignList
- A list of CampaignType
objects to be updated.RespondCampaignDataAreaType
object that contains the IDs of the updated campaigns.CampaignException
public AcknowledgeCampaignDataAreaType deleteCampaign(java.lang.String campaignId) throws CampaignException
campaignId
- The ID of the campaign to be deleted.AcknowledgeCampaignDataAreaType
object that contains the ID of the deleted campaign.CampaignException
public AcknowledgeCampaignDataAreaType deleteCampaign(java.util.List campaignIdList) throws CampaignException
campaignIdList
- The list of IDs of the campaigns to be deleted.AcknowledgeCampaignDataAreaType
that contains the IDs of the deleted campaigns.CampaignException
public AcknowledgeMarketingEmailTemplateDataAreaType createMarketingEmailTemplate(MarketingEmailTemplateType emailTemplate) throws MarketingEmailTemplateException
emailTemplate
- A MarketingEmailTemplateType
object to be created.AcknowledgeMarketingEmailTemplateDataAreaType
object that contains the ID of the created marketing e-mail template.MarketingEmailTemplateException
public AcknowledgeMarketingEmailTemplateDataAreaType createMarketingEmailTemplate(java.util.List emailTemplateList) throws MarketingEmailTemplateException
emailTemplateList
- A list of MarketingEmailTemplateType
objects to be created.AcknowledgeMarketingEmailTemplateDataAreaType
object that contains the IDs of the created marketing e-mail templates.MarketingEmailTemplateException
public RespondMarketingEmailTemplateDataAreaType updateMarketingEmailTemplate(MarketingEmailTemplateType emailTemplate) throws MarketingEmailTemplateException
emailTemplate
- A MarketingEmailTemplateType
object to be updated.RespondMarketingEmailTemplateDataAreaType
object that contains the ID of the updated marketing e-mail template.MarketingEmailTemplateException
public RespondMarketingEmailTemplateDataAreaType updateMarketingEmailTemplate(java.util.List emailTemplateList) throws MarketingEmailTemplateException
emailTemplateList
- A list of MarketingEmailTemplateType
objects to be updated.RespondMarketingEmailTemplateDataAreaType
object that contains the IDs of the updated marketing e-mail templates.MarketingEmailTemplateException
public AcknowledgeMarketingEmailTemplateDataAreaType deleteMarketingEmailTemplate(java.lang.String emailTemplateId) throws MarketingEmailTemplateException
emailTemplateId
- The ID of the marketing e-mail template to be deleted.AcknowledgeMarketingEmailTemplateDataAreaType
object that contains the ID of the deleted marketing e-mail template.MarketingEmailTemplateException
public AcknowledgeMarketingEmailTemplateDataAreaType deleteMarketingEmailTemplate(java.util.List emailTemplateIdList) throws MarketingEmailTemplateException
emailTemplateIdList
- A list of IDs of the marketing e-mail templates to be deleted.AcknowledgeMarketingEmailTemplateDataAreaType
object that contains the IDs of the deleted marketing e-mail templates.MarketingEmailTemplateException
public AcknowledgeActivityDataAreaType createActivity(ActivityType activity) throws ActivityException
activity
- An ActivityType
object to be created.AcknowledgeActivityDataAreaType
object that contains the ID of the created activity.ActivityException
public AcknowledgeActivityDataAreaType createActivity(java.util.List activityList) throws ActivityException
activityList
- A list of ActivityType
objects to be created.AcknowledgeActivityDataAreaType
object that contains the IDs of the created activities.ActivityException
public RespondActivityDataAreaType updateActivity(ActivityType activity) throws ActivityException
activity
- An ActivityType
object to be updated.RespondActivityDataAreaType
object that contains the ID of the updated activity.ActivityException
public RespondActivityDataAreaType updateActivity(java.util.List activityList) throws ActivityException
activityList
- A list of ActivityType
objects to be updated.RespondActivityDataAreaType
object that contains the IDs of the updated activities.ActivityException
public AcknowledgeActivityDataAreaType deleteActivity(java.lang.String activityId) throws ActivityException
activityId
- The ID of the activity to be deleted.AcknowledgeActivityDataAreaType
object that contains the ID of the deleted activity.ActivityException
public AcknowledgeActivityDataAreaType deleteActivity(java.util.List activityIdList) throws ActivityException
activityIdList
- The list of IDs of the activities to be deleted.AcknowledgeActivityDataAreaType
that contains the IDs of the deleted activities.ActivityException
public AcknowledgeActivityDataAreaType activateActivity(java.lang.String activityId) throws ActivityException
activityId
- The ID of the activity to be activated.AcknowledgeActivityDataAreaType
that contains the ID of the activated activity.ActivityException
public AcknowledgeActivityDataAreaType activateActivity(java.util.List activityIdList) throws ActivityException
activityIdList
- The list of IDs of the activities to be activated.AcknowledgeActivityDataAreaType
that contains the IDs of the activated activities.ActivityException
public AcknowledgeActivityDataAreaType deactivateActivity(java.lang.String activityId) throws ActivityException
activityId
- The ID of the activity to be deactivated.AcknowledgeActivityDataAreaType
that contains the ID of the deactivated activity.ActivityException
public AcknowledgeActivityDataAreaType deactivateActivity(java.util.List activityIdList) throws ActivityException
activityIdList
- The list of IDs of the activities to be deactivated.AcknowledgeActivityDataAreaType
that contains the IDs of the activated activities.ActivityException
public AcknowledgeActivityDataAreaType processActivityWinner(java.lang.String activityId) throws ActivityException
activityId
- The ID of the activity to be processed.AcknowledgeActivityDataAreaType
that contains the ID of the processed activity.ActivityException
public AcknowledgeActivityDataAreaType processActivityWinner(java.util.List activityIdList) throws ActivityException
activityIdList
- The list of IDs of the activities to be processed.AcknowledgeActivityDataAreaType
that contains the IDs of the processed activities.ActivityException
public RespondActivityDataAreaType createElement(CampaignElementType element, java.lang.String activityId) throws ActivityException
element
- A CampaignElementType
object to be created.activityId
- The ID of the activity to which the element belongs.RespondActivityDataAreaType
object that contains the ID of the created element.ActivityException
public RespondActivityDataAreaType createElement(java.util.List elementList, java.util.List activityIdList) throws ActivityException
createElementsInActivity
.elementList
- A list of CampaignElementType
objects to be created.activityIdList
- The list of IDs of the activities to which the elements belong.RespondActivityDataAreaType
object that contains the IDs of the created elements.ActivityException
public RespondActivityDataAreaType updateElement(CampaignElementType element, java.lang.String activityId) throws ActivityException
element
- A CampaignElementType
object to be updated.activityId
- The ID of the activity to which the element belongs.RespondActivityDataAreaType
object that contains the ID of the updated element.ActivityException
public RespondActivityDataAreaType updateElement(java.util.List elementList, java.util.List activityIdList) throws ActivityException
updateElementsInActivity
.elementList
- A list of CampaignElementType
objects to be updated.activityIdList
- The list of IDs of the activities to which the elements belongs.RespondActivityDataAreaType
object that contains the IDs of the updated elements.ActivityException
public RespondActivityDataAreaType deleteElement(java.lang.String elementName, java.lang.String activityId) throws ActivityException
elementName
- The name of the element to be deleted.activityId
- The ID of the activity associated with the element to be deleted.AcknowledgeActivityDataAreaType
that contains the ID of the deleted element.ActivityException
public RespondActivityDataAreaType deleteElement(java.lang.Integer elementId, java.lang.String activityId) throws ActivityException
elementId
- The uniqueId of the element to be deleted.activityId
- The ID of the activity associated with the element to be deleted.AcknowledgeActivityDataAreaType
that contains the ID of the deleted element.ActivityException
public RespondActivityDataAreaType deleteElement(java.util.List elementNameList, java.util.List activityIdList) throws ActivityException
elementNameList
- The list of names or uniqueIds of the elements to be deleted.activityIdList
- The list of IDs of the activities associated with the elements to be deleted.AcknowledgeActivityDataAreaType
that contains the IDs of the deleted elements.ActivityException
public AcknowledgeMarketingContentDataAreaType createMarketingContent(MarketingContentType marketingContent) throws MarketingContentException
marketingContent
- A MarketingContentType
object to be created.AcknowledgeMarketingContentDataAreaType
object that contains the ID of the created marketing content.MarketingContentException
public AcknowledgeMarketingContentDataAreaType createMarketingContent(java.util.List marketingContentList) throws MarketingContentException
marketingContentList
- A list of MarketingContentType
objects to be created.AcknowledgeMarketingContentDataAreaType
object that contains the IDs of the created marketing content.MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContent(MarketingContentType marketingContent) throws MarketingContentException
marketingContent
- A MarketingContentType
object to be updated.RespondMarketingContentDataAreaType
object that contains the ID of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContent(java.util.List marketingContentList) throws MarketingContentException
marketingContentList
- A list of MarketingContentType
objects to be updated.RespondMarketingContentDataAreaType
object that contains the IDs of the updated marketing content.MarketingContentException
public AcknowledgeMarketingContentDataAreaType deleteMarketingContent(java.lang.String marketingContentId) throws MarketingContentException
marketingContentId
- The ID of the marketing content to be deleted.AcknowledgeMarketingContentDataAreaType
object that contains the ID of the deleted marketing content.MarketingContentException
public AcknowledgeMarketingContentDataAreaType deleteMarketingContent(java.util.List marketingContentIdList) throws MarketingContentException
marketingContentIdList
- A list of IDs of the marketing content to be deleted.AcknowledgeMarketingContentDataAreaType
object that contains the IDs of the deleted marketing content.MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentDescription(MarketingContentDescriptionType description, java.lang.String marketingContentId) throws MarketingContentException
description
- A MarketingContentDescriptionType
object to be created.marketingContentId
- The ID of the marketing content to which the description belongs.RespondMarketingContentDataAreaType
object that contains the ID of the marketing content.MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentImageMap(com.ibm.commerce.marketing.facade.datatypes.MarketingContentImageMapType imageMap, java.lang.String marketingContentId) throws MarketingContentException
imageMap
- A MarketingContentImageMapType
object to be created.marketingContentId
- The ID of the marketing content to which the image map belongs.RespondMarketingContentDataAreaType
object that contains the ID of the marketing content.MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList) throws MarketingContentException
descriptionList
- A list of MarketingContentDescriptionType
objects to be created.marketingContentIdList
- The list of IDs of the marketing content to which the descriptions belong.RespondMarketingContentDataAreaType
object that contains the IDs of the marketing content.MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList) throws MarketingContentException
imageMapList
- A list of MarketingContentImageMapType
objects to be created.marketingContentIdList
- The list of IDs of the marketing content to which the image maps belong.RespondMarketingContentDataAreaType
object that contains the IDs of the marketing content.MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentDescription(MarketingContentDescriptionType description, java.lang.String marketingContentId) throws MarketingContentException
description
- A MarketingContentDescriptionType
object to be updated.marketingContentId
- The ID of the marketing content to which the description belongs.RespondMarketingContentDataAreaType
object that contains the ID of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentImageMap(com.ibm.commerce.marketing.facade.datatypes.MarketingContentImageMapType imageMap, java.lang.String marketingContentId) throws MarketingContentException
imageMap
- A MarketingContentImageMapType
object to be updated.marketingContentId
- The ID of the marketing content to which the image map belongs.RespondMarketingContentDataAreaType
object that contains the ID of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList) throws MarketingContentException
descriptionList
- A list of MarketingContentDescriptionType
objects to be updated.marketingContentIdList
- The list of IDs of the marketing content to which the descriptions belongs.RespondMarketingContentDataAreaType
object that contains the IDs of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList) throws MarketingContentException
imageMapList
- A list of MarketingContentImageMapType
objects to be updated.marketingContentIdList
- The list of IDs of the marketing content to which the image maps belong.RespondMarketingContentDataAreaType
object that contains the IDs of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentDescription(MarketingContentDescriptionType description, java.lang.String marketingContentId) throws MarketingContentException
description
- A MarketingContentDescriptionType
object to be deleted.marketingContentId
- The ID of the marketing content to which the description belongs.RespondMarketingContentDataAreaType
object that contains the ID of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentImageMap(com.ibm.commerce.marketing.facade.datatypes.MarketingContentImageMapType imageMap, java.lang.String marketingContentId) throws MarketingContentException
imageMap
- A MarketingContentImageMapType
object to be deleted.marketingContentId
- The ID of the marketing content to which the image map belongs.RespondMarketingContentDataAreaType
object that contains the ID of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentDescription(java.util.List descriptionList, java.util.List marketingContentIdList) throws MarketingContentException
descriptionList
- A list of MarketingContentDescriptionType
objects to be deleted.marketingContentIdList
- The list of IDs of the marketing content to which the descriptions belongs.RespondMarketingContentDataAreaType
object that contains the IDs of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentImageMap(java.util.List imageMapList, java.util.List marketingContentIdList) throws MarketingContentException
imageMapList
- A list of MarketingContentImagemapType
objects to be deleted.marketingContentIdList
- The list of IDs of the marketing content to which the image maps belong.RespondMarketingContentDataAreaType
object that contains the IDs of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentAttachment(AttachmentReferenceType attachment, java.lang.String marketingContentId) throws MarketingContentException
attachment
- An AttachmentReferenceType
object to be created.marketingContentId
- The ID of the marketing content to which the attachment belongs.RespondMarketingContentDataAreaType
object that contains the ID of the marketing content.MarketingContentException
public RespondMarketingContentDataAreaType createMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList) throws MarketingContentException
attachmentList
- A list of AttachmentReferenceType
objects to be created.marketingContentIdList
- The list of IDs of the marketing content to which the attachments belong.RespondMarketingContentDataAreaType
object that contains the IDs of the marekting content.MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentAttachment(AttachmentReferenceType attachment, java.lang.String marketingContentId) throws MarketingContentException
attachment
- An AttachmentReferenceType
object to be updated.marketingContentId
- The ID of the marketing content to which the attachment belongs.RespondMarketingContentDataAreaType
object that contains the ID of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType updateMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList) throws MarketingContentException
attachmentList
- A list of AttachmentReferenceType
objects to be updated.marketingContentIdList
- The list of IDs of the marketing content to which the attachments belongs.RespondMarketingContentDataAreaType
object that contains the IDs of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentAttachment(AttachmentReferenceType attachment, java.lang.String marketingContentId) throws MarketingContentException
attachment
- An AttachmentReferenceType
object to be deleted.marketingContentId
- The ID of the marketing content to which the attachment belongs.RespondMarketingContentDataAreaType
object that contains the ID of the updated marketing content.MarketingContentException
public RespondMarketingContentDataAreaType deleteMarketingContentAttachment(java.util.List attachmentList, java.util.List marketingContentIdList) throws MarketingContentException
attachmentList
- A list of AttachmentReferenceType
objects to be deleted.marketingContentIdList
- The list of IDs of the marketing content to which the attachments belongs.RespondMarketingContentDataAreaType
object that contains the IDs of the updated marketing content.MarketingContentException
public AcknowledgeMarketingSpotDataAreaType createMarketingSpot(MarketingSpotType emspot) throws MarketingSpotException
emspot
- A MarketingSpotType
object to be created.AcknowledgeMarketingSpotDataAreaType
object that contains the ID of the created marketing spot.MarketingSpotException
public AcknowledgeMarketingSpotDataAreaType createMarketingSpot(java.util.List emspotList) throws MarketingSpotException
emspotList
- A list of MarketingSpotType
objects to be created.AcknowledgeMarketingSpotDataAreaType
object that contains the IDs of the created marketing spots.MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpot(MarketingSpotType emspot) throws MarketingSpotException
emspot
- A MarketingSpotType
object to be updated.RespondMarketingSpotDataAreaType
object that contains the ID of the updated marketing spot.MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpot(java.util.List emspotList) throws MarketingSpotException
emspotList
- A list of MarketingSpotType
objects to be updated.RespondMarketingSpotDataAreaType
object that contains the IDs of the updated marketing spots.MarketingSpotException
public AcknowledgeMarketingSpotDataAreaType deleteMarketingSpot(java.lang.String emspotId) throws MarketingSpotException
emspotId
- The ID of the marketing spot to be deleted.AcknowledgeMarketingSpotDataAreaType
object that contains the ID of the deleted marketing spot.MarketingSpotException
public AcknowledgeMarketingSpotDataAreaType deleteMarketingSpot(java.util.List emspotIdList) throws MarketingSpotException
emspotIdList
- The list of IDs of the marketing spots to be deleted.AcknowledgeMarketingSpotDataAreaType
that contains the IDs of the deleted marketing spots.MarketingSpotException
public RespondMarketingSpotDataAreaType createMarketingSpotDefaultContent(DefaultContentType defaultContent, java.lang.String marketingSpotId) throws MarketingSpotException
defaultContent
- A DefaultContentType
object to be created.marketingSpotId
- The ID of the marketing spot to which the default content belongs.RespondMarketingSpotDataAreaType
object that contains the ID of the default content.MarketingSpotException
public RespondMarketingSpotDataAreaType createMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList) throws MarketingSpotException
defaultContentList
- A list of DefaultContentType
objects to be created.marketingSpotIdList
- The list of IDs of the marketing spot to which the default content belong.RespondMarketingSpotDataAreaType
object that contains the IDs of the marketing default content.MarketingSpotException
public RespondMarketingSpotDataAreaType deleteMarketingSpotDefaultContent(DefaultContentType defaultContent, java.lang.String marketingSpotId) throws MarketingSpotException
defaultContent
- A DefaultContentType
object to be deleted.marketingSpotId
- The ID of the marketing spot to which the default content belongs.RespondMarketingSpotDataAreaType
object that contains the ID of the deleted marketing default content.MarketingSpotException
public RespondMarketingSpotDataAreaType deleteMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList) throws MarketingSpotException
defaultContentList
- A list of DefaultContentType
objects to be deleted.marketingSpotIdList
- The list of IDs of the marketing spots to which the default content belong.RespondMarketingSpotDataAreaType
object that contains the IDs of the deleted default content.MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpotDefaultContent(DefaultContentType defaultContent, java.lang.String marketingSpotId) throws MarketingSpotException
defaultContent
- A DefaultContentType
object to be updated.marketingSpotId
- The ID of the marketing spot to which the default content belongs.RespondMarketingSpotDataAreaType
object that contains the ID of the updated marketing default content.MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpotDefaultContent(java.util.List defaultContentList, java.util.List marketingSpotIdList) throws MarketingSpotException
defaultContentList
- A list of DefaultContentType
objects to be updated.marketingSpotIdList
- The list of IDs of the marketing spots to which the default content belong.RespondMarketingSpotDataAreaType
object that contains the IDs of the updated default content.MarketingSpotException
public RespondMarketingSpotDataAreaType createMarketingSpotTitle(com.ibm.commerce.marketing.facade.datatypes.DefaultMarketingSpotTitleType marketingSpotTitle, java.lang.String marketingSpotId) throws MarketingSpotException
marketingSpotTitle
- A DefaultMarketingSpotTitleType
object to be created.marketingSpotId
- The ID of the marketing spot to which the default title belongs.RespondMarketingSpotDataAreaType
object that contains the ID of the default title.MarketingSpotException
public RespondMarketingSpotDataAreaType createMarketingSpotTitle(java.util.List titleList, java.util.List marketingSpotIdList) throws MarketingSpotException
titleList
- A list of DefaultMarketingSpotTitleType
objects to be created.marketingSpotIdList
- The list of IDs of the marketing spot to which the default title belong.RespondMarketingSpotDataAreaType
object that contains the IDs of the marketing default title.MarketingSpotException
public RespondMarketingSpotDataAreaType deleteMarketingSpotTitle(com.ibm.commerce.marketing.facade.datatypes.DefaultMarketingSpotTitleType marketingSpotTitle, java.lang.String marketingSpotId) throws MarketingSpotException
marketingSpotTitle
- A DefaultMarketingSpotTitleType
object to be deleted.marketingSpotId
- The ID of the marketing spot to which the default title belongs.RespondMarketingSpotDataAreaType
object that contains the ID of the deleted marketing default title.MarketingSpotException
public RespondMarketingSpotDataAreaType deleteMarketingSpotTitle(java.util.List titleList, java.util.List marketingSpotIdList) throws MarketingSpotException
titleList
- A list of DefaultMarketingSpotTitleType
objects to be deleted.marketingSpotIdList
- The list of IDs of the marketing spots to which the default title belong.RespondMarketingSpotDataAreaType
object that contains the IDs of the deleted default title.MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpotTitle(com.ibm.commerce.marketing.facade.datatypes.DefaultMarketingSpotTitleType title, java.lang.String marketingSpotId) throws MarketingSpotException
title
- A DefaultMarketingSpotTitleType
object to be updated.marketingSpotId
- The ID of the marketing spot to which the default title belongs.RespondMarketingSpotDataAreaType
object that contains the ID of the updated marketing default title.MarketingSpotException
public RespondMarketingSpotDataAreaType updateMarketingSpotTitle(java.util.List titleList, java.util.List marketingSpotIdList) throws MarketingSpotException
titleList
- A list of DefaultMarketingSpotTitleType
objects to be updated.marketingSpotIdList
- The list of IDs of the marketing spots to which the default title belong.RespondMarketingSpotDataAreaType
object that contains the IDs of the updated default title.MarketingSpotException