public interface TestandtargetService
This service is able to perform operations on both Adobe Target entry points - XML and REST. While care has been taken to make the API backend transparent, to the caller, there are some methods where there are small differences, usually due the XML API providing less information than the REST API. These limitations are clearly documented in the method-level javadocs.
As such, clients of this service are encouraged to use the REST API rather than XML API. This setting is a property on the cloud service configuration and is properly saved by the cloud configuration UI.
TestandtargetCampaignMediator
Modifier and Type | Field and Description |
---|---|
static String |
CAMPAIGN_STATE_APPROVED |
static String |
CAMPAIGN_STATE_DEACTIVATED |
static String |
OPERATION_CAMPAIGN_LIST
Deprecated.
|
static String |
OPERATION_DELETE
Deprecated.
|
static String |
OPERATION_FOLDER_LIST
Deprecated.
|
static String |
OPERATION_GET_HTML_OFFER
Deprecated.
|
static String |
OPERATION_HTML_OFFER_LIST
Deprecated.
|
static String |
OPERATION_REPORT
Deprecated.
|
static String |
OPERATION_SAVE
Deprecated.
|
static String |
OPERATION_SAVE_CAMPAIGN
Deprecated.
|
static String |
OPERATION_SAVE_HTML_OFFER
Deprecated.
|
static String |
OPERATION_SET_CAMPAIGN_STATE
Deprecated.
|
static String |
PN_CLIENTCODE
Deprecated.
|
static String |
PN_EMAIL
Deprecated.
|
static String |
PN_PASSWORD
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
checkCredentials(String clientcode,
String email,
String password)
Checks the provided
email , password and
clientcode by issuing an API call on the method campaignList
with a dummy search string. |
long |
createHTMLOffer(Configuration configuration,
SaveOfferRequest request)
Creates a HTML offer
|
void |
createHTMLOffer(Configuration configuration,
String offerName,
String folderId,
String content)
Deprecated.
|
String |
createWidgetOffer(Configuration configuration,
String name,
String url,
String id)
Deprecated.
widget offers are no longer supported in the current integration
|
HTMLOffer |
getHTMLOffer(Configuration configuration,
String offerName)
|
List<String> |
getMboxActivityCollisions(Configuration configuration,
String mboxName,
String mboxUrl)
Detects the usage of an mbox in multiple activities
|
PerformanceReport |
getPerformanceReport(Configuration configuration,
PerformanceReportRequest request)
Retrieves the performance report data for a specific campaign
|
Reports |
getPerformanceReport(Configuration configuration,
ReportType reportType,
String thirdPartyCampaignId,
String campaignId,
Date start,
Date end,
Resolution resolution)
Deprecated.
Not supported by the REST API. Use
getPerformanceReport(Configuration, PerformanceReportRequest) |
ViewOfferResponse |
getReusableOffer(Configuration configuration,
ViewOfferRequest request)
Retrieves an offer from Adobe Target
|
Map<Integer,String> |
listCampaigns(Configuration configuration,
Date before,
Date after,
String environment,
String name,
String state,
String label)
Returns a
Map with campaigns. |
Folder |
listFolders(Configuration configuration)
Returns a tree of folders available in Adobe Target.
|
Collection<ViewOfferResponse> |
listOffers(Configuration configuration,
ListOffersRequest request)
Returns a list of offers currently registered in Target
|
Collection<Offer> |
listOffers(Configuration configuration,
String folderId)
Deprecated.
|
List<Segment> |
listSegments(Configuration configuration,
ListSegmentsRequest request)
Retrieves a list of segments for the specified configuration
|
String |
publishOffer(Configuration configuration,
String name,
String url,
String id)
Deprecated.
widget offers are no longer supported in the current integration
|
void |
saveCampaign(Configuration configuration,
String thirdPartyId,
TestandtargetCampaign campaign)
Deprecated.
|
boolean |
setCampaignState(Configuration configuration,
String campaignState,
String testAndTargetCampaignId,
String thirdPartyCampaignId)
Updates the state of the campaign in Adobe Target.
|
String |
unpublishOffer(Configuration configuration,
String name,
String url,
String id)
Deprecated.
widget offers are no longer supported in the current integration
|
@Deprecated static final String OPERATION_FOLDER_LIST
@Deprecated static final String OPERATION_CAMPAIGN_LIST
@Deprecated static final String OPERATION_SAVE_HTML_OFFER
@Deprecated static final String OPERATION_GET_HTML_OFFER
@Deprecated static final String OPERATION_HTML_OFFER_LIST
@Deprecated static final String OPERATION_DELETE
@Deprecated static final String OPERATION_SAVE
@Deprecated static final String OPERATION_SET_CAMPAIGN_STATE
@Deprecated static final String OPERATION_SAVE_CAMPAIGN
@Deprecated static final String OPERATION_REPORT
@Deprecated static final String PN_EMAIL
@Deprecated static final String PN_PASSWORD
static final String CAMPAIGN_STATE_APPROVED
static final String CAMPAIGN_STATE_DEACTIVATED
@Deprecated static final String PN_CLIENTCODE
Folder listFolders(Configuration configuration) throws TestandtargetException
configuration
- Service Configuration
TestandtargetException
@Deprecated String publishOffer(Configuration configuration, String name, String url, String id) throws TestandtargetException
configuration
- Service Configuration
name
- Name of the widget offerurl
- The encoded URL of the third-party server that hosts the
dynamically generated responseid
- The third-party ID of the widget offerTestandtargetException
@Deprecated String unpublishOffer(Configuration configuration, String name, String url, String id) throws TestandtargetException
configuration
- Service Configuration
name
- Name of the widget offerurl
- The encoded URL of the third-party server that hosts the
dynamically generated responseid
- The third-party ID of the widget offerTestandtargetException
@Deprecated void saveCampaign(Configuration configuration, String thirdPartyId, TestandtargetCampaign campaign) throws TestandtargetException
configuration
- Service Configuration
thirdPartyId
- The campaign third party id, used for tracking updatescampaign
- The campaign which is to be saved in Adobe TargetTestandtargetException
@Deprecated String createWidgetOffer(Configuration configuration, String name, String url, String id) throws TestandtargetException
configuration
- Service Configuration
name
- Name of the widget offerurl
- The encoded URL of the third-party server that hosts the
dynamically generated responseid
- The third-party ID of the widget offerTestandtargetException
@Deprecated void createHTMLOffer(Configuration configuration, String offerName, String folderId, String content) throws TestandtargetException
createHTMLOffer(com.day.cq.wcm.webservicesupport.Configuration, SaveOfferRequest)
instead.configuration
- Service Configuration
offerName
- Name of the offerfolderId
- Folder idcontent
- Offer content as plain HTML.TestandtargetException
long createHTMLOffer(Configuration configuration, SaveOfferRequest request) throws TestandtargetException
configuration
- the cloud-service configurationrequest
- a SaveOfferRequest
object containing the operation's details, such as the offer data.
This object may be incomplete, i.e. just contain the essential data for creating an offer - name and contentTestandtargetException
@Deprecated HTMLOffer getHTMLOffer(Configuration configuration, String offerName) throws TestandtargetException
configuration
- Service Configuration
offerName
- Name of the offerTestandtargetException
ViewOfferResponse getReusableOffer(Configuration configuration, ViewOfferRequest request) throws TestandtargetException
configuration
- the cloud services configuration for the Adobe Target accountrequest
- a ViewOfferRequest
object containing the request dataViewOfferResponse
object containing the offer's dataTestandtargetException
@Deprecated Collection<Offer> listOffers(Configuration configuration, String folderId) throws TestandtargetException
configuration
- Service Configuration
folderId
- Folder idCollection
of Offer
objectsTestandtargetException
Collection<ViewOfferResponse> listOffers(Configuration configuration, ListOffersRequest request) throws TestandtargetException
configuration
- a reference to the service Configuration
request
- a ListOffersRequest
object containing the request detailsViewOfferResponse
objects.TestandtargetException
Map<Integer,String> listCampaigns(Configuration configuration, Date before, Date after, String environment, String name, String state, String label) throws TestandtargetException
Map
with campaigns. The Map key contains the campaign
ID and the Map value the campaign name.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.TestandtargetException
boolean setCampaignState(Configuration configuration, String campaignState, String testAndTargetCampaignId, String thirdPartyCampaignId) throws TestandtargetException
configuration
- Service Configuration
campaignState
- The campaign state , one of CAMPAIGN_STATE_APPROVED
or CAMPAIGN_STATE_DEACTIVATED
testAndTargetCampaignId
- The campaign identifier. You must provide either testAndTargetCampaignId or thirdPartyCampaignIdthirdPartyCampaignId
- The third-party campaign identifier. You must provide either testAndTargetCampaignId or thirdPartyCampaignIdTestandtargetException
void checkCredentials(String clientcode, String email, String password) throws TestandtargetException
email
, password
and
clientcode
by issuing an API call on the method campaignList
with a dummy search string.email
- password
- clientcode
- TestandtargetException
@Deprecated Reports getPerformanceReport(Configuration configuration, ReportType reportType, String thirdPartyCampaignId, String campaignId, Date start, Date end, Resolution resolution) throws TestandtargetException
getPerformanceReport(Configuration, PerformanceReportRequest)
All parameters are mandatory, except for campaignId and thirdPartyId , out of which exactly one must be specified.
configuration
- the cloud services configuration associated with the Adobe Target accountreportType
- a ReportType
object representing the type of reportcampaignId
- the id of the campaign, as defined in Adobe TargetthirdPartyCampaignId
- the third party id of the campaignstart
- the start date of the campaign (used as report filter)end
- the end date of the campaign (used as a report filter)resolution
- the campaign's resolution (hour, day etc.)TestandtargetException
PerformanceReport getPerformanceReport(Configuration configuration, PerformanceReportRequest request) throws TestandtargetException
The data returned by this method always returns visits for the PerformanceReportItem.getEntryCount()
method
Note that it is recommended that the request is configured with a campaign id rather than a third party id. The reason is that when using the REST API an additional call is performed to map the third party id to a campaign id.
configuration
- the cloud services configuration associated with the Adobe Target accountrequest
- the request object holding all data needed to retrieve the performance datanull
TestandtargetException
List<Segment> listSegments(Configuration configuration, ListSegmentsRequest request) throws TestandtargetException
Optional filtering parameters may be set in the request parameter.
configuration
- Service Configuration
request
- optional request parameters. May be null.null
TestandtargetException
List<String> getMboxActivityCollisions(Configuration configuration, String mboxName, String mboxUrl) throws TestandtargetException
configuration
- a reference to the Cloud Service configurationmboxName
- the name of the mboxmboxUrl
- the URL of the mbox. "http://localhost" is acceptedTestandtargetException
"Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"