-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #88 from foomo/v0.12.0
V0.12.0
- Loading branch information
Showing
17 changed files
with
402 additions
and
174 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| # Emarsys Web Extend | ||
|
|
||
| The emarsys server side web extend provider makes use of the [Web Extend Command](https://dev.emarsys.com/docs/web-extend-reference/a1a185e5fbb6b-web-extend-command-implementation). | ||
|
|
||
| ## Initialization | ||
|
|
||
| Since we need to trigger multiple commands, we need to ensure we're always sending the same `sessionId`, `visitorId` & `pageViewId` for all calls. | ||
| The initialization sets the `emarsys.page_view_id` variable into the `dataLayer` to be sent with each following request. | ||
|
|
||
| ```mermaid | ||
| sequenceDiagram | ||
| participant Data Layer | ||
| participant Web Container | ||
| participant Server Container | ||
| participant Emarsys | ||
| Web Container->>+Server Container: initialization (/gtag/js/emarsys) | ||
| Server Container->>Emarsys: pageViewId (sesssionId, visitorId) | ||
| Server Container->>-Web Container: Cookies (emarsys_cdv, emarsys_s) | ||
| Web Container->>Data Layer: emarsys.page_view_id | ||
| ``` | ||
|
|
||
| ## Commands | ||
|
|
||
| ### Cart | ||
|
|
||
| NOTE: The default `page_view` event does not contain the `items` so we need to enrich them in the `collect` service. | ||
|
|
||
| ```mermaid | ||
| sequenceDiagram | ||
| participant Web Container | ||
| participant Collect | ||
| participant Server Container | ||
| participant Emarsys | ||
| Web Container->>Collect: page_view | ||
| Collect->>+Server Container: enrich: items | ||
| Server Container->>Emarsys: cart<br/>Cookies (s, cdv, xp, fc) | ||
| Server Container->>-Web Container: Cookies (s, cdv, xp, fc) | ||
| ``` | ||
|
|
||
| Standard implementation | ||
|
|
||
| ```javascript | ||
| // The usual commands to identify visitors and report cart contents. | ||
| ScarabQueue.push(['cart', [ | ||
| {item: 'item_1', price: 19.9, quantity: 1}, | ||
| {item: 'item_2', price: 29.7, quantity: 3} | ||
| ]]); | ||
| // Firing the ScarabQueue. Should be the last call on the page, called only once. | ||
| ScarabQueue.push(['go']); | ||
| ``` | ||
|
|
||
| ### View | ||
|
|
||
| ```mermaid | ||
| sequenceDiagram | ||
| participant Web Container | ||
| participant Server Container | ||
| participant Emarsys | ||
| Web Container->>+Server Container: view_item | ||
| Server Container->>Emarsys: view<br/>Cookies (s, cdv, xp, fc) | ||
| Server Container->>-Web Container: Cookies (s, cdv, xp, fc) | ||
| ``` | ||
|
|
||
| Standard implementation | ||
|
|
||
| ```javascript | ||
| // Passing on item ID to report product view. Item ID should match the value listed in the Product Catalog | ||
| ScarabQueue.push(['view', 'item_3']); | ||
| // Firing the ScarabQueue. Should be the last call on the page, called only once. | ||
| ScarabQueue.push(['go']); | ||
| ``` | ||
|
|
||
| ## Category | ||
|
|
||
| ```mermaid | ||
| sequenceDiagram | ||
| participant Web Container | ||
| participant Server Container | ||
| participant Emarsys | ||
| Web Container->>+Server Container: view_item_list | ||
| Server Container->>Emarsys: category<br/>Cookies (s, cdv, xp, fc) | ||
| Server Container->>-Web Container: Cookies (s, cdv, xp, fc) | ||
| ``` | ||
|
|
||
| Standard implementation | ||
|
|
||
| ```javascript | ||
| // Passing on the category path being visited. Must match the 'category' values listed in the Product Catalog | ||
| ScarabQueue.push(['category', 'Bikes > Road Bikes']); | ||
| // Firing the ScarabQueue. Should be the last call on the page, called only once. | ||
| ScarabQueue.push(['go']); | ||
| ``` | ||
|
|
||
| ## Purchase | ||
|
|
||
| ```mermaid | ||
| sequenceDiagram | ||
| participant Web Container | ||
| participant Server Container | ||
| participant Emarsys | ||
| Web Container->>+Server Container: purchase | ||
| Server Container->>Emarsys: category<br/>Cookies (s, cdv, xp, fc) | ||
| Server Container->>-Web Container: Cookies (s, cdv, xp, fc) | ||
| ``` | ||
|
|
||
| Standard implementation | ||
|
|
||
| ```javascript | ||
| // Passing on order details. The price values passed on here serve as the basis of our revenue and revenue contribution reports. | ||
| ScarabQueue.push(['purchase', { | ||
| orderId: '231213', | ||
| items: [ | ||
| {item: 'item_1', price: 19.9, quantity: 1}, | ||
| {item: 'item_2', price: 29.7, quantity: 3} | ||
| ] | ||
| }]); | ||
| // Firing the ScarabQueue. Should be the last call on the page, called only once. | ||
| ScarabQueue.push(['go']); | ||
| ``` | ||
|
|
||
| ## References | ||
|
|
||
| - [Web Extend Command](https://dev.emarsys.com/docs/web-extend-reference/a1a185e5fbb6b-web-extend-command-implementationhttps://dev.emarsys.com/docs/web-extend-reference/a1a185e5fbb6b-web-extend-command-implementation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.