Promote (advertisements) - AFS

AFS Integration Guide

Product
AFS
AFS_Version
7.7
Category
Reference Guide

This widget displays advertisements related to the current query.

It is designed to work with the Promote Back Office application (see Promote). It displays replies with their title, description and URL. Additionally it supports reply metadata. See Replies Parameters for the list of supported metadata.

Enabling this widget automatically sets the usePromote option to true. See Global Configuration Widget.

By default the widget's title is not displayed.

<div data-type="AFSWidget" data-name="Promote">
</div>

In order to display it, use the below configuration:

<div data-type="AFSWidget" data-name="Promote">
<script type="application/json">
{
"showTitle": true
}
</script>
</div>

The default title "Publicités" in French, "Ads" in English is displayed above the ads.

To display your own title instead of the default one, use this configuration:

<div data-type="AFSWidget" data-name="Promote">
<script type="application/json">
{
"title": "Ads by Antidot",
"showTitle": true
}
</script>
</div>

Promote - Display the ads related to the current search terms (if any). The URI of the promote replySet when different from "Promote" has to be configured in the Configuration Widget

Parameter

Type

Card

Default

Description

title

String

Optional

Ads

Publicité

The title displayed above the ads.

showTitle

Boolean

Optional

false

The title is not displayed by default.