Campaign-specific Integration

Integrate campaign responses such as advisor flows, feedback text, pushed products, and redirects.

Overview

Different actions are needed depending on the campaign type. The next sections explain how to handle the different campaign settings. Keep in mind that FactFinder NG can return several campaigns at once.

Not all campaigns need to be handled in the same way. For example, you may receive several redirection campaigns. Because NG does not return campaigns in priority order, define that priority in your integration project.

Integrating Advisor Campaigns

These are campaigns where the flavour attribute is set to ADVISOR. Advisor campaigns contain two sections in the response:

• The first section contains the active questions and associated answers.

• The second section contains the full question-and-answer tree. The active questions are the ones currently shown to the shop visitor. Because the campaign is structured as a tree, the active section initially contains the first question in that tree.

When the user selects an answer, the follow-up questions below that answer are returned as active questions.

Integrating Feedback Campaigns

Feedback campaigns let you return text or products to the shop as “feedback.” These campaigns use the type, or flavour, FEEDBACK.

Feedback Text

Earlier FactFinder versions managed this kind of variable content with numeric identifiers. The integration project defined where each feedback text number appeared on the shop page. For example, feedback text number 3 might have been placed above the search results [1].

Since version 6.7, feedback texts use names instead.

For current integrations, use those names as identifiers.

[1] "Above the search results" in this instance really is simply an example. The position of the feedback text can be selected by the shop operator in the integration project.

The names are agreed with the shop operator during the integration project and then configured in FactFinder. In the user interface, users can select from those predefined names. You can also define whether each feedback text may contain HTML. FactFinder returns this property together with the feedback text, so your integration can decide whether the text should be HTML-escaped [2].

[2] The default value for the HTML attribute is false. If the HTML attribute is not specified, this means that the feedback text may not contain HTML and must therefore be escaped.

Pushed Products

You can assign products to Feedback Campaigns. FactFinder returns the product list with the campaign.

Note: The product list entries each contain the complete field list from the product record in the FactFinder database. However, in order to save bandwidth you can also pass the parameters idsOnly=true with the search request. In this case the content of the records is omitted.

Note: A campaign can also be returned with 0 products. Users can choose to integrate campaign products directly into the search results. In that case, no separate campaign product list is returned. The campaign itself is still returned so the shop knows that the search query triggered it.

Integrating Redirect Campaigns

If the campaign is a redirection campaign, the type is set to REDIRECT and the redirection field is populated:

JSON: “flavour” and “target” within a campaignsList element.

A redirection consists of an optional name and a target URL. The URL is passed exactly as the user entered it (FactFinder does not perform any conversion on the URL).

When a redirection campaign triggers, the default behavior is to redirect the current page automatically to the specified URL. Other responses are possible too. For example, you can use redirection campaigns to show selectable links instead. In that case, use the redirection name as the display text. The final display behavior is defined during the integration project.