Package com.day.cq.analytics.testandtarget

Interface TargetMediator

All Superinterfaces:

TestandtargetCampaignMediator

@ProviderType
public interface TargetMediator
extends TestandtargetCampaignMediator

The TargetMediator creates and keeps sync of reusable Adobe Target objects such as segments and offers

Field Summary

Fields

Modifier and Type	Field	Description
static String	PN_AUTHOR_EXTERNAL_ID	The JCR property that holds the Adobe Target id on the managed objects on the author instance.
static String	PN_EXTERNAL_ID	Deprecated. Use PN_PUBLISH_EXTERNAL_ID or PN_AUTHOR_EXTERNAL_ID instead
static String	PN_PUBLISH_EXTERNAL_ID	The JCR property that holds the Adobe Target id on the managed objects on the author instance.

Method Summary

Modifier and Type	Method	Description
void	deleteCampaign(String campaignPath)	Deletes the Target campaign associated with the campaign at the provided path.
void	deleteOffer(Configuration configuration, long id)	Deprecated.
void	deleteOffer(Configuration configuration, long id, SaveOfferRequest request)	Deletes the Target offer with the the provided id.
long	syncOffer(Configuration configuration, SaveOfferRequest request)	Synchronizes an offer with Adobe Target.
long	syncOffer(Configuration configuration, String offerPath)	Synchronizes an offer with Adobe Target.
long	syncSegment(Configuration configuration, String segmentPath)	Synchronizes a segment with Adobe Target

Methods inherited from interface com.day.cq.analytics.testandtarget.TestandtargetCampaignMediator

deactivatePublishCampaign, syncAuthorCampaign, syncPublishCampaign

Field Detail

PN_EXTERNAL_ID

static final String PN_EXTERNAL_ID

Deprecated.

Use PN_PUBLISH_EXTERNAL_ID or PN_AUTHOR_EXTERNAL_ID instead

The JCR property that holds the Adobe Target id on the managed objects

See Also:

Constant Field Values

PN_AUTHOR_EXTERNAL_ID

static final String PN_AUTHOR_EXTERNAL_ID

The JCR property that holds the Adobe Target id on the managed objects on the author instance.

See Also:

Constant Field Values

PN_PUBLISH_EXTERNAL_ID

static final String PN_PUBLISH_EXTERNAL_ID

The JCR property that holds the Adobe Target id on the managed objects on the author instance.

See Also:

Constant Field Values

Method Detail

syncOffer

long syncOffer(Configuration configuration,
               String offerPath)
        throws TestandtargetException

Synchronizes an offer with Adobe Target. After a successful synchronization this method returns the object id from Target

Parameters:

offerPath - the repository path of the offer.

configuration - the cloud services configuration containing the Adobe Target account details

Returns:

the object id from Target

Throws:

TestandtargetException - TestandtargetException

syncOffer

long syncOffer(Configuration configuration,
               SaveOfferRequest request)
        throws TestandtargetException

Synchronizes an offer with Adobe Target. After a successful synchronization this method returns the object id from Adobe Target.

Parameters:

configuration - the Adobe Target cloud service configuration.

request - a SaveOfferRequest object containing the offer's data - title and content.

Returns:

the offerId generated by Adobe Target.

Throws:

TestandtargetException - if any errors are encountered during synchronization

syncSegment

long syncSegment(Configuration configuration,
                 String segmentPath)
          throws TestandtargetException

Synchronizes a segment with Adobe Target

Parameters:

segmentPath - Segment Path

configuration - the cloud services configuration containing the Adobe Target account details

Returns:

the object id from Target.

Throws:

TestandtargetException - TestandtargetException

deleteCampaign

void deleteCampaign(String campaignPath)
             throws TestandtargetException

Deletes the Target campaign associated with the campaign at the provided path.

Parameters:

campaignPath - the repository path of the campaign.

Throws:

TestandtargetException - TestandtargetException

deleteOffer

@Deprecated
void deleteOffer(Configuration configuration,
                 long id)
          throws TestandtargetException

Deprecated.

Deletes the Target offer with the the provided id.

Parameters:

configuration - the cloud services configuration containing the Adobe Target account details.

id - the offer id.

Throws:

TestandtargetException - TestandtargetException

deleteOffer

void deleteOffer(Configuration configuration,
                 long id,
                 SaveOfferRequest request)
          throws TestandtargetException

Deletes the Target offer with the the provided id.

Parameters:

configuration - the cloud services configuration containing the Adobe Target account details.

id - the offer id.

request - a SaveOfferRequest object containing the offer's data

Throws:

TestandtargetException - TestandtargetException