Integrating the Editor’s Pick Module

The Editor’s Pick Module enhances your content delivery by recommending articles picked by editors. This document provides a detailed guide on how to integrate this module with your system. The process primarily consists of three steps:

  1. Identifying and marking items picked by editors during item metadata synchronization with Froomle.

  2. Communicating the specific metadata used for marking these items to your Froomle Account Manager.

  3. Align with your Froomle Account Manager about the list_name of the editor’s pick module used in recommendation requests.

The subsequent sections elaborate on these steps.

1. Identifying and Marking Editor’s Picks

To facilitate editor’s picks recommendations, Froomle must distinguish which items have been chosen by editors.

This distinction is enabled by tagging the selected items with a unique identifier during item metadata synchronization with Froomle. You can employ various methods to indicate items as "picked by editors." Froomle recommends:

  1. Adding items to a specific category, such as editors_pick_homepage; or

  2. Attaching a unique tag to them, such as editors_pick_homepage.

The assigned identifier does not change over time.

To generate recommendations, Froomle combines this identifier with the item’s age. Unless otherwise specified, Froomle will recommend editor’s pick items that are:

  • Up to 72 hours old for websites, apps, and daily emails; and

  • Up to 7 days old for weekly emails.

  • Not yet read by the reader.

2. Communicating the Editor’s Pick Identifier to your Froomle Account Manager

After marking the items, it is crucial to inform your Froomle Account Manager about the specific identifier (key-value-pair) used. For example, if you used tags, you might inform them of a tag like "tags":["editors_pick_homepage"].

3. Notifying the integration details of the Editor’s Pick Module to your Froomle Account Manager

To ensure the correct configuration of recommendations, Froomle needs to know the list_name of the editor’s pick module you use when making recommendation requests.

If it concerns a new module, your Account Manager will create the proper list_name and communicate it to you.

If it concerns changes to an existing module, you need to inform your Account Manager about the list_name. This allows Froomle to correctly process any incoming recommendations request for this particular triplet, ensuring accurate generation of editor’s pick recommendations.

This means that the configuration of the module happens mostly in the back-end, and that this information does not need to be appended to every request for recommendations.