When requesting content containing actual recommendations (recommended products or items), use the Target Delivery API.
To retrieve recommendations, send an Adobe Target Delivery API POST call with the appropriate contextual information, which may include a user ID (for use with profile-specific recommendations such as the user’s recently viewed items), relevant mbox name, mbox parameters, profile parameters, or other attributes. The response will include recommended entity.ids (and may include other entity data) in JSON or HTML format, which can then be displayed in the device.
The Delivery API for Adobe Target exposes all existing features that a standard Target request provides.
The Delivery API:
To use the Delivery API to deliver Target experiences—including recommendations—follow these steps:
To create recommendations that can be used with the Delivery API, use the Form-based Composer.
First, create and save a JSON-based design to use in your recommendation. For sample JSON, plus background information regarding how JSON responses can be returned when configuring a form-based activity, see the documentation on Creating Recommendation Designs. In this example, the design is named Simple JSON.
In Target, navigate to Activities > Create Activity > Recommendations, then select Form.
Select a Property, and click Next.
Define the location where you would like users to receive the recommendation’s response. The example below uses a location named api_charter. Select your JSON-based design, created earlier, named Simple JSON.
Save and activate the recommendation. It will generate results. Once the results are ready, you can use the Delivery API to retrieve them.
The syntax for the Delivery API is:
Using the Delivery API with Recommendations in this way enables you to perform additional steps prior to displaying recommendations to the visitor on the non-HTML device. For example, you can take the response from the Delivery API to perform an additional, real-time lookup of entity attribute details (inventory, price, rating, and so on) from another system (such as a CMS, PIM or ecommerce platform), before displaying final results.
Using the approach outlined in this tutorial, you can get any application to leverage the response from Target to provide personalized recommendations!
The following resources provide examples of various non-HTML focused implementations. Keep in mind every implementation will be unique, due to the system and devices involved.
|Consuming RESTful APIs in AEM||How to create and deploy an Adobe Experience Manager OSGi bundle that consumes data from a third-party RESTful web service.|
|Adobe Target Everywhere - Implement Server Side or in the IoT||Adobe Summit 2019 Lab that provides hands-on experience for a React application that leverages Adobe Target server-side APIs.|
|Adobe Target in a Mobile App Without the Adobe SDK||This guide shows you how to set up Adobe Target in your mobile app without installing the Adobe SDK. This solution uses the Tealium SDK webview and the Remote Commands module to send and receive requests to the Adobe Visitor API (Experience Cloud) and the Adobe Target API.|
|How Adobe Target Works in Mobile Apps||How Target works with the Mobile SDK|
|Configuring the Target extension in Experience Platform Launch and Implementing Target APIs||Steps for configuring the Target extension in Experience Platform Launch, adding the Target Extension to your app, and implementing Target APIs to request activities, prefetch offers, and Enter visual preview mode.|
|Adobe Target Node Client||Open-sourced Target Node.js SDK v1.0|
|Server Side overview||Information about Adobe Target Server Side delivery APIs, Server Side Batch Delivery APIs, Node.js SDK, and Adobe Target Recommendations APIs.|
|Adobe Campaign Content Recommendations in Email||Blog that describes how to leverage content recommendations in email via Adobe Target and Adobe I/O Runtime in Adobe Campaign.|
Most of the time, recommendations are configured in the Adobe Target UI, then used or accessed via the Target APIs, for reasons such as the ones mentioned in the sections above. This UI-API coordination is common. However, sometimes users may want to perform all actions via APIs—both setup, as well as the use of results. Although much less common, users can absolutely configure, execute, and leverage the results of recommendations entirely using the APIs.
We learned in an earlier section how to manage Adobe Target Recommendations entities and deliver them server-side. Similarly, Adobe I/O allows you to manage criteria, promotions, collections, and design templates without having to log in to Adobe Target. A complete list of all Recommendations APIs may be found here, but here is a summary for reference.
|Collections||List, create, get, edit, and delete collections.|
|Criteria||List and get criteria.|
|Designs||List, create, get, edit, delete, and validate designs.|
|Entities||Save, delete, and get entities.|
|Promotions||List, create, get, edit, and delete promotions.|
|Category Criteria||List, create, get, edit, and delete category criteria.|
|Custom Criteria||List, create, get, edit, and delete custom criteria.|
|Item Criteria||List, create, get, edit, and delete item criteria.|
|Popularity Criteria||List, create, get, edit, and delete popularity criteria.|
|Profile Attribute Criteria||List, create, get, edit, and delete profile attribute criteria.|
|Recent Criteria||List, create, get, edit, and delete recent criteria.|
|Sequence Criteria||List, create, get, edit, and delete sequence criteria.|
Congratulations! By finishing this tutorial, you have learned how to: