diff --git a/Gemfile.lock b/Gemfile.lock index 1ecaa4c479..d91c23fa65 100755 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -131,7 +131,7 @@ GEM terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) thread_safe (0.3.6) - tzinfo (1.2.9) + tzinfo (1.2.10) thread_safe (~> 0.1) tzinfo-data (1.2021.4) tzinfo (>= 1.0.0) diff --git a/scripts/private-destination.js b/scripts/private-destination.js index 6f39aa24ed..934b080ea5 100644 --- a/scripts/private-destination.js +++ b/scripts/private-destination.js @@ -68,7 +68,7 @@ const addPrivateDestination = async () => { let actions = destination.actions let presets = destination.presets - if (destination.status == "PRIVATE_BETA") { + if (destination.status == "PRIVATE_BETA" || destination.status == "PRIVATE_BUILDING") { let updatePrivateDest = { id: destination.id, diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index e5b7c4ffb4..b3c79dc678 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination categories last updated 2022-07-21 +# destination categories last updated 2022-07-26 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index c1a768923b..1605c0874b 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination data last updated 2022-07-21 +# destination data last updated 2022-07-26 items: - id: 60b5d0a01f3726b85dc05aab display_name: 2mee @@ -16106,8 +16106,7 @@ items: url: >- https://public-segment-devcenter-production.s3.amazonaws.com/7f0c5fbb-79c5-4df3-bf26-ae352b560dd3.svg mark: - url: >- - https://public-segment-devcenter-production.s3.amazonaws.com/9a3f1dcd-557f-4231-9a9e-c31e9f7581ad.svg + url: https://cdn.filepicker.io/api/file/y1R78BMSMOuKakrT0Wvx methods: track: true identify: true @@ -16138,8 +16137,8 @@ items: type: string defaultValue: '' description: >- - Go to https://app.factors.ai/#/settings/segment. Choose your Project on - the top dropdown. Enable Segment and Copy the API Key. + Go to https://app.factors.ai/settings/integration, Enable Segment and Copy + API Key required: true label: API Key - name: publishableApiKey @@ -20140,7 +20139,7 @@ items: hidden: false defaultTrigger: type = "page" fields: - - id: bcJDSeYjueLf77GGrWnAJR + - id: hjj5FHVct6tP6wiLyFm1e3 sortOrder: 0 fieldKey: clientId label: Client ID @@ -20160,7 +20159,7 @@ items: choices: null dynamic: false allowNull: false - - id: mTEspKZKudTL8yWyG4mN1b + - id: 4T8qRP7maPvkW5AfofP2b7 sortOrder: 1 fieldKey: user_id label: User ID @@ -20177,8 +20176,25 @@ items: choices: null dynamic: false allowNull: false - - id: 5iPigjhATcB8rmpGh6quy6 + - id: rbHVknwbZ8sZEbyKCwHPar sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 2FyKLVc69L6nPMqXVQFjMt + sortOrder: 3 fieldKey: page_location label: Page Location type: STRING @@ -20191,8 +20207,8 @@ items: choices: null dynamic: false allowNull: false - - id: hqwL2j3fazdfFpDQtupfcv - sortOrder: 3 + - id: th3XfdANuVRV3m4PqTvZ5g + sortOrder: 4 fieldKey: page_referrer label: Page Referrer type: STRING @@ -20205,8 +20221,8 @@ items: choices: null dynamic: false allowNull: false - - id: d1iAkJnBuF9RFCEb9HLb96 - sortOrder: 4 + - id: 7w2Uwx6kwVKMvToip6uNPJ + sortOrder: 5 fieldKey: user_properties label: User Properties type: OBJECT @@ -20222,8 +20238,8 @@ items: choices: null dynamic: false allowNull: false - - id: 8Mu2UCszojFbcuy7vreoV4 - sortOrder: 5 + - id: 9rjYMdetUhfRsTJmaeq2G + sortOrder: 6 fieldKey: page_title label: Page Title type: STRING @@ -20236,8 +20252,8 @@ items: choices: null dynamic: false allowNull: false - - id: YcHuB3En281X16YHC9HTu - sortOrder: 6 + - id: duKE1RDhU3UTgDS3vncxji + sortOrder: 7 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -20253,8 +20269,8 @@ items: choices: null dynamic: false allowNull: false - - id: nao5naou6XMm78S5iKoohK - sortOrder: 7 + - id: dkMvBiCHTwdoE47Gv8Xuva + sortOrder: 8 fieldKey: params label: Event Parameters type: OBJECT @@ -20273,7 +20289,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Promotion Clicked" fields: - - id: 9RVy52RK3ng97gM8gZezcG + - id: rh1isA5NBLDnWEWKQAoECH sortOrder: 0 fieldKey: client_id label: Client ID @@ -20293,7 +20309,7 @@ items: choices: null dynamic: false allowNull: false - - id: rMFnV4jRHqXHGEauZPKHn6 + - id: kFAPbF2f9ngfaqvtG3cuZT sortOrder: 1 fieldKey: user_id label: User ID @@ -20310,8 +20326,25 @@ items: choices: null dynamic: false allowNull: false - - id: gdjJZ5qXHNvpsiJEkhzbLR + - id: necnpiEscNsCmWrhtb5wMp sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 6ccXmaPJSq5ffKaNVCJjZw + sortOrder: 3 fieldKey: creative_name label: Creative Name type: STRING @@ -20322,8 +20355,8 @@ items: choices: null dynamic: false allowNull: false - - id: qbwc2bNoPNqRo8arpXCGgH - sortOrder: 3 + - id: rGQGnWyxEcDN2DH2b1NB9S + sortOrder: 4 fieldKey: creative_slot label: Creative Slot type: STRING @@ -20336,8 +20369,8 @@ items: choices: null dynamic: false allowNull: false - - id: vxhXZyVzJbgNEgirMFgKSz - sortOrder: 4 + - id: tR6aTXKX6hvGW81Xdoeu6b + sortOrder: 5 fieldKey: location_id label: Location ID type: STRING @@ -20348,8 +20381,8 @@ items: choices: null dynamic: false allowNull: false - - id: wFXDFRFkJ7bQiMDFWHNMAR - sortOrder: 5 + - id: 6Jf7QjteeGLaY5YKkXMbgr + sortOrder: 6 fieldKey: promotion_id label: Promotion ID type: STRING @@ -20362,8 +20395,8 @@ items: choices: null dynamic: false allowNull: false - - id: tEMBk3n5eMpS7FY9gmcUyc - sortOrder: 6 + - id: 2wQ36g1k9uJvCUJan7vEdD + sortOrder: 7 fieldKey: promotion_name label: Promotion Name type: STRING @@ -20376,8 +20409,8 @@ items: choices: null dynamic: false allowNull: false - - id: 9qGJWHJeCtgc545MeN69pn - sortOrder: 7 + - id: rtDWSKMLr7jLamQGM3iiLH + sortOrder: 8 fieldKey: items label: Products type: OBJECT @@ -20409,8 +20442,8 @@ items: choices: null dynamic: false allowNull: false - - id: 5pBhGJ6Nw5VsAVhd86LFwg - sortOrder: 8 + - id: fDwbwhT4T9qQG41Bj5awPY + sortOrder: 9 fieldKey: user_properties label: User Properties type: OBJECT @@ -20426,8 +20459,8 @@ items: choices: null dynamic: false allowNull: false - - id: 7webPqa3xnYy5DZiKqGeec - sortOrder: 9 + - id: hovpv6o2n8KZ5qrvmDzaAd + sortOrder: 10 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -20443,8 +20476,8 @@ items: choices: null dynamic: false allowNull: false - - id: cZ99atoqFrv3nAgW2rvgo6 - sortOrder: 10 + - id: n3yRLDdibdQtZmetM92vhU + sortOrder: 11 fieldKey: params label: Event Parameters type: OBJECT @@ -20463,7 +20496,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Product List Viewed" fields: - - id: 2HtMWy4oiHSR72ZLkSQnDT + - id: nhCgovCA4vcXBKBZP4tqHK sortOrder: 0 fieldKey: client_id label: Client ID @@ -20483,7 +20516,7 @@ items: choices: null dynamic: false allowNull: false - - id: urUXEWvcgosKbUyFJweTqU + - id: 7exNFiWwKxM3s7biixrwq6 sortOrder: 1 fieldKey: user_id label: User ID @@ -20500,8 +20533,25 @@ items: choices: null dynamic: false allowNull: false - - id: oo1b6m4383ZrDFwgfb92DY + - id: g53TEL8zvPBabYdxbon9HP sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: gfuUvitVqJNTZ3xQUNA112 + sortOrder: 3 fieldKey: item_list_id label: Item List ID type: STRING @@ -20514,8 +20564,8 @@ items: choices: null dynamic: false allowNull: false - - id: swJjA5dKTxaBwrk6WmqGBM - sortOrder: 3 + - id: fuHDZoECupg93knraiTexi + sortOrder: 4 fieldKey: item_list_name label: Item List Name type: STRING @@ -20528,8 +20578,8 @@ items: choices: null dynamic: false allowNull: false - - id: qujDrfMirnUYdZcCrQtJGz - sortOrder: 4 + - id: iPdNnVqFse547jHUJpyFU5 + sortOrder: 5 fieldKey: items label: Products type: OBJECT @@ -20563,8 +20613,8 @@ items: choices: null dynamic: false allowNull: false - - id: gXoBQ6DMhvd3Kz9hvejqnJ - sortOrder: 5 + - id: pHydfLbrpfDRr7JNEzAz87 + sortOrder: 6 fieldKey: user_properties label: User Properties type: OBJECT @@ -20580,8 +20630,8 @@ items: choices: null dynamic: false allowNull: false - - id: o3BRTXqE4GiDSaXpqRG4bR - sortOrder: 6 + - id: qaupKTuPhgHiwunxTtEhxW + sortOrder: 7 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -20597,8 +20647,8 @@ items: choices: null dynamic: false allowNull: false - - id: uWKcSM4w3zUQheRRsZH717 - sortOrder: 7 + - id: g7DayWgxTqCVkScMYms4eG + sortOrder: 8 fieldKey: params label: Event Parameters type: OBJECT @@ -20617,7 +20667,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Checkout Started" fields: - - id: 8YCoHjc1d8JvsxwzejeqqU + - id: eaWufFNbrkHh1ECrUsQgvs sortOrder: 0 fieldKey: client_id label: Client ID @@ -20637,7 +20687,7 @@ items: choices: null dynamic: false allowNull: false - - id: msJf7e4PGUnGtz1rhbyBBG + - id: wNpVR4iy45ec8M4JjVqaQV sortOrder: 1 fieldKey: user_id label: User ID @@ -20654,8 +20704,25 @@ items: choices: null dynamic: false allowNull: false - - id: gapRqpiUQuJ2PvQKYZvMWu + - id: vRZiDQigpFoTuD3CWKjNf3 sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 4uf26fAuGH7tUxE41VrsPZ + sortOrder: 3 fieldKey: coupon label: Coupon type: STRING @@ -20668,8 +20735,8 @@ items: choices: null dynamic: false allowNull: false - - id: 7wUxyWkBxtgZ62uLvrim36 - sortOrder: 3 + - id: nHvTTQ6ykXycox49A2Bn46 + sortOrder: 4 fieldKey: currency label: Currency type: STRING @@ -20684,8 +20751,8 @@ items: choices: null dynamic: false allowNull: false - - id: qtZ9N1iw7Qcajf2DZ9qriw - sortOrder: 4 + - id: 5hevmFXC8cUcPWUrNDHMZu + sortOrder: 5 fieldKey: items label: Products type: OBJECT @@ -20719,8 +20786,8 @@ items: choices: null dynamic: false allowNull: false - - id: de2kfMh4dDEoVMHP7qid2s - sortOrder: 5 + - id: duf4wnsH7zYNNUXjjP5wmX + sortOrder: 6 fieldKey: value label: Value type: NUMBER @@ -20733,8 +20800,8 @@ items: choices: null dynamic: false allowNull: false - - id: 6ht59QLR5FGJnJwYkgNtqx - sortOrder: 6 + - id: vaWaEfJrW6yrQkW7WM4gsp + sortOrder: 7 fieldKey: user_properties label: User Properties type: OBJECT @@ -20750,8 +20817,8 @@ items: choices: null dynamic: false allowNull: false - - id: eTEPhmFWcujKVii3dUA12j - sortOrder: 7 + - id: 3keWnYqQTYsvjjKEdS6otf + sortOrder: 8 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -20767,8 +20834,8 @@ items: choices: null dynamic: false allowNull: false - - id: sEeQzCmU9gSyUc8ZqbeNuT - sortOrder: 8 + - id: pKkFgY6NyRhJxMAP1iJeYh + sortOrder: 9 fieldKey: params label: Event Parameters type: OBJECT @@ -20787,7 +20854,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Order Refunded" fields: - - id: duhT7gXVroiPUgQjin3opg + - id: rV5ySZrqGyfBcqgB3WX9FJ sortOrder: 0 fieldKey: client_id label: Client ID @@ -20807,7 +20874,7 @@ items: choices: null dynamic: false allowNull: false - - id: zYBAjYZbikEU2AA7MVoHd + - id: 5rwDRPnKUgEgvTMcvgS7zx sortOrder: 1 fieldKey: user_id label: User ID @@ -20824,8 +20891,25 @@ items: choices: null dynamic: false allowNull: false - - id: wAuZHwDbgQ8k8XgXcFSRJd + - id: teyVR9sZtwSPh173GG8C7Q sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 58divcDBhj4aD5q8yhvSUz + sortOrder: 3 fieldKey: currency label: Currency type: STRING @@ -20840,8 +20924,8 @@ items: choices: null dynamic: false allowNull: false - - id: 2vbsxWMfWdj6zwp8THwJoN - sortOrder: 3 + - id: 71J2GjQ81Z1uFCbqCKJR3X + sortOrder: 4 fieldKey: transaction_id label: Order Id type: STRING @@ -20854,8 +20938,8 @@ items: choices: null dynamic: false allowNull: false - - id: tfNbTCtscQozzp5nXVEan8 - sortOrder: 4 + - id: 5jF59pDN7V4WWfYQ84VYcS + sortOrder: 5 fieldKey: value label: Value type: NUMBER @@ -20868,8 +20952,8 @@ items: choices: null dynamic: false allowNull: false - - id: iAJPCtqYLr6V2fKs4qZJRZ - sortOrder: 5 + - id: 2z782kg58gZShAykSBeTdJ + sortOrder: 6 fieldKey: affiliation label: Affiliation type: STRING @@ -20884,8 +20968,8 @@ items: choices: null dynamic: false allowNull: false - - id: gVcGcohE2NwgJ8Qo4gbq1q - sortOrder: 6 + - id: x744inKoeegww64hjfYxBk + sortOrder: 7 fieldKey: coupon label: Coupon type: STRING @@ -20896,8 +20980,8 @@ items: choices: null dynamic: false allowNull: false - - id: tQueL37dJNm9jbL5QiUoLZ - sortOrder: 7 + - id: fSeAp8Ld5gmGqMcmbMh8gu + sortOrder: 8 fieldKey: shipping label: Shipping type: NUMBER @@ -20910,8 +20994,8 @@ items: choices: null dynamic: false allowNull: false - - id: e6qHKJ9A6KFj6CL2SuE992 - sortOrder: 8 + - id: uuPBNUhgBL6dyxjWLkgWh2 + sortOrder: 9 fieldKey: tax label: Tax type: NUMBER @@ -20922,8 +21006,8 @@ items: choices: null dynamic: false allowNull: false - - id: BVxirVuDBmwDHRNLdLMKy - sortOrder: 9 + - id: 9uCSLCHoFauYWUSyCecYMw + sortOrder: 10 fieldKey: items label: Products type: OBJECT @@ -20957,8 +21041,8 @@ items: choices: null dynamic: false allowNull: false - - id: rNjq89yvVMtWXJuKHEHsZZ - sortOrder: 10 + - id: v9KGxTh3m4iQ2uuBoqt4TD + sortOrder: 11 fieldKey: user_properties label: User Properties type: OBJECT @@ -20974,8 +21058,8 @@ items: choices: null dynamic: false allowNull: false - - id: Vnmrf9pMcWdgHTYnAExs6 - sortOrder: 11 + - id: temNph31khaed8oNmD1vaN + sortOrder: 12 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -20991,8 +21075,8 @@ items: choices: null dynamic: false allowNull: false - - id: oSnTSRJJLMxhBa7BtwWSYF - sortOrder: 12 + - id: 6vDdzzDqZaRJxjugobNmB3 + sortOrder: 13 fieldKey: params label: Event Parameters type: OBJECT @@ -21011,7 +21095,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Product Added" fields: - - id: mZHuex1MsLsE5xHG2XNvD9 + - id: dprkGyTXMZhtJwes8dCGkf sortOrder: 0 fieldKey: client_id label: Client ID @@ -21031,7 +21115,7 @@ items: choices: null dynamic: false allowNull: false - - id: cKcRTbbGMiwQfpkasXMCWr + - id: ob2FKME5zGRS1V5g7DPLn7 sortOrder: 1 fieldKey: user_id label: User ID @@ -21048,8 +21132,25 @@ items: choices: null dynamic: false allowNull: false - - id: phUsX7HhoAtRBmyD2F4Ufc + - id: w7cEbNeTXybZe7kXkux1sV sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: nxApc4mzFDnKwwsU9BdiE6 + sortOrder: 3 fieldKey: currency label: Currency type: STRING @@ -21064,8 +21165,8 @@ items: choices: null dynamic: false allowNull: false - - id: axhd5rjY5TewrvoEmQFZxo - sortOrder: 3 + - id: hpcvrGWjDU8ss4L8jnT1Zo + sortOrder: 4 fieldKey: items label: Products type: OBJECT @@ -21097,8 +21198,8 @@ items: choices: null dynamic: false allowNull: false - - id: qh9j2Tv99Xb441tVeX9Cap - sortOrder: 4 + - id: oGvRyVYGMUL5zEsVZgsc6T + sortOrder: 5 fieldKey: value label: Value type: NUMBER @@ -21111,8 +21212,8 @@ items: choices: null dynamic: false allowNull: false - - id: 9wyoeSXdGoMSmtJVacwraN - sortOrder: 5 + - id: 8X5fNbGUPTAwmxFZr5CtxC + sortOrder: 6 fieldKey: user_properties label: User Properties type: OBJECT @@ -21128,8 +21229,8 @@ items: choices: null dynamic: false allowNull: false - - id: aENcGKZMk9ZN9EE8BiHDrf - sortOrder: 6 + - id: d2UjTjc3GNMTWgFJ8nCnF + sortOrder: 7 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -21145,8 +21246,8 @@ items: choices: null dynamic: false allowNull: false - - id: 8XTBoWYLUHRp63TC8sAkt2 - sortOrder: 7 + - id: kpSxPwrp1VKUNh9PLM5Evo + sortOrder: 8 fieldKey: params label: Event Parameters type: OBJECT @@ -21165,7 +21266,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Payment Info Entered" fields: - - id: w5rBKjgj9992qiWdV3XMrY + - id: ri7xDSeUUBcu8PAYJFCbWs sortOrder: 0 fieldKey: client_id label: Client ID @@ -21185,7 +21286,7 @@ items: choices: null dynamic: false allowNull: false - - id: 72rZ5G2PQJ8DsisSi8sBY8 + - id: cEFGc2tMmiAFK5sjjMjGYG sortOrder: 1 fieldKey: user_id label: User ID @@ -21202,8 +21303,25 @@ items: choices: null dynamic: false allowNull: false - - id: itWYTvrR11gnPLQgofThWG + - id: vMvYcv4bHjJM7FNFCqkuNg sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bkKwgFsgEnk65GkBu6PuC + sortOrder: 3 fieldKey: currency label: Currency type: STRING @@ -21218,8 +21336,8 @@ items: choices: null dynamic: false allowNull: false - - id: sUHHKt8ETJBB6DbnvYwH88 - sortOrder: 3 + - id: 22pLKeYxUoT3t69sRYSfu2 + sortOrder: 4 fieldKey: value label: Value type: NUMBER @@ -21232,8 +21350,8 @@ items: choices: null dynamic: false allowNull: false - - id: 286eU61zJVhZH3y2RB5LL4 - sortOrder: 4 + - id: 6cD3PKihV3Xxjtsw89FxhL + sortOrder: 5 fieldKey: coupon label: Coupon type: STRING @@ -21244,8 +21362,8 @@ items: choices: null dynamic: false allowNull: false - - id: mEGeaoqNQxhJEHGdb25s53 - sortOrder: 5 + - id: fN5ge3pgkE7SBtSma6mtX2 + sortOrder: 6 fieldKey: payment_type label: Payment Type type: STRING @@ -21258,8 +21376,8 @@ items: choices: null dynamic: false allowNull: false - - id: 6kugMgiAqwfpMEc64nzWtb - sortOrder: 6 + - id: j6amizkdY6KN9pWkDUfC5J + sortOrder: 7 fieldKey: items label: Products type: OBJECT @@ -21293,8 +21411,8 @@ items: choices: null dynamic: false allowNull: false - - id: auFtzv9sSPdWcpFoDLNy2h - sortOrder: 7 + - id: ajHbZ7uCHB4cTi7bSge7Vy + sortOrder: 8 fieldKey: user_properties label: User Properties type: OBJECT @@ -21310,8 +21428,8 @@ items: choices: null dynamic: false allowNull: false - - id: v5GUhiQH1TVxqQN6DCDJLm - sortOrder: 8 + - id: hzTXFckEqSAq9jGjGpHemH + sortOrder: 9 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -21327,8 +21445,8 @@ items: choices: null dynamic: false allowNull: false - - id: aUhechTi7FCdRaW1RTJSai - sortOrder: 9 + - id: aKHR269fP2nvD6aqtZ7kTx + sortOrder: 10 fieldKey: params label: Event Parameters type: OBJECT @@ -21347,7 +21465,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Product Added to Wishlist" fields: - - id: i4V1rZVF4LXQaW818HJn5d + - id: aGfscH6JAZyyRdjL1VtYr1 sortOrder: 0 fieldKey: client_id label: Client ID @@ -21367,7 +21485,7 @@ items: choices: null dynamic: false allowNull: false - - id: 9sdVfSfaVxfZZhm38eGUG3 + - id: e3p8FwvFEH6qmMCk6z2Gv9 sortOrder: 1 fieldKey: user_id label: User ID @@ -21384,8 +21502,25 @@ items: choices: null dynamic: false allowNull: false - - id: cwBRo4kynXAiYpe1APyqJz + - id: u2mQnj4JGqonjfWhKzpMHZ sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: w69U6gnUAuG1V62W4xPn5z + sortOrder: 3 fieldKey: currency label: Currency type: STRING @@ -21400,8 +21535,8 @@ items: choices: null dynamic: false allowNull: false - - id: g16zFiTqTANJAt133voJY1 - sortOrder: 3 + - id: hsReXfBF6v4pebk454jAKo + sortOrder: 4 fieldKey: value label: Value type: NUMBER @@ -21414,8 +21549,8 @@ items: choices: null dynamic: false allowNull: false - - id: mhKz5zHftozhPctaE3u9BS - sortOrder: 4 + - id: rgKg1nNLUAaxP3mUXMXxD + sortOrder: 5 fieldKey: items label: Products type: OBJECT @@ -21447,8 +21582,8 @@ items: choices: null dynamic: false allowNull: false - - id: wbruMLWMdfAmUnNR5icpbv - sortOrder: 5 + - id: bC5KteMd4mTXXYQeNH1fwH + sortOrder: 6 fieldKey: user_properties label: User Properties type: OBJECT @@ -21464,8 +21599,8 @@ items: choices: null dynamic: false allowNull: false - - id: em5WaKBYxfP4ALoUSg2h6a - sortOrder: 6 + - id: ihYrWS22Bnam1WjGM11UbN + sortOrder: 7 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -21481,8 +21616,8 @@ items: choices: null dynamic: false allowNull: false - - id: jFsBYbTPVuNSEEfrjavq28 - sortOrder: 7 + - id: tZxeuva8hqGRthAeb6gRJN + sortOrder: 8 fieldKey: params label: Event Parameters type: OBJECT @@ -21501,7 +21636,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Product Viewed" fields: - - id: gN3USaGtE3suRfYG95RpGG + - id: hJginWinULuJ7tMHmvwNdV sortOrder: 0 fieldKey: client_id label: Client ID @@ -21521,7 +21656,7 @@ items: choices: null dynamic: false allowNull: false - - id: iy8Nk74gvuAKrYqXPLtmiE + - id: 9FHgo1xEkxe1yBqNcLUqWf sortOrder: 1 fieldKey: user_id label: User ID @@ -21538,8 +21673,25 @@ items: choices: null dynamic: false allowNull: false - - id: 6AdwaSJzBdS5Tix8bZ7Gj5 + - id: 94WmYj6Z7CoKdeczz7nqn6 sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 7naSkVVeySWxWNXCW3dff5 + sortOrder: 3 fieldKey: currency label: Currency type: STRING @@ -21554,8 +21706,8 @@ items: choices: null dynamic: false allowNull: false - - id: rMGQm46w1xEcypcY78wcH4 - sortOrder: 3 + - id: jTPv71mkZzsuCbcLGZgwrg + sortOrder: 4 fieldKey: value label: Value type: NUMBER @@ -21568,8 +21720,8 @@ items: choices: null dynamic: false allowNull: false - - id: aCSPNw4jsgyrekfcSiEcby - sortOrder: 4 + - id: rxcmsWf7TPGspSyCqMtPRb + sortOrder: 5 fieldKey: items label: Products type: OBJECT @@ -21601,8 +21753,8 @@ items: choices: null dynamic: false allowNull: false - - id: jXo87gr9mxrQaWRiZW64xk - sortOrder: 5 + - id: wfSJm2wi4FeeJ3rqMhaZye + sortOrder: 6 fieldKey: user_properties label: User Properties type: OBJECT @@ -21618,8 +21770,8 @@ items: choices: null dynamic: false allowNull: false - - id: bRkiUNhvRsn366LsK2xMSZ - sortOrder: 6 + - id: DuHHMizjV1Xf4oZwtLCGo + sortOrder: 7 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -21635,8 +21787,8 @@ items: choices: null dynamic: false allowNull: false - - id: fm62X4CLWCVw5Aw1QqZocB - sortOrder: 7 + - id: wUYWLTgDxtbzpyzUFuckS3 + sortOrder: 8 fieldKey: params label: Event Parameters type: OBJECT @@ -21657,7 +21809,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Signed Up" fields: - - id: 8cQhpTYhnAEKPuBAHTwVzF + - id: oD7Zh6Mx4JPGcXkjinc3fv sortOrder: 0 fieldKey: client_id label: Client ID @@ -21677,7 +21829,7 @@ items: choices: null dynamic: false allowNull: false - - id: b2gSgWEXfJxGUZximkbnhN + - id: 9yinPpU1oNEzB3CPruKztC sortOrder: 1 fieldKey: user_id label: User ID @@ -21694,8 +21846,25 @@ items: choices: null dynamic: false allowNull: false - - id: dPZZdx1nrHahd1uwpiZaM9 + - id: px81wFM53Mbyy8mJXVCvKQ sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: qqW5vzpR6KAr5n1NGNdaXh + sortOrder: 3 fieldKey: method label: Method type: STRING @@ -21708,8 +21877,8 @@ items: choices: null dynamic: false allowNull: false - - id: qBDbzWFtEXAbDG92711NKx - sortOrder: 3 + - id: eBnMXgNp5DhZEGqUx39pHm + sortOrder: 4 fieldKey: user_properties label: User Properties type: OBJECT @@ -21725,8 +21894,8 @@ items: choices: null dynamic: false allowNull: false - - id: i23AHFioZBzkCQ6Gba9DYC - sortOrder: 4 + - id: 5sguAyBiJXEnrHFdyum7TT + sortOrder: 5 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -21742,8 +21911,8 @@ items: choices: null dynamic: false allowNull: false - - id: pjXdzwRo3rrZaty8mjpAxs - sortOrder: 5 + - id: 5mHYgRwcF1ezod72BNKQAz + sortOrder: 6 fieldKey: params label: Event Parameters type: OBJECT @@ -21762,7 +21931,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Order Completed" fields: - - id: tjGVPnJaeZZzk1C9Z2rUe5 + - id: CJNsE7wX6Jb75mv1GQKwp sortOrder: 0 fieldKey: client_id label: Client ID @@ -21782,7 +21951,7 @@ items: choices: null dynamic: false allowNull: false - - id: tArN17kxGpQhhHAvJ58eMG + - id: 2xF4AeRxG3eAhqNR727Bcm sortOrder: 1 fieldKey: user_id label: User ID @@ -21799,8 +21968,25 @@ items: choices: null dynamic: false allowNull: false - - id: 7jS3rYzaUGHSMMepYL6oQ5 + - id: 2yC2S63oLoWsHsEuB8vneS sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: x7vVHx2wisKXgAwMXRv8TM + sortOrder: 3 fieldKey: affiliation label: Affiliation type: STRING @@ -21815,8 +22001,8 @@ items: choices: null dynamic: false allowNull: false - - id: hXGy9WrSmZWLyLkMtiYou7 - sortOrder: 3 + - id: sK1Wumohrw1W8PGKpnxJgB + sortOrder: 4 fieldKey: coupon label: Coupon type: STRING @@ -21829,8 +22015,8 @@ items: choices: null dynamic: false allowNull: false - - id: i6PkkyXsmHeFaVLv4tjKUH - sortOrder: 4 + - id: vj5pf1zjeTxaRpUSBWxNzZ + sortOrder: 5 fieldKey: currency label: Currency type: STRING @@ -21845,8 +22031,8 @@ items: choices: null dynamic: false allowNull: false - - id: wSwmy9eA3QxQFV7ehNkDUR - sortOrder: 5 + - id: xwoXd5mYuwBjKWs3vcudBX + sortOrder: 6 fieldKey: items label: Products type: OBJECT @@ -21880,8 +22066,8 @@ items: choices: null dynamic: false allowNull: false - - id: fuYcZtN6xxwDpyMPBLaQmx - sortOrder: 6 + - id: GeNEarsKMwx8cdMQSiBZQ + sortOrder: 7 fieldKey: transaction_id label: Order Id type: STRING @@ -21894,8 +22080,8 @@ items: choices: null dynamic: false allowNull: false - - id: hfyhFNZ2SdvD7uuHWhF5C6 - sortOrder: 7 + - id: umhr8zv2wZyrDeiMVhcJiR + sortOrder: 8 fieldKey: shipping label: Shipping type: NUMBER @@ -21908,8 +22094,8 @@ items: choices: null dynamic: false allowNull: false - - id: 2uUABtZZ8yg8jrh1AN7Xy5 - sortOrder: 8 + - id: x6euGaHikYiSziMa83wLp2 + sortOrder: 9 fieldKey: tax label: Tax type: NUMBER @@ -21922,8 +22108,8 @@ items: choices: null dynamic: false allowNull: false - - id: oUCnpdtKE4JkreyNG8FDRe - sortOrder: 9 + - id: svpqdtfj3UEsgdMqc6y8AU + sortOrder: 10 fieldKey: value label: Value type: NUMBER @@ -21936,8 +22122,8 @@ items: choices: null dynamic: false allowNull: false - - id: 7yLPK9tranyeQFacKUKVm2 - sortOrder: 10 + - id: kciwfEw8YEauNknR9w8dWG + sortOrder: 11 fieldKey: user_properties label: User Properties type: OBJECT @@ -21953,8 +22139,8 @@ items: choices: null dynamic: false allowNull: false - - id: xau8oZEDBUUwws6nMLRVnZ - sortOrder: 11 + - id: fb4qvFKBWkvCiBWUbBz6KC + sortOrder: 12 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -21970,8 +22156,8 @@ items: choices: null dynamic: false allowNull: false - - id: 5LKcqQ9kTkvMb3VLa2GEZW - sortOrder: 12 + - id: 3sVKhFfzy5B386uv2TDgUs + sortOrder: 13 fieldKey: params label: Event Parameters type: OBJECT @@ -21990,7 +22176,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Promotion Viewed" fields: - - id: qh5Nx2RgWVu4kKaoNV5nQo + - id: x13zGaHqPaLmV4fFhKtgrD sortOrder: 0 fieldKey: client_id label: Client ID @@ -22010,7 +22196,7 @@ items: choices: null dynamic: false allowNull: false - - id: aPkwN8GV26omjbh7gqhLvj + - id: w7S5jEvrKJWsuJ7cF13MJv sortOrder: 1 fieldKey: user_id label: User ID @@ -22027,8 +22213,25 @@ items: choices: null dynamic: false allowNull: false - - id: ikvVjV1EnEVNJkkZ8WaS9h + - id: cokf412TrtVVeEtD4Qhysb sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: whRAA27dSrcQakuZuKh9Mt + sortOrder: 3 fieldKey: creative_name label: Creative Name type: STRING @@ -22039,8 +22242,8 @@ items: choices: null dynamic: false allowNull: false - - id: 6zHrGFs9n4NbfS2w2Wpk3 - sortOrder: 3 + - id: huL25u5xF73i5FWbWygadL + sortOrder: 4 fieldKey: creative_slot label: Creative Slot type: STRING @@ -22053,8 +22256,8 @@ items: choices: null dynamic: false allowNull: false - - id: 7485rb6JdKdZiDEYWsq7Kp - sortOrder: 4 + - id: hXzSJeqYC9qaqSASoNfJz7 + sortOrder: 5 fieldKey: location_id label: Location ID type: STRING @@ -22067,8 +22270,8 @@ items: choices: null dynamic: false allowNull: false - - id: d7VTipezRrds1thE8JkKaF - sortOrder: 5 + - id: wd6zqdRAHW5cjkr3tnjBE2 + sortOrder: 6 fieldKey: promotion_id label: Promotion ID type: STRING @@ -22081,8 +22284,8 @@ items: choices: null dynamic: false allowNull: false - - id: 5L28dDG8RZLxk7qeB2WSKD - sortOrder: 6 + - id: 39FZQGyJsj23nqX68zcFGM + sortOrder: 7 fieldKey: promotion_name label: Promotion Name type: STRING @@ -22095,8 +22298,8 @@ items: choices: null dynamic: false allowNull: false - - id: poNgLMLjt9kQub22heDtFd - sortOrder: 7 + - id: 6bjcPFvzjqh7nxj7SLsUXC + sortOrder: 8 fieldKey: items label: Products type: OBJECT @@ -22128,8 +22331,8 @@ items: choices: null dynamic: false allowNull: false - - id: c77CLW2vDVdU7hEiditA9a - sortOrder: 8 + - id: qiRg26xQBmFR4hMgCtv4QN + sortOrder: 9 fieldKey: user_properties label: User Properties type: OBJECT @@ -22145,8 +22348,8 @@ items: choices: null dynamic: false allowNull: false - - id: urNbadFEvP9LUphiHo71mm - sortOrder: 9 + - id: 2eFUUqD3XZcPdq2JyDESgc + sortOrder: 10 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -22162,8 +22365,8 @@ items: choices: null dynamic: false allowNull: false - - id: gEHJHKhWoFw6ob1i1kTSZz - sortOrder: 10 + - id: qhf9KbStkpjQF7SSBuYb2J + sortOrder: 11 fieldKey: params label: Event Parameters type: OBJECT @@ -22182,7 +22385,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Cart Viewed" fields: - - id: 4v519DdUtCsG2q9CuvDFNS + - id: s6az6Tk82fo8jA7orNmuWJ sortOrder: 0 fieldKey: client_id label: Client ID @@ -22202,7 +22405,7 @@ items: choices: null dynamic: false allowNull: false - - id: hQ4hUeevTTm7wXm2ZU6ZXk + - id: by2141fcGQPkm9MghgLpPJ sortOrder: 1 fieldKey: user_id label: User ID @@ -22219,8 +22422,25 @@ items: choices: null dynamic: false allowNull: false - - id: tAue635mUjj11t6887uF2X + - id: 4HPgA2jCXyFsmbP8AJe8V5 sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: nqXdP55zYbVvhFZn2a3SdY + sortOrder: 3 fieldKey: currency label: Currency type: STRING @@ -22235,8 +22455,8 @@ items: choices: null dynamic: false allowNull: false - - id: sYxp48XvxpYSQEEAakAQLK - sortOrder: 3 + - id: o6VAbnjrHKaUA7n25rzqPB + sortOrder: 4 fieldKey: value label: Value type: NUMBER @@ -22249,8 +22469,8 @@ items: choices: null dynamic: false allowNull: false - - id: 7bUxzRNjBf2hH1CXr7L2ds - sortOrder: 4 + - id: brU4A4UwoQGhJRRwsosZsq + sortOrder: 5 fieldKey: items label: Products type: OBJECT @@ -22284,8 +22504,8 @@ items: choices: null dynamic: false allowNull: false - - id: hDMkZiqM7a7rbsC1ewpC1M - sortOrder: 5 + - id: qqfz2UdBfqJy1Fy7Uz6e9C + sortOrder: 6 fieldKey: user_properties label: User Properties type: OBJECT @@ -22301,8 +22521,8 @@ items: choices: null dynamic: false allowNull: false - - id: 2ao4CfUSABx6k1Cdz8A69r - sortOrder: 6 + - id: t9Sz2BkdoHqjArhdfKTKGo + sortOrder: 7 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -22318,8 +22538,8 @@ items: choices: null dynamic: false allowNull: false - - id: ew7ChLMuokw3MqPiCvtNud - sortOrder: 7 + - id: tSnHur6cQYU5xB8aCDGu55 + sortOrder: 8 fieldKey: params label: Event Parameters type: OBJECT @@ -22338,7 +22558,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Signed In" fields: - - id: vZ2vmjaNdwKwrTTrPQQVmA + - id: 3XHAzz9fk7xbwh7ehJZiG2 sortOrder: 0 fieldKey: client_id label: Client ID @@ -22358,7 +22578,7 @@ items: choices: null dynamic: false allowNull: false - - id: aweXv6QhN9XjqW799SKVoq + - id: tanxZ4DNAfhz1rM3DnqAuP sortOrder: 1 fieldKey: user_id label: User ID @@ -22375,8 +22595,25 @@ items: choices: null dynamic: false allowNull: false - - id: emcxFZAgVQZuro98raQn55 + - id: 7LskJcZzrGFYxerKezbQhG sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: rPxtbEFxFhAvAoZz2Nr24W + sortOrder: 3 fieldKey: method label: Method type: STRING @@ -22387,8 +22624,8 @@ items: choices: null dynamic: false allowNull: false - - id: h3ojFUok8b3uRDbXH21GLE - sortOrder: 3 + - id: 8H5dG7YzDQmz5P3rqwLQ52 + sortOrder: 4 fieldKey: user_properties label: User Properties type: OBJECT @@ -22404,8 +22641,8 @@ items: choices: null dynamic: false allowNull: false - - id: 9Ghyh5zYthBkEc5hDtFqzq - sortOrder: 4 + - id: 51Tj4yB72id8Ep3u3Aw2YE + sortOrder: 5 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -22421,8 +22658,8 @@ items: choices: null dynamic: false allowNull: false - - id: u6nbVNR4nbZr8AhR2oXnwu - sortOrder: 5 + - id: 2r2KBnFTjaiSkwcmo3nhaQ + sortOrder: 6 fieldKey: params label: Event Parameters type: OBJECT @@ -22441,7 +22678,7 @@ items: hidden: false defaultTrigger: type = "track" fields: - - id: brzw3B4WZG6fU9ysrdngFE + - id: x86vDKkm7wGwyv7fTWxNTp sortOrder: 0 fieldKey: clientId label: Client ID @@ -22461,7 +22698,7 @@ items: choices: null dynamic: false allowNull: false - - id: dEEAQjsM87KyEBAUv5FSH3 + - id: jQUiq8Dh2aou94TDC3hkXB sortOrder: 1 fieldKey: user_id label: User ID @@ -22478,8 +22715,25 @@ items: choices: null dynamic: false allowNull: false - - id: bDtBkKemR5ovCv99Uq8SSr + - id: 6ygkp67ghmJ1ELmDJSvCk4 sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: kdmPdYjU4kFVhREYTGjtqz + sortOrder: 3 fieldKey: name label: Event Name type: STRING @@ -22497,8 +22751,8 @@ items: choices: null dynamic: false allowNull: false - - id: xmtKyzk7VPjtW7SqsWbSwr - sortOrder: 3 + - id: 9eNpDNLPqjSEXg5B22gHZq + sortOrder: 4 fieldKey: lowercase label: Lowercase Event Name type: BOOLEAN @@ -22515,8 +22769,8 @@ items: choices: null dynamic: false allowNull: false - - id: 2EsNsfFL4KAcDqNLGQ3ETx - sortOrder: 4 + - id: tCp6im95FjdZqktPxdsPVK + sortOrder: 5 fieldKey: user_properties label: User Properties type: OBJECT @@ -22532,8 +22786,8 @@ items: choices: null dynamic: false allowNull: false - - id: ajwvQcjSnuXdxV5ox4bdW - sortOrder: 5 + - id: tMCxZvkgviFzKDEsRCjmp + sortOrder: 6 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -22549,8 +22803,8 @@ items: choices: null dynamic: false allowNull: false - - id: rCwEb9oJebmE9pfiw7S6CU - sortOrder: 6 + - id: 4M2HRrZZKM53sJ2WnQrJCP + sortOrder: 7 fieldKey: params label: Event Parameters type: OBJECT @@ -22569,7 +22823,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Product Removed" fields: - - id: wDeWd7ctCMs5EBVenLjC1Y + - id: rAnZPf4z6DEdM7imb8pNW3 sortOrder: 0 fieldKey: client_id label: Client ID @@ -22589,7 +22843,7 @@ items: choices: null dynamic: false allowNull: false - - id: 3ED6XU4QhXJrj782DR5vDH + - id: ovAGFi9CxuqsKYUhApCWsa sortOrder: 1 fieldKey: user_id label: User ID @@ -22606,8 +22860,25 @@ items: choices: null dynamic: false allowNull: false - - id: w42PJuHb4dnHKgHZuvzVYb + - id: mpuvZpotMBBLBULrpyJGCV sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: xvvZChEv6eigvE8ozgwnei + sortOrder: 3 fieldKey: currency label: Currency type: STRING @@ -22622,8 +22893,8 @@ items: choices: null dynamic: false allowNull: false - - id: gidoZLnMvBfRWmgF18rcP7 - sortOrder: 3 + - id: vFgS4mvZ9wRfrSFmq7VJqe + sortOrder: 4 fieldKey: value label: Value type: NUMBER @@ -22636,8 +22907,8 @@ items: choices: null dynamic: false allowNull: false - - id: szDKPLxXWRJdjNJSiUS26V - sortOrder: 4 + - id: fYNXrBNK55UnHcHF5ijTfz + sortOrder: 5 fieldKey: items label: Products type: OBJECT @@ -22669,8 +22940,8 @@ items: choices: null dynamic: false allowNull: false - - id: pWLqk4nLk7zvU3qbwdq85b - sortOrder: 5 + - id: 96MkZ1s7Ysj5ynijpyt1wD + sortOrder: 6 fieldKey: user_properties label: User Properties type: OBJECT @@ -22686,8 +22957,8 @@ items: choices: null dynamic: false allowNull: false - - id: fNGVmo8tKWCGVmR3ig7Qmq - sortOrder: 6 + - id: qqj2pvuDPzSJtL4kSzKeLY + sortOrder: 7 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -22703,8 +22974,8 @@ items: choices: null dynamic: false allowNull: false - - id: hXhJoB5NrvxWsqUE44tYzi - sortOrder: 7 + - id: 7TdHLV6EhePU2LhttLH6pe + sortOrder: 8 fieldKey: params label: Event Parameters type: OBJECT @@ -22723,7 +22994,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Products Searched" fields: - - id: cHMJFWYJetkaA6sgFbPERx + - id: wvgGDQ5HrVQptaZ31YYaED sortOrder: 0 fieldKey: client_id label: Client ID @@ -22743,7 +23014,7 @@ items: choices: null dynamic: false allowNull: false - - id: aC6j73MQnSJ5XiRroATrHN + - id: 64xUa3T28FSKFEMvdSBmFL sortOrder: 1 fieldKey: user_id label: User ID @@ -22760,8 +23031,25 @@ items: choices: null dynamic: false allowNull: false - - id: hgcn4xSin1UoSSCKe6DjT9 + - id: bPh2LdSTrwerKi78j9huxd sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: fp8hxDhtZrcoiZbuRF1VVq + sortOrder: 3 fieldKey: search_term label: Search Term type: STRING @@ -22774,8 +23062,8 @@ items: choices: null dynamic: false allowNull: false - - id: tGyZsTdzGhojQCdao1GXpA - sortOrder: 3 + - id: 85gDNxusDAV6a8sqJ4vgcj + sortOrder: 4 fieldKey: user_properties label: User Properties type: OBJECT @@ -22791,8 +23079,8 @@ items: choices: null dynamic: false allowNull: false - - id: jdBcXUjDeka424yycuCGu9 - sortOrder: 4 + - id: ji3GDZTPWHoMGD4YBHvw6 + sortOrder: 5 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -22808,8 +23096,8 @@ items: choices: null dynamic: false allowNull: false - - id: qDgEbsi1oHDSDNCtv6B2dd - sortOrder: 5 + - id: oakPuRebXC5M2L2HQ352Yn + sortOrder: 6 fieldKey: params label: Event Parameters type: OBJECT @@ -22828,7 +23116,7 @@ items: hidden: false defaultTrigger: type = "track" and event = "Product Clicked" fields: - - id: 6CdiaFtEAxhXntcmqBkWui + - id: pDA4eW91PDpZQJFEE6Z5oH sortOrder: 0 fieldKey: client_id label: Client ID @@ -22848,7 +23136,7 @@ items: choices: null dynamic: false allowNull: false - - id: 3gtQhpc9ow4KRAqSZ7QZ2i + - id: vZ1EDtamd9QgQWJEwM4D7H sortOrder: 1 fieldKey: user_id label: User ID @@ -22865,8 +23153,25 @@ items: choices: null dynamic: false allowNull: false - - id: 3PBELbU2z446zVsjsngBuh + - id: pouSQZXtDMf91NgKutrQKN sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: rJ1GLgp9qHJkba3aw73uhy + sortOrder: 3 fieldKey: item_list_name label: Item List Name type: STRING @@ -22877,8 +23182,8 @@ items: choices: null dynamic: false allowNull: false - - id: tFx8fugQW3ph4HGUuBe6us - sortOrder: 3 + - id: iJwKDBSwdnptqcPxs7hxTe + sortOrder: 4 fieldKey: item_list_id label: Item List Id type: STRING @@ -22889,8 +23194,8 @@ items: choices: null dynamic: false allowNull: false - - id: rXJJV5LfAp2TxSC1yzgtfF - sortOrder: 4 + - id: 9t3YnqBzWejsrvjX8TV2M5 + sortOrder: 5 fieldKey: items label: Products type: OBJECT @@ -22922,8 +23227,8 @@ items: choices: null dynamic: false allowNull: false - - id: pNFJ13wvNLi8YHhusu5Dth - sortOrder: 5 + - id: 8HeC5FWQ2XS77Y5js6j9U8 + sortOrder: 6 fieldKey: user_properties label: User Properties type: OBJECT @@ -22939,8 +23244,8 @@ items: choices: null dynamic: false allowNull: false - - id: hgbYuKLt39mkcoCBGxaeek - sortOrder: 6 + - id: hP2tKnBcoeeqD9ScCouZPv + sortOrder: 7 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -22956,8 +23261,8 @@ items: choices: null dynamic: false allowNull: false - - id: dR8WFFi59FpQKNtAvHtwwT - sortOrder: 7 + - id: qVTvy48jv9JEhPjAKfkoq8 + sortOrder: 8 fieldKey: params label: Event Parameters type: OBJECT @@ -22976,7 +23281,7 @@ items: hidden: false defaultTrigger: type = "track" fields: - - id: 7bBsUhT8BSuHp5413uEDuf + - id: xmR6aPja31U9NnnkyywkYf sortOrder: 0 fieldKey: client_id label: Client ID @@ -22996,7 +23301,7 @@ items: choices: null dynamic: false allowNull: false - - id: hmgzQSBmsy5ad7vnpN9XwX + - id: b1prGc89bFojnzjJD8Mfuo sortOrder: 1 fieldKey: user_id label: User ID @@ -23013,8 +23318,25 @@ items: choices: null dynamic: false allowNull: false - - id: tFpnj592tGsthE1Lgm8z9F + - id: x42BBFLtsDLCMz1x3Jn6Rf sortOrder: 2 + fieldKey: timestamp_micros + label: Event Timestamp + type: STRING + description: >- + A Unix timestamp (in microseconds) for the time to associate with the + event. Events can be backdated up to 3 calendar days based on the + property's timezone. + placeholder: '' + defaultValue: + '@path': $.timestamp + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 84RQaB1P3HECxczvnJMk3p + sortOrder: 3 fieldKey: currency label: Currency type: STRING @@ -23029,8 +23351,8 @@ items: choices: null dynamic: false allowNull: false - - id: k1JRyyS49mfd55CjuM2wWg - sortOrder: 3 + - id: 37NfP8S9wfMaQmRLeFCQQZ + sortOrder: 4 fieldKey: value label: Value type: NUMBER @@ -23043,8 +23365,8 @@ items: choices: null dynamic: false allowNull: false - - id: f9pNsxmMTaLNjKEQKvFWdL - sortOrder: 4 + - id: tGPFvyQtZA7WX5eejTGVGw + sortOrder: 5 fieldKey: user_properties label: User Properties type: OBJECT @@ -23060,8 +23382,8 @@ items: choices: null dynamic: false allowNull: false - - id: qrP12tZMMZbNJHQWarufVF - sortOrder: 5 + - id: rFbRG1t95WkNr5iQuAiQL7 + sortOrder: 6 fieldKey: engagement_time_msec label: Engagement Time in Milliseconds type: NUMBER @@ -23077,8 +23399,8 @@ items: choices: null dynamic: false allowNull: false - - id: 2ubqLUpk1QDtF1NYgA5f7V - sortOrder: 6 + - id: nxCCH6g4zvQzf2djsEMq16 + sortOrder: 7 fieldKey: params label: Event Parameters type: OBJECT @@ -23345,7 +23667,7 @@ items: hidden: false defaultTrigger: null fields: - - id: tG93ni23SGyNLvogMfKfor + - id: fwzaDksBFeSZLhT2SeJZKV sortOrder: 0 fieldKey: conversion_label label: Conversion Label @@ -23361,7 +23683,7 @@ items: choices: null dynamic: false allowNull: false - - id: 2npceitqsmUwXfyAAwZ5j3 + - id: ssdy5STkxwiKkauRCTKzKm sortOrder: 1 fieldKey: email label: Email @@ -23381,7 +23703,7 @@ items: choices: null dynamic: false allowNull: false - - id: uKEaVyMy8yKrqYNqtkCW1F + - id: itxAigMVZ5F1jrg7CeSoD9 sortOrder: 2 fieldKey: transaction_id label: Order ID @@ -23399,7 +23721,7 @@ items: choices: null dynamic: false allowNull: false - - id: bhSjKCwn7iBJ2jpeY3WBPj + - id: uoeQCfmvnMegdVGu15zRZK sortOrder: 3 fieldKey: user_agent label: User Agent @@ -23418,7 +23740,7 @@ items: choices: null dynamic: false allowNull: false - - id: kJ5Ji677SvLvwHXTGUVsjH + - id: bNuJWahrcT3Td8svjjCL5 sortOrder: 4 fieldKey: conversion_time label: Conversion Time @@ -23432,7 +23754,7 @@ items: choices: null dynamic: false allowNull: false - - id: qBesWkP9wps4vSRdQSS3CT + - id: jnamHjA3hA5MnfsNb5Vu5o sortOrder: 5 fieldKey: value label: Value @@ -23446,7 +23768,7 @@ items: choices: null dynamic: false allowNull: false - - id: dKzzSxrGVZ1m8sxbRg439X + - id: aRZWUNHEbTZ5zpPxwmWKcj sortOrder: 6 fieldKey: currency_code label: Currency Code @@ -23462,7 +23784,7 @@ items: choices: null dynamic: false allowNull: false - - id: rdjgErM6PGJ2211P2wWFZc + - id: m3vGxtANLp2E1pccftjzCv sortOrder: 7 fieldKey: is_app_incrementality label: App Conversion for Incrementality Study @@ -23475,8 +23797,23 @@ items: choices: null dynamic: false allowNull: false - - id: pQxufXd7QEDKkiHCrZxdwc + - id: 4mXgdY8wqw2NchNMLyZrnJ sortOrder: 8 + fieldKey: pcc_game + label: PCC Game Flag + type: BOOLEAN + description: >- + Alpha feature offered by Google for gaming industry. When set to true, + Segment will send pcc_game = 1 to Google. + placeholder: '' + defaultValue: false + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 5fN9CDCmsYWszHou4WNuCP + sortOrder: 9 fieldKey: phone_number label: Phone Number type: STRING @@ -23497,8 +23834,8 @@ items: choices: null dynamic: false allowNull: false - - id: 6KYacjzzceMyuGkjVfzwcJ - sortOrder: 9 + - id: rTLxn7JSEkbcYEHo3cLRTh + sortOrder: 10 fieldKey: first_name label: First Name type: STRING @@ -23517,8 +23854,8 @@ items: choices: null dynamic: false allowNull: false - - id: n9N5SD1SLEc9UZ1CgXM2WN - sortOrder: 10 + - id: epMzFWmC6LSf9947WDR6qV + sortOrder: 11 fieldKey: last_name label: Last Name type: STRING @@ -23537,8 +23874,8 @@ items: choices: null dynamic: false allowNull: false - - id: eBbHv8TeRXD1aKBt96Ac17 - sortOrder: 11 + - id: 9rgKdNe4H476NF8d7M6whe + sortOrder: 12 fieldKey: street_address label: Street Address type: STRING @@ -23557,8 +23894,8 @@ items: choices: null dynamic: false allowNull: false - - id: m9jWATWLxhvhztw7z8exAA - sortOrder: 12 + - id: cYSgg9f8x2AXz6XU8CcE25 + sortOrder: 13 fieldKey: city label: City type: STRING @@ -23577,8 +23914,8 @@ items: choices: null dynamic: false allowNull: false - - id: 5ckT4H9BiE8JjZAJpa7JCF - sortOrder: 13 + - id: tQE2j75Jc55Xsa5AenLAxK + sortOrder: 14 fieldKey: region label: Region type: STRING @@ -23597,8 +23934,8 @@ items: choices: null dynamic: false allowNull: false - - id: gLwMFHZ5vtv1f7cL9VPTmt - sortOrder: 14 + - id: q75o6nXMq8KZRY1wVjLwhG + sortOrder: 15 fieldKey: post_code label: Postal Code type: STRING @@ -23617,8 +23954,8 @@ items: choices: null dynamic: false allowNull: false - - id: jUzjm36RqqE97dYzCaGhwP - sortOrder: 15 + - id: ikaHLKJKJZ15PknGwq9g54 + sortOrder: 16 fieldKey: country label: Country type: STRING @@ -41506,6 +41843,139 @@ items: required: true label: Deployment actions: + - id: 2boWRtktKhqiuK9a2bZApN + name: Update Customer Sessions + slug: updateCustomerSession + description: This updates a customer session. + platform: CLOUD + hidden: false + defaultTrigger: null + fields: + - id: 3fSNMFMMRa2jU45msmjnP1 + sortOrder: 0 + fieldKey: customerSessionId + label: Customer Session ID + type: STRING + description: The customer session integration identifier to use in Talon.One. + placeholder: '' + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 4dCB5vomvMswutab2rr9Hx + sortOrder: 1 + fieldKey: callbackDestination + label: Callback Destination URI + type: STRING + description: >- + This specifies the address of the service and its endpoint to do + callback request. + placeholder: http://mydomain.com/api/callback_here + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: k8bZfFK8AZzcxphC9dStEE + sortOrder: 2 + fieldKey: callbackAPIKey + label: Callback API Key + type: STRING + description: >- + This specifies API key and relative header. The header is specified + optionally + placeholder: X-API-Key 123456789123456789123456789123456789 + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: dpvAbUrwj3GrrZ2uvjdEqo + sortOrder: 3 + fieldKey: contentFields + label: Content Fields + type: STRING + description: >- + This specifies a list of the fields from the response you need to + receive. Comma character is separator. If omitted, all the fields will + be forwarded from the response to the callback destination. + placeholder: effects,customerProfile + defaultValue: effects + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: yjCZPJpcoGAdF7mkWPdYX + sortOrder: 4 + fieldKey: callbackCorrelationId + label: Correlation ID + type: STRING + description: >- + This specifies ID of the request that will be forwarded to the + destination URI with the callback request with the same header name. If + omitted, the X-Correlation-ID will not be in the callback request. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 3PzPLNs9EGpgdouGgRgiUq + sortOrder: 5 + fieldKey: customerSession + label: Customer Session Data + type: OBJECT + description: This contains all the data related to customer session. + placeholder: '' + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: mG3BbABmN2yAVrxu29FAeE + sortOrder: 6 + fieldKey: sessionAttributesInfo + label: Session Attributes info + type: OBJECT + description: >- + Use this field if you want to identify a session attribute with a + specific type + placeholder: '' + defaultValue: + '@arrayPath': + - $.properties.attributesInfo + - name: + '@path': $.name + type: + '@path': $.type + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: fwgZ2JkE8ZaxsrSMBRt5JR + sortOrder: 7 + fieldKey: cartItemsAttributesInfo + label: Cart Items Attributes info + type: OBJECT + description: >- + Use this field if you want to identify a cart item attribute with a + specific type + placeholder: '' + defaultValue: + '@arrayPath': + - $.properties.attributesInfo + - name: + '@path': $.name + type: + '@path': $.type + required: false + multiple: true + choices: null + dynamic: false + allowNull: false - id: 9f9ULnyoFhzXZAo2FNYNpG name: Create Audience slug: createAudience @@ -41514,7 +41984,7 @@ items: hidden: false defaultTrigger: null fields: - - id: vFLU38kyuvdC5frFvVMbjY + - id: cAQdGieL8P2HNGjhfSF42c sortOrder: 0 fieldKey: audienceId label: Segment Audience ID @@ -41526,7 +41996,7 @@ items: choices: null dynamic: false allowNull: false - - id: kSZYvdGq3iwFmTbPpqtdhm + - id: s2PkkEiUnmK5TgZa8Vmwja sortOrder: 1 fieldKey: audienceName label: Audience Name @@ -41546,7 +42016,7 @@ items: hidden: false defaultTrigger: null fields: - - id: k9JpvKceuJvd89hZ2zj9cR + - id: b7VTMAkHee1UwwSkF9da3P sortOrder: 0 fieldKey: customerProfileId label: Customer Profile ID @@ -41562,7 +42032,7 @@ items: choices: null dynamic: false allowNull: false - - id: w42QmR458sPQUia2M1SrFm + - id: oD7yWJPHCWS7qoByh3aeC7 sortOrder: 1 fieldKey: eventType label: Event Type @@ -41576,7 +42046,7 @@ items: choices: null dynamic: false allowNull: false - - id: uhh8nzGyAiTGsc7TQaHFXH + - id: w437ejSebsNf6RnoH99s8S sortOrder: 2 fieldKey: type label: Type @@ -41591,7 +42061,7 @@ items: choices: null dynamic: false allowNull: false - - id: 9kemZNTwCpZonWpxbAeS8r + - id: rbHoU1PNhPGKUF7RjJsKLb sortOrder: 3 fieldKey: attributes label: Attribute-Value pairs @@ -41601,12 +42071,31 @@ items: info](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). placeholder: '' defaultValue: - '@path': $.properties + '@path': $.properties.attributes required: false multiple: false choices: null dynamic: false allowNull: false + - id: jec8qfCnCtkuPqUSZB22vC + sortOrder: 4 + fieldKey: attributesInfo + label: Attributes info + type: OBJECT + description: Use this field if you want to identify an attribute with a specific type + placeholder: '' + defaultValue: + '@arrayPath': + - $.properties.attributesInfo + - name: + '@path': $.name + type: + '@path': $.type + required: false + multiple: true + choices: null + dynamic: false + allowNull: false - id: dFGebKtTfihwGAT1kAoayw name: Update Customer Profile slug: updateCustomerProfile @@ -41615,7 +42104,7 @@ items: hidden: false defaultTrigger: null fields: - - id: wXWZcY8s6d6HBBsmF1vUTT + - id: 4jddVccPUyu3CNgLcgZnzh sortOrder: 0 fieldKey: attributes label: Attribute-Value pairs @@ -41631,7 +42120,7 @@ items: choices: null dynamic: false allowNull: false - - id: iHwSoD9Qwfnkf3aKL2ForH + - id: vmJFJfFHNFERboqKDqm5Er sortOrder: 1 fieldKey: customerProfileId label: Customer Profile ID @@ -41645,7 +42134,7 @@ items: choices: null dynamic: false allowNull: false - - id: k4AT2M6Bf4KG81At4TiuKz + - id: nPZkstNpC6rpZ9ZhckNCLj sortOrder: 2 fieldKey: deleteAudienceIds label: List of audience ID to dissociate with the customer profile. @@ -41657,7 +42146,7 @@ items: choices: null dynamic: false allowNull: false - - id: 2gTB2vaXkRHq2FBiBLsyEz + - id: fzdyQDyPhdQb7eDFNFism9 sortOrder: 3 fieldKey: addAudienceIds label: List of audience ID to associate with the customer profile. @@ -41669,21 +42158,42 @@ items: choices: null dynamic: false allowNull: false - - id: bpXXAv2sSWY8NLehg3hmo5 + - id: pNG5dDST7LCZisbvbGnLZH sortOrder: 4 fieldKey: runRuleEngine label: Run rule engine type: BOOLEAN description: >- This runs rule engine in Talon.One upon updating customer profile. Set - to true to trigger rules. + to true to trigger rules. Setting this property to false improves + response times. For audiences changes the runRuleEngine should be true. + Default value is false. placeholder: '' - defaultValue: true + defaultValue: false required: false multiple: false choices: null dynamic: false allowNull: false + - id: bpFsZTNNjk8oGK2h8kFYQR + sortOrder: 5 + fieldKey: attributesInfo + label: Attributes with types + type: OBJECT + description: Use this field if you want to identify an attribute with a specific type + placeholder: '' + defaultValue: + '@arrayPath': + - $.traits.attributesInfo + - name: + '@path': $.name + type: + '@path': $.type + required: false + multiple: true + choices: null + dynamic: false + allowNull: false - id: hjRssUycBvLhi7QPFAvXPS name: Delete Audience slug: deleteAudience @@ -41692,7 +42202,7 @@ items: hidden: false defaultTrigger: null fields: - - id: 75RmXT97iqF6wEQp1Miaio + - id: 3SwFkJc2pV5xxFiJgiJMik sortOrder: 0 fieldKey: audienceId label: Segment Audience ID @@ -41712,7 +42222,7 @@ items: hidden: false defaultTrigger: null fields: - - id: 8ok4sfWaaqia7KSpKWUcQa + - id: 5ypo8XqRLsLq2j8JgkWUkv sortOrder: 0 fieldKey: data label: Data item to change customer profile attributes @@ -41726,7 +42236,7 @@ items: choices: null dynamic: false allowNull: false - - id: obDk87Piw4nMuMQorUnhgp + - id: uxJj4CCfkpKyq52D96nygm sortOrder: 1 fieldKey: mutualAttributes label: Mutual Attribute-Value pairs @@ -41742,6 +42252,137 @@ items: choices: null dynamic: false allowNull: false + - id: qSTyeH7b71N9vFYzsfZFmo + sortOrder: 2 + fieldKey: attributesInfo + label: Attributes with types + type: OBJECT + description: Use this field if you want to identify an attribute with a specific type + placeholder: '' + defaultValue: + '@arrayPath': + - $.traits.attributesInfo + - name: + '@path': $.name + type: + '@path': $.type + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: ovrUz47WP9wvxzprj2sxxC + name: Update Customer Profile V2 + slug: updateCustomerProfileV2 + description: >- + You do not have to create attributes or audiences before using this + endpoint. + platform: CLOUD + hidden: false + defaultTrigger: null + fields: + - id: p1eLi9m5QwNfPWYz3bHtCx + sortOrder: 0 + fieldKey: customerProfileId + label: Customer Profile ID + type: STRING + description: The customer profile integration identifier to use in Talon.One. + placeholder: '' + defaultValue: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: kAstesuRUHFJANEebT6BVT + sortOrder: 1 + fieldKey: audiencesToAdd + label: The audiences for the customer to join. + type: OBJECT + description: Audience name and integration ID + placeholder: '' + defaultValue: + '@arrayPath': + - $.properties.audiencesToAdd + - name: + '@path': $.name + integrationId: + '@path': $.integrationId + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: tWRWwm3F9SZaPBUTb49Fch + sortOrder: 2 + fieldKey: audiencesToDelete + label: The audiences for the customer to leave. + type: OBJECT + description: Audience name and integration ID + placeholder: '' + defaultValue: + '@arrayPath': + - $.properties.audiencesToDelete + - name: + '@path': $.name + integrationId: + '@path': $.integrationId + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: dvNvAdvZVDbjSEd8SbGgRQ + sortOrder: 3 + fieldKey: runRuleEngine + label: Run rule engine + type: BOOLEAN + description: >- + This runs rule engine in Talon.One upon updating customer profile. Set + to true to trigger rules. + placeholder: '' + defaultValue: true + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: nN6okVis3NoVED7jtYXtLP + sortOrder: 4 + fieldKey: attributes + label: Attribute-Value pairs + type: OBJECT + description: >- + Extra attributes associated with the customer profile. [See more + info](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). + placeholder: '' + defaultValue: + '@path': $.traits + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: mAFVwitSyJKWP3FUERdPPK + sortOrder: 5 + fieldKey: attributesInfo + label: Attributes info + type: OBJECT + description: Use this field if you want to identify an attribute with a specific type + placeholder: '' + defaultValue: + '@arrayPath': + - $.properties.attributesInfo + - name: + '@path': $.name + type: + '@path': $.type + required: false + multiple: true + choices: null + dynamic: false + allowNull: false - id: uZ8mzsLo5KFgwoSQsDXnKK name: Update Audience Name slug: updateAudience @@ -41750,7 +42391,7 @@ items: hidden: false defaultTrigger: null fields: - - id: rNQwCVQhXHwnTaQ2B9KNw3 + - id: bR93vSCXBWiwuJKxk2qQty sortOrder: 0 fieldKey: audienceId label: Segment Audience ID @@ -41762,7 +42403,7 @@ items: choices: null dynamic: false allowNull: false - - id: nDpNEr3EVvFciyjQQZoJMX + - id: xdMMWn3ZUnhqENMa6uHkEq sortOrder: 1 fieldKey: audienceName label: Audience Name @@ -41782,7 +42423,7 @@ items: hidden: false defaultTrigger: null fields: - - id: sWnFPRmPBniKsZTRoHb3k8 + - id: c1z4SedapRbuMUkbXUMBwb sortOrder: 0 fieldKey: data label: Data item to change customer profile audiences diff --git a/src/_data/catalog/overrides-list.yml b/src/_data/catalog/overrides-list.yml deleted file mode 100644 index 2f0ae9c444..0000000000 --- a/src/_data/catalog/overrides-list.yml +++ /dev/null @@ -1,8 +0,0 @@ -items: - - hubspot - - iterable - - google-ads-gtag - - klaviyo - - friendbuy - - google-ads-classic - diff --git a/src/_data/catalog/overrides.yml b/src/_data/catalog/overrides.yml index 71b66bb6f9..a30f36383f 100644 --- a/src/_data/catalog/overrides.yml +++ b/src/_data/catalog/overrides.yml @@ -1,5 +1,4 @@ -# This file is manually generated. When you add or remove an item, add or remove -# it from the `overrides-list.yml` too. +# This file is manually generated. items: - slug: moengage id: 55b280290a20f4e22f0fb3d6 diff --git a/src/_data/catalog/regional-supported.yml b/src/_data/catalog/regional-supported.yml index 98388b23d9..6bde01ffb1 100644 --- a/src/_data/catalog/regional-supported.yml +++ b/src/_data/catalog/regional-supported.yml @@ -1,5 +1,5 @@ # AUTOGENERATED LIST OF CONNECTIONS THAT SUPPORT REGIONAL -# Last updated 2022-07-21 +# Last updated 2022-07-26 warehouses: - id: WcjBCzUGff display_name: Azure SQL Data Warehouse @@ -274,6 +274,14 @@ sources: - us endpoints: - us + - id: 94LHXFps4k + display_name: Gladly + slug: gladly + url: connections/sources/catalog/cloud-apps/gladly + regions: + - us + endpoints: + - us - id: yBvi77aEwr display_name: Go slug: go diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index 6123e5fb3d..e682760c84 100644 --- a/src/_data/catalog/source_categories.yml +++ b/src/_data/catalog/source_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# source cateogries last updated 2022-07-21 +# source cateogries last updated 2022-07-26 items: - display_name: A/B Testing slug: a-b-testing @@ -19,6 +19,8 @@ items: slug: enrichment - display_name: Feature Flagging slug: feature-flagging + - display_name: Help Desk + slug: help-desk - display_name: Helpdesk slug: helpdesk - display_name: Learning Management System diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index 56ad8c61f1..dbedfea9d3 100644 --- a/src/_data/catalog/sources.yml +++ b/src/_data/catalog/sources.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# sources last updated 2022-07-21 +# sources last updated 2022-07-26 items: - id: 8HWbgPTt3k display_name: .NET @@ -458,6 +458,29 @@ items: url: https://cdn.filepicker.io/api/file/ZkStZnT0qg7CyY2wiVgi categories: - Referrals + - id: 94LHXFps4k + display_name: Gladly + isCloudEventSource: true + slug: gladly + url: connections/sources/catalog/cloud-apps/gladly + hidden: false + regions: + - us + endpoints: + - us + source_type: cloud-app + description: >- + Gladly helps commerce and retail brands track customer service requests by + sending customer, conversation, agent and topic data each time a Gladly + conversation is either opened or closed. Once configured, Gladly data is + automatically sent to Segment every time a conversation is opened or + closed in real time. + logo: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/6c48e7ac-18d4-4974-aed3-95afb0624caf.svg + categories: + - Help Desk + - Customer Success - id: yBvi77aEwr display_name: Go isCloudEventSource: false diff --git a/src/_includes/content/destination-dossier.html b/src/_includes/content/destination-dossier.html index d35c02dd0a..b9cf345554 100644 --- a/src/_includes/content/destination-dossier.html +++ b/src/_includes/content/destination-dossier.html @@ -52,7 +52,7 @@
Destination Info
{% if destinationInfo.status == "PUBLIC_BETA" %}
  • This destination is in Beta
    • {% endif %} {% if components.size > 0%} - +{% unless page.hide-components %}
    Components
    - +{% endunless %} +{% unless page.hide-cmodes %}
    Connection Modes
    @@ -90,6 +91,7 @@
    Connection Modes
    +{% endunless %} {% endif %} {% endif %} \ No newline at end of file diff --git a/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md b/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md index f1edb3a48d..d569670f2b 100644 --- a/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md +++ b/src/connections/destinations/catalog/actions-facebook-conversions-api/index.md @@ -152,7 +152,7 @@ Segment creates a SHA-256 hash of the following fields before sending to Faceboo - Email - Phone - Gender -- Data of Birth +- Date of Birth - Last Name - First Name - City diff --git a/src/connections/destinations/catalog/actions-fullstory-cloud/index.md b/src/connections/destinations/catalog/actions-fullstory-cloud/index.md new file mode 100644 index 0000000000..b961b1c86f --- /dev/null +++ b/src/connections/destinations/catalog/actions-fullstory-cloud/index.md @@ -0,0 +1,39 @@ +--- +title: FullStory Cloud Mode (Actions) +hide-boilerplate: true +hide-dossier: false +id: 62d9aa9899b06480f83e8a66 +--- +{% include content/plan-grid.md name="actions" %} + +[FullStory](https://www.fullstory.com/){:target="_blank"} lets product and support teams easily understand everything about the customer experience. The Segment integration for FullStory helps accurately identify your customers within FullStory. + +FullStory’s cloud mode Segment integration allows you send user and event data to FullStory from your servers and Cloud Apps so that you apply it to your analysis throughout FullStory. For example, you could build a funnel to analyze drop-off of users who engaged with a certain marketing campaign. + +If you want to use FullStory’s tagless autocapture, use the [FullStory Device Mode (Actions) web destination](/docs/connections/destinations/catalog/actions-fullstory/). However, if you want to capture custom user properties and events from other [server-side sources](/docs/connections/sources/#server) or [cloud apps](/docs/connections/sources/#cloud-apps), such as recurring subscription purchases, use this cloud mode destination. + +### Overview + +The FullStory cloud mode destination sends information about your users and related events to FullStory. It uses [FullStory’s REST APIs](https://developer.fullstory.com){:target="_blank"}. + +- **Identify User:** Converts Segment [Identify](/docs/connections/spec/identify/) calls to [FullStory Set User Properties API calls](https://developer.fullstory.com/set-user-properties){:target="_blank"}. Use this to set custom attributes which can be used to search and segment within FullStory. +- **Track Custom Event**: Converts Segment [Track](/docs/connections/spec/track/) calls to [FullStory custom event API calls](https://developer.fullstory.com/server-events){:target="_blank"}. Use this to capture more context about your user’s experience on your site or to capture user’s actions in other applications to build a more complete understanding of your user’s overall experience. + +### Benefits of FullStory Cloud Mode (Actions) + +- Works with FullStory’s latest data capture APIs +- Ability to send custom events from new sources +- Use [Destination Filters](/docs/connections/destinations/destination-filters/) to selectively send certain events or user properties to FullStory + +### Getting Started + +1. You need a FullStory API Key to use the FullStory cloud mode destination. Refer to [this article](https://help.fullstory.com/hc/en-us/articles/360052021773-Managing-API-Keys){:target="_blank"} to learn how to generate a new API Key within FullStory. +2. From the Segment web app, click **Catalog**, then click **Destinations**. +3. Find “FullStory Cloud Mode (Actions)” in the Destinations list and click it. +4. Click **Configure FullStory Cloud Mode (Actions)**. +5. Select an existing Source to connect to FullStory Cloud Mode (Actions). +6. Provide a Destination Name and select **Fill in settings manually.** Ensure the “Actions” destinations framework is selected and click **Save.** +7. On the **Basic Settings** page, enter your FullStory API Key from step 1 and click **Save Changes**. +8. On the **Mappings** tab, you can view default mappings as well as add, modify, or disable mappings. + +{% include components/actions-fields.html %} \ No newline at end of file diff --git a/src/connections/destinations/catalog/actions-fullstory/index.md b/src/connections/destinations/catalog/actions-fullstory/index.md index 2048c14374..1ca82e6108 100644 --- a/src/connections/destinations/catalog/actions-fullstory/index.md +++ b/src/connections/destinations/catalog/actions-fullstory/index.md @@ -1,5 +1,5 @@ --- -title: FullStory (Actions) +title: FullStory Device Mode (Actions) hide-boilerplate: true hide-dossier: false id: 6141153ee7500f15d3838703 @@ -13,19 +13,19 @@ versions: [FullStory](https://www.fullstory.com/){:target="_blank"} lets product and support teams easily understand everything about the customer experience. The Segment integration for FullStory helps accurately identify your customers within the FullStory dashboard. -## Benefits of FullStory (Actions) vs FullStory Classic +## Benefits of FullStory Device Mode (Actions) vs FullStory Classic - Greater control over the page properties you send. - Send events specific to individual pages. -- Select by name the specific to send. +- Select by name the specific user properties or custom events to send. ## Getting started 1. From the Segment web app, click **Catalog**, then click **Destinations**. 2. Find the Destinations Actions item in the left navigation, and click it. -3. Select FullStory (Actions), then click **Configure FullStory (Actions)**. -4. Select an existing Source to connect to FullStory (Actions). +3. Select FullStory Device Mode (Actions), then click **Configure FullStory Device Mode (Actions)**. +4. Select an existing Source to connect to FullStory Device Mode (Actions). 5. Click Customized Setup to start from a blank mapping. {% include components/actions-fields.html %} @@ -35,6 +35,6 @@ versions: -Follow the table below to map your existing FullStory destination configuration to FullStory (Actions). +Follow the table below to map your existing FullStory destination configuration to FullStory Device Mode (Actions). {% include components/actions-map-table.html name="fullstory" %} \ No newline at end of file diff --git a/src/connections/destinations/catalog/factorsai/index.md b/src/connections/destinations/catalog/factorsai/index.md index 69fdaa19ed..dcc89c0b35 100644 --- a/src/connections/destinations/catalog/factorsai/index.md +++ b/src/connections/destinations/catalog/factorsai/index.md @@ -2,6 +2,8 @@ title: FactorsAI Destination rewrite: true id: 5d1060c40d357d000181e92c +hide-cmodes: true +hide-components: true --- [FactorsAI](https://www.factors.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides advanced and intuitive analytics for marketers and product managers, to help drive growth. With FactorsAI you get immediate insights to optimize marketing campaigns, improve conversions and understand user behaviours that drive feature adoption and retention. @@ -11,8 +13,6 @@ This destination is maintained by FactorsAI. For any issues with the destination ## Getting Started -{% include content/connection-modes.md %} - 1. From the Segment web app, click **Catalog**. 2. Search for "FactorsAI" in the Catalog, select it, and choose which of your sources to connect the destination to. 3. Enter the "API Key" into your Segment Settings UI which you can find from your [FactorsAI dashboard](https://app.factors.ai/#/settings/segment). diff --git a/src/connections/sources/catalog/cloud-apps/gladly/index.md b/src/connections/sources/catalog/cloud-apps/gladly/index.md new file mode 100644 index 0000000000..6a4c713608 --- /dev/null +++ b/src/connections/sources/catalog/cloud-apps/gladly/index.md @@ -0,0 +1,58 @@ +--- +title: Gladly Source +id: 94LHXFps4k +--- + +[Gladly](https://www.gladly.com/){:target="_blank"} is the only platform purposely built to help the world's fastest growing brands deliver radically personal customer service. Designed around people and not tickets, Gladly's all-in-one platform features every channel - from voice to SMS - natively built into a single UI, allowing agents to communicate seamlessly across all channels. Rated the #1 easiest-to-use customer service platform, Gladly is empowering brands of all sizes to deliver and scale exceptional customer and agent experiences and build brand loyalty. + +The Gladly Source is an [Event Cloud Source](/docs/sources#event-cloud-sources) that can be used to track when your customers open or closed a conversation with an agent. Not only can you export data into your Segment warehouse, but you can also send the exported data into your other enabled Segment Destinations. + +This source is maintained by Gladly. For any issues with the source, [contact the Gladly Support team](mailto:support@gladly.com). + +## Getting Started + +1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**. +2. Search for "Gladly" in the Sources Catalog, select click Gladly, and click **Add Source**. +3. On the next screen, give the Source a nickname configure any other settings. +5. Click **Add Source** to save your settings. +6. Copy the `Write key` from the Segment UI +7. Log into Gladly +8. Go to Settings -> App Developer Tools -> Apps +9. Click **Add App** and select **Segment** +10. Name your app +11. Paste your `Write Key` into the **Segment Private Key** field +12. Save your app + +## Events + +The table below lists events that Gladly sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. Gladly includes the `userId` if available. + +| Event | Description | +| ------------------- | -------------------------------------------------------- | +| Conversation Opened | A conversation was opened and assigned to an agent | +| Conversation Closed | A conversation was closed and required no further action | + +## Event properties + +The table below list the properties included in the events listed above. + +| Property Name | Description | +| -------------- | ------------------------------------------------------------------- | +| event | Conversation Status | +| userId | Customer's Gladly ID | +| customerName | Customer's Name | +| email | Customer's Email Address | +| phone | Customer's Phone Number | +| conversationId | Conversation's ID | +| status | Conversation's Status | +| topics | List of Topic IDs for a Conversation (only for Conversation Closed) | +| agentId | Assigned Agent's ID | +| agentName | Assigned Agent's Name | +| timestamp | Conversation Opened/Conversation Closed time | +## Add Destinations + +Now that your Source is set up, you can connect it with Destinations. + +Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](https://segment.com/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting. + +If there are any issues with how the events are arriving to Segment, [contact the Gladly support team](mailto:support@gladly.com). diff --git a/src/connections/sources/catalog/libraries/mobile/react-native/migration.md b/src/connections/sources/catalog/libraries/mobile/react-native/migration.md index a67bb2f8d3..6d2cfcc25f 100644 --- a/src/connections/sources/catalog/libraries/mobile/react-native/migration.md +++ b/src/connections/sources/catalog/libraries/mobile/react-native/migration.md @@ -5,6 +5,9 @@ strat: react-native If you're using `analytics-react-native 1.5.1` or older, follow these steps to upgrade to `analytics-react-native 2.0`. You can continue to use your React Native source write key for the upgrade to view historical events. Additionally, with React Native 2.0, you don't need to leverage bundled SDK packages, but can use [this list of supported destinations](/docs/connections/sources/catalog/libraries/mobile/react-native#supported-destinations). +> info "" +> Analytics React Native 2.0 implements a new storage framework, [@segment/sovran-react-native](https://github.com/segmentio/sovran-react-native){:target="_blank"}, which makes it impossible to determine if your app has been previously installed. Migrating to Analytics React Native 2.0 results in new `Application Installed` events for your existing users. To filter these events out you can either create an Enrichment Plugin to drop events or filter them using your Segment workspace. + To upgrade to React Native 2.0: 1. Update the existing package: diff --git a/src/connections/spec/video.md b/src/connections/spec/video.md index 6a3fdb8edc..7045e39c46 100644 --- a/src/connections/spec/video.md +++ b/src/connections/spec/video.md @@ -2,11 +2,11 @@ title: Video Spec --- -Segment's video spec helps you define how a customer is engaging with your video and ad content. The below documentation covers the naming syntax and conventions for how you should send events when tracking video analytics. +Segment's video spec helps you define how customers engage with your video and ad content. This document covers the naming syntax and conventions for how you should send events when tracking video analytics. -*Note:* not all destinations support video tracking and you should always check with the individual destination documentation to confirm. +**Note:** not all destinations support video tracking, and you should always check with the individual destination documentation to confirm. -## Getting Started +## Getting started Before you start implementing the Segment video spec, you should understand the overall structure and classification of events. The video spec will be organized into **three** distinct event categories: @@ -16,105 +16,40 @@ Before you start implementing the Segment video spec, you should understand the ## Playback -You can think of playback events being related to the actual _playback_ of the video content. This means that these events are meant to track information about the video player (ie. pause, resume, play). Thus, you can think of playback events to be at the session level. For example, when a customer presses play on your video, you would start by sending a [Video Playback Started](#video-playback-started) event with a unique `session_id`. In particular, this event should fire after the last user action required for playback to begin. +You can think of playback events being related to the actual _playback_ of the video content. This means that these events are meant to track information about the video player (such as pause, resume, or play). Thus, you can think of playback events to be at the session level. For example, when a customer presses play on your video, you would start by sending a [Video Playback Started](#video-playback-started) event with a unique `session_id`. In particular, this event should fire after the last user action required for playback to begin. Then, for the duration of that user's session with that specific video player, all -subsequent events generated from this session/playback should be tied with the same aforementioned `session_id`. So if you had a web page that had two video players, you would have two separate sessions and `session_id`s while contrastingly if you only had one video player on the page but the playback played two video contents in a row, you would only have one session but two contents tied to it. - -### Playback Event Object - -All playback events share the same event properties that describe information about the current state of the player. Below is a full list of the supported properties of this object. - -```js -{ - session_id: String - content_asset_id | content_asset_ids: String | Array - content_pod_id | content_pod_ids: String | Array - ad_asset_id: String | Array - ad_pod_id: String | Array - ad_type: Enum {'pre-roll', 'mid-roll', 'post-roll'} - position: Integer - total_length: Integer - bitrate: Integer - framerate: Float - video_player: String - sound: Integer - full_screen: Boolean - ad_enabled: Boolean - quality: String - method: String - livestream: Boolean -} -``` - -#### Session Id: `String` - -The unique ID of the overall session used to tie all events generated from a specific playback. This value should be same across all playback, content, and ad events if they are from the same playback session - -#### Content Asset Id | Content Asset Ids: `String | Array[string]` - -The Content Asset Id(s) of the video/videos playing or about to be played in the video player. **For [Video Playback Started](#video-playback-started) events only**, you should send the plural form with an Array of unique asset IDs. For all other playback events, you should send the singular form with the ID of the current content asset playing at the time of the event. - -#### Content Pod Id | Content Pod Ids: `String | Array[string]` - -The Content Pod Id(s) of the video/videos playing or about to be played in the video player. **For [Video Playback Started](#video-playback-started) events only**, you should send the plural form with an Array of unique pod IDs. For all other playback events, you should send the singular form with the ID of the current content pod playing at the time of the event. - -#### Ad Asset ID: `String | Array[string]` - -The Ad Asset Id(s) of the ad/ads playing or about to be played in the video player. **For [Video Playback Started](#video-playback-started) events only**, you should send an Array of unique ad asset IDs. For all other playback events, you should send a string with the ID of the current ad asset playing at the time of the event. - -#### Ad Pod ID: `String | Array[string]` - -The Ad Pod Id(s) of the ad/ads playing or about to be played in the video player. **For [Video Playback Started](#video-playback-started) events only**, you should send an Array of unique ad pod IDs. For all other playback events, you should send a string with the ID of the current ad pod playing at the time of the event. - -#### Ad Type: `Enum {'pre-roll' | 'mid-roll' | 'post-roll'}` - -The type of ad playing at the time of the event. Values can include 'pre-roll', 'mid-roll', and 'post-roll'. - -#### Position: `Integer` - -The current index position **in seconds** of the playhead, including the duration of any ads seen (if available). If the playback is a livestream, check the documentation for relevant destinations for details on how to correctly pass the playhead position. - -#### Seek Position: `Integer` - -The index position **in seconds** of the playhead where the user is seeking to. Only needed on Video Playback Seek Started events, since on Video Playback Seek Completed, the `seek_position` should be the `position`. - -#### Total Length: `Integer` - -The total duration of the playback in seconds. This should include the duration of all your content and ad included in this playback session. For livestream playback, send `null`. - -#### Bitrate: `Integer` -The current `kbps`. - -#### Framerate: `Float` -The average `fps`. - -#### Video Player: `String` -The name of the video player (for example `youtube`, `vimeo`). - -#### Sound `Integer` -The sound level of the playback represented in a 0 to 100 scale where 0 is muted and 100 is full volume. - -#### Full Screen: `Boolean` -`true` if playback is currently in full screen mode and `false` otherwise. - -#### Ad Enabled: `Boolean` -`false` if the user has adblock or any other ad blockers, `true` otherwise if they can view your video ads. - -#### Quality: `String` -The quality of the video, ie. 'highres', 'hd1080', '480p'. - -#### Method: `String` -**For Video Playback Interrupted events only**, you can send this property denoting how the playback was interrupted (ie. 'browser redirect', 'device lock', 'call'). - -#### Livestream: `Boolean` -If the playback will be a livetream, send `true`, otherwise `false`. - -### Playback Events +subsequent events generated from this session/playback should be tied with the same aforementioned `session_id`. So if you had a web page that had two video players, you would have two separate sessions and `session_ids` while contrastingly if you only had one video player on the page but the playback played two video contents in a row, you would only have one session but two contents tied to it. + +### Playback event object + +All playback events share the same event properties that describe information about the current state of the player. Below is a table of the supported properties of this object. + +| Property | Type | Description | +| ---------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `session_id` | String | The unique ID of the overall session used to tie all events generated from a specific playback. This value should be the same across all playback, content, and ad events if they are from the same playback session. | +| `content_asset_id`, `content_asset_ids` | String, Array[string] | The Content Asset Id(s) of the video/videos playing or about to be played in the video player. **For [Video Playback Started](#video-playback-started) events only**, you should send the plural form with an Array of unique asset IDs. For all other playback events, you should send the singular form with the ID of the current content asset playing at the time of the event. | +| `content_pod_id`, `content_pod_ids` | String, Array[string] | The Content Pod Id(s) of the video/videos playing or about to be played in the video player. **For [Video Playback Started](#video-playback-started) events only**, you should send the plural form with an Array of unique pod IDs. For all other playback events, you should send the singular form with the ID of the current content pod playing at the time of the event. | +| `ad_asset_id` | String, Array[string] | The Ad Asset Id(s) of the ad/ads playing or about to be played in the video player. **For [Video Playback Started](#video-playback-started) events only**, you should send an Array of unique ad asset IDs. For all other playback events, you should send a string with the ID of the current ad asset playing at the time of the event. | +| `ad_pod_id` | String, Array[string] | The Ad Pod Id(s) of the ad/ads playing or about to be played in the video player. **For [Video Playback Started](#video-playback-started) events only**, you should send an Array of unique ad pod IDs. For all other playback events, you should send a string with the ID of the current ad pod playing at the time of the event. | +| `ad_type` | Enum {`pre-roll`, `mid-roll`, `post-roll`} | The type of ad playing at the time of the event. Values can include `pre-roll`, `mid-roll`, and `post-roll`. | +| `position` | Integer | The current index position **in seconds** of the playhead, including the duration of any ads seen (if available). If the playback is a livestream, check the documentation for relevant destinations for details on how to correctly pass the playhead position. | +| `total_length`| Integer | The total duration of the playback in seconds. This should include the duration of all your content and ad included in this playback session. For livestream playback, send `null`. | +| `bitrate` | Integer | The current `kbps`. | +| `framerate` | Float | The average `fps`. | +| `video_player`| String | The name of the video player (for example, `youtube` or `vimeo`). | +| `sound` | Integer | The sound level of the playback represented in a 0 to 100 scale where 0 is muted and 100 is full volume. | +| `full_screen` | Boolean | `true` if playback is currently in full screen mode and `false` otherwise. | +| `ad_enabled` | Boolean | `false` if the user has adblock or any other ad blockers, otherwise `true` if they can view your video ads. | +| `quality` | String | The quality of the video, for example, `highres`, `hd1080`, or `480p`. | +| `method` | String | **For Video Playback Interrupted events only**, you can send this property denoting how the playback was interrupted (such as `browser redirect`, `device lock`, or `call`). | +| `livestream` | Boolean | If the playback will be a livetream, send `true`, otherwise `false`. | + +### Playback events Below is the full list of Video Playback Events. -#### Video Playback Started -When a user presses Play; after the last user action required for playback to begin (eg, after user login/authentication). +#### Video playback started +When a user presses Play; after the last user action required for playback to begin (for example, after user login/authentication). {% comment %} api-example '{ "action": "track", "event": "Video Playback Started", @@ -165,7 +100,7 @@ When a user presses Play; after the last user action required for playback to be } ``` -#### Video Playback Paused +#### Video playback paused When a user presses Pause. {% comment %} api-example '{ "action": "track", @@ -211,8 +146,8 @@ When a user presses Pause. } ``` -#### Video Playback Interrupted -When the playback stops unintentionally (ie. network loss, browser close/redirect, app crash). With this event you can pass `method` as a property to denote the cause of the interruption. +#### Video playback interrupted +When the playback stops unintentionally (such as from network loss, browser close/redirect, or app crash). With this event you can pass `method` as a property to denote the cause of the interruption. {% comment %} api-example '{ "action": "track", @@ -260,7 +195,7 @@ When the playback stops unintentionally (ie. network loss, browser close/redirec } ``` -#### Video Playback Buffer Started +#### Video playback buffer started When playback starts buffering content or an ad. {% comment %} api-example '{ "action": "track", @@ -306,7 +241,7 @@ When playback starts buffering content or an ad. } ``` -#### Video Playback Buffer Completed +#### Video playback buffer completed When playback finishes buffering content or an ad. {% comment %} api-example '{ "action": "track", @@ -352,7 +287,7 @@ When playback finishes buffering content or an ad. } ``` -#### Video Playback Seek Started +#### Video playback seek started When a user manually seeks a certain position of the content or ad in the playback. Pass in the `seek_position` to denote where the user is seeking to, and pass in the `position` property to denote where the user is seeking from. {% comment %} api-example '{ "action": "track", @@ -400,7 +335,7 @@ When a user manually seeks a certain position of the content or ad in the playba } ``` -#### Video Playback Seek Completed +#### Video playback seek completed After a user manually seeks to a certain position of the content or ad in the playback. Pass in the `position` property to denote where the user desires to begin the playback from. {% comment %} api-example '{ "action": "track", @@ -446,7 +381,7 @@ After a user manually seeks to a certain position of the content or ad in the pl } ``` -#### Video Playback Resumed +#### Video playback resumed When playback is resumed, by the user, after being paused. {% comment %} api-example '{ "action": "track", @@ -492,7 +427,7 @@ When playback is resumed, by the user, after being paused. } ``` -#### Video Playback Completed +#### Video playback completed When playback is complete and only when the session is finished. {% comment %} api-example '{ "action": "track", @@ -538,7 +473,7 @@ When playback is complete and only when the session is finished. } ``` -#### Video Playback Exited +#### Video playback exited When user navigates away from a playback/stream. {% comment %} api-example '{ "action": "track", @@ -592,95 +527,36 @@ Underneath the playback level, we now have the **pod** level. A pod can be seen Consider, for example, a playback session that might have some content and one mid-roll advertisement. This would mean that you would have two _content_ pods (since the mid-roll ad split the content playback into two sections) while you might have one ad pod for the mid-roll ad. In this instance, you'd start and complete the first pod of content; you'd start and complete the ad; you'd start and complete the second pod of content. All of this would happen within one playback start. -### Content Event Object -All content events share the same event properties that describe information about the current video content the user is interacting with. Below is a full list of the supported properties of this object. - -```js -{ - session_id: String - asset_id: String - pod_id: String - title: String - description: String - keywords: Array[string] - season: String - episode: String - genre: String - program: String - publisher: String - position: Integer - total_length: Integer - channel: String - full_episode: Boolean - livestream: Boolean - airdate: ISO 8601 Date String - position: Integer - total_length: Integer - bitrate: Integer - framerate: Float -} -``` - -#### Session Id: `String` -The unique ID of the overall session used to tie all events generated from a specific playback. This value should be same across all playback, content, and ad events if they are from the same playback session. - -#### Asset Id: `String` -The unique ID of the content asset. - -#### Pod Id: `String` -The unique ID of the content pod. - -#### Title: `String` -The title of the video content. - -#### Description: `String` -Short description of the video content. - -#### Keywords: `Array[string]` -An array of arbitrary keywords or tags that describe or categorize the video content. - -#### Season: `String` -The season number if applicable. - -#### Episode: `String` -The episode number if applicable. - -#### Genre: `String` -The genre of the content, ie. 'comedy', 'action'. - -#### Program: `String` -The name of the program, show, etc. of the content if applicable. - -#### Publisher: `String` -The content creator, author, producer, or publisher. - -#### Channel: `String` -The channel in which the video content is playing, ie. 'espn', 'my blog'. - -#### Full Episode: `Boolean` -`true` if content is a full episode and `false` otherwise. - -#### Airdate: `ISO 8601 Date String` -An [ISO 8601 Date String](https://en.wikipedia.org/wiki/ISO_8601) representing the original air date or published date. - -#### Position: `Integer` -The current index position **in seconds** of the playhead into the content/asset. This position must exclude the duration of any ads played. - -If the playback is a livestream, check the documentation for relevant destinations for details on how to correctly pass the playhead position. - -#### Total Length: `Integer` -The total duration of the content/asset in seconds. This should exclude the duration of any ads included in the playback of this asset. For livestream playback, send `null`. - -#### Bitrate: `Integer` -The current `kbps`. - -#### Framerate: `Float` -The average `fps`. - -### Content Events +### Content event object +All content events share the same event properties that describe information about the current video content the user is interacting with. Below is a table of the supported properties of this object. + +| Property | Type | Description | +| ---------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `session_id` | String | The unique ID of the overall session used to tie all events generated from a specific playback. This value should be same across all playback, content, and ad events if they are from the same playback session. | +| `asset_id` | String | The unique ID of the content asset. | +| `pod_id` | String | The unique ID of the content pod. | +| `title` | String | The title of the video content. | +| `description` | String | Short description of the video content. | +| `keywords` | Array[string] | An array of arbitrary keywords or tags that describe or categorize the video content. | +| `season` | String | The season number if applicable. | +| `episode` | String | The episode number if applicable. | +| `genre` | String | The genre of the content. For example,`comedy` or `action`. | +| `program` | String | The name of the content program or show if applicable. | +| `publisher` | String | The content creator, author, producer, or publisher. | +| `position` | Integer | The current index position **in seconds** of the playhead into the content/asset. This position must exclude the duration of any ads played. If the playback is a livestream, check the documentation for relevant destinations for details on how to correctly pass the playhead position. | +| `total_length` | Integer | The total duration of the content/asset in seconds. This should exclude the duration of any ads included in the playback of this asset. For livestream playback, send `null`. | +| `channel` | String | The channel in which the video content is playing, such as `espn` or `my blog`. | +| `full_episode` | Boolean | `true` if content is a full episode and `false` otherwise. | +| `livestream` | Boolean | If the playback is a livestream, check the documentation for relevant destinations for details on how to correctly pass the playhead position. | +| `airdate` | ISO 8601 Date String | An [ISO 8601 Date String](https://en.wikipedia.org/wiki/ISO_8601){:target="_blank"} representing the original air date or published date. | +| `bitrate` | Integer | The current `kbps`. | +| `framerate` | Float | The average `fps`. | + + +### Content events Below is the full list of Video Content Events. -#### Video Content Started +#### Video content started When a video content segment starts playing within a playback. {% comment %} api-example '{ "action": "track", @@ -726,7 +602,7 @@ When a video content segment starts playing within a playback. } ``` -#### Video Content Playing +#### Video content playing Heartbeats that you can fire every n seconds to track how far into the content the user is currently viewing as indicated by the `position`. {% comment %} api-example '{ "action": "track", @@ -772,7 +648,7 @@ Heartbeats that you can fire every n seconds to track how far into the content t } ``` -#### Video Content Completed +#### Video content completed When a video content segment completes playing within a playback. That is, `position` and `total_length` are equal. {% comment %} api-example '{ "action": "track", @@ -827,69 +703,31 @@ Just like Content events, Ad Events also live underneath the playback level and - ad pod 2: plays the one mid-roll ad - ad pod 3: plays the one post-roll ad -### Ad Event Object -All ad events share the same event properties that describe information about the current ad content the user is interacting with. Below is a full list of the supported properties of this object. - -```js - session_id: String - asset_id: String - pod_id: String - pod_position: Integer - pod_length: Integer - type: Enum {'pre-roll', 'mid-roll', 'post-roll'} - title: String, - publisher: String, - position: Integer, - total_length: Integer, - load_type: Enum {'linear' | 'dynamic'} - content: Object[ContentEventObject] - quartile: Integer -``` - -#### Session Id: `String` -The unique ID of the overall session used to tie all events generated from a specific playback. This value should be same across all playback, content, and ad events if they are from the same playback session. - -#### Asset Id: `String` -The unique ID of the ad asset. - -#### Pod Id: `String` -The unique ID of the ad pod. - -#### Pod Position: `Integer` -The position of the ad asset relative to other assets in the same pod. - -#### Pod Length: `Integer` -The number of ad assets the current ad pod contains. - -#### Title: `String` -The title of the video ad. - -#### Type: `Enum {'pre-roll' | 'mid-roll' | 'post-roll'}` -The ad type. You can send either 'pre-roll', 'mid-roll', or 'post-roll - -#### Publisher: `String` -The ad creator, author, producer, or publisher. - -#### Load Type: `Enum {'linear' | 'dynamic'}` -`dynamic` if ads are loaded dynamically and `linear` if ads are same for all users. - -#### Position: `Integer` -The current index position in seconds of the playhead with respect to the length of the ad. - -#### Total Length: `Integer` -The total duration of the current ad asset in seconds. - -#### Content: `Object[ContentEventObject]` -For video destinations that require content metadata to be sent with ad events, you can send all the content metadata nested under this property (ie. `content.asset_id`, `content.title`) as a Content Event Object. +### Ad event object +All ad events share the same event properties that describe information about the current ad content the user is interacting with. Below is a table of the supported properties of this object. -#### Quartile: `Integer` -For Video Ad Playing events, this property can be set to indicate when a specific ad quartile has been reached (1,2, or 3). If you are using a Segment client-side library to track your video events you do not need to send this property as our libraries will automatically track quartiles. +| Property | Type | Description | +| ---------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `session_id` | String | The unique ID of the overall session used to tie all events generated from a specific playback. This value should be same across all playback, content, and ad events if they are from the same playback session. | +| `asset_id` | String | The unique ID of the ad asset. | +| `pod_id` | String | The unique ID of the ad pod. | +| `pod_position` | Integer | The position of the ad asset relative to other assets in the same pod. | +| `pod_length` | Integer | The number of ad assets the current ad pod contains. | +| `type` | Enum {`pre-roll`, `mid-roll`, `post-roll`} | The ad type. You can send either `pre-roll`, `mid-roll`, or `post-roll`. | +| `title` | String | The title of the video ad. | +| `publisher` | String | The ad creator, author, producer, or publisher. | +| `position` | Integer | The current index position, in seconds, of the playhead with respect to the length of the ad. | +| `total_length` | Integer | The total duration of the current ad asset in seconds. | +| `load_type` | Enum {`linear`, `dynamic`} | `dynamic` if ads are loaded dynamically and `linear` if ads are same for all users. | +| `content` | Object[ContentEventObject] | For video destinations that require content metadata to be sent with ad events, you can send all the content metadata nested under this property (such as `content.asset_id` or `content.title`) as a Content Event Object. | +| `quartile` | Integer | For Video Ad Playing events, this property can be set to indicate when a specific ad quartile has been reached (1,2, or 3). If you are using a Segment client-side library to track your video events you don't need to send this property as Segment's libraries will automatically track quartiles. | -**Note:** Since some video destinations require sending Content metadata along with Ad metadata, you may need to send your content properties also in all your ad events under `properties.content` depending on the video destination you are using. +> info "" +> Since some video destinations require sending Content metadata along with Ad metadata, you may need to send your content properties also in all your ad events under `properties.content` depending on the video destination you're using. -### Ad Events +### Ad events -#### Video Ad Started +#### Video ad started {% comment %} api-example '{ "action": "track", @@ -927,7 +765,7 @@ For Video Ad Playing events, this property can be set to indicate when a specifi } ``` -#### Video Ad Playing +#### Video ad playing {% comment %} api-example '{ "action": "track", @@ -965,7 +803,7 @@ For Video Ad Playing events, this property can be set to indicate when a specifi } ``` -#### Video Ad Completed +#### Video ad completed {% comment %} api-example '{ "action": "track", @@ -1003,11 +841,11 @@ For Video Ad Playing events, this property can be set to indicate when a specifi } ``` -## Resuming Playback +## Resuming playback When you fire a [Video Playback Resumed](#video-playback-resumed) event, you *should* immediately call a Segment heartbeat event ([Video Content Playing](#video-content-playing) or [Video Ad Playing](#video-ad-playing) depending on what the playback resumed to). This should effectively mean that you are also resuming your 10 second heartbeats (since they should've been paused after sending Video Playback Paused event). -## Video Quality Event +## Video quality event It's important to analyze the performance of your video content. To keep track of quality changes, you can track a `Video Quality Updated` event when there is a change in video quality with the following properties: @@ -1026,7 +864,7 @@ It's important to analyze the performance of your video content. To keep track o -## Example Event Lifecycle +## Example event lifecycle Below is an example of how one might implement the video spec: @@ -1121,7 +959,7 @@ analytics.track('Video Content Playing', { }); ``` -4) Playback is paused & resumed: +4) Playback is paused and resumed: ```js analytics.track('Video Playback Paused', { @@ -1334,6 +1172,6 @@ analytics.track('Video Playback Completed', { }); ``` -Below is a graphical view of how a playback that has 3 mid-roll ads interspersed within the content: - ![](images/Video_Tracking_Workflow.png) +Below is an example of how a playback that has three mid-roll ads interspersed within the content: + ![Playback with three mid-roll ads interspersed within content](images/Video_Tracking_Workflow.png)