@metarouter/ajs-starter-kit 1.0.82-alpha.2 → 1.0.83

package/.dist/criteo/connection.etag.json

@@ -1 +1 @@
-"0c471d1504392504e2bfca3a657124c9"
+"526713ff0a5f473df5c1dc0426ed3f3e"

package/.dist/criteo/connection.json

@@ -1,6 +1,41 @@
 {
+  "params": [
+    {
+      "name": "FIRST_PARTY_DOMAIN",
+      "exampleValue": "www.metarouter.io",
+      "description": "The domain of the partner. for www.fnac.com, it could be “fnac.com” or “www.fnac.com”…. this parameter is used to avoid id collisions on two different websites. Collisions are unlikely to happen if the GUID is correctly generated.",
+      "isOptional": false
+    },
+    {
+      "name": "FIRST_PARTY_NAME",
+      "exampleValue": "www.metarouter.io",
+      "description": "Advertiser name.",
+      "isOptional": false
+    },
+    {
+      "name": "PARTNER_ID",
+      "exampleValue": "my-partner-id",
+      "description": "The partner ID of the account you are sending the data to. Please reach out to your Criteo representative if you do not have this value.",
+      "isOptional": false
+    }
+  ],
   "default": {
-    "endpoint": "http://widget.criteo.com/m/event?version=s2s_v0",
-    "method": "POST"
+    "endpoint": "https://sslwidget.criteo.com/fpm/event",
+    "transform": {
+      "lang": "lua",
+      "body": "local retailer_visitor_id = batch[1].retailer_visitor_id\nrequest.url = request.url ..\"?first_party_id=\".. retailer_visitor_id\nrequest.url = request.url ..\"&first_party_domain=\" .. \"$$FIRST_PARTY_DOMAIN$$\"\nrequest.url = request.url ..\"&first_party_name=\" .. \"$$FIRST_PARTY_NAME$$\"\nrequest.url = request.url ..\"&p=\" .. \"$$PARTNER_ID$$\"\nreturn request"
+    },
+    "method": "POST",
+    "batchSize": 1,
+    "headers": [
+      {
+        "key": "Content-Type",
+        "value": "application/json"
+      },
+      {
+        "key": "Accept-Encoding",
+        "value": "json"
+      }
+    ]
   }
 }

package/.dist/criteo/kit.etag.json

@@ -1 +1 @@
-"1419e74b9efaa9436da1b88aa4425713"
+"11cef502ce31e460d7b55996697bfe0a"

package/.dist/criteo/metadata.json

@@ -2,12 +2,12 @@
   "isDraft": false,
   "isBeta": true,
   "friendlyName": "Criteo",
-  "description": "With our holistic suite of advertising solutions, retailers, brands, and publishers of all sizes can access the data\nand technology they need to best attract and keep their customers.",
-  "logo": "https://cdn.metarouter.io/logo.svg",
-  "color": "#F37822",
+  "description": "Criteo is a Commerce Media Platform that offers programmatic advertising solutions.",
+  "logo": "https://cdn.metarouter.io/criteo.png",
+  "color": "#f55615",
   "eventSource": {
-    "isAndroidApp": true,
-    "isIosApp": true,
+    "isAndroidApp": false,
+    "isIosApp": false,
     "isWebApp": true
   },
   "inputSchema": "analytics_js",
@@ -23,6 +23,10 @@
     {
       "date": "2023-12-13T00:00:00.000Z",
       "note": "Marked as unstable version: 0.1.0"
+    },
+    {
+      "date": "2024-03-06T05:00:00.000Z",
+      "note": "Migrated to Server to Server endpoint"
     }
   ]
 }

package/.dist/criteo/playbook.etag.json

@@ -1 +1 @@
-"a2e0cf4a85eef88fd901b4cafb13b73d"
+"cabe263814512a5000a1bdbdd8b00f9d"

package/.dist/criteo/playbook.json

@@ -1,60 +1,125 @@
 {
-  "version": "0.1.0",
+  "version": "0.2.0",
   "params": [
     {
-      "name": "ACCOUNT",
-      "exampleValue": "my-account"
-    },
-    {
-      "name": "MAPPING_KEY",
-      "exampleValue": "my-mapping-key"
+      "name": "PARTNER_ID",
+      "exampleValue": "my-partner-id",
+      "description": "The partner ID of the account you are sending the data to. Please reach out to your Criteo representative if you do not have this value.",
+      "isOptional": false
     }
   ],
   "global": {
     "enrichments": [
       {
-        "staticString": "$$ACCOUNT$$",
+        "staticString": "$$PARTNER_ID$$",
         "outputKey": "account"
       },
       {
         "staticString": "d",
         "outputKey": "site_type"
-      },
-      {
-        "staticInt": 1,
-        "outputKey": "deduplication"
-      },
-      {
-        "staticString": "$$MAPPING_KEY$$",
-        "outputKey": "id.mapping_key"
       }
     ],
     "mappings": [
+      {
+        "inputKey": "anonymousId",
+        "outputKey": "retailer_visitor_id"
+      },
       {
         "inputKey": "context.ip",
         "outputKey": "ip"
       },
       {
-        "inputKey": "context.providers.criteo.userId",
-        "outputKey": "id.mapped_user_id"
+        "inputKey": "context.page.url",
+        "outputKey": "full_url"
+      },
+      {
+        "inputKey": "context.page.title",
+        "outputKey": "page_title"
+      },
+      {
+        "inputKey": "context.userAgent",
+        "outputKey": "user_agent"
+      },
+      {
+        "inputKey": "input",
+        "outputKey": "id.email.raw",
+        "transforms": [
+          {
+            "expression": {
+              "lang": "lua",
+              "body": "return LOWER(TRIM(input.traits.email))"
+            }
+          }
+        ]
+      },
+      {
+        "inputKey": "traits.email",
+        "outputKey": "id.email.sha256_md5",
+        "transforms": [
+          {
+            "expression": {
+              "lang": "lua",
+              "body": "return TO_SHA256_HASH(TO_MD5_HASH(LOWER(TRIM(input.traits.email))))"
+            }
+          }
+        ]
+      },
+      {
+        "inputKey": "input",
+        "outputKey": "id.email.md5",
+        "transforms": [
+          {
+            "expression": {
+              "lang": "lua",
+              "body": "return TO_MD5_HASH(LOWER(TRIM(input.traits.email)))"
+            }
+          }
+        ]
+      },
+      {
+        "inputKey": "input",
+        "outputKey": "id.email.sha256",
+        "transforms": [
+          {
+            "expression": {
+              "lang": "lua",
+              "body": "return TO_SHA256_HASH(LOWER(TRIM(input.traits.email)))"
+            }
+          }
+        ]
+      },
+      {
+        "inputKey": "timestamp",
+        "outputKey": "events.timestamp",
+        "transforms": [
+          {
+            "toDateTime": {
+              "inputFormat": "2006-01-02T15:04:05Z07:00",
+              "outputFormat": "2006-01-02T15:04:05Z07:00"
+            }
+          }
+        ]
       }
     ]
   },
   "eventSpecific": {
-    "page": {
-      "filters": [
-        {
-          "byConditions": {
-            "action": "allow",
-            "when": {
-              "stringEqual": {
-                "inputPath": "context.page.path",
-                "value": "/"
+    "product_list_viewed": {
+      "mappings": [
+        {
+          "inputKey": "input",
+          "outputKey": "events",
+          "transforms": [
+            {
+              "expression": {
+                "lang": "lua",
+                "body": "local event = {\n    {\n        event = \"viewList\",\n        currency = UPPER(input.properties.currency),\n        item = {}\n    }\n}\n\n-- returns an array of the top 3 products on the listing page a user visited.\nfor i, product in ipairs(input.properties.products) do\n    if i <= 3 then\n        table.insert(event[1].item, {id = product.product_id})\n    else\n        break\n    end\nend\nreturn event"
               }
             }
-          }
+          ]
         }
-      ],
+      ]
+    },
+    "cart_viewed": {
       "mappings": [
         {
           "inputKey": "input",
@@ -63,26 +128,43 @@
             {
               "expression": {
                 "lang": "lua",
-                "body": "return {{\n  event = 'viewHome',\n  ua_raw_string = input.context.userAgent or '',\n}}"
+                "body": "local event = {{\nevent = \"viewBasket\",\ncurrency = UPPER(input.properties.currency),\n  item = MAP(\n    input.properties.products,\n    function (p)\n      return {\n        id=p.product_id,\n        price = p.price,\n        category = p.category,\n        quantity = p.quantity\n        }\n    end\n  )\n}}\nreturn event"
               }
             }
           ]
         }
       ]
     },
-    "product_list_viewed": {
-      "filters": [
+    "order_completed": {
+      "mappings": [
         {
-          "byConditions": {
-            "action": "allow",
-            "when": {
-              "inputPathIsObject": {
-                "inputPath": "properties.products.0"
+          "inputKey": "properties.currency",
+          "outputKey": "events.currency",
+          "transforms": [
+            {
+              "modifyString": "uppercase"
+            }
+          ]
+        },
+        {
+          "inputKey": "properties.order_id",
+          "outputKey": "events.order_id"
+        },
+        {
+          "inputKey": "input",
+          "outputKey": "events",
+          "transforms": [
+            {
+              "expression": {
+                "lang": "lua",
+                "body": "local event = {{\n    event = \"trackTransaction\",\n    timestamp = TO_DATE_TIME(input.timestamp, { inputFormat = \"2006-01-02T15:04:05Z07:00\" }),\n    id = input.properties.order_id,\n    currency = UPPER(input.properties.currency),\n      item = MAP(\n        input.properties.products,\n        function (p)\n          return {\n            id=p.product_id,\n            price = p.price,\n            quantity = p.quantity\n            }\n        end\n      )\n    }}\n    return event"
               }
             }
-          }
+          ]
         }
-      ],
+      ]
+    },
+    "product_added": {
       "mappings": [
         {
           "inputKey": "input",
@@ -91,7 +173,7 @@
             {
               "expression": {
                 "lang": "lua",
-                "body": "return {{\n  event = 'viewList',\n  ua_raw_string = input.context.userAgent or '',\n  item = PLUCK(input.properties.products, \"product_id\"),\n}}"
+                "body": "local event = {{\nevent = \"addToCart\",\ntimestamp = TO_DATE_TIME(input.timestamp, { inputFormat = \"2006-01-02T15:04:05Z07:00\" }),\ncurrency = UPPER(input.properties.currency),\n  item ={{\n    id=input.properties.product_id,\n    price = input.properties.price,\n    quantity = input.properties.quantity\n    }}\n}}\nreturn event"
               }
             }
           ]
@@ -99,19 +181,32 @@
       ]
     },
     "product_viewed": {
-      "filters": [
-        {
-          "byConditions": {
-            "action": "allow",
-            "when": {
-              "stringNotEqual": {
-                "inputPath": "properties.product_id",
-                "value": ""
+      "enrichments": [
+        {
+          "staticString": "viewItem",
+          "outputKey": "events.event"
+        }
+      ],
+      "mappings": [
+        {
+          "inputKey": "properties.product_id",
+          "outputKey": "events.item"
+        },
+        {
+          "inputKey": "timestamp",
+          "outputKey": "events.timestamp",
+          "transforms": [
+            {
+              "toDateTime": {
+                "inputFormat": "2006-01-02T15:04:05Z07:00",
+                "outputFormat": "2006-01-02T15:04:05Z07:00"
               }
             }
-          }
+          ]
         }
-      ],
+      ]
+    },
+    "products_searched": {
       "mappings": [
         {
           "inputKey": "input",
@@ -120,27 +215,36 @@
             {
               "expression": {
                 "lang": "lua",
-                "body": "return {{\n  event = 'viewItem',\n  ua_raw_string = input.context.userAgent or '',\n  item = input.properties.product_id,\n}}"
+                "body": "local event = {{\nevent = \"viewList\",\ntimestamp = TO_DATE_TIME(input.timestamp, { inputFormat = \"2006-01-02T15:04:05Z07:00\" }),\ncategory = input.properties.category,\nkeyword = input.properties.query,\n  item ={{\n    id=input.properties.product_id,\n    price = input.properties.price,\n    quantity = input.properties.quantity\n    }}\n}}\nreturn event"
               }
             }
           ]
         }
       ]
     },
-    "cart_viewed": {
-      "filters": [
+    "payment_info_entered": {
+      "enrichments": [
         {
-          "byConditions": {
-            "action": "allow",
-            "when": {
-              "inputPathIsObject": {
-                "inputPath": "properties.products.0"
-              }
-            }
-          }
+          "staticString": "addPaymentInfo",
+          "outputKey": "events.event"
         }
-      ],
+      ]
+    },
+    "checkout_started": {
       "mappings": [
+        {
+          "inputKey": "properties.currency",
+          "outputKey": "events.currency",
+          "transforms": [
+            {
+              "modifyString": "uppercase"
+            }
+          ]
+        },
+        {
+          "inputKey": "properties.order_id",
+          "outputKey": "events.id"
+        },
         {
           "inputKey": "input",
           "outputKey": "events",
@@ -148,35 +252,31 @@
             {
               "expression": {
                 "lang": "lua",
-                "body": "local items = MAP(\n              input.properties.products,\n              function (p)\n                return {\n                  id = p.product_id,\n                  price = TO_FLOAT(p.price),\n                  quantity = TO_FLOAT(p.quantity or 1)\n                }\n                end\n            )\nreturn {{\n  event = 'viewBasket',\n  ua_raw_string = input.context.userAgent or '',\n  item = items,\n}}"
+                "body": "local event = {{\nevent = \"beginCheckout\",\ntimestamp = TO_DATE_TIME(input.timestamp, { inputFormat = \"2006-01-02T15:04:05Z07:00\" }),\ncurrency = UPPER(input.properties.currency),\n  item = MAP(\n    input.properties.products,\n    function (p)\n      return {\n        id=p.product_id,\n        price = p.price,\n        quantity = p.quantity\n        }\n    end\n  )\n}}\nreturn event"
               }
             }
           ]
         }
       ]
     },
-    "order_completed": {
-      "filters": [
+    "identify": {
+      "enrichments": [
         {
-          "byConditions": {
-            "action": "allow",
-            "when": {
-              "inputPathIsObject": {
-                "inputPath": "properties.products.0"
-              }
-            }
-          }
+          "staticString": "login",
+          "outputKey": "events.event"
         }
-      ],
+      ]
+    },
+    "page": {
       "mappings": [
         {
           "inputKey": "input",
-          "outputKey": "events",
+          "outputKey": "events.event",
           "transforms": [
             {
               "expression": {
                 "lang": "lua",
-                "body": "local items = MAP(\n              input.properties.products,\n              function (p)\n                return {\n                  id = p.product_id,\n                  price = TO_FLOAT(p.price),\n                  quantity = TO_FLOAT(p.quantity or 1)\n                }\n                end\n            )\n  return {{\n    event = 'trackTransaction',\n    ua_raw_string = input.context.userAgent or '',\n    id = input.properties.order_id,\n    item = items,\n    currency = UPPER(input.properties.currency),\n  }}"
+                "body": "return (input.context.page.path == \"/\" and \"viewHome\") or \"viewPage\""
               }
             }
           ]

package/README.md

@@ -5,6 +5,9 @@ event methods, you will create a rich, actionable data set from your website, mo
 server, and other sources. It is particularly useful for tracking the pages or screens your 
 users visit, the actions they take on your property, and whether the user has been identified 
 previously.
+## 2024-03
+- Criteo (BETA)
+
 ## 2024-02
 - Azure Blob
 - Commission Junction (BETA)
@@ -35,7 +38,6 @@ previously.
 - Blueshift (BETA)
 - Braze
 - Convert (BETA)
-- Criteo (BETA)
 - Customer.io
 - Facebook Pixel
 - Google Ads (BETA)
@@ -75,6 +77,7 @@ previously.
 
 | Kit Name | Date | Latest Note |
 |----------|------|-------------|
+| Criteo (BETA) | 2024-03 | Migrated to Server to Server endpoint |
 | Azure Blob | 2024-02 | Removed Identity |
 | Commission Junction (BETA) | 2024-02 | Add order_canceled and order_updated. |
 | Google Cloud Storage (BETA) | 2024-02 | Removed Identity |
@@ -100,7 +103,6 @@ previously.
 | Blueshift (BETA) | 2023-12 | Marked as unstable version: 0.1.0 |
 | Braze | 2023-12 | Marked as stable version: 1.0.0 |
 | Convert (BETA) | 2023-12 | Marked as unstable version: 0.1.0 |
-| Criteo (BETA) | 2023-12 | Marked as unstable version: 0.1.0 |
 | Customer.io | 2023-12 | Marked as stable version: 1.0.0 |
 | Facebook Pixel | 2023-12 | Marked as stable version: 1.0.0 |
 | Google Ads (BETA) | 2023-12 | Marked as unstable version: 0.1.0 |

package/index.js

@@ -121,15 +121,14 @@ exports.convert = {
     endpointSchema: require('./.dist/criteo/connection.json'),
     playbook: require('./.dist/criteo/playbook.json'),
     metadata: require('./.dist/criteo/metadata.json')
+  },
+  exports['customer-io'] = {
+    connectionTemplate: connectionSchemas.properties.customerIo,
+    endpointSchema: require('./.dist/customer-io/connection.json'),
+    playbook: require('./.dist/customer-io/playbook.json'),
+    metadata: require('./.dist/customer-io/metadata.json')
   }
 
-exports['customer-io'] = {
-  connectionTemplate: connectionSchemas.properties.customerIo,
-  endpointSchema: require('./.dist/customer-io/connection.json'),
-  playbook: require('./.dist/customer-io/playbook.json'),
-  metadata: require('./.dist/customer-io/metadata.json')
-}
-
 exports['facebook-pixel'] = {
   connectionTemplate: connectionSchemas.properties.facebookPixel,
   endpointSchema: require('./.dist/facebook-pixel/connection.json'),
@@ -525,7 +524,7 @@ exports.etags = {
     playbook: require('./.dist/convert/playbook.etag.json'),
     kit: require('./.dist/convert/kit.etag.json')
   },
- 'commission-junction': {
+  'commission-junction': {
     endpointSchema: require('./.dist/commission-junction/connection.etag.json'),
     playbook: require('./.dist/commission-junction/playbook.etag.json'),
     kit: require('./.dist/commission-junction/kit.etag.json')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metarouter/ajs-starter-kit",
-  "version": "1.0.82-alpha.2",
+  "version": "1.0.83",
   "description": "MetaRouter analytics.js starter kit",
   "main": "index.js",
   "scripts": {