com.day.cq.analytics.testandtarget

Interface TestandtargetService

public interface TestandtargetService

The TestandtargetService is the entry point for all the operations which interact with the Test&Target REST API.

See Also:

TestandtargetCampaignMediator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAMPAIGN_STATE_APPROVED
static java.lang.String	CAMPAIGN_STATE_DEACTIVATED
static java.lang.String	OPERATION_CAMPAIGN_LIST campaign list operation
static java.lang.String	OPERATION_DELETE Widget offer deletion operation
static java.lang.String	OPERATION_FOLDER_LIST folder list operation
static java.lang.String	OPERATION_GET_HTML_OFFER HTML offer get operation
static java.lang.String	OPERATION_HTML_OFFER_LIST HTML offer list operation
static java.lang.String	OPERATION_REPORT
static java.lang.String	OPERATION_SAVE Widget offer save operation
static java.lang.String	OPERATION_SAVE_CAMPAIGN Campaign create operation
static java.lang.String	OPERATION_SAVE_HTML_OFFER HTML offer save operation
static java.lang.String	OPERATION_SET_CAMPAIGN_STATE save operation
static java.lang.String	PN_CLIENTCODE Property name client code
static java.lang.String	PN_EMAIL Property name E-Mail
static java.lang.String	PN_PASSWORD Property name password

Method Summary

Methods

Modifier and Type	Method and Description
void	checkCredentials(java.lang.String clientcode, java.lang.String email, java.lang.String password) Checks the provided email, password and clientcode by issuing an API call on the method campaignList with a dummy search string.
void	createHTMLOffer(Configuration configuration, java.lang.String offerName, java.lang.String folderId, java.lang.String content) Creates an HTML offer.
java.lang.String	createWidgetOffer(Configuration configuration, java.lang.String name, java.lang.String url, java.lang.String id) Creates a widget offer.
HTMLOffer	getHTMLOffer(Configuration configuration, java.lang.String offerName) Gets a HTML offer.
Reports	getPerformanceReport(Configuration configuration, ReportType reportType, java.lang.String thirdPartyCampaignId, java.lang.String campaignId, java.util.Date start, java.util.Date end, Resolution resolution) Retrieves the performance report data for a specific campaign
java.util.Map<java.lang.Integer,java.lang.String>	listCampaigns(Configuration configuration, java.util.Date before, java.util.Date after, java.lang.String environment, java.lang.String name, java.lang.String state, java.lang.String label) Returns a Map with campaigns.
Folder	listFolders(Configuration configuration) Returns a Tree of the available folders on Test&Target.
java.util.Collection<Offer>	listOffers(Configuration configuration, java.lang.String folderId) Returns a JSON representation of offers.
java.lang.String	publishOffer(Configuration configuration, java.lang.String name, java.lang.String url, java.lang.String id) Deprecated.
void	saveCampaign(Configuration configuration, java.lang.String thirdPartyId, com.day.cq.analytics.testandtarget.impl.TestandtargetCampaign campaign) Creates or updates a campaign
boolean	setCampaignState(Configuration configuration, java.lang.String campaignState, java.lang.String testAndTargetCampaignId, java.lang.String thirdPartyCampaignId) Set the state of a campaign.
java.lang.String	unpublishOffer(Configuration configuration, java.lang.String name, java.lang.String url, java.lang.String id) Deprecated.

Field Detail

OPERATION_FOLDER_LIST

static final java.lang.String OPERATION_FOLDER_LIST

folder list operation

See Also:

Constant Field Values

OPERATION_CAMPAIGN_LIST

static final java.lang.String OPERATION_CAMPAIGN_LIST

campaign list operation

See Also:

Constant Field Values

OPERATION_SAVE_HTML_OFFER

static final java.lang.String OPERATION_SAVE_HTML_OFFER

HTML offer save operation

See Also:

Constant Field Values

OPERATION_GET_HTML_OFFER

static final java.lang.String OPERATION_GET_HTML_OFFER

HTML offer get operation

See Also:

Constant Field Values

OPERATION_HTML_OFFER_LIST

static final java.lang.String OPERATION_HTML_OFFER_LIST

HTML offer list operation

See Also:

Constant Field Values

OPERATION_DELETE

static final java.lang.String OPERATION_DELETE

Widget offer deletion operation

See Also:

Constant Field Values

OPERATION_SAVE

static final java.lang.String OPERATION_SAVE

Widget offer save operation

See Also:

Constant Field Values

OPERATION_SET_CAMPAIGN_STATE

static final java.lang.String OPERATION_SET_CAMPAIGN_STATE

save operation

See Also:

Constant Field Values

OPERATION_SAVE_CAMPAIGN

static final java.lang.String OPERATION_SAVE_CAMPAIGN

Campaign create operation

See Also:

Constant Field Values

OPERATION_REPORT

static final java.lang.String OPERATION_REPORT

See Also:

Constant Field Values

PN_CLIENTCODE

static final java.lang.String PN_CLIENTCODE

Property name client code

See Also:

Constant Field Values

PN_EMAIL

static final java.lang.String PN_EMAIL

Property name E-Mail

See Also:

Constant Field Values

PN_PASSWORD

static final java.lang.String PN_PASSWORD

Property name password

See Also:

Constant Field Values

CAMPAIGN_STATE_APPROVED

static final java.lang.String CAMPAIGN_STATE_APPROVED

See Also:

Constant Field Values

CAMPAIGN_STATE_DEACTIVATED

static final java.lang.String CAMPAIGN_STATE_DEACTIVATED

See Also:

Constant Field Values

Method Detail

listFolders

Folder listFolders(Configuration configuration)
                   throws TestandtargetException

Returns a Tree of the available folders on Test&Target.

Parameters:

configuration - Service Configuration

Returns:

A Tree of available folders

Throws:

TestandtargetException

publishOffer

@Deprecated
java.lang.String publishOffer(Configuration configuration,
                                       java.lang.String name,
                                       java.lang.String url,
                                       java.lang.String id)
                              throws TestandtargetException

Deprecated.

Creates a widget offer on Test&Target.

Parameters:

configuration - Service Configuration

name - Name of the widget offer

url - The encoded URL of the third-party server that hosts the dynamically generated response

id - The third-party ID of the widget offer

Returns:

A string representation of the third-party id

Throws:

TestandtargetException

unpublishOffer

@Deprecated
java.lang.String unpublishOffer(Configuration configuration,
                                         java.lang.String name,
                                         java.lang.String url,
                                         java.lang.String id)
                                throws TestandtargetException

Deprecated.

Deletes a widget offer on Test&Target.

Parameters:

configuration - Service Configuration

name - Name of the widget offer

url - The encoded URL of the third-party server that hosts the dynamically generated response

id - The third-party ID of the widget offer

Returns:

A string representation of the third-party id

Throws:

TestandtargetException

saveCampaign

void saveCampaign(Configuration configuration,
                java.lang.String thirdPartyId,
                com.day.cq.analytics.testandtarget.impl.TestandtargetCampaign campaign)
                  throws TestandtargetException

Creates or updates a campaign

Parameters:

configuration - Service Configuration

thirdPartyId - The campaign third party id, used for tracking updates

campaign - TODO

Throws:

TestandtargetException

createWidgetOffer

java.lang.String createWidgetOffer(Configuration configuration,
                                 java.lang.String name,
                                 java.lang.String url,
                                 java.lang.String id)
                                   throws TestandtargetException

Creates a widget offer.

Parameters:

configuration - Service Configuration

name - Name of the widget offer

url - The encoded URL of the third-party server that hosts the dynamically generated response

id - The third-party ID of the widget offer

Returns:

A string representation of the third-party id

Throws:

TestandtargetException

createHTMLOffer

void createHTMLOffer(Configuration configuration,
                   java.lang.String offerName,
                   java.lang.String folderId,
                   java.lang.String content)
                     throws TestandtargetException

Creates an HTML offer.

Parameters:

configuration - Service Configuration

offerName - Name of the offer

folderId - Folder id

content - Offer content as plain HTML.

Throws:

TestandtargetException

getHTMLOffer

HTMLOffer getHTMLOffer(Configuration configuration,
                     java.lang.String offerName)
                       throws TestandtargetException

Gets a HTML offer.

Parameters:

configuration - Service Configuration

offerName - Name of the offer

folderId - Folder id

Returns:

An HTMLOffer

Throws:

TestandtargetException

listOffers

java.util.Collection<Offer> listOffers(Configuration configuration,
                                     java.lang.String folderId)
                                       throws TestandtargetException

Returns a JSON representation of offers.

Parameters:

configuration - Service Configuration

folderId - Folder id

Returns:

An Collection of Offers

Throws:

TestandtargetException

listCampaigns

java.util.Map<java.lang.Integer,java.lang.String> listCampaigns(Configuration configuration,
                                                              java.util.Date before,
                                                              java.util.Date after,
                                                              java.lang.String environment,
                                                              java.lang.String name,
                                                              java.lang.String state,
                                                              java.lang.String label)
                                                                throws TestandtargetException

Returns a Map with campaigns. The Map key contains the campaign ID and the Map value the campaign name.

Parameters:

configuration - Service Configuration

before - A date value. Includes campaigns that were active at least once before the specified date. By default, the before parameter is 2100-01-01T00:00.

after - A date value. Includes campaigns that were active at least once after the specified date. By default, the after parameter is 1969-00-00T00:00.

environment - A URL-encoded host group name, as defined in the T&T Tool. By default, the environment value is Production.

name - The campaign name, or portion of the campaign name, that you want to match.

state - Comma-separated list of states to match. Supported values include: saved, activated, library. By default, the filtered results include all states.

label - Comma-separated list of labels to match. By default, the filtered results include all labels.

Returns:

Throws:

TestandtargetException

setCampaignState

boolean setCampaignState(Configuration configuration,
                       java.lang.String campaignState,
                       java.lang.String testAndTargetCampaignId,
                       java.lang.String thirdPartyCampaignId)
                         throws TestandtargetException

Set the state of a campaign.

Parameters:

configuration - Service Configuration

state - The campaign state , one of CAMPAIGN_STATE_APPROVED or CAMPAIGN_STATE_DEACTIVATED

testAndTargetCampaignId - The campaign identifier. You must provide either testAndTargetCampaignId or thirdPartyCampaignId

thirdPartyCampaignId - The third-party campaign identifier. You must provide either testAndTargetCampaignId or thirdPartyCampaignId

Returns:

true if the operation succeeded

Throws:

TestandtargetException

checkCredentials

void checkCredentials(java.lang.String clientcode,
                    java.lang.String email,
                    java.lang.String password)
                      throws TestandtargetException

Checks the provided email, password and clientcode by issuing an API call on the method campaignList with a dummy search string.

Parameters:

email -

password -

clientcode -

Throws:

TestandtargetException

getPerformanceReport

Reports getPerformanceReport(Configuration configuration,
                           ReportType reportType,
                           java.lang.String thirdPartyCampaignId,
                           java.lang.String campaignId,
                           java.util.Date start,
                           java.util.Date end,
                           Resolution resolution)
                             throws TestandtargetException

Retrieves the performance report data for a specific campaign

All parameters are mandatory, except for campaignId and thirdPartyId , out of which exactly one must be specified.

Parameters:

configuration -

reportType -

campaignId -

thirdPartyCampaignId -

start -

end -

resolution -

Throws:

TestandtargetException

See Also:

Test&Target performance report API