public interface TestandtargetService
TestandtargetCampaignMediator
Modifier and Type | Field and Description |
---|---|
static String |
CAMPAIGN_STATE_APPROVED |
static String |
CAMPAIGN_STATE_DEACTIVATED |
static String |
OPERATION_CAMPAIGN_LIST
campaign list operation
|
static String |
OPERATION_DELETE
Widget offer deletion operation
|
static String |
OPERATION_FOLDER_LIST
folder list operation
|
static String |
OPERATION_GET_HTML_OFFER
HTML offer get operation
|
static String |
OPERATION_HTML_OFFER_LIST
HTML offer list operation
|
static String |
OPERATION_REPORT |
static String |
OPERATION_SAVE
Widget offer save operation
|
static String |
OPERATION_SAVE_CAMPAIGN
Campaign create operation
|
static String |
OPERATION_SAVE_HTML_OFFER
HTML offer save operation
|
static String |
OPERATION_SET_CAMPAIGN_STATE
save operation
|
static String |
PN_CLIENTCODE
Property name client code
|
static String |
PN_EMAIL
Property name E-Mail
|
static String |
PN_PASSWORD
Property name password
|
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. |
void |
createHTMLOffer(Configuration configuration,
String offerName,
String folderId,
String content)
Creates an HTML offer.
|
String |
createWidgetOffer(Configuration configuration,
String name,
String url,
String id)
Creates a widget offer.
|
HTMLOffer |
getHTMLOffer(Configuration configuration,
String offerName)
Gets a HTML offer.
|
Reports |
getPerformanceReport(Configuration configuration,
ReportType reportType,
String thirdPartyCampaignId,
String campaignId,
Date start,
Date end,
Resolution resolution)
Retrieves the performance report data for a specific campaign
|
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 the available folders on Adobe Target. |
Collection<Offer> |
listOffers(Configuration configuration,
String folderId)
Returns a JSON representation of offers.
|
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.
|
void |
saveCampaign(Configuration configuration,
String thirdPartyId,
TestandtargetCampaign campaign)
Creates or updates a campaign
|
boolean |
setCampaignState(Configuration configuration,
String campaignState,
String testAndTargetCampaignId,
String thirdPartyCampaignId)
Set the state of a campaign.
|
String |
unpublishOffer(Configuration configuration,
String name,
String url,
String id)
Deprecated.
|
static final String OPERATION_FOLDER_LIST
static final String OPERATION_CAMPAIGN_LIST
static final String OPERATION_SAVE_HTML_OFFER
static final String OPERATION_GET_HTML_OFFER
static final String OPERATION_HTML_OFFER_LIST
static final String OPERATION_DELETE
static final String OPERATION_SAVE
static final String OPERATION_SET_CAMPAIGN_STATE
static final String OPERATION_SAVE_CAMPAIGN
static final String OPERATION_REPORT
static final String PN_CLIENTCODE
static final String PN_EMAIL
static final String PN_PASSWORD
static final String CAMPAIGN_STATE_APPROVED
static final String CAMPAIGN_STATE_DEACTIVATED
Folder listFolders(Configuration configuration) throws TestandtargetException
Tree
of the available folders on Adobe Target.configuration
- Service Configuration
Tree
of available foldersTestandtargetException
@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
void saveCampaign(Configuration configuration, String thirdPartyId, TestandtargetCampaign campaign) throws TestandtargetException
configuration
- Service Configuration
thirdPartyId
- The campaign third party id, used for tracking updatescampaign
- TODOTestandtargetException
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
void createHTMLOffer(Configuration configuration, String offerName, String folderId, String content) throws TestandtargetException
configuration
- Service Configuration
offerName
- Name of the offerfolderId
- Folder idcontent
- Offer content as plain HTML.TestandtargetException
HTMLOffer getHTMLOffer(Configuration configuration, String offerName) throws TestandtargetException
configuration
- Service Configuration
offerName
- Name of the offerfolderId
- Folder idTestandtargetException
Collection<Offer> listOffers(Configuration configuration, String folderId) throws TestandtargetException
configuration
- Service Configuration
folderId
- Folder idCollection
of Offers
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
state
- 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
Reports getPerformanceReport(Configuration configuration, ReportType reportType, String thirdPartyCampaignId, String campaignId, Date start, Date end, Resolution resolution) throws TestandtargetException
All parameters are mandatory, except for campaignId and thirdPartyId , out of which exactly one must be specified.
configuration
- reportType
- campaignId
- thirdPartyCampaignId
- start
- end
- resolution
- 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
"Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"