Package com.day.cq.analytics.testandtarget

Interface TestandtargetService

  • @ProviderType
@Deprecated
public interface TestandtargetService
    Deprecated.
    This service will be removed in future versions. No replacement will be provided.
    The TestandtargetService is the entry point for all the operations which interact with the Adobe Target API

    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.

    See Also:
    TestandtargetCampaignMediator

    • Field Detail

      • OPERATION_FOLDER_LIST

        static final java.lang.String OPERATION_FOLDER_LIST
        Deprecated.
        folder list operation
        See Also:
        Constant Field Values

      • OPERATION_CAMPAIGN_LIST

        static final java.lang.String OPERATION_CAMPAIGN_LIST
        Deprecated.
        campaign list operation
        See Also:
        Constant Field Values

      • OPERATION_SAVE_HTML_OFFER

        static final java.lang.String OPERATION_SAVE_HTML_OFFER
        Deprecated.
        HTML offer save operation
        See Also:
        Constant Field Values

      • OPERATION_GET_HTML_OFFER

        static final java.lang.String OPERATION_GET_HTML_OFFER
        Deprecated.
        HTML offer get operation
        See Also:
        Constant Field Values

      • OPERATION_HTML_OFFER_LIST

        static final java.lang.String OPERATION_HTML_OFFER_LIST
        Deprecated.
        HTML offer list operation
        See Also:
        Constant Field Values

      • OPERATION_DELETE

        static final java.lang.String OPERATION_DELETE
        Deprecated.
        Widget offer deletion operation
        See Also:
        Constant Field Values

      • OPERATION_SAVE

        static final java.lang.String OPERATION_SAVE
        Deprecated.
        Widget offer save operation
        See Also:
        Constant Field Values

      • OPERATION_SET_CAMPAIGN_STATE

        static final java.lang.String OPERATION_SET_CAMPAIGN_STATE
        Deprecated.
        save operation
        See Also:
        Constant Field Values

      • OPERATION_SAVE_CAMPAIGN

        static final java.lang.String OPERATION_SAVE_CAMPAIGN
        Deprecated.
        Campaign create operation
        See Also:
        Constant Field Values

      • OPERATION_REPORT

        static final java.lang.String OPERATION_REPORT
        Deprecated.
        See Also:
        Constant Field Values

      • PN_EMAIL

        static final java.lang.String PN_EMAIL
        Deprecated.
        Property name E-Mail
        See Also:
        Constant Field Values

      • PN_PASSWORD

        static final java.lang.String PN_PASSWORD
        Deprecated.
        Property name password
        See Also:
        Constant Field Values

      • CAMPAIGN_STATE_APPROVED

        static final java.lang.String CAMPAIGN_STATE_APPROVED
        Deprecated.
        See Also:
        Constant Field Values

      • CAMPAIGN_STATE_DEACTIVATED

        static final java.lang.String CAMPAIGN_STATE_DEACTIVATED
        Deprecated.
        See Also:
        Constant Field Values

      • PN_CLIENTCODE

        static final java.lang.String PN_CLIENTCODE
        Deprecated.
        Property name client code
        See Also:
        Constant Field Values

      • PN_TENANTID

        static final java.lang.String PN_TENANTID
        Deprecated.
        Property name tenant id
        See Also:
        Constant Field Values

      • PN_AUTHENTICATION

        static final java.lang.String PN_AUTHENTICATION
        Deprecated.
        Property name authentication
        See Also:
        Constant Field Values

    • Method Detail

      • 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 Adobe 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 - TestandtargetException on all errors

      • unpublishOffer

        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 Adobe 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 - TestandtargetException on all errors

      • createWidgetOffer

        @Deprecated
java.lang.String createWidgetOffer​(Configuration configuration,
                                   java.lang.String name,
                                   java.lang.String url,
                                   java.lang.String id)
                            throws TestandtargetException
        Deprecated.
        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 - TestandtargetException on all errors

      • createHTMLOffer

        long createHTMLOffer​(Configuration configuration,
                     SaveOfferRequest request)
              throws TestandtargetException
        Deprecated.
        Creates a HTML offer
        Parameters:
        configuration - the cloud-service configuration
        request - 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 content
        Returns:
        the offer id, as set by Adobe Target. If the XML API is used this method return -1
        Throws:
        TestandtargetException - TestandtargetException on all errors

      • listCampaigns

        @Deprecated
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
        Deprecated.
        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:
        Map of campaigns
        Throws:
        TestandtargetException - TestandtargetException on all errors

      • setCampaignState

        boolean setCampaignState​(Configuration configuration,
                         java.lang.String campaignState,
                         java.lang.String testAndTargetCampaignId,
                         java.lang.String thirdPartyCampaignId)
                  throws TestandtargetException
        Deprecated.
        Updates the state of the campaign in Adobe Target.
        Parameters:
        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 thirdPartyCampaignId
        thirdPartyCampaignId - The third-party campaign identifier. You must provide either testAndTargetCampaignId or thirdPartyCampaignId
        Returns:
        true if the operation succeeded
        Throws:
        TestandtargetException - TestandtargetException on all errors

      • 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
        Deprecated.
        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 - the cloud services configuration associated with the Adobe Target account
        reportType - a ReportType object representing the type of report
        campaignId - the id of the campaign, as defined in Adobe Target
        thirdPartyCampaignId - the third party id of the campaign
        start - 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.)
        Returns:
        performance report data for a specific campaign
        Throws:
        TestandtargetException - TestandtargetException on all errors
        See Also:
        Adobe Target performance report API

      • getPerformanceReport

        PerformanceReport getPerformanceReport​(Configuration configuration,
                                       PerformanceReportRequest request)
                                throws TestandtargetException
        Deprecated.
        Retrieves the performance report data for a specific campaign

        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.

        Parameters:
        configuration - the cloud services configuration associated with the Adobe Target account
        request - the request object holding all data needed to retrieve the performance data
        Returns:
        the performance report data, never null
        Throws:
        TestandtargetException - TestandtargetException on all errors

      • getMboxActivityCollisions

        @Deprecated
java.util.List<java.lang.String> getMboxActivityCollisions​(Configuration configuration,
                                                           java.lang.String mboxName,
                                                           java.lang.String mboxUrl)
                                                    throws TestandtargetException
        Deprecated.
        Detects the usage of an mbox in multiple activities
        Parameters:
        configuration - a reference to the Cloud Service configuration
        mboxName - the name of the mbox
        mboxUrl - the URL of the mbox. "http://localhost" is accepted
        Returns:
        a list of campaign names which reference the specified mbox. The return value can be empty, which signals that there are no collisions. It can also be null, which signals that there is no information about collisions
        Throws:
        TestandtargetException - TestandtargetException on all errors

      • listMboxNames

        java.util.List<java.lang.String> listMboxNames​(Configuration configuration)
                                        throws TestandtargetException
        Deprecated.
        Get the mboxes list for a given configuration
        Parameters:
        configuration - a reference to the Cloud Service configuration
        Returns:
        a list of mbox names. The list can be empty if no mboxes are available for the received configuration
        Throws:
        TestandtargetException - TestandtargetException on all errors