Added Raptor doc (#3200)

Author: mnocon

code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml

@@ -11,6 +11,10 @@ ibexa:
 
                 # Raptor Recommendations API URL, optional, set by default
                 recommendations_api_url: '%ibexa.connector.raptor.recommendations.api_url%'
+
+                # Cookie lifetime in days for server-side tracking identifier
+                # Default: 365 days. Minimum: 1 day.
+                cookie_id_lifetime_days: 365
 ibexa_connector_raptor:
     # When enabled, tracking exceptions are thrown instead of being silently handled
     strict_exceptions: true

docs/recommendations/raptor_integration/connector_installation_configuration.md

@@ -26,7 +26,7 @@ composer require ibexa/connector-raptor
 To configure the Raptor connector, use the `ibexa.system.<scope>.connector_raptor` configuration key in the `config/packages/ibexa_connector_raptor.yaml` file:
 
 ``` yaml
-[[= include_file('code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml', 0, 13) =]]
+[[= include_file('code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml', 0, 17) =]]
 ```
 
 - `enabled` - enables or disables the connector for a given scope. Default value: `true`. If set to `false`, no tracking or recommendation requests are executed.
@@ -36,6 +36,7 @@ To configure the Raptor connector, use the `ibexa.system.<scope>.connector_rapto
     - `server` - tracking is handled on the backend, with events sent directly to the tracking API. It's not affected by ad blockers.
 - `recommendations_api_key` - an API key used to authenticate requests to the Recommendations API. This key allows the connector to retrieve personalized recommendations from the recommendation engine. You can find this value as ["API key"](connector_installation_configuration.md#recommendations-api-key) in Raptor Control Panel.
 - `recommendations_api_url` (optional) - overrides the default Raptor address, do not set it unless a custom endpoint is required.
+- `cookie_id_lifetime_days` (optional) - the lifetime in days of the server-side tracking identifier cookies. Default value: `365` days. Minimum value: `1` day.
 
 By default, `tracking_type` is set to `client` as client-side tracking is the standard Raptor mode.
 To understand the differences between client and server tracking types, including their advantages and disadvantages, refer to the [Raptor documentation](https://content.raptorservices.com/help-center/client-side-vs.-server-side-tracking).
@@ -73,6 +74,6 @@ The following settings are global and apply to the entire application (they are
 
 This value can be overridden in `config/packages/ibexa_connector_raptor.yaml` file, for example:
 
-``` yaml hl_lines="14-17"
+``` yaml hl_lines="18-20"
 [[= include_file('code_samples/recommendations/config/packages/ibexa_connector_raptor.yaml') =]]
 ```

docs/recommendations/raptor_integration/raptor_connector_guide.md

@@ -68,7 +68,9 @@ Recommendation blocks are organized into dedicated categories, each grouping blo
     - [Most popular content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-content-block)
     - [Other customers have also seen this content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#other-customers-have-also-seen-this-content-block)
     - [Personalized content recommendations]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#personalized-content-recommendations-block)
+    - [User’s content history]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#users-content-history-block)
 - **Recommendations: Product** - displays product suggestions based on visitors’ browsing history:
+    - [Items associated with the given Content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#items-associated-with-the-given-content-block)
     - [Most popular products]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-products-block)
     - [Most popular products in category]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-products-in-category-block)
     - [Other customers have also seen]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#other-customers-have-also-seen-block)

docs/recommendations/raptor_integration/recommendation_blocks.md

@@ -23,7 +23,9 @@ In the toolbar, corresponding categories for recommendation blocks are available
     - [Most popular content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-content-block)
     - [Other customers have also seen this content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#other-customers-have-also-seen-this-content-block)
     - [Personalized content recommendations]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#personalized-content-recommendations-block)
+    - [User’s content history]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#users-content-history-block)
 - **Recommendations: Product** - displays product suggestions based on visitors’ browsing history:
+    - [Items associated with the given Content]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#items-associated-with-the-given-content-block)
     - [Most popular products]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-products-block)
     - [Most popular products in category]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#most-popular-products-in-category-block)
     - [Other customers have also seen]([[= user_doc =]]/recommendations/raptor_integration/raptor_recommendation_blocks/#other-customers-have-also-seen-block)

docs/recommendations/raptor_integration/tracking_php_api.md

@@ -28,6 +28,7 @@ For more information, see the same arguments of the Twig function [`ibexa_tracki
 | `EventType::BUY`           | `ProductInterface`      | `EventContext::SUBTOTAL`,<br>`EventContext::CURRENCY`,<br>`EventContext::QUANTITY`,<br>(optional) `EventContext::CATEGORY_IDENTIFIER`,<br>(optional) `EventContext::WEBSITE_ID`                   |
 | `EventType::BASKET`        | `ProductInterface`      | `EventContext::BASKET_CONTENT`,<br>`EventContext::BASKET_ID`,<br>(optional) `EventContext::CATEGORY_IDENTIFIER`,<br>(optional) `EventContext::QUANTITY`,<br>(optional) `EventContext::WEBSITE_ID` |
 | `EventType::ITEM_CLICK`    | `string` (product code) | `EventContext::MODULE_NAME`,<br>`EventContext::REDIRECT_URL`                                                                                                                                      |
+| `EventType::PAGEVIEW`      | `string` (URL)          | `EventContext::URL` (required),<br>(optional) `EventContext::WEBSITE_ID`                                                                                                                          |
 
 Check the following example:
 

docs/templating/twig_function_reference/recommendations_twig_functions.md

@@ -78,6 +78,12 @@ ibexa_tracking_track_event(
 
 The following events are supported and can be triggered from Twig templates:
 
+### `pageview` event
+
+The `ibexa_tracking_script()` Twig function automatically sends a [`pageview`](https://content.raptorservices.com/help-center/tracking-events-parameters-reference#:~:text=Event%20Specifications%20%28Full%20Reference) event to Raptor for every incoming GET request, in both `client` and `server` tracking types.
+
+Use it for basic page metrics and debugging the Live Tracking Stream.
+
 ### Product `visit` event
 
 This event tracks product page visits by users.