com.ibm.commerce.marketing.facade.client

Class MarketingFacadeClient


  • 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 Detail

      • MarketingFacadeClient

        public MarketingFacadeClient()
        Creates an instance of the client to communicate with the Marketing facade.

      • MarketingFacadeClient

        public MarketingFacadeClient(BusinessContextType businessContext,
                             javax.security.auth.callback.CallbackHandler callbackHandler)
        Creates an instance of the client to communicate with the Marketing facade.
        Parameters:
        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.

    • Method Detail

      • getMarketingSpotData

        public java.util.List getMarketingSpotData(java.lang.String triggerParameters)
                                    throws MarketingSpotDataException
        This method returns a list of 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.
        Parameters:
        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&param1=value1&param2=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.

        Returns:
        The list of MarketingSpotData objects that matches the expression specified.
        Throws:
        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.

      • getMarketingSpotData

        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
        This method returns a list of 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.
        Parameters:
        eSpotName - The name of the e-Marketing Spot.
        usage - The usage type, as defined for the EMSPOT table.
        triggerParametersMap - A map of type containing all the e-Marketing Spot parameters. If there are no parameters, this parameter can be null.
        accessProfile - The access profile. This value can be null.
        Returns:
        The list of MarketingSpotData objects that matches the expression specified.
        Throws:
        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.

      • getMarketingSpot

        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
        This method returns a list of all 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.
        Parameters:
        usage - The usage type, as defined for the EMSPOT table.
        triggerParametersMap - A map of type containing all the e-Marketing Spot parameters. If there are no parameters, this parameter can be null.
        accessProfile - The access profile. This value can be null.
        Returns:
        The list of MarketingSpot objects that matches the expression specified.
        Throws:
        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.

      • getContentSpotData

        public java.util.List getContentSpotData(java.lang.String spotName,
                                         java.lang.Integer maxResults)
                                  throws com.ibm.commerce.marketing.facade.client.ContentSpotDataException
        This method returns a list of ContentSpotData objects with the data to display to the customer in the content spot.
        Parameters:
        spotName - The name of the content spot.
        maxResults - The maximum number of results to display in the content spot.
        Returns:
        The list of ContentSpotDatas that matches the expression specified.
        Throws:
        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.

      • getCampaignElementTemplate

        public CampaignElementTemplateType getCampaignElementTemplate(java.lang.String templateId)
                                                       throws CampaignElementTemplateException
        This method returns a CampaignElementTemplateType object representing a campaign element template.
        Parameters:
        templateId - The ID of the campaign element template to retrieve.
        Returns:
        The CampaignElementTemplateType object.
        Throws:
        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.

      • processMarketingTrigger

        public AcknowledgeMarketingTriggerDataAreaType processMarketingTrigger(java.lang.String action,
                                                                       java.util.Map nvps,
                                                                       java.lang.String triggerParameters)
        This method processes a marketing trigger. 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.
        Parameters:
        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&param2=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&param2=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.

        Returns:
        The AcknowledgeMarketingTriggerDataAreaType object.

      • evaluateMarketingTrigger

        public java.util.Map evaluateMarketingTrigger(java.util.Map parameters)
                                       throws MarketingTriggerException
        This method processes a marketing trigger with the 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&param2=B&param3=M
        Parameters:
        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.

        Returns:
        This method returns an empty Map
        Throws:
        MarketingTriggerException

      • createCampaign

        public AcknowledgeCampaignDataAreaType createCampaign(CampaignType campaign)
                                               throws CampaignException
        This method builds and then sends a request to create a campaign.
        Parameters:
        campaign - A CampaignType object to be created.
        Returns:
        This method returns the AcknowledgeCampaignDataAreaType object that contains the ID of the created campaign.
        Throws:
        CampaignException

      • createCampaign

        public AcknowledgeCampaignDataAreaType createCampaign(java.util.List campaignList)
                                               throws CampaignException
        This method builds and then sends a request to create campaigns.
        Parameters:
        campaignList - A list of CampaignType objects to be created.
        Returns:
        This method returns the AcknowledgeCampaignDataAreaType object that contains the IDs of the created campaigns.
        Throws:
        CampaignException

      • updateCampaign

        public RespondCampaignDataAreaType updateCampaign(CampaignType campaign)
                                           throws CampaignException
        This method builds and then sends a request to update a campaign.
        Parameters:
        campaign - A CampaignType object to be updated.
        Returns:
        This method returns the RespondCampaignDataAreaType object that contains the ID of the updated campaign.
        Throws:
        CampaignException

      • updateCampaign

        public RespondCampaignDataAreaType updateCampaign(java.util.List campaignList)
                                           throws CampaignException
        This method builds and then sends a request to update campaigns.
        Parameters:
        campaignList - A list of CampaignType objects to be updated.
        Returns:
        This method returns the RespondCampaignDataAreaType object that contains the IDs of the updated campaigns.
        Throws:
        CampaignException

      • deleteCampaign

        public AcknowledgeCampaignDataAreaType deleteCampaign(java.lang.String campaignId)
                                               throws CampaignException
        This method builds and then sends a request to delete a campaign.
        Parameters:
        campaignId - The ID of the campaign to be deleted.
        Returns:
        This method returns the AcknowledgeCampaignDataAreaType object that contains the ID of the deleted campaign.
        Throws:
        CampaignException

      • deleteCampaign

        public AcknowledgeCampaignDataAreaType deleteCampaign(java.util.List campaignIdList)
                                               throws CampaignException
        This method deletes campaigns.
        Parameters:
        campaignIdList - The list of IDs of the campaigns to be deleted.
        Returns:
        The AcknowledgeCampaignDataAreaType that contains the IDs of the deleted campaigns.
        Throws:
        CampaignException

      • createMarketingEmailTemplate

        public AcknowledgeMarketingEmailTemplateDataAreaType createMarketingEmailTemplate(java.util.List emailTemplateList)
                                                                           throws MarketingEmailTemplateException
        This method builds and then sends a request to create marketing e-mail templates.
        Parameters:
        emailTemplateList - A list of MarketingEmailTemplateType objects to be created.
        Returns:
        This method returns the AcknowledgeMarketingEmailTemplateDataAreaType object that contains the IDs of the created marketing e-mail templates.
        Throws:
        MarketingEmailTemplateException

      • updateMarketingEmailTemplate

        public RespondMarketingEmailTemplateDataAreaType updateMarketingEmailTemplate(java.util.List emailTemplateList)
                                                                       throws MarketingEmailTemplateException
        This method builds and then sends a request to update marketing e-mail templates.
        Parameters:
        emailTemplateList - A list of MarketingEmailTemplateType objects to be updated.
        Returns:
        This method returns the RespondMarketingEmailTemplateDataAreaType object that contains the IDs of the updated marketing e-mail templates.
        Throws:
        MarketingEmailTemplateException

      • deleteMarketingEmailTemplate

        public AcknowledgeMarketingEmailTemplateDataAreaType deleteMarketingEmailTemplate(java.lang.String emailTemplateId)
                                                                           throws MarketingEmailTemplateException
        This method builds and then sends a request to delete a marketing e-mail template.
        Parameters:
        emailTemplateId - The ID of the marketing e-mail template to be deleted.
        Returns:
        This method returns the AcknowledgeMarketingEmailTemplateDataAreaType object that contains the ID of the deleted marketing e-mail template.
        Throws:
        MarketingEmailTemplateException

      • deleteMarketingEmailTemplate

        public AcknowledgeMarketingEmailTemplateDataAreaType deleteMarketingEmailTemplate(java.util.List emailTemplateIdList)
                                                                           throws MarketingEmailTemplateException
        This method builds and then sends a request to delete marketing e-mail templates.
        Parameters:
        emailTemplateIdList - A list of IDs of the marketing e-mail templates to be deleted.
        Returns:
        This method returns the AcknowledgeMarketingEmailTemplateDataAreaType object that contains the IDs of the deleted marketing e-mail templates.
        Throws:
        MarketingEmailTemplateException

      • createActivity

        public AcknowledgeActivityDataAreaType createActivity(ActivityType activity)
                                               throws ActivityException
        This method builds and sends a request to create a marketing activity.
        Parameters:
        activity - An ActivityType object to be created.
        Returns:
        This method returns the AcknowledgeActivityDataAreaType object that contains the ID of the created activity.
        Throws:
        ActivityException

      • createActivity

        public AcknowledgeActivityDataAreaType createActivity(java.util.List activityList)
                                               throws ActivityException
        This method builds and then sends a request to create activities.
        Parameters:
        activityList - A list of ActivityType objects to be created.
        Returns:
        This method returns the AcknowledgeActivityDataAreaType object that contains the IDs of the created activities.
        Throws:
        ActivityException

      • updateActivity

        public RespondActivityDataAreaType updateActivity(ActivityType activity)
                                           throws ActivityException
        This method builds and then sends a request to update a marketing activity.
        Parameters:
        activity - An ActivityType object to be updated.
        Returns:
        This method returns the RespondActivityDataAreaType object that contains the ID of the updated activity.
        Throws:
        ActivityException

      • updateActivity

        public RespondActivityDataAreaType updateActivity(java.util.List activityList)
                                           throws ActivityException
        This method builds and then sends a request to update activities.
        Parameters:
        activityList - A list of ActivityType objects to be updated.
        Returns:
        This method returns the RespondActivityDataAreaType object that contains the IDs of the updated activities.
        Throws:
        ActivityException

      • deleteActivity

        public AcknowledgeActivityDataAreaType deleteActivity(java.lang.String activityId)
                                               throws ActivityException
        This method builds and then sends a request to delete a marketing activity.
        Parameters:
        activityId - The ID of the activity to be deleted.
        Returns:
        This method returns the AcknowledgeActivityDataAreaType object that contains the ID of the deleted activity.
        Throws:
        ActivityException

      • deleteActivity

        public AcknowledgeActivityDataAreaType deleteActivity(java.util.List activityIdList)
                                               throws ActivityException
        This method deletes activities.
        Parameters:
        activityIdList - The list of IDs of the activities to be deleted.
        Returns:
        The AcknowledgeActivityDataAreaType that contains the IDs of the deleted activities.
        Throws:
        ActivityException

      • activateActivity

        public AcknowledgeActivityDataAreaType activateActivity(java.lang.String activityId)
                                                 throws ActivityException
        This method activates an activity.
        Parameters:
        activityId - The ID of the activity to be activated.
        Returns:
        The AcknowledgeActivityDataAreaType that contains the ID of the activated activity.
        Throws:
        ActivityException

      • activateActivity

        public AcknowledgeActivityDataAreaType activateActivity(java.util.List activityIdList)
                                                 throws ActivityException
        This method activates activities.
        Parameters:
        activityIdList - The list of IDs of the activities to be activated.
        Returns:
        The AcknowledgeActivityDataAreaType that contains the IDs of the activated activities.
        Throws:
        ActivityException

      • deactivateActivity

        public AcknowledgeActivityDataAreaType deactivateActivity(java.lang.String activityId)
                                                   throws ActivityException
        This method deactivates an activity.
        Parameters:
        activityId - The ID of the activity to be deactivated.
        Returns:
        The AcknowledgeActivityDataAreaType that contains the ID of the deactivated activity.
        Throws:
        ActivityException

      • deactivateActivity

        public AcknowledgeActivityDataAreaType deactivateActivity(java.util.List activityIdList)
                                                   throws ActivityException
        This method deactivates activities.
        Parameters:
        activityIdList - The list of IDs of the activities to be deactivated.
        Returns:
        The AcknowledgeActivityDataAreaType that contains the IDs of the activated activities.
        Throws:
        ActivityException

      • processActivityWinner

        public AcknowledgeActivityDataAreaType processActivityWinner(java.lang.String activityId)
                                                      throws ActivityException
        This method processes the winner an activity experiment.
        Parameters:
        activityId - The ID of the activity to be processed.
        Returns:
        The AcknowledgeActivityDataAreaType that contains the ID of the processed activity.
        Throws:
        ActivityException

      • processActivityWinner

        public AcknowledgeActivityDataAreaType processActivityWinner(java.util.List activityIdList)
                                                      throws ActivityException
        This method processes the winners of activity experiments.
        Parameters:
        activityIdList - The list of IDs of the activities to be processed.
        Returns:
        The AcknowledgeActivityDataAreaType that contains the IDs of the processed activities.
        Throws:
        ActivityException

      • createElement

        public RespondActivityDataAreaType createElement(CampaignElementType element,
                                                 java.lang.String activityId)
                                          throws ActivityException
        This method builds and then sends a request to create a campaign element.
        Parameters:
        element - A CampaignElementType object to be created.
        activityId - The ID of the activity to which the element belongs.
        Returns:
        This method returns the RespondActivityDataAreaType object that contains the ID of the created element.
        Throws:
        ActivityException

      • createElement

        public RespondActivityDataAreaType createElement(java.util.List elementList,
                                                 java.util.List activityIdList)
                                          throws ActivityException
        This method builds and then sends a request to create campaign elements. If all the elements are in the same activity, then use the method createElementsInActivity.
        Parameters:
        elementList - A list of CampaignElementType objects to be created.
        activityIdList - The list of IDs of the activities to which the elements belong.
        Returns:
        This method returns the RespondActivityDataAreaType object that contains the IDs of the created elements.
        Throws:
        ActivityException

      • updateElement

        public RespondActivityDataAreaType updateElement(CampaignElementType element,
                                                 java.lang.String activityId)
                                          throws ActivityException
        This method builds and then sends a request to update a campaign element.
        Parameters:
        element - A CampaignElementType object to be updated.
        activityId - The ID of the activity to which the element belongs.
        Returns:
        This method returns the RespondActivityDataAreaType object that contains the ID of the updated element.
        Throws:
        ActivityException

      • updateElement

        public RespondActivityDataAreaType updateElement(java.util.List elementList,
                                                 java.util.List activityIdList)
                                          throws ActivityException
        This method builds and then sends a request to update campaign elements. If all the elements are in the same activity, then use the method updateElementsInActivity.
        Parameters:
        elementList - A list of CampaignElementType objects to be updated.
        activityIdList - The list of IDs of the activities to which the elements belongs.
        Returns:
        This method returns the RespondActivityDataAreaType object that contains the IDs of the updated elements.
        Throws:
        ActivityException

      • deleteElement

        public RespondActivityDataAreaType deleteElement(java.lang.String elementName,
                                                 java.lang.String activityId)
                                          throws ActivityException
        This method deletes a campaign element.
        Parameters:
        elementName - The name of the element to be deleted.
        activityId - The ID of the activity associated with the element to be deleted.
        Returns:
        The AcknowledgeActivityDataAreaType that contains the ID of the deleted element.
        Throws:
        ActivityException

      • deleteElement

        public RespondActivityDataAreaType deleteElement(java.lang.Integer elementId,
                                                 java.lang.String activityId)
                                          throws ActivityException
        This method deletes a campaign element.
        Parameters:
        elementId - The uniqueId of the element to be deleted.
        activityId - The ID of the activity associated with the element to be deleted.
        Returns:
        The AcknowledgeActivityDataAreaType that contains the ID of the deleted element.
        Throws:
        ActivityException

      • deleteElement

        public RespondActivityDataAreaType deleteElement(java.util.List elementNameList,
                                                 java.util.List activityIdList)
                                          throws ActivityException
        This method deletes campaign elements.
        Parameters:
        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.
        Returns:
        The AcknowledgeActivityDataAreaType that contains the IDs of the deleted elements.
        Throws:
        ActivityException

      • createMarketingContent

        public AcknowledgeMarketingContentDataAreaType createMarketingContent(java.util.List marketingContentList)
                                                               throws MarketingContentException
        This method builds and then sends a request to create marketing content.
        Parameters:
        marketingContentList - A list of MarketingContentType objects to be created.
        Returns:
        This method returns the AcknowledgeMarketingContentDataAreaType object that contains the IDs of the created marketing content.
        Throws:
        MarketingContentException

      • updateMarketingContent

        public RespondMarketingContentDataAreaType updateMarketingContent(java.util.List marketingContentList)
                                                           throws MarketingContentException
        This method builds and then sends a request to update marketing content.
        Parameters:
        marketingContentList - A list of MarketingContentType objects to be updated.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the IDs of the updated marketing content.
        Throws:
        MarketingContentException

      • deleteMarketingContent

        public AcknowledgeMarketingContentDataAreaType deleteMarketingContent(java.lang.String marketingContentId)
                                                               throws MarketingContentException
        This method builds and then sends a request to delete a marketing content.
        Parameters:
        marketingContentId - The ID of the marketing content to be deleted.
        Returns:
        This method returns the AcknowledgeMarketingContentDataAreaType object that contains the ID of the deleted marketing content.
        Throws:
        MarketingContentException

      • deleteMarketingContent

        public AcknowledgeMarketingContentDataAreaType deleteMarketingContent(java.util.List marketingContentIdList)
                                                               throws MarketingContentException
        This method builds and then sends a request to delete marketing content.
        Parameters:
        marketingContentIdList - A list of IDs of the marketing content to be deleted.
        Returns:
        This method returns the AcknowledgeMarketingContentDataAreaType object that contains the IDs of the deleted marketing content.
        Throws:
        MarketingContentException

      • createMarketingContentDescription

        public RespondMarketingContentDataAreaType createMarketingContentDescription(MarketingContentDescriptionType description,
                                                                             java.lang.String marketingContentId)
                                                                      throws MarketingContentException
        This method builds and then sends a request to create a marketing content description.
        Parameters:
        description - A MarketingContentDescriptionType object to be created.
        marketingContentId - The ID of the marketing content to which the description belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the ID of the marketing content.
        Throws:
        MarketingContentException

      • createMarketingContentImageMap

        public RespondMarketingContentDataAreaType createMarketingContentImageMap(com.ibm.commerce.marketing.facade.datatypes.MarketingContentImageMapType imageMap,
                                                                          java.lang.String marketingContentId)
                                                                   throws MarketingContentException
        This method builds and then sends a request to create a marketing content image map.
        Parameters:
        imageMap - A MarketingContentImageMapType object to be created.
        marketingContentId - The ID of the marketing content to which the image map belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the ID of the marketing content.
        Throws:
        MarketingContentException

      • createMarketingContentDescription

        public RespondMarketingContentDataAreaType createMarketingContentDescription(java.util.List descriptionList,
                                                                             java.util.List marketingContentIdList)
                                                                      throws MarketingContentException
        This method builds and then sends a request to create marketing content descriptions.
        Parameters:
        descriptionList - A list of MarketingContentDescriptionType objects to be created.
        marketingContentIdList - The list of IDs of the marketing content to which the descriptions belong.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the IDs of the marketing content.
        Throws:
        MarketingContentException

      • createMarketingContentImageMap

        public RespondMarketingContentDataAreaType createMarketingContentImageMap(java.util.List imageMapList,
                                                                          java.util.List marketingContentIdList)
                                                                   throws MarketingContentException
        This method builds and then sends a request to create marketing content image maps.
        Parameters:
        imageMapList - A list of MarketingContentImageMapType objects to be created.
        marketingContentIdList - The list of IDs of the marketing content to which the image maps belong.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the IDs of the marketing content.
        Throws:
        MarketingContentException

      • updateMarketingContentDescription

        public RespondMarketingContentDataAreaType updateMarketingContentDescription(MarketingContentDescriptionType description,
                                                                             java.lang.String marketingContentId)
                                                                      throws MarketingContentException
        This method builds and then sends a request to update a marketing content description.
        Parameters:
        description - A MarketingContentDescriptionType object to be updated.
        marketingContentId - The ID of the marketing content to which the description belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the ID of the updated marketing content.
        Throws:
        MarketingContentException

      • updateMarketingContentImageMap

        public RespondMarketingContentDataAreaType updateMarketingContentImageMap(com.ibm.commerce.marketing.facade.datatypes.MarketingContentImageMapType imageMap,
                                                                          java.lang.String marketingContentId)
                                                                   throws MarketingContentException
        This method builds and then sends a request to update a marketing content image map.
        Parameters:
        imageMap - A MarketingContentImageMapType object to be updated.
        marketingContentId - The ID of the marketing content to which the image map belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the ID of the updated marketing content.
        Throws:
        MarketingContentException

      • updateMarketingContentDescription

        public RespondMarketingContentDataAreaType updateMarketingContentDescription(java.util.List descriptionList,
                                                                             java.util.List marketingContentIdList)
                                                                      throws MarketingContentException
        This method builds and then sends a request to update marketing content descriptions.
        Parameters:
        descriptionList - A list of MarketingContentDescriptionType objects to be updated.
        marketingContentIdList - The list of IDs of the marketing content to which the descriptions belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the IDs of the updated marketing content.
        Throws:
        MarketingContentException

      • updateMarketingContentImageMap

        public RespondMarketingContentDataAreaType updateMarketingContentImageMap(java.util.List imageMapList,
                                                                          java.util.List marketingContentIdList)
                                                                   throws MarketingContentException
        This method builds and then sends a request to update marketing content image maps.
        Parameters:
        imageMapList - A list of MarketingContentImageMapType objects to be updated.
        marketingContentIdList - The list of IDs of the marketing content to which the image maps belong.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the IDs of the updated marketing content.
        Throws:
        MarketingContentException

      • deleteMarketingContentDescription

        public RespondMarketingContentDataAreaType deleteMarketingContentDescription(MarketingContentDescriptionType description,
                                                                             java.lang.String marketingContentId)
                                                                      throws MarketingContentException
        This method builds and then sends a request to delete a marketing content description.
        Parameters:
        description - A MarketingContentDescriptionType object to be deleted.
        marketingContentId - The ID of the marketing content to which the description belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the ID of the updated marketing content.
        Throws:
        MarketingContentException

      • deleteMarketingContentImageMap

        public RespondMarketingContentDataAreaType deleteMarketingContentImageMap(com.ibm.commerce.marketing.facade.datatypes.MarketingContentImageMapType imageMap,
                                                                          java.lang.String marketingContentId)
                                                                   throws MarketingContentException
        This method builds and then sends a request to delete a marketing content image map.
        Parameters:
        imageMap - A MarketingContentImageMapType object to be deleted.
        marketingContentId - The ID of the marketing content to which the image map belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the ID of the updated marketing content.
        Throws:
        MarketingContentException

      • deleteMarketingContentDescription

        public RespondMarketingContentDataAreaType deleteMarketingContentDescription(java.util.List descriptionList,
                                                                             java.util.List marketingContentIdList)
                                                                      throws MarketingContentException
        This method builds and then sends a request to delete marketing content descriptions.
        Parameters:
        descriptionList - A list of MarketingContentDescriptionType objects to be deleted.
        marketingContentIdList - The list of IDs of the marketing content to which the descriptions belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the IDs of the updated marketing content.
        Throws:
        MarketingContentException

      • deleteMarketingContentImageMap

        public RespondMarketingContentDataAreaType deleteMarketingContentImageMap(java.util.List imageMapList,
                                                                          java.util.List marketingContentIdList)
                                                                   throws MarketingContentException
        This method builds and then sends a request to delete marketing content image maps.
        Parameters:
        imageMapList - A list of MarketingContentImagemapType objects to be deleted.
        marketingContentIdList - The list of IDs of the marketing content to which the image maps belong.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the IDs of the updated marketing content.
        Throws:
        MarketingContentException

      • createMarketingContentAttachment

        public RespondMarketingContentDataAreaType createMarketingContentAttachment(AttachmentReferenceType attachment,
                                                                            java.lang.String marketingContentId)
                                                                     throws MarketingContentException
        This method builds and then sends a request to create a marketing content attachment reference.
        Parameters:
        attachment - An AttachmentReferenceType object to be created.
        marketingContentId - The ID of the marketing content to which the attachment belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the ID of the marketing content.
        Throws:
        MarketingContentException

      • createMarketingContentAttachment

        public RespondMarketingContentDataAreaType createMarketingContentAttachment(java.util.List attachmentList,
                                                                            java.util.List marketingContentIdList)
                                                                     throws MarketingContentException
        This method builds and then sends a request to create a marketing content attachment reference.
        Parameters:
        attachmentList - A list of AttachmentReferenceType objects to be created.
        marketingContentIdList - The list of IDs of the marketing content to which the attachments belong.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the IDs of the marekting content.
        Throws:
        MarketingContentException

      • updateMarketingContentAttachment

        public RespondMarketingContentDataAreaType updateMarketingContentAttachment(AttachmentReferenceType attachment,
                                                                            java.lang.String marketingContentId)
                                                                     throws MarketingContentException
        This method builds and then sends a request to update a marketing content attachment reference.
        Parameters:
        attachment - An AttachmentReferenceType object to be updated.
        marketingContentId - The ID of the marketing content to which the attachment belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the ID of the updated marketing content.
        Throws:
        MarketingContentException

      • updateMarketingContentAttachment

        public RespondMarketingContentDataAreaType updateMarketingContentAttachment(java.util.List attachmentList,
                                                                            java.util.List marketingContentIdList)
                                                                     throws MarketingContentException
        This method builds and then sends a request to update a marketing content attachment reference.
        Parameters:
        attachmentList - A list of AttachmentReferenceType objects to be updated.
        marketingContentIdList - The list of IDs of the marketing content to which the attachments belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the IDs of the updated marketing content.
        Throws:
        MarketingContentException

      • deleteMarketingContentAttachment

        public RespondMarketingContentDataAreaType deleteMarketingContentAttachment(AttachmentReferenceType attachment,
                                                                            java.lang.String marketingContentId)
                                                                     throws MarketingContentException
        This method builds and then sends a request to delete a marketing content attachment reference.
        Parameters:
        attachment - An AttachmentReferenceType object to be deleted.
        marketingContentId - The ID of the marketing content to which the attachment belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the ID of the updated marketing content.
        Throws:
        MarketingContentException

      • deleteMarketingContentAttachment

        public RespondMarketingContentDataAreaType deleteMarketingContentAttachment(java.util.List attachmentList,
                                                                            java.util.List marketingContentIdList)
                                                                     throws MarketingContentException
        This method builds and then sends a request to delete a marketing content attachment reference.
        Parameters:
        attachmentList - A list of AttachmentReferenceType objects to be deleted.
        marketingContentIdList - The list of IDs of the marketing content to which the attachments belongs.
        Returns:
        This method returns the RespondMarketingContentDataAreaType object that contains the IDs of the updated marketing content.
        Throws:
        MarketingContentException

      • createMarketingSpot

        public AcknowledgeMarketingSpotDataAreaType createMarketingSpot(java.util.List emspotList)
                                                         throws MarketingSpotException
        This method builds and then sends a request to create marketing spots.
        Parameters:
        emspotList - A list of MarketingSpotType objects to be created.
        Returns:
        This method returns the AcknowledgeMarketingSpotDataAreaType object that contains the IDs of the created marketing spots.
        Throws:
        MarketingSpotException

      • updateMarketingSpot

        public RespondMarketingSpotDataAreaType updateMarketingSpot(java.util.List emspotList)
                                                     throws MarketingSpotException
        This method builds and then sends a request to update marketing spots.
        Parameters:
        emspotList - A list of MarketingSpotType objects to be updated.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the IDs of the updated marketing spots.
        Throws:
        MarketingSpotException

      • deleteMarketingSpot

        public AcknowledgeMarketingSpotDataAreaType deleteMarketingSpot(java.lang.String emspotId)
                                                         throws MarketingSpotException
        This method builds and then sends a request to delete a marketing spot.
        Parameters:
        emspotId - The ID of the marketing spot to be deleted.
        Returns:
        This method returns the AcknowledgeMarketingSpotDataAreaType object that contains the ID of the deleted marketing spot.
        Throws:
        MarketingSpotException

      • deleteMarketingSpot

        public AcknowledgeMarketingSpotDataAreaType deleteMarketingSpot(java.util.List emspotIdList)
                                                         throws MarketingSpotException
        This method deletes marketing spots.
        Parameters:
        emspotIdList - The list of IDs of the marketing spots to be deleted.
        Returns:
        The AcknowledgeMarketingSpotDataAreaType that contains the IDs of the deleted marketing spots.
        Throws:
        MarketingSpotException

      • createMarketingSpotDefaultContent

        public RespondMarketingSpotDataAreaType createMarketingSpotDefaultContent(DefaultContentType defaultContent,
                                                                          java.lang.String marketingSpotId)
                                                                   throws MarketingSpotException
        This method builds and then sends a request to create a marketing spot default content.
        Parameters:
        defaultContent - A DefaultContentType object to be created.
        marketingSpotId - The ID of the marketing spot to which the default content belongs.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the ID of the default content.
        Throws:
        MarketingSpotException

      • createMarketingSpotDefaultContent

        public RespondMarketingSpotDataAreaType createMarketingSpotDefaultContent(java.util.List defaultContentList,
                                                                          java.util.List marketingSpotIdList)
                                                                   throws MarketingSpotException
        This method builds and then sends a request to create marketing spot default content.
        Parameters:
        defaultContentList - A list of DefaultContentType objects to be created.
        marketingSpotIdList - The list of IDs of the marketing spot to which the default content belong.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the IDs of the marketing default content.
        Throws:
        MarketingSpotException

      • deleteMarketingSpotDefaultContent

        public RespondMarketingSpotDataAreaType deleteMarketingSpotDefaultContent(DefaultContentType defaultContent,
                                                                          java.lang.String marketingSpotId)
                                                                   throws MarketingSpotException
        This method builds and then sends a request to delete a marketing spot default content.
        Parameters:
        defaultContent - A DefaultContentType object to be deleted.
        marketingSpotId - The ID of the marketing spot to which the default content belongs.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the ID of the deleted marketing default content.
        Throws:
        MarketingSpotException

      • deleteMarketingSpotDefaultContent

        public RespondMarketingSpotDataAreaType deleteMarketingSpotDefaultContent(java.util.List defaultContentList,
                                                                          java.util.List marketingSpotIdList)
                                                                   throws MarketingSpotException
        This method builds and then sends a request to delete marketing spot default content.
        Parameters:
        defaultContentList - A list of DefaultContentType objects to be deleted.
        marketingSpotIdList - The list of IDs of the marketing spots to which the default content belong.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the IDs of the deleted default content.
        Throws:
        MarketingSpotException

      • updateMarketingSpotDefaultContent

        public RespondMarketingSpotDataAreaType updateMarketingSpotDefaultContent(DefaultContentType defaultContent,
                                                                          java.lang.String marketingSpotId)
                                                                   throws MarketingSpotException
        This method builds and then sends a request to update a marketing spot default content.
        Parameters:
        defaultContent - A DefaultContentType object to be updated.
        marketingSpotId - The ID of the marketing spot to which the default content belongs.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the ID of the updated marketing default content.
        Throws:
        MarketingSpotException

      • updateMarketingSpotDefaultContent

        public RespondMarketingSpotDataAreaType updateMarketingSpotDefaultContent(java.util.List defaultContentList,
                                                                          java.util.List marketingSpotIdList)
                                                                   throws MarketingSpotException
        This method builds and then sends a request to update marketing spot default content.
        Parameters:
        defaultContentList - A list of DefaultContentType objects to be updated.
        marketingSpotIdList - The list of IDs of the marketing spots to which the default content belong.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the IDs of the updated default content.
        Throws:
        MarketingSpotException

      • createMarketingSpotTitle

        public RespondMarketingSpotDataAreaType createMarketingSpotTitle(com.ibm.commerce.marketing.facade.datatypes.DefaultMarketingSpotTitleType marketingSpotTitle,
                                                                 java.lang.String marketingSpotId)
                                                          throws MarketingSpotException
        This method builds and then sends a request to create a marketing spot default title.
        Parameters:
        marketingSpotTitle - A DefaultMarketingSpotTitleType object to be created.
        marketingSpotId - The ID of the marketing spot to which the default title belongs.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the ID of the default title.
        Throws:
        MarketingSpotException

      • createMarketingSpotTitle

        public RespondMarketingSpotDataAreaType createMarketingSpotTitle(java.util.List titleList,
                                                                 java.util.List marketingSpotIdList)
                                                          throws MarketingSpotException
        This method builds and then sends a request to create marketing spot default title.
        Parameters:
        titleList - A list of DefaultMarketingSpotTitleType objects to be created.
        marketingSpotIdList - The list of IDs of the marketing spot to which the default title belong.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the IDs of the marketing default title.
        Throws:
        MarketingSpotException

      • deleteMarketingSpotTitle

        public RespondMarketingSpotDataAreaType deleteMarketingSpotTitle(com.ibm.commerce.marketing.facade.datatypes.DefaultMarketingSpotTitleType marketingSpotTitle,
                                                                 java.lang.String marketingSpotId)
                                                          throws MarketingSpotException
        This method builds and then sends a request to delete a marketing spot default title.
        Parameters:
        marketingSpotTitle - A DefaultMarketingSpotTitleType object to be deleted.
        marketingSpotId - The ID of the marketing spot to which the default title belongs.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the ID of the deleted marketing default title.
        Throws:
        MarketingSpotException

      • deleteMarketingSpotTitle

        public RespondMarketingSpotDataAreaType deleteMarketingSpotTitle(java.util.List titleList,
                                                                 java.util.List marketingSpotIdList)
                                                          throws MarketingSpotException
        This method builds and then sends a request to delete marketing spot default title.
        Parameters:
        titleList - A list of DefaultMarketingSpotTitleType objects to be deleted.
        marketingSpotIdList - The list of IDs of the marketing spots to which the default title belong.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the IDs of the deleted default title.
        Throws:
        MarketingSpotException

      • updateMarketingSpotTitle

        public RespondMarketingSpotDataAreaType updateMarketingSpotTitle(com.ibm.commerce.marketing.facade.datatypes.DefaultMarketingSpotTitleType title,
                                                                 java.lang.String marketingSpotId)
                                                          throws MarketingSpotException
        This method builds and then sends a request to update a marketing spot default title.
        Parameters:
        title - A DefaultMarketingSpotTitleType object to be updated.
        marketingSpotId - The ID of the marketing spot to which the default title belongs.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the ID of the updated marketing default title.
        Throws:
        MarketingSpotException

      • updateMarketingSpotTitle

        public RespondMarketingSpotDataAreaType updateMarketingSpotTitle(java.util.List titleList,
                                                                 java.util.List marketingSpotIdList)
                                                          throws MarketingSpotException
        This method builds and then sends a request to update marketing spot default title.
        Parameters:
        titleList - A list of DefaultMarketingSpotTitleType objects to be updated.
        marketingSpotIdList - The list of IDs of the marketing spots to which the default title belong.
        Returns:
        This method returns the RespondMarketingSpotDataAreaType object that contains the IDs of the updated default title.
        Throws:
        MarketingSpotException
Skip navigation links