diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 37196c03be..1b3c073288 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 2023-08-10 +# destination categories last updated 2023-08-15 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 672f11d800..ead72fb104 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 2023-08-10 +# destination data last updated 2023-08-15 items: - id: 637e8d185e2dec264895ea89 display_name: 1Flow @@ -2741,96 +2741,21 @@ items: label: Domain actions: [] presets: [] -- id: 5d373a350abf930001a6b70f - display_name: Algolia Insights - name: Algolia Insights - slug: algolia-insights - hidden: false - endpoints: - - US - regions: - - us-west-2 - url: connections/destinations/catalog/algolia-insights - previous_names: - - Algolia - - Algolia Insights - website: https://www.algolia.com - status: PUBLIC - categories: - - A/B Testing - - Analytics - - Personalization - logo: - url: https://cdn.filepicker.io/api/file/SJLFYZy3ShugvijIJzoI - mark: - url: https://cdn.filepicker.io/api/file/akdcOqKsQwOhGGSSXJSy - methods: - track: true - identify: false - group: false - alias: false - screen: false - page: false - platforms: - browser: true - mobile: false - server: true - warehouse: false - components: - - code: https://segment.com/docs/connections/destinations/catalog/algolia/ - owner: PARTNER - type: SERVER - browserUnbundlingSupported: false - browserUnbundlingPublic: false - replay: false - connection_modes: - device: - web: false - mobile: false - server: false - cloud: - web: true - mobile: true - server: true - settings: - - name: apiKey - type: string - defaultValue: '' - description: The Search API Key of your Algolia Application - required: true - label: API Key - - name: appId - type: string - defaultValue: '' - description: The ID of your Algolia Application - required: true - label: App ID - - name: renameEvents - type: text-map - defaultValue: {} - description: >- - (optional) Rename your events if your event names aren't following the - official Segment specification. Put your current event name in the left - field, and the new name in the right field. - required: true - label: Rename Events - actions: [] - presets: [] - id: 63e52bea7747fbc311d5b872 display_name: Algolia Insights (Actions) name: Algolia Insights (Actions) - slug: algolia-insights-actions - hidden: true + slug: actions-algolia-insights + hidden: false endpoints: - US regions: - us-west-2 - eu-west-1 - url: connections/destinations/catalog/algolia-insights-actions + url: connections/destinations/catalog/actions-algolia-insights previous_names: - Algolia Insights (Actions) website: https://www.algolia.com/ - status: PUBLIC_BETA + status: PUBLIC categories: - Personalization - Raw Data @@ -48183,7 +48108,7 @@ items: hidden: false defaultTrigger: event = "Audience Entered" or event = "Audience Exited" fields: - - id: jcVeFsehCiYtsfdp8nfGCS + - id: wz5t1SjS5hVmdRqNv4WWAA sortOrder: 0 fieldKey: dmp_segment_name label: DMP Segment Display Name @@ -48200,7 +48125,7 @@ items: choices: null dynamic: false allowNull: false - - id: 4zPS53458R7dERvi4XVKzb + - id: 7pqyXTjTtBcXUDNgsbUTA2 sortOrder: 1 fieldKey: enable_batching label: Enable Batching @@ -48213,7 +48138,7 @@ items: choices: null dynamic: false allowNull: false - - id: 9hFKbbzuGFXd265RKTb3bU + - id: fuu3wBKehpb7LmvJ94gfUp sortOrder: 2 fieldKey: email label: User Email @@ -48227,7 +48152,7 @@ items: choices: null dynamic: false allowNull: false - - id: be2ANvsfsg2yYPybSUMbEA + - id: ae4cHLbcYdVybnRUraXUdL sortOrder: 3 fieldKey: google_advertising_id label: User Google Advertising ID @@ -48241,7 +48166,7 @@ items: choices: null dynamic: false allowNull: false - - id: 9xFTPFKJWPAnP3J3LP6ARi + - id: r79zAjQqT7hHsuGEyB47vG sortOrder: 4 fieldKey: source_segment_id label: LinkedIn Source Segment ID @@ -48258,7 +48183,7 @@ items: choices: null dynamic: false allowNull: false - - id: sSgTrU1TZDc8EeKVJpW9Gq + - id: qiYh8uCn7sSA7Ey1NVBoth sortOrder: 5 fieldKey: personas_audience_key label: Segment Engage Audience Key @@ -48273,7 +48198,7 @@ items: choices: null dynamic: false allowNull: false - - id: gx9rqynZ3C2fLt6FndV2RT + - id: rY6Xcwj6ujemQU3vSGYw74 sortOrder: 6 fieldKey: event_name label: Event Name @@ -48287,6 +48212,25 @@ items: choices: null dynamic: false allowNull: false + - id: 7SwPoY5EKvojx9JpvVKcxs + sortOrder: 7 + fieldKey: dmp_user_action + label: DMP User Action + type: STRING + description: A Segment specific key used to define action type. + placeholder: '' + defaultValue: AUTO + required: false + multiple: false + choices: + - label: Auto Detect + value: AUTO + - label: Add + value: ADD + - label: Remove + value: REMOVE + dynamic: false + allowNull: false presets: [] - id: 59526b3170a3e552b957552b display_name: LinkedIn Insight Tag @@ -50475,7 +50419,7 @@ items: hidden: false defaultTrigger: null fields: - - id: 6LMTVMYZuAxd37ixyyMijX + - id: kYD18uhoh74i4hpJg9Wd1Q sortOrder: 0 fieldKey: alias label: Alias @@ -50497,7 +50441,7 @@ items: choices: null dynamic: false allowNull: true - - id: 5sHvXHtBNUFNaJ4nqGAFUx + - id: 6UcNscK56CmMeNLkj2ueCZ sortOrder: 1 fieldKey: distinct_id label: Distinct ID @@ -50519,7 +50463,7 @@ items: hidden: false defaultTrigger: type = "track" fields: - - id: cnWpbnWAAVtqHMJcH2u5JC + - id: gWMrqwUVwYxgYUjvjUERV9 sortOrder: 0 fieldKey: generatePurchaseEventPerProduct label: Generate Purchase Event Per Product @@ -50534,7 +50478,7 @@ items: choices: null dynamic: false allowNull: false - - id: tuW8RxgqsAW4hYpGwQ6FmZ + - id: eGtU2CwGZ3kwnqxxPo1Acy sortOrder: 1 fieldKey: distinct_id label: Distinct ID @@ -50554,7 +50498,7 @@ items: choices: null dynamic: false allowNull: false - - id: npJxWV2CeW5sE9QPRG7sDc + - id: 8Yjus9pceonzBqKZUHHq76 sortOrder: 2 fieldKey: anonymous_id label: Anonymous ID @@ -50568,7 +50512,7 @@ items: choices: null dynamic: false allowNull: false - - id: oAGiSoknqYWi9SM8euTrvX + - id: qfjsB71VbLnNMXyuCZVUwz sortOrder: 3 fieldKey: user_id label: User ID @@ -50582,7 +50526,7 @@ items: choices: null dynamic: false allowNull: false - - id: qEBHhqESAYQT2nnDtkRd2C + - id: pGbPqystEnxNAgHLAYuZia sortOrder: 4 fieldKey: group_id label: Group ID @@ -50596,7 +50540,7 @@ items: choices: null dynamic: false allowNull: false - - id: xaFiCBripCaKpC77CEW822 + - id: oJ1C4MiMtFzphzrc2pzYHB sortOrder: 5 fieldKey: insert_id label: Insert ID @@ -50612,7 +50556,7 @@ items: choices: null dynamic: false allowNull: false - - id: m3KgcH6RgYCJkKgCuUwXnH + - id: jvKsEgUYuugHNG4Lb2Sv9Y sortOrder: 6 fieldKey: time label: Timestamp @@ -50630,7 +50574,7 @@ items: choices: null dynamic: false allowNull: false - - id: ctWBTqUhERjpLR6S65Rz6a + - id: pn4aoJynefpzMVnh82VV5c sortOrder: 7 fieldKey: app_name label: App Name @@ -50644,7 +50588,7 @@ items: choices: null dynamic: false allowNull: false - - id: YtngZfkBCsiJmFDyht987 + - id: yjvJFo1newKo4fK719f69 sortOrder: 8 fieldKey: app_namespace label: App Namespace @@ -50658,7 +50602,7 @@ items: choices: null dynamic: false allowNull: false - - id: 49PWqWJptRJQKoxEVrio7F + - id: 61zfJkfs27oyykoXmgLb2p sortOrder: 9 fieldKey: app_build label: App Build @@ -50672,7 +50616,7 @@ items: choices: null dynamic: false allowNull: false - - id: s9fsgzV2f2kVkWD3Q291VV + - id: 4d48BCKtFHx2LeaNMQN5se sortOrder: 10 fieldKey: app_version label: App Version @@ -50686,7 +50630,7 @@ items: choices: null dynamic: false allowNull: false - - id: nFZgQqGcVqvKMDZpfGg7Rd + - id: tR1uKwYSjQp9xcmVsdz3Us sortOrder: 11 fieldKey: os_name label: OS Name @@ -50702,7 +50646,7 @@ items: choices: null dynamic: false allowNull: false - - id: 7K9MysJxcbe8fx127CXbKx + - id: 99uQ3Nh9tU52UQcpATRqxF sortOrder: 12 fieldKey: os_version label: OS Version @@ -50716,7 +50660,7 @@ items: choices: null dynamic: false allowNull: false - - id: 7237uwj8CWNfJKZMuDT9Cp + - id: 38mct7xEGo2s4drzAieGe4 sortOrder: 13 fieldKey: device_id label: Device ID @@ -50730,7 +50674,7 @@ items: choices: null dynamic: false allowNull: false - - id: efsdWpLzZDfNW3SH3qo7He + - id: k3okzpByTNzmks5g3FVDdi sortOrder: 14 fieldKey: device_type label: Device Type @@ -50744,7 +50688,7 @@ items: choices: null dynamic: false allowNull: false - - id: 8gusEGLxyfxszPtenphnnG + - id: eovNi4WDw4a2rpgrCYog3K sortOrder: 15 fieldKey: device_name label: Device Name @@ -50758,7 +50702,7 @@ items: choices: null dynamic: false allowNull: false - - id: agsrUjEZhvzsoVdWwzEFht + - id: ebdGQjB1qERgfkzxBYb8Xv sortOrder: 16 fieldKey: device_manufacturer label: Device Manufacturer @@ -50772,7 +50716,7 @@ items: choices: null dynamic: false allowNull: false - - id: 8UZwJ7h9EwH6miHoZvYyFb + - id: dvm4SSQHUgBDKgpj3c8Kes sortOrder: 17 fieldKey: device_model label: Device Model @@ -50786,7 +50730,7 @@ items: choices: null dynamic: false allowNull: false - - id: xtuoAgsQJHXUJ3Zf3TnH4x + - id: wnCZ7uMBZ4PyAWDMwN8mYw sortOrder: 18 fieldKey: bluetooth label: Bluetooth Enabled @@ -50800,7 +50744,7 @@ items: choices: null dynamic: false allowNull: false - - id: 3kZ4bP4uXSz4WbZr8i1TE8 + - id: acRosyZCzeCD9Edd7JZrNo sortOrder: 19 fieldKey: carrier label: Carrier @@ -50814,7 +50758,7 @@ items: choices: null dynamic: false allowNull: false - - id: eDY7HzbmmzUnhz3wQ6ith4 + - id: bKYRp9qhVjSDz3y9vnR6t5 sortOrder: 20 fieldKey: cellular label: Cellular Enabled @@ -50828,7 +50772,7 @@ items: choices: null dynamic: false allowNull: false - - id: kSFm4eRc3ik7TLhraA7QcK + - id: g7GUXraTfB3bDCPFzmMLU1 sortOrder: 21 fieldKey: wifi label: Wifi @@ -50844,7 +50788,7 @@ items: choices: null dynamic: false allowNull: false - - id: cbc98rQAMyHLFU3hXg7hbn + - id: 2wbsxQPkNk5nE44bdrUhAQ sortOrder: 22 fieldKey: country label: Country @@ -50858,7 +50802,7 @@ items: choices: null dynamic: false allowNull: false - - id: jFtKtu67Vrsvgofx1tgvxC + - id: sqPhRK1YmfhK2DguPLD2R sortOrder: 23 fieldKey: region label: Region @@ -50872,7 +50816,7 @@ items: choices: null dynamic: false allowNull: false - - id: s9nGjuUvxc2cEQBNcNMpvZ + - id: 8tNED5nX4ozVgkn4abuTdS sortOrder: 24 fieldKey: language label: Language @@ -50886,7 +50830,7 @@ items: choices: null dynamic: false allowNull: false - - id: q6TH7FwBAK6r39eSksXk3w + - id: tKicVJacZdRrLpAwk6igPh sortOrder: 25 fieldKey: library_name label: Library Name @@ -50900,7 +50844,7 @@ items: choices: null dynamic: false allowNull: false - - id: tpHJQUMDjGtSMbRF2UEtyD + - id: gTZsVQKVwhvRwNeiV9TGSi sortOrder: 26 fieldKey: library_version label: Library Version @@ -50914,7 +50858,7 @@ items: choices: null dynamic: false allowNull: false - - id: rgZSiMo85CZRzwQQ4Zbbrp + - id: tzChELAZUgEzi2AUg1EoSh sortOrder: 27 fieldKey: ip label: IP Address @@ -50930,7 +50874,7 @@ items: choices: null dynamic: false allowNull: false - - id: dZwCs3CBGEAjmfRPRzhiaB + - id: uQbptDtoy8Cw6d6axxDoMo sortOrder: 28 fieldKey: idfa label: Identifier For Advertiser (IDFA) @@ -50950,7 +50894,7 @@ items: choices: null dynamic: false allowNull: false - - id: v5E2Lgca88ymw4kiZ1KiTH + - id: qLpH25XTVt4ZeApyvf3ro1 sortOrder: 29 fieldKey: url label: URL @@ -50964,7 +50908,7 @@ items: choices: null dynamic: false allowNull: false - - id: rmfRvTnJUV4UWRXWasvuwG + - id: 7E2MD2nrYbcosESe85DtRQ sortOrder: 30 fieldKey: screen_width label: Screen width @@ -50978,7 +50922,7 @@ items: choices: null dynamic: false allowNull: false - - id: mGuexZ4du2M2JNAdZSdh2s + - id: hAtQFBRmtU3PS7uvDHBGbW sortOrder: 31 fieldKey: screen_height label: Screen height @@ -50992,7 +50936,7 @@ items: choices: null dynamic: false allowNull: false - - id: hA1LgPXYW3JLb7AxmrvPRF + - id: m2xdF5Bs58jzUwwLHvts1g sortOrder: 32 fieldKey: screen_density label: Screen density @@ -51006,7 +50950,7 @@ items: choices: null dynamic: false allowNull: false - - id: tkLiK244uMcy3eBL66v7Uq + - id: cDDYdLiLfSiMp2WtumgDGU sortOrder: 33 fieldKey: referrer label: Referrer @@ -51020,7 +50964,7 @@ items: choices: null dynamic: false allowNull: false - - id: qEYCJkWsGR9JXiLKY9Y3iz + - id: aLVgv9tuNXSL5h7MNTF6tF sortOrder: 34 fieldKey: userAgent label: User Agent @@ -51034,8 +50978,84 @@ items: choices: null dynamic: false allowNull: false - - id: bTR7ECWv2Kcgi4rLgEFku5 + - id: 4SGeSzAQAYaP9tUPoXEbLj sortOrder: 35 + fieldKey: advertising_id + label: Advertising ID + type: STRING + description: Advertising ID + placeholder: '' + defaultValue: + '@path': $.context.device.advertisingId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 3yy2RkQvPPDACiEwWYmKDW + sortOrder: 36 + fieldKey: ad_tracking_enabled + label: Ad Tracking Enabled + type: STRING + description: Ad Tracking Enabled (true or false) + placeholder: '' + defaultValue: + '@path': $.context.device.adTrackingEnabled + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: uFbD1MF4MiZbcG5w5gqv4F + sortOrder: 37 + fieldKey: timezone + label: Timezone + type: STRING + description: The event timezone + placeholder: '' + defaultValue: + '@path': $.context.timezone + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 9beGV2S4NuDs7Yrus8mhQU + sortOrder: 38 + fieldKey: app_platform + label: App Platform + type: STRING + description: The App Platform, if applicable + placeholder: '' + defaultValue: + '@path': $.context.app.platform + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: ryEwwVb7Y1qDP8QHsxZJSq + sortOrder: 39 + fieldKey: name + label: Event Original Name + type: STRING + description: The Event Original Name, if applicable + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.event + then: + '@path': $.event + else: + '@path': $.name + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 27nsuDqkp1h21e8aaRDYge + sortOrder: 40 fieldKey: event_properties label: Event Properties type: OBJECT @@ -51050,8 +51070,8 @@ items: choices: null dynamic: false allowNull: false - - id: tpGToX8rwZFDduvVfnr41H - sortOrder: 36 + - id: eVKswxo1Vun7CbjW7gktdM + sortOrder: 41 fieldKey: context label: Event context type: OBJECT @@ -51066,8 +51086,8 @@ items: choices: null dynamic: false allowNull: false - - id: v57ySGqm68ng3YZyeuk9Z5 - sortOrder: 37 + - id: hvSMCnzydt4UXZHrbTr5Az + sortOrder: 42 fieldKey: utm_properties label: UTM Properties type: OBJECT @@ -51089,8 +51109,8 @@ items: choices: null dynamic: false allowNull: false - - id: hRfjVL6KuRYHV7x1wBZ518 - sortOrder: 38 + - id: densrLmoAh4p487L1G7eRq + sortOrder: 43 fieldKey: enable_batching label: Batch Data to Mixpanel type: BOOLEAN @@ -51102,8 +51122,8 @@ items: choices: null dynamic: false allowNull: false - - id: 8FY56yFCXyoc3YdWpz9M9a - sortOrder: 39 + - id: p78kwW92ZNum46w3HAEKDe + sortOrder: 44 fieldKey: products label: Products type: OBJECT @@ -51141,8 +51161,8 @@ items: choices: null dynamic: false allowNull: false - - id: kb8pt1GBeoygfARWi9aWko - sortOrder: 40 + - id: md3mbxAERPRqsTB7ftVwUq + sortOrder: 45 fieldKey: event label: Event Name type: STRING @@ -51166,7 +51186,7 @@ items: hidden: false defaultTrigger: type = "group" fields: - - id: pBUhbZbTaVXtMoUBZa6zUL + - id: tBq2auw6ukG2oZk423MunW sortOrder: 0 fieldKey: group_key label: Group Key @@ -51180,7 +51200,7 @@ items: choices: null dynamic: false allowNull: false - - id: jeLxJW89h71R67ToXZbfL5 + - id: eyEQmGvWXtzuRybw6Ycs6F sortOrder: 1 fieldKey: group_id label: Group ID @@ -51196,7 +51216,7 @@ items: choices: null dynamic: false allowNull: false - - id: qHE13mPrQWVSVWdknyKeEs + - id: nQVj6XUtHmEaNK241JPJDD sortOrder: 2 fieldKey: traits label: Group Properties @@ -51220,7 +51240,7 @@ items: hidden: false defaultTrigger: type = "track" fields: - - id: czZ51BJNUCf39EwSDQsLTz + - id: kbqrxbrWnXBdoCe4PypsH sortOrder: 0 fieldKey: event label: Event Name @@ -51234,7 +51254,7 @@ items: choices: null dynamic: false allowNull: false - - id: hJQbLSiYVCVLNTWJZJFsmu + - id: 5QXdD7baiTBduzhexqcFF1 sortOrder: 1 fieldKey: distinct_id label: Distinct ID @@ -51254,7 +51274,7 @@ items: choices: null dynamic: false allowNull: false - - id: neGmKSZBZoTicmDMhx1F1y + - id: hrbCirxcAuJMLRC3BUTjuD sortOrder: 2 fieldKey: anonymous_id label: Anonymous ID @@ -51268,7 +51288,7 @@ items: choices: null dynamic: false allowNull: false - - id: aMx7H3nLoDJNCZjS4DZiAk + - id: pKhVzNCuuRdYz3CWzyBUc3 sortOrder: 3 fieldKey: user_id label: User ID @@ -51282,7 +51302,7 @@ items: choices: null dynamic: false allowNull: false - - id: vmi5SR3JmioZg9XVD7241p + - id: c25FMHcP33FV3tniZGnqyy sortOrder: 4 fieldKey: group_id label: Group ID @@ -51296,7 +51316,7 @@ items: choices: null dynamic: false allowNull: false - - id: vyLPRvzKKzJsR9DDA8APSd + - id: rtcoD8kTzFTtUzU14j6ptD sortOrder: 5 fieldKey: insert_id label: Insert ID @@ -51312,7 +51332,7 @@ items: choices: null dynamic: false allowNull: false - - id: tcgn4kN6fc3DShXf2L4mro + - id: gQrfj7x7Yw25tPnz7JB9RT sortOrder: 6 fieldKey: time label: Timestamp @@ -51330,7 +51350,7 @@ items: choices: null dynamic: false allowNull: false - - id: 5LBeFb7gxA8sp4uGmXwBAZ + - id: s9mMJb1ugkxoszvnQ9zRNq sortOrder: 7 fieldKey: app_name label: App Name @@ -51344,7 +51364,7 @@ items: choices: null dynamic: false allowNull: false - - id: 2gyenxRYgtE1447FpCZvCk + - id: kpH3WKxkx4Gnm39R2qHEN1 sortOrder: 8 fieldKey: app_namespace label: App Namespace @@ -51358,7 +51378,7 @@ items: choices: null dynamic: false allowNull: false - - id: psdjVeWvCgAUQc4xdbzZb3 + - id: vveEmpByssj3QYyDJyPnwx sortOrder: 9 fieldKey: app_build label: App Build @@ -51372,7 +51392,7 @@ items: choices: null dynamic: false allowNull: false - - id: kM1N8ihLEUMzXHEuancBm8 + - id: 8B1ZXzUxwigTv9pg9m9jpy sortOrder: 10 fieldKey: app_version label: App Version @@ -51386,7 +51406,7 @@ items: choices: null dynamic: false allowNull: false - - id: 3mB8LqCbZ6FpJo7i27U4ic + - id: jVpP3Fy76H5qj9ENQqPqq3 sortOrder: 11 fieldKey: os_name label: OS Name @@ -51402,7 +51422,7 @@ items: choices: null dynamic: false allowNull: false - - id: xfUFWseCMPPrDYeqQHWado + - id: gvMDBufYrCeYmjWF792Njn sortOrder: 12 fieldKey: os_version label: OS Version @@ -51416,7 +51436,7 @@ items: choices: null dynamic: false allowNull: false - - id: 4jXTBpxKjYuUwxw3XskQzk + - id: rNWeF6jYSDWB8cDf2SxPnf sortOrder: 13 fieldKey: device_id label: Device ID @@ -51430,7 +51450,7 @@ items: choices: null dynamic: false allowNull: false - - id: 9RqEddSx2So3RvWYiAwggE + - id: if4yGcJTUtJYjGT3UwiSjt sortOrder: 14 fieldKey: device_type label: Device Type @@ -51444,7 +51464,7 @@ items: choices: null dynamic: false allowNull: false - - id: d2hmNjV8wJvpUonyzNX2kD + - id: u1QZ1nJ7kTS6Gyu6HxAe8e sortOrder: 15 fieldKey: device_name label: Device Name @@ -51458,7 +51478,7 @@ items: choices: null dynamic: false allowNull: false - - id: nzjhYuvtD4oDZXRxibzBRS + - id: h1SBdq6nrctYiWzWiG9kP2 sortOrder: 16 fieldKey: device_manufacturer label: Device Manufacturer @@ -51472,7 +51492,7 @@ items: choices: null dynamic: false allowNull: false - - id: 6fH4HFV5z4AKa7LsBdL53f + - id: bnYxoqXE35u1WRgpAoJSmj sortOrder: 17 fieldKey: device_model label: Device Model @@ -51486,7 +51506,7 @@ items: choices: null dynamic: false allowNull: false - - id: uWeRiKxcQ4dH5dFbbnDbpg + - id: fSg4K74i5ujbSDGzAfq4ft sortOrder: 18 fieldKey: bluetooth label: Bluetooth Enabled @@ -51500,7 +51520,7 @@ items: choices: null dynamic: false allowNull: false - - id: 5m29Eee9Wfk6gwbRXcKusy + - id: vCGymAX4hXeK9txXR7meju sortOrder: 19 fieldKey: carrier label: Carrier @@ -51514,7 +51534,7 @@ items: choices: null dynamic: false allowNull: false - - id: dYt5CusUp57NPiyHh1LY5A + - id: 2FExm5DqxHUausbuYYvQFr sortOrder: 20 fieldKey: cellular label: Cellular Enabled @@ -51528,7 +51548,7 @@ items: choices: null dynamic: false allowNull: false - - id: nHG2dMz5qzRbTjYY3zzABQ + - id: t18ef41W2H99e6mKvBk5UV sortOrder: 21 fieldKey: wifi label: Wifi @@ -51544,7 +51564,7 @@ items: choices: null dynamic: false allowNull: false - - id: ujPeA8b3sjj4J161A1GtDB + - id: 8js7ZH8pajPmm5BoENGEXp sortOrder: 22 fieldKey: country label: Country @@ -51558,7 +51578,7 @@ items: choices: null dynamic: false allowNull: false - - id: 5x2vFh6dSndPYw3h94tqt6 + - id: s4qKyawggWTgSc2UmU1xsf sortOrder: 23 fieldKey: region label: Region @@ -51572,7 +51592,7 @@ items: choices: null dynamic: false allowNull: false - - id: 94VqJgrLjgPqPAiDXi1HH6 + - id: oo9JKzMPx41jYo9rvWMofr sortOrder: 24 fieldKey: language label: Language @@ -51586,7 +51606,7 @@ items: choices: null dynamic: false allowNull: false - - id: vLGiyWJoMz5Yu1aZapZWbH + - id: 8yXBJ9ZPxyi8vz6Gc2SMMa sortOrder: 25 fieldKey: library_name label: Library Name @@ -51600,7 +51620,7 @@ items: choices: null dynamic: false allowNull: false - - id: vtUpyds15mJtwGLoNPGZwx + - id: urbZ6iHYkMUaKhEjGjtwXp sortOrder: 26 fieldKey: library_version label: Library Version @@ -51614,7 +51634,7 @@ items: choices: null dynamic: false allowNull: false - - id: tHkdneGiDtmeW3DdYYbw4m + - id: 6XDBwfwonA9bnSn1sckv7h sortOrder: 27 fieldKey: ip label: IP Address @@ -51630,7 +51650,7 @@ items: choices: null dynamic: false allowNull: false - - id: hZ6Z4ZtvffySzqKtFuZLVe + - id: pmce2ACGMoeDutV5oGLiGK sortOrder: 28 fieldKey: idfa label: Identifier For Advertiser (IDFA) @@ -51650,7 +51670,7 @@ items: choices: null dynamic: false allowNull: false - - id: v72Kb96bQH1GxMZyR4KV1C + - id: aWPTXjYoCzzeEEYKoKVwNZ sortOrder: 29 fieldKey: url label: URL @@ -51664,7 +51684,7 @@ items: choices: null dynamic: false allowNull: false - - id: 6EpHMMjfGKMjp8Wyq3FML8 + - id: d69V7Jrz1VRknAzuGYhqSi sortOrder: 30 fieldKey: screen_width label: Screen width @@ -51678,7 +51698,7 @@ items: choices: null dynamic: false allowNull: false - - id: 8LDKGQuFX7kKNbJp3kt6W5 + - id: dBKcbZq7LqJ9rQg3274DdS sortOrder: 31 fieldKey: screen_height label: Screen height @@ -51692,7 +51712,7 @@ items: choices: null dynamic: false allowNull: false - - id: 2HEGGGNCjnvLeq6zu8UTPL + - id: mvy5v8aziMUYXgXEBqonDi sortOrder: 32 fieldKey: screen_density label: Screen density @@ -51706,7 +51726,7 @@ items: choices: null dynamic: false allowNull: false - - id: rkU2kaZNqrqjXQz9Hjf1rM + - id: z7qL65W6ykXPU1zgbiAS5 sortOrder: 33 fieldKey: referrer label: Referrer @@ -51720,7 +51740,7 @@ items: choices: null dynamic: false allowNull: false - - id: 3NKnaSMspFBYJwuB7YhX4E + - id: 48kgdR9gXdJ8vmGoEk7QT sortOrder: 34 fieldKey: userAgent label: User Agent @@ -51734,8 +51754,84 @@ items: choices: null dynamic: false allowNull: false - - id: uoxiL93XNzyaQMAEEAMQ1S + - id: k3zgnn6W8JDt27jkVjHU7D sortOrder: 35 + fieldKey: advertising_id + label: Advertising ID + type: STRING + description: Advertising ID + placeholder: '' + defaultValue: + '@path': $.context.device.advertisingId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: mdhp7cVGqaC4RET9i1JuNR + sortOrder: 36 + fieldKey: ad_tracking_enabled + label: Ad Tracking Enabled + type: STRING + description: Ad Tracking Enabled (true or false) + placeholder: '' + defaultValue: + '@path': $.context.device.adTrackingEnabled + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jtyuYnCpE5x1F3HGjTDmjZ + sortOrder: 37 + fieldKey: timezone + label: Timezone + type: STRING + description: The event timezone + placeholder: '' + defaultValue: + '@path': $.context.timezone + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 2fH6ErRg6nmwRtufHAPVPU + sortOrder: 38 + fieldKey: app_platform + label: App Platform + type: STRING + description: The App Platform, if applicable + placeholder: '' + defaultValue: + '@path': $.context.app.platform + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: g7UQumG9vBaWHz1VAa8MmC + sortOrder: 39 + fieldKey: name + label: Event Original Name + type: STRING + description: The Event Original Name, if applicable + placeholder: '' + defaultValue: + '@if': + exists: + '@path': $.event + then: + '@path': $.event + else: + '@path': $.name + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 4V46ZGexjpkGDJqxx7WHgo + sortOrder: 40 fieldKey: event_properties label: Event Properties type: OBJECT @@ -51750,8 +51846,8 @@ items: choices: null dynamic: false allowNull: false - - id: nZizXQQzWq59wVzMa1GXyT - sortOrder: 36 + - id: ibG32bMVShR7AyrPzR4U3h + sortOrder: 41 fieldKey: context label: Event context type: OBJECT @@ -51766,8 +51862,8 @@ items: choices: null dynamic: false allowNull: false - - id: 5GT7eJSuaCqQe3RhBHPNSb - sortOrder: 37 + - id: gERUEyf4pfmYw6kfb48vvQ + sortOrder: 42 fieldKey: utm_properties label: UTM Properties type: OBJECT @@ -51789,8 +51885,8 @@ items: choices: null dynamic: false allowNull: false - - id: 72CnqUHeSjCmawW8V66W53 - sortOrder: 38 + - id: 65DUfsuJ2KxWvsB29yhabC + sortOrder: 43 fieldKey: enable_batching label: Batch Data to Mixpanel type: BOOLEAN @@ -51815,7 +51911,7 @@ items: hidden: false defaultTrigger: type = "identify" fields: - - id: bKp2FbtkXdKsaRZxgdkw5N + - id: 2Mkm1YeirC7ZshPDU98Pfs sortOrder: 0 fieldKey: ip label: IP Address @@ -51831,7 +51927,7 @@ items: choices: null dynamic: false allowNull: false - - id: mZuWoJv4UrosYHgJujQeQa + - id: 9VPSHEWSKd2VnqcWvXcNDv sortOrder: 1 fieldKey: user_id label: User ID @@ -51845,7 +51941,7 @@ items: choices: null dynamic: false allowNull: true - - id: oRD4bSemSU9X7smaQKScQm + - id: 5ETYFVuMWkSAeSTghM2bji sortOrder: 2 fieldKey: anonymous_id label: Anonymous ID @@ -51859,7 +51955,7 @@ items: choices: null dynamic: false allowNull: true - - id: 2V1pYVaUVKKLMyrRtakfFb + - id: mEpNg6mGCTDBMDKginT1aP sortOrder: 3 fieldKey: traits label: User Properties @@ -51874,19 +51970,23 @@ items: dynamic: false allowNull: false presets: - - actionId: drUNmF6UifiVmB9NStLWS1 - name: Group Calls + - actionId: iLgPGgELNm5SgSVaqztJeJ + name: Identify Calls fields: - group_id: - '@path': $.groupId + ip: + '@path': $.context.ip + user_id: + '@path': $.userId + anonymous_id: + '@path': $.anonymousId traits: '@path': $.traits - trigger: type = "group" + trigger: type = "identify" - actionId: etDoZEKaPvjgeXw6c84cvi - name: Page Calls + name: Track Calls fields: event: - '@template': Viewed {{name}} + '@path': $.event distinct_id: '@if': exists: @@ -51967,6 +52067,22 @@ items: '@path': $.context.page.referrer userAgent: '@path': $.context.userAgent + advertising_id: + '@path': $.context.device.advertisingId + ad_tracking_enabled: + '@path': $.context.device.adTrackingEnabled + timezone: + '@path': $.context.timezone + app_platform: + '@path': $.context.app.platform + name: + '@if': + exists: + '@path': $.event + then: + '@path': $.event + else: + '@path': $.name event_properties: '@path': $.properties context: @@ -51983,11 +52099,12 @@ items: utm_content: '@path': $.context.campaign.content enable_batching: true - trigger: type = "page" - - actionId: a6YW8RCSKobYuCSEaiYKqY - name: Order Completed Calls + trigger: type = "track" and event != "Order Completed" + - actionId: etDoZEKaPvjgeXw6c84cvi + name: Page Calls fields: - generatePurchaseEventPerProduct: true + event: + '@template': Viewed {{name}} distinct_id: '@if': exists: @@ -52068,6 +52185,22 @@ items: '@path': $.context.page.referrer userAgent: '@path': $.context.userAgent + advertising_id: + '@path': $.context.device.advertisingId + ad_tracking_enabled: + '@path': $.context.device.adTrackingEnabled + timezone: + '@path': $.context.timezone + app_platform: + '@path': $.context.app.platform + name: + '@if': + exists: + '@path': $.event + then: + '@path': $.event + else: + '@path': $.name event_properties: '@path': $.properties context: @@ -52084,41 +52217,20 @@ items: utm_content: '@path': $.context.campaign.content enable_batching: true - products: - '@arrayPath': - - $.properties.products - - product_id: - '@path': product_id - sku: - '@path': sku - category: - '@path': category - name: - '@path': name - brand: - '@path': brand - variant: - '@path': variant - price: - '@path': price - quantity: - '@path': quantity - coupon: - '@path': coupon - position: - '@path': position - url: - '@path': url - image_url: - '@path': image_url - event: - '@path': $.event - trigger: type = "track" and event = "Order Completed" + trigger: type = "page" + - actionId: drUNmF6UifiVmB9NStLWS1 + name: Group Calls + fields: + group_id: + '@path': $.groupId + traits: + '@path': $.traits + trigger: type = "group" - actionId: etDoZEKaPvjgeXw6c84cvi - name: Track Calls + name: Screen Calls fields: event: - '@path': $.event + '@template': Viewed {{name}} distinct_id: '@if': exists: @@ -52199,6 +52311,22 @@ items: '@path': $.context.page.referrer userAgent: '@path': $.context.userAgent + advertising_id: + '@path': $.context.device.advertisingId + ad_tracking_enabled: + '@path': $.context.device.adTrackingEnabled + timezone: + '@path': $.context.timezone + app_platform: + '@path': $.context.app.platform + name: + '@if': + exists: + '@path': $.event + then: + '@path': $.event + else: + '@path': $.name event_properties: '@path': $.properties context: @@ -52215,12 +52343,11 @@ items: utm_content: '@path': $.context.campaign.content enable_batching: true - trigger: type = "track" and event != "Order Completed" - - actionId: etDoZEKaPvjgeXw6c84cvi - name: Screen Calls + trigger: type = "screen" + - actionId: a6YW8RCSKobYuCSEaiYKqY + name: Order Completed Calls fields: - event: - '@template': Viewed {{name}} + generatePurchaseEventPerProduct: true distinct_id: '@if': exists: @@ -52301,6 +52428,22 @@ items: '@path': $.context.page.referrer userAgent: '@path': $.context.userAgent + advertising_id: + '@path': $.context.device.advertisingId + ad_tracking_enabled: + '@path': $.context.device.adTrackingEnabled + timezone: + '@path': $.context.timezone + app_platform: + '@path': $.context.app.platform + name: + '@if': + exists: + '@path': $.event + then: + '@path': $.event + else: + '@path': $.name event_properties: '@path': $.properties context: @@ -52317,19 +52460,36 @@ items: utm_content: '@path': $.context.campaign.content enable_batching: true - trigger: type = "screen" - - actionId: iLgPGgELNm5SgSVaqztJeJ - name: Identify Calls - fields: - ip: - '@path': $.context.ip - user_id: - '@path': $.userId - anonymous_id: - '@path': $.anonymousId - traits: - '@path': $.traits - trigger: type = "identify" + products: + '@arrayPath': + - $.properties.products + - product_id: + '@path': product_id + sku: + '@path': sku + category: + '@path': category + name: + '@path': name + brand: + '@path': brand + variant: + '@path': variant + price: + '@path': price + quantity: + '@path': quantity + coupon: + '@path': coupon + position: + '@path': position + url: + '@path': url + image_url: + '@path': image_url + event: + '@path': $.event + trigger: type = "track" and event = "Order Completed" - id: 54521fd925e721e32a72eed6 display_name: Mixpanel (Legacy) name: Mixpanel (Legacy) diff --git a/src/_data/catalog/destinations_private.yml b/src/_data/catalog/destinations_private.yml index e4306fd398..5f3de52191 100644 --- a/src/_data/catalog/destinations_private.yml +++ b/src/_data/catalog/destinations_private.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination data last updated 2023-08-10 +# destination data last updated 2023-08-15 items: - id: 54521fd725e721e32a72eec6 display_name: Intercom @@ -2454,6 +2454,344 @@ items: source_ip: '@path': $.context.ip trigger: type = "track" + - id: 644ad6c6c4a87a3290450602 + display_name: LiveRamp Audiences + name: LiveRamp Audiences + slug: liveramp-audiences + previous_names: + - Liveramp Audiences + - LiveRamp Audiences + url: connections/destinations/catalog/liveramp-audiences + website: http://www.segment.com + status: PRIVATE_BETA + logo: + url: https://cdn.filepicker.io/api/file/BE6oXQG4QzK346NMQMGN + mark: + url: https://cdn.filepicker.io/api/file/8SFtDBrtSrS5E14mAgsY + methods: + track: true + identify: true + group: true + alias: true + screen: false + page: true + platforms: + browser: true + mobile: false + server: true + warehouse: false + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + settings: [] + actions: + - id: 2Xg7PHV6kQDWdS8j2da66P + name: Audience Entered (SFTP) + slug: audienceEnteredSFTP + description: >- + Uploads audience membership data to a file through SFTP for LiveRamp + ingestion. + platform: CLOUD + hidden: false + defaultTrigger: event = "Audience Entered" + fields: + - id: q7p7uqJNcybthVZ3xSqimU + sortOrder: 0 + fieldKey: sftp_username + label: Username + type: STRING + description: >- + User credentials for establishing an SFTP connection with + LiveRamp. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: hH9xtqw3gNAKkvzxStXGvM + sortOrder: 1 + fieldKey: sftp_password + label: Password + type: PASSWORD + description: >- + User credentials for establishing an SFTP connection with + LiveRamp. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: w4LA4u7nUDWKKZfbHDcivo + sortOrder: 2 + fieldKey: sftp_folder_path + label: Folder Path + type: STRING + description: >- + Path within the LiveRamp SFTP server to upload the files to. This + path must exist and all subfolders must be pre-created. + placeholder: '' + defaultValue: /uploads/audience_name/ + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: nU2Zxh6gh1NzE3FZEhZUGu + sortOrder: 3 + fieldKey: audience_key + label: Audience Key + type: STRING + description: Identifies the user within the entered audience. + placeholder: '' + defaultValue: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: g6t2tGMYvaLTPUDhhbcGF2 + sortOrder: 4 + fieldKey: identifier_data + label: Identifier Data + type: OBJECT + description: Additional data pertaining to the user to be written to the file. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: kNTwvVxTKmTWWP7JbtYPaY + sortOrder: 5 + fieldKey: unhashed_identifier_data + label: Hashable Identifier Data + type: OBJECT + description: >- + Additional data pertaining to the user to be hashed before written + to the file + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: tYxvXLh3RWUGBLecrWVnyB + sortOrder: 6 + fieldKey: delimiter + label: Delimeter + type: STRING + description: Character used to separate tokens in the resulting file. + placeholder: '' + defaultValue: ',' + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: oYP7CcxkBx4y2gdU9FMV9d + sortOrder: 7 + fieldKey: filename + label: Filename + type: STRING + description: Name of the CSV file to upload for LiveRamp ingestion. + placeholder: '' + defaultValue: + '@template': '{{properties.audience_key}}_PII_{{timestamp}}.csv' + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: oa4jhf7vBPQyZWij2yVhTf + sortOrder: 8 + fieldKey: enable_batching + label: Batch data + type: BOOLEAN + description: >- + Receive events in a batch payload. This is required for LiveRamp + audiences ingestion. + placeholder: '' + defaultValue: true + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: r55cQvUwCA9ayRYZQR9hMe + sortOrder: 9 + fieldKey: batch_size + label: Batch Size + type: NUMBER + description: >- + Maximum number of events to include in each batch. Actual batch + sizes may be lower. + placeholder: '' + defaultValue: 100000 + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jkMRBs4cqeNgEZ7uc6z78Z + name: Audience Entered (S3) + slug: audienceEnteredS3 + description: >- + Uploads audience membership data to a file in S3 for LiveRamp + ingestion. + platform: CLOUD + hidden: false + defaultTrigger: event = "Audience Entered" + fields: + - id: vJKEgZMQe8BJGHc1GpZhU5 + sortOrder: 0 + fieldKey: s3_aws_access_key + label: AWS Access Key ID + type: STRING + description: IAM user credentials with write permissions to the S3 bucket. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: bkoLEGMZXEPJ5w5PEznQ3J + sortOrder: 1 + fieldKey: s3_aws_secret_key + label: AWS Secret Access Key + type: PASSWORD + description: IAM user credentials with write permissions to the S3 bucket. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: p2UcUyUbSt2rBXtzGHFan + sortOrder: 2 + fieldKey: s3_aws_bucket_name + label: AWS Bucket Name + type: STRING + description: Name of the S3 bucket where the files will be uploaded to. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 64bQKxosN51kQGCoKjjkxp + sortOrder: 3 + fieldKey: s3_aws_region + label: AWS Region (S3 only) + type: STRING + description: Region where the S3 bucket is hosted. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 4aJHYjVm8trfZy7kr6fZjd + sortOrder: 4 + fieldKey: audience_key + label: Audience Key + type: STRING + description: Identifies the user within the entered audience. + placeholder: '' + defaultValue: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 3HrRosDdtKQ2Ajtn7skydo + sortOrder: 5 + fieldKey: identifier_data + label: Identifier Data + type: OBJECT + description: Additional data pertaining to the user to be written to the file. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: e7fgLkWzKVkAiZscyRuNQg + sortOrder: 6 + fieldKey: unhashed_identifier_data + label: Hashable Identifier Data + type: OBJECT + description: >- + Additional data pertaining to the user to be hashed before written + to the file + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: spaS1wyvP1DQbpnJifo2xD + sortOrder: 7 + fieldKey: delimiter + label: Delimeter + type: STRING + description: Character used to separate tokens in the resulting file. + placeholder: '' + defaultValue: ',' + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 354R6ebe6g62Sv8jhX4ahw + sortOrder: 8 + fieldKey: filename + label: Filename + type: STRING + description: Name of the CSV file to upload for LiveRamp ingestion. + placeholder: '' + defaultValue: + '@template': '{{properties.audience_key}}_PII_{{timestamp}}.csv' + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: b6RBLHXYVMM78JPvEv5KDi + sortOrder: 9 + fieldKey: enable_batching + label: Batch data + type: BOOLEAN + description: >- + Receive events in a batch payload. This is required for LiveRamp + audiences ingestion. + placeholder: '' + defaultValue: true + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: hJyAYie73q4f2SpE6LBr6J + sortOrder: 10 + fieldKey: batch_size + label: Batch Size + type: NUMBER + description: >- + Maximum number of events to include in each batch. Actual batch + sizes may be lower. + placeholder: '' + defaultValue: 170000 + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + presets: [] - id: 64b67be0d0dd66094c162ca7 display_name: App Fit name: App Fit diff --git a/src/_data/catalog/regional-supported.yml b/src/_data/catalog/regional-supported.yml index caa1ff8457..6908ced4b9 100644 --- a/src/_data/catalog/regional-supported.yml +++ b/src/_data/catalog/regional-supported.yml @@ -93,6 +93,15 @@ sources: - us endpoints: - us + - id: T4gvCx0YNM + display_name: AppICETest + hidden: false + slug: appicetest + url: connections/sources/catalog/cloud-apps/appicetest + regions: + - us + endpoints: + - us - id: dZeHygTSD4 display_name: Apple hidden: false diff --git a/src/_data/catalog/slugs.yml b/src/_data/catalog/slugs.yml index 9437a26dad..a490319973 100644 --- a/src/_data/catalog/slugs.yml +++ b/src/_data/catalog/slugs.yml @@ -118,4 +118,6 @@ destinations: - original: "pardot-actions" override: "actions-pardot" - original: "airship-actions" - override: "actions-airship" \ No newline at end of file + override: "actions-airship" + - original: "algolia-insights-actions" + override: "actions-algolia-insights" \ No newline at end of file diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index d31a7a6c8b..d1ed0c86fc 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 categories last updated 2023-08-10 +# source categories last updated 2023-08-15 items: - display_name: A/B Testing slug: a-b-testing diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index 6c8d951297..8cabc0126a 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 2023-08-10 +# sources last updated 2023-08-15 items: - id: 8HWbgPTt3k display_name: .NET @@ -2271,7 +2271,12 @@ items: Unlocking Attribution takes all your usage data stored within Segment, joins it to your paid media spend data (such as Google and Meta) and determines which of your inbound channels are most effectively driving - your business. + your business. + + + Additionally, Unlocking Attribution lets you pull in paid media spend data + from other advertising platforms not already in Segment's base catalog, + such as LinkedIn, Capterra, Twitter/X. logo: url: https://cdn.filepicker.io/api/file/qkACXlPTS6i7AdJ98Yy3 categories: diff --git a/src/_data/catalog/test_sources.yml b/src/_data/catalog/test_sources.yml index fe5cd78417..be238726c6 100644 --- a/src/_data/catalog/test_sources.yml +++ b/src/_data/catalog/test_sources.yml @@ -35,3 +35,4 @@ - 5sm7ImJ0LJ - zZjAgSjgHi - VfR29KdimB +- T4gvCx0YNM \ No newline at end of file diff --git a/src/_includes/content/functions/runtime.md b/src/_includes/content/functions/runtime.md index febc2f490a..3790f49d02 100644 --- a/src/_includes/content/functions/runtime.md +++ b/src/_includes/content/functions/runtime.md @@ -1,4 +1,4 @@ -Beginning April 30, 2023, Functions is migrating from Node.js 14.x to Node.js 16.x. You're not required to take any further action. +As of April 30, 2023, Functions migrated from Node.js 14.x to Node.js 16.x. This change automatically takes effect as you update and deploy an existing function. All new functions use Node.js 16.x. Segment recommends you to check your function post-deployment to ensure everything's working.

Node.js 18.x:

Starting June 30, 2023, you can [contact Segment](https://segment.com/help/contact/){:target="_blank"} to migrate to Node.js 18.x.

diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_api_keys.png b/src/connections/destinations/catalog/actions-algolia-insights/images/algolia_api_keys.png similarity index 100% rename from src/connections/destinations/catalog/algolia-insights/images/algolia_api_keys.png rename to src/connections/destinations/catalog/actions-algolia-insights/images/algolia_api_keys.png diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_app_id_dropdown.png b/src/connections/destinations/catalog/actions-algolia-insights/images/algolia_app_id_dropdown.png similarity index 100% rename from src/connections/destinations/catalog/algolia-insights/images/algolia_app_id_dropdown.png rename to src/connections/destinations/catalog/actions-algolia-insights/images/algolia_app_id_dropdown.png diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_dashboard_settings.png b/src/connections/destinations/catalog/actions-algolia-insights/images/algolia_dashboard_settings.png similarity index 100% rename from src/connections/destinations/catalog/algolia-insights/images/algolia_dashboard_settings.png rename to src/connections/destinations/catalog/actions-algolia-insights/images/algolia_dashboard_settings.png diff --git a/src/connections/destinations/catalog/algolia-insights/images/algolia_settings_menu.png b/src/connections/destinations/catalog/actions-algolia-insights/images/algolia_settings_menu.png similarity index 100% rename from src/connections/destinations/catalog/algolia-insights/images/algolia_settings_menu.png rename to src/connections/destinations/catalog/actions-algolia-insights/images/algolia_settings_menu.png diff --git a/src/connections/destinations/catalog/algolia-insights/images/destination_settings.png b/src/connections/destinations/catalog/actions-algolia-insights/images/destination_settings.png similarity index 100% rename from src/connections/destinations/catalog/algolia-insights/images/destination_settings.png rename to src/connections/destinations/catalog/actions-algolia-insights/images/destination_settings.png diff --git a/src/connections/destinations/catalog/algolia-insights/images/mapping_tab.png b/src/connections/destinations/catalog/actions-algolia-insights/images/mapping_tab.png similarity index 100% rename from src/connections/destinations/catalog/algolia-insights/images/mapping_tab.png rename to src/connections/destinations/catalog/actions-algolia-insights/images/mapping_tab.png diff --git a/src/connections/destinations/catalog/algolia-insights/images/mapping_tab_edit.png b/src/connections/destinations/catalog/actions-algolia-insights/images/mapping_tab_edit.png similarity index 100% rename from src/connections/destinations/catalog/algolia-insights/images/mapping_tab_edit.png rename to src/connections/destinations/catalog/actions-algolia-insights/images/mapping_tab_edit.png diff --git a/src/connections/destinations/catalog/algolia-insights/images/rename_events.png b/src/connections/destinations/catalog/actions-algolia-insights/images/rename_events.png similarity index 100% rename from src/connections/destinations/catalog/algolia-insights/images/rename_events.png rename to src/connections/destinations/catalog/actions-algolia-insights/images/rename_events.png diff --git a/src/connections/destinations/catalog/algolia-insights/index.md b/src/connections/destinations/catalog/actions-algolia-insights/index.md similarity index 90% rename from src/connections/destinations/catalog/algolia-insights/index.md rename to src/connections/destinations/catalog/actions-algolia-insights/index.md index 004e1fc3e2..85f4ee80b3 100644 --- a/src/connections/destinations/catalog/algolia-insights/index.md +++ b/src/connections/destinations/catalog/actions-algolia-insights/index.md @@ -1,12 +1,11 @@ --- -title: Algolia Insights Destination +title: Algolia Insights (Actions) Destination rewrite: true redirect_from: - '/connections/destinations/catalog/algolia/' - - '/connections/destinations/catalog/actions-algolia-insights/' -id: 5d373a350abf930001a6b70f +id: 63e52bea7747fbc311d5b872 --- -This [Algolia Insights](https://www.algolia.com/products/analytics/) destination is a means of facilitating sending [Insights Events](https://www.algolia.com/doc/guides/sending-events/getting-started/). Sending these events is a required step for using several Algolia features: +With the [Algolia Insights (Actions)](https://www.algolia.com/products/analytics/){:target="_blank"} destination, you can send [Insights Events](https://www.algolia.com/doc/guides/sending-events/getting-started/){:target="_blank"}. It's required to send Insight Events to use these Algolia features: - Click and conversion analytics - A/B Testing diff --git a/src/connections/destinations/catalog/actions-liveramp-audiences/index.md b/src/connections/destinations/catalog/actions-liveramp-audiences/index.md new file mode 100644 index 0000000000..8103a3f751 --- /dev/null +++ b/src/connections/destinations/catalog/actions-liveramp-audiences/index.md @@ -0,0 +1,47 @@ +--- +title: LiveRamp Audiences Destination +hide-boilerplate: true +hide-dossier: false +id: 644ad6c6c4a87a3290450602 +private: true +hidden: true +--- + +[LiveRamp](https://liveramp.com/){:target="_blank"} gives companies and their partners the power to connect, control, and activate data to transform customer experiences and generate more valuable business outcomes. Segment's integration with LiveRamp enables you to push user audiences created in [Twilio Engage](https://www.twilio.com/en-us/engage){:target="_blank"} into your LiveRamp account to execute various marketing use cases. + +The LiveRamp Audiences destination allows users to connect their Engage Audiences to LiveRamp through their SFTP or a customer-managed S3 cloud storage bucket. Users will be able to configure their delivery preferences within Segment. + +The LiveRamp Audiences destination can be connected to **Twilio Engage sources only**. + +## Getting started + +### Setup your file drop + +#### SFTP +1. Contact your LiveRamp representative to gain a set of [SFTP](https://docs.liveramp.com/connect/en/upload-a-file-via-liveramp-s-sftp.html){:target="_blank"} credentials. +2. Connect to the SFTP server using the client of your choice, and create a new folder under `/uploads` with the name of your audience. + +#### S3 +1. Create a new S3 bucket. +2. Create a new IAM Role with `PutObject` access to the S3 bucket. +3. Create a new IAM User and assign them the role. +4. Generate a new Access Key pair for the user and note them down; you'll use it for the settings. + +### Connect LiveRamp Audiences +1. Create and configure your Engage Audience. +2. Navigate to **Engage > Engage Settings > Destinations** tab and click **Add Destination**. +3. Select **LiveRamp Audiences**, select your Audience Space as the source, and name your destination. +4. On the **Mappings** tab, click **Add Mapping** and choose whether your will be using S3 or SFTP to upload the files. Within the mapping, configure which fields from your payload will be included in the files. +5. Enable the destination and configured mappings. +6. On the **Engage > Audiences > (your audience)** page, click **Add Destination** and select the destination just created. +7. Disable *Send Identify* and Enable *Send Track*. Keep event names as they are. + +{% include components/actions-fields.html settings="false"%} + +## Limitations + +* Audience must have at least 25 unique members, otherwise the destination will fail and the data will not be synced. +* Audience sync happens once per day. +* Audience sync is a full sync. +* Files are created per audience. +* After initial ingestion is complete, changing the mappings will cause the LiveRamp ingestion to start failing until ingestion setup is run again. \ No newline at end of file diff --git a/src/connections/destinations/catalog/actions-snap-conversions/index.md b/src/connections/destinations/catalog/actions-snap-conversions/index.md index edd266b40a..e134377f04 100644 --- a/src/connections/destinations/catalog/actions-snap-conversions/index.md +++ b/src/connections/destinations/catalog/actions-snap-conversions/index.md @@ -36,6 +36,12 @@ The Snapchat Conversions API destination provides the following benefits: ## FAQ and Troubleshooting +### Invalid token error +If you're experiencing 400 Bad Requests errors related to an invalid token, follow [these instructions](https://segment.com/docs/connections/destinations/catalog/actions-snap-conversions/#getting-started) to reauthorize your account: +- On the **Settings** tab, authenticate with Snap using OAuth. +- Click **Connect to Snapchat Conversions API**. +- Follow the prompts to authenticate using OAuth with a Snapchat login. Use a Snapchat login that is a member of the Snapchat Ads account you want to connect. + ### Deduplication with the Snap Pixel or App Ads Kit (SDK) There are many ways to send conversion data to Snap, including through the Snap Pixel, App Ads Kit or Conversions API. Snap recommends sending redundant data across sources to ensure the best optimization, targeting, and measurement capabilities. The Client Deduplication ID, Transaction ID, and Mobile Ad Identifier are used by Snap to deduplicate events across sources. Please see below for guidance on when to use each field for deduplication. - **Web**: Snap Conversions API and PixeI diff --git a/src/connections/destinations/catalog/actions-tiktok-audiences/index.md b/src/connections/destinations/catalog/actions-tiktok-audiences/index.md index 4a46b63b56..19e7b8e0a1 100644 --- a/src/connections/destinations/catalog/actions-tiktok-audiences/index.md +++ b/src/connections/destinations/catalog/actions-tiktok-audiences/index.md @@ -21,6 +21,9 @@ By using Segment's TikTok Audiences destination, you can increase traffic and dr You must create an audience segment in your TikTok Advertising account. You can send Engage audiences to an existing audience segment, or create a new audience. Please note the `audience_id` as this is required to send Engage audiences to TikTok. +> warning "" +> You can only send audience data from Segment to a "Partner audience" custom audience in TikTok Ads Manager. While TikTok's UI doesn't allow you to select this custom audience type, you can use this destination's **Create Audience** mapping to create "Partner audience" custom audiences in TikTok. + #### Create a TikTok Audience To create an audience in Segment: diff --git a/src/connections/destinations/catalog/actions-webhook/index.md b/src/connections/destinations/catalog/actions-webhook/index.md index 270f71bd9a..3eaf83f345 100644 --- a/src/connections/destinations/catalog/actions-webhook/index.md +++ b/src/connections/destinations/catalog/actions-webhook/index.md @@ -23,3 +23,7 @@ Segment's Webhooks (Actions) destination uses internet protocol and HTTP callbac 7. Enable the destination and configured mappings. {% include components/actions-fields.html settings="true"%} + +## Batch size limits + +In Webhook Actions mapping, the default value of batch size is `1000`. You can change this value, but there's a maximum batch size limit of `4000`. diff --git a/src/connections/destinations/catalog/algolia-insights-actions/index.md b/src/connections/destinations/catalog/algolia-insights-actions/index.md deleted file mode 100644 index 960af0fc58..0000000000 --- a/src/connections/destinations/catalog/algolia-insights-actions/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: 'Algolia Insights (Actions) Destination' -hidden: true -id: 63e52bea7747fbc311d5b872 -published: false -beta: true ---- diff --git a/src/connections/destinations/catalog/customer-io/index.md b/src/connections/destinations/catalog/customer-io/index.md index edf246a72e..b982376b38 100644 --- a/src/connections/destinations/catalog/customer-io/index.md +++ b/src/connections/destinations/catalog/customer-io/index.md @@ -118,9 +118,9 @@ analytics.track('Clicked Button'); Track events send to Customer.io as `custom events`. In the Customer.io "Activity Logs", "Activity Type" sets to `event` and "Activity Name" sets to the event name. -## Device Token Set up +## Device token setup -Set `device.token` before you send the `Application Installed`, `Application Uninstalled`, or `Application Opened` events to Segment. +Set `device.token` before you send the `Application Installed`, `Application Uninstalled`, or `Application Opened` events to Segment. For more on why you'd want to send `device.token`, see Customer.io's [device token documentation](https://customer.io/docs/journeys/device-tokens/#what-is-a-device-token){:target="_blank"}. You'll likely need to extract this value from your push notification provider. For that, you need to make the following calls: diff --git a/src/connections/destinations/catalog/facebook-pixel/index.md b/src/connections/destinations/catalog/facebook-pixel/index.md index 05bf0907ed..df0a65485e 100644 --- a/src/connections/destinations/catalog/facebook-pixel/index.md +++ b/src/connections/destinations/catalog/facebook-pixel/index.md @@ -4,20 +4,20 @@ rewrite: true strat: facebook id: 5661eb58e954a874ca44cc07 --- -[Facebook Pixel](https://developers.facebook.com/docs/facebook-pixel) lets you measure and optimize the performance of your Facebook Ads. It makes conversion tracking, optimization and remarketing easier than ever. The Facebook Pixel Destination is open-source. You can browse the code [on GitHub](https://github.com/segment-integrations/analytics.js-integration-facebook-pixel). +[Facebook Pixel](https://developers.facebook.com/docs/facebook-pixel) lets you measure and optimize the performance of your Facebook Ads, making conversion tracking, optimization and remarketing easier than ever. The Facebook Pixel Destination is open-source. You can browse the code [on GitHub](https://github.com/segment-integrations/analytics.js-integration-facebook-pixel){:target="_blank"}. > warning "" -> Facebook has deprecated the modular "Ads For Websites" suite, which previously comprised Facebook Custom Audiences and Facebook Conversion Tracking. We've consolidated those two destinations into this new and improved "Facebook Pixel" destination. +> Facebook deprecated the modular Ads For Websites suite, which previously comprised Facebook Custom Audiences and Facebook Conversion Tracking. Segment consolidated those two destinations into this new and improved Facebook Pixel destination. **Use Cases** -* [Increase conversions by retargeting shopping cart abandoners on Facebook](https://segment.com/recipes/abandon-cart-retargeting-facebook/) +* [Increase conversions by retargeting shopping cart abandoners on Facebook](https://segment.com/recipes/abandon-cart-retargeting-facebook/){:target="_blank"} -## Other Facebook Destinations Supported by Segment -This page is about the **Facebook Pixel**. For documentation on other Facebook destinations, see the pages linked below. +## Other Facebook Destinations supported by Segment +This page is about the **Facebook Pixel** destination. For documentation on other Facebook destinations, see the pages linked below. | **Facebook Destination** | Supported by Engage | | ----------------------------------------------------------------------------------------------------------- | ------------------- | @@ -28,13 +28,11 @@ This page is about the **Facebook Pixel**. For documentation on other Facebook d | **[Facebook Conversions API](/docs/connections/destinations/catalog/actions-facebook-conversions-api/)** | Yes | -## Getting Started - - +## Getting started 1. From the Segment web app, click **Catalog**. 2. Search for "Facebook Pixel" in the Catalog, select it, and choose which of your sources to connect the destination to. -3. In the destination settings, enter your `pixelId` from the [Pixels tab in Facebook Ads Manager](https://www.facebook.com/ads/manager/pixel/facebook_pixel). +3. In the destination settings, enter your `pixelId` from the [Pixels tab in Facebook Ads Manager](https://www.facebook.com/ads/manager/pixel/facebook_pixel){:target="_blank"}. When you enable Facebook Pixel as a destination in your Segment workspace, Segment automatically initializes Facebook's pixel with your `pixelId` upon loading `analytics.js`. This means you should remove the native Facebook script from your page. @@ -46,7 +44,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th analytics.page(); ``` -Segment maps `analytics.page()` to Facebook's `fbq('track', "PageView")` method and will forward all page views accordingly. Note that the integration will ignore any parameters you pass to `analytics.page()`. +Segment maps `analytics.page()` to Facebook's `fbq('track', "PageView")` method and will forward all page views accordingly. The integration will ignore any parameters you pass to `analytics.page()`. ## Identify @@ -79,9 +77,9 @@ analytics.track("My Custom Event", { }); ``` -On our analytics.js client-side integration we support all three [documented](https://developers.facebook.com/docs/facebook-pixel/api-reference#events) methods of sending events to Facebook. +Segment's analytics.js client-side integration supports all three [documented](https://developers.facebook.com/docs/facebook-pixel/api-reference#events){:target="_blank"} methods of sending events to Facebook. -At any time, you can define a custom `contentType` on the integration options. If the value is present, it will take +At any time, you can define a custom `contentType` on the integration options. If the value is present, it takes precedence over any other setting or default value. ```javascript @@ -99,23 +97,22 @@ analytics.track('Checkout Started', { ); ``` -### Standard Events +### Standard events -To send *Standard* events, use the Segment destination setting labeled "Map Your Events to Standard FB Events". Then, any time Segment receives one of the events in that mapping, it will be sent to Facebook as the standard event you specified. All properties you included in the event will be sent as event properties. You can find documentation on these events [here](https://developers.facebook.com/docs/facebook-pixel/implementation/conversion-tracking/#standard-events). +To send *Standard* events, use the Segment destination setting labeled "Map Your Events to Standard FB Events". Then, any time Segment receives one of the events in that mapping, it will be sent to Facebook as the standard event you specified. All properties you included in the event will be sent as event properties. For more information, view [Meta's conversion tracking documentation](https://developers.facebook.com/docs/facebook-pixel/implementation/conversion-tracking/#standard-events){:target="_blank"}. -In addition, Segment will specially handle the following event types and send them as Standard events: +In addition, Segment sends the following event types as Standard events: -- "Order Completed" will be sent as "Purchase" -- "Product Added" will be sent as "AddToCart" -- "Product List Viewed" will be sent as "ViewContent" -- "Product Viewed" will be sent as "ViewContent" -- "Products Searched" will be sent as "Search" -- "Checkout Started" will be sent as "InitiateCheckout" +- `Order Completed`, which Segment sends as `Purchase` +- `Product Added`, which Segment sends as `AddToCart` +- `Product List Viewed`, which Segment sends as `ViewContent` +- `Product Viewed`, which Segment sends as `ViewContent` +- `Products Searched`, which Segment sends as `Search` +- `Checkout Started`, which Segment sends as `InitiateCheckout` -Facebook requires a currency for "Purchase" events -- if you leave it out, Segment will set a default value of "USD". +Facebook requires a currency for `Purchase` events. If you leave it out a currency, Segment will set a default value of `USD`. -You can set custom properties for the events listed above. Use the setting "Standard Events custom properties" to list -all the properties you want to send. +You can set custom properties for the events listed above. Use the setting "Standard Events custom properties" to list all the properties you want to send. Here is how you'd specify standard events in the settings view: @@ -123,17 +120,17 @@ Here is how you'd specify standard events in the settings view: You can map more than one Track event to the same Facebook standard event. -### Legacy Events +### Legacy events -To send *Legacy Conversion* events, use the Segment setting called "Legacy Conversion Pixel IDs". Any events that appear in that mapping will be sent to Facebook with the specified Pixel ID used as the Facebook Pixel `eventName`. Conversion events only support `currency` and `value` as event properties, so only these will be associated with the event. `currency` will default to "USD" if left out. +To send *Legacy Conversion* events, use the Segment setting called "Legacy Conversion Pixel IDs". Any events that appear in that mapping will be sent to Facebook with the specified Pixel ID used as the Facebook Pixel `eventName`. Conversion events only support `currency` and `value` as event properties, so only these will be associated with the event. `currency` will default to `USD` if left out. -### Custom Events +### Custom events -To send *Custom* events, send any event that does not appear in either mapping. All properties you include in the event are included as event properties. Any events you don't add to the "Map Your Events to Standard FB Events" setting are sent to Facebook as a custom event. There is no setting to add custom events in the Facebook Pixel Destination configuration. +To send *Custom* events, send any event that does not appear in either mapping. All properties you include in the event are included as event properties. Segment sends any events you don't add to the "Map Your Events to Standard FB Events" setting to Facebook as a custom event. There is no setting to add custom events in the Facebook Pixel Destination configuration. ### Timestamps -Facebook Pixel uses a custom timestamp format: an ISO 8601 timestamp without timezone information. For the following event fields, if you pass in a JavaScript `Date` object, it will be converted to this custom format. If you pass in a string, it is assumed that the string is already formatted as Facebook expects: +Facebook Pixel uses a custom timestamp format: an ISO 8601 timestamp without timezone information. For the following event fields, if you pass in a JavaScript `Date` object, it will be converted to this custom format. If you pass in a string, Segment assumes that the string is already formatted as Facebook expects: - `checkinDate` - `checkoutDate` @@ -144,9 +141,9 @@ Facebook Pixel uses a custom timestamp format: an ISO 8601 timestamp without tim - `travelEnd` - `travelStart` -### Advanced Matching +### Advanced matching -The Segment Facebook Pixel integration supports [Advanced Matching](https://developers.facebook.com/docs/facebook-pixel/advanced/advanced-matching) which enables you to send your customer data through the pixel to match more website actions with Facebook users. With this additional data, you can report and optimize your ads for more conversions and build larger re-marketing audiences. When the page loads, before we fire off the pixels, we'll check for traits that the user has been previously identified with and send that along with each call. +The Segment Facebook Pixel integration supports [Advanced Matching](https://developers.facebook.com/docs/facebook-pixel/advanced/advanced-matching){:target="_blank"}, which enables you to send your customer data through the pixel to match more website actions with Facebook users. With this additional data, you can report and optimize your ads for more conversions and build larger re-marketing audiences. When the page loads, and before Segment fires off the pixels, Segment checks for traits that the user has been previously identified with and sends that along with each call. Facebook accepts the following properties: @@ -162,23 +159,23 @@ Facebook accepts the following properties: If you follow Segment's [spec](/docs/connections/spec/identify/#traits), these properties send in the correct format. -When you use Advanced Matching, Facebook also accepts an External ID. This can be any unique ID from the advertiser, like loyalty membership IDs, user IDs, and external cookie IDs. To send an `external_id` to Facebook you can either: +When you use Advanced Matching, Facebook also accepts an `external_id`. This can be any unique ID from the advertiser, like loyalty membership IDs, user IDs, and external cookie IDs. To send an `external_id` to Facebook you can either: - Send the Segment `userId` or `anonymousId` as `external_id` using the **Use User ID or Anonymous ID as External ID** setting - Indicate which user trait you would like Segment to map to `external_id` using the **Advanced Match Trait Key for External ID** setting -## Limited Data Use +## Limited data use {% include content/facebook-ldu-intro.md %} > info "" -> The **Use Limited Data Use** destination setting is disabled by default for all Facebook destinations except for Facebook Pixel. This must be enabled manually from the destination settings if you're using other Facebook destinations. +> The **Use Limited Data Use** destination setting is disabled by default for all Facebook destinations except for Facebook Pixel. You must enable the setting manually from the destination settings if you're using other Facebook destinations. {% include content/facebook-ldu-params.md %} -Facebook uses the `context.ip` to determine the geolocation of the event. +Facebook uses `context.ip` to determine event geolocation. -You can manually change the Data Processing parameters by adding settings to the `integrations` object. For Facebook Pixel, you must store these settings in the [Load object](/docs/connections/sources/catalog/libraries/website/javascript/#load-options) so that Segment can set them *before* it calls `init`. The example below shows how you might set custom Data Processing parameters in Analytics.js. +You can manually change the Data Processing parameters by adding settings to the `integrations` object. For Facebook Pixel, you must store these settings in the [Load object](/docs/connections/sources/catalog/libraries/website/javascript/#load-options) so that Segment can set them *before* it calls `init`. The following example shows how you might set custom Data Processing parameters in Analytics.js. ```javascript analytics.load("replace_with_your_write_key", { @@ -190,19 +187,17 @@ analytics.load("replace_with_your_write_key", { }); ``` -## Settings - -### Map Categories to FB Content Types +## Map categories to Facebook content types -If you're using real estate, travel, or automotive [Dynamic Ads](https://www.facebook.com/business/learn/facebook-create-ad-dynamic-ads) you can map `category` values to `content_type` values. For example, you might map the category "cars" to the "vehicle" content type so Facebook promotes relevant vehicles from your catalog. To understand which content types you can map to, consult the [Facebook Dynamic Ads](https://developers.facebook.com/docs/marketing-api/dynamic-ad) documentation. +If you're using real estate, travel, or automotive [Dynamic Ads](https://www.facebook.com/business/learn/facebook-create-ad-dynamic-ads){:target="_blank"} you can map `category` values to `content_type` values. For example, you might map the category "cars" to the "vehicle" content type so Facebook promotes relevant vehicles from your catalog. To understand which content types you can map to, consult the [Facebook Dynamic Ads documentation](https://developers.facebook.com/docs/marketing-api/dynamic-ad){:target="_blank"}. -For most implementations we recommend leaving these mappings blank. By default, we'll set `content_type` to "product". +For most implementations, Segment recommends leaving these mappings blank. By default, Segment sets `content_type` to "product". ## Troubleshooting -### PII Blocklisting +### PII blocklisting -Facebook enforces strict guidelines around sending Personally Identifiable Information (PII) as properties of Pixel events. In order to adhere to these guidelines, Segment will automatically scan `track` event properties for PII and remove any that get flagged from the event to Facebook. The following keys are currently filtered: +Facebook enforces strict guidelines around sending Personally Identifiable Information (PII) as properties of Pixel events. To adhere to these guidelines, Segment automatically scans `track` event properties for PII and removes any that get flagged from the event to Facebook. The following keys are currently filtered: - email - firstName @@ -219,24 +214,24 @@ Any `track` events with properties containing those keys will be sent to Faceboo If you have events that use any of those keys for non-PII properties, you can manually allowlist them using the **Allowlist PII Properties** setting. You may also add to this list and/or optionally hash blocklisted properties with the **Blocklist PII Properties** setting. -### Inconsistent or Missing Conversions +### Inconsistent or missing conversions -The most common reason for Facebook conversion pixels to fire inconsistently is that the page redirects or reloads before the pixel has time to be loaded on the page. Make sure your page does not redirect or reload for at least 300ms after the conversion event happens. In some cases a delay of 500ms is necessary. +Facebook conversion pixels can fire inconsistently due to page redirects or reloads before the pixel has finished loading on the page. Make sure your page doesn't redirect or reload for at least 300ms after the conversion event happens. In some cases a delay of 500ms is necessary. -We recommend using our `trackLink` or `trackForm` helpers to delay the page redirect. [Documentation here](/docs/connections/sources/catalog/libraries/website/javascript#track-link). You can extend the delay by [setting the timeout to 500ms](/docs/connections/sources/catalog/libraries/website/javascript#extending-timeout). +Segment recommends using the `trackLink` or `trackForm` helpers to delay the page redirect. For more on these methods, view [the track link documentation](/docs/connections/sources/catalog/libraries/website/javascript#track-link). You can extend the delay by [setting the timeout to 500ms](/docs/connections/sources/catalog/libraries/website/javascript#extending-timeout). -### Extra or Duplicate Conversions +### Extra or duplicate conversions -This may be due to conversion events being sent from your development, staging, or testing environments. We recommend setting up separate source for each environment. That way you can either point events to test conversion pixels in Facebook Conversion Tracking or turn off Facebook Conversion Tracking completely in non-production environments. +This may be due to conversion events being sent from your development, staging, or testing environments. Segment recommends setting up separate sources for each environment, which will let you either point events to test conversion pixels in Facebook Conversion Tracking or turn off Facebook Conversion Tracking completely in non-production environments. -Double check that your mapped conversion events aren't happening anywhere else on your site. If the user reloads the conversion page or re-triggers the tracked event they may be double counted. +Double check that your mapped conversion events aren't happening anywhere else on your site. If the user reloads the conversion page or re-triggers the tracked event, they may be double counted. Facebook's conversion reports count view-through conversions as well as click-through conversions by default. You can change that setting inside Facebook Conversion Tracking in the report attribution settings. -### Facebook Conversions Not Matching Google Analytics +### Facebook conversions not matching Google Analytics Facebook counts conversions per person, as opposed to Google Analytics which counts per browser cookie session (unless you're using [Google Analytics User-ID](/docs/connections/destinations/catalog/google-analytics/#user-id)). -If someone saw or clicked on your ad on a mobile phone then later came back directly to purchase on a desktop machine Google Analytics wouldn't know that this was the same person, but Facebook would. In that scenario Google Analytics counts 2 unique visits with a conversion last attributed to a direct visit on desktop. Facebook counts one conversion with the conversion properly attributed to the last ad click/view on mobile. +If someone saw or clicked on your ad on a mobile phone then later came back directly to purchase on a desktop machine, Google Analytics wouldn't know that this was the same person, but Facebook would. In that scenario, Google Analytics would count two unique visits with a conversion last attributed to a direct visit on desktop. Facebook would count one conversion with the conversion properly attributed to the last ad click/view on mobile. -{% include content/client-side-script-unverified.md %} +{% include content/client-side-script-unverified.md %} \ No newline at end of file diff --git a/src/connections/destinations/catalog/humanic-ai/index.md b/src/connections/destinations/catalog/humanic-ai/index.md index 103e5c89e6..027a7d624a 100644 --- a/src/connections/destinations/catalog/humanic-ai/index.md +++ b/src/connections/destinations/catalog/humanic-ai/index.md @@ -1,7 +1,7 @@ --- title: Humanic AI Destination id: 64b0e177091331e4a2a00c83 -___ +--- [Humanic AI](https://humanic.ai/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is revolutionizing the CRM space to make it easier than ever for growing companies to maximize revenue from their existing users. Humanic is the industry's first PLG CRM for today’s modern revenue teams. With support from top industry veterans at DoorDash, Notion, Miro, Canvas, MailChimp and more - there's no better time explore what Humanic can offer your business. diff --git a/src/connections/functions/insert-functions.md b/src/connections/functions/insert-functions.md index 388cb913a1..43359bf7f6 100644 --- a/src/connections/functions/insert-functions.md +++ b/src/connections/functions/insert-functions.md @@ -164,6 +164,14 @@ If you don't supply a function for an event type, Segment throws an `EventNotSup You can read more about [error handling](#destination-insert-functions-logs-and-errors) below. +## Insert Functions and Actions destinations + +There are a couple of behavorial nuances to consider when using Insert Functions with Actions destinations. + +Insert Functions block Actions destinations from triggering multiple mapping subscriptions for a single payload. If you have a single payload coming through the pipeline that you expect to trigger multiple mapping subscriptions in your configuration, it will work as expected without an Insert Function enabled. With an Insert Function enabled, however, when a payload that is meant to trigger multiple mappings subscriptions is seen, no mappings subscriptions will fire. If you have an Insert Function enabled for a destination, make sure that you configure your payloads so that they only trigger a single mapping subscription. + +A payload must also come into the pipeline with the attributes that allow it to match your mapping triggers. You can't use an Insert Function to change the event to match your mapping triggers. If an event comes into an Actions destination and already matches a mapping trigger, that mapping subscription will fire. If a payload doesn't come to the Actions destination matching a mapping trigger, even if an Insert Function is meant to alter the event to allow it to match a trigger, it won't fire that mapping subscription. Segment sees the mapping trigger first in the pipeline, so a payload won't make it to the Insert Function at all if it doesn't come into the pipeline matching a mapping trigger. + ## Create settings and secrets {% include content/functions/settings.md %} @@ -311,10 +319,6 @@ No, destination insert functions are currently available as cloud-mode destinati If you are a partner, looking to publish your destination and distribute your app through Segment catalog, visit the [Developer Center](https://segment.com/partners/developer-center/){:target="_blank"} and check out the Segment [partner docs](/docs/partners/). -##### Are there any nuances to consider in using Insert Functions with Actions destinations? - -Yes. Without Insert Functions enabled, a single event could trigger multiple mappings. With Insert Functions enabled, though, events only trigger one Actions mapping, even if more than one mapping is set up to run when a particular event is seen. - {% comment %} diff --git a/src/connections/sources/catalog/libraries/website/javascript/index.md b/src/connections/sources/catalog/libraries/website/javascript/index.md index 1cf9738e6b..ecad474185 100644 --- a/src/connections/sources/catalog/libraries/website/javascript/index.md +++ b/src/connections/sources/catalog/libraries/website/javascript/index.md @@ -654,16 +654,20 @@ Though middlewares function the same as plugins, it's best to use plugins as the ### Plugin categories Plugins are bound by Analytics 2.0 which handles operations such as observability, retries, and error handling. There are two different categories of plugins: * **Critical Plugins**: Analytics.js expects this plugin to be loaded before starting event delivery. Failure to load a critical plugin halts event delivery. Use this category sparingly, and only for plugins that are critical to your tracking. + +| Type | Details | +| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `before` | Executes before event processing begins. These are plugins that run before any other plugins run.

For example, validating events before passing them along to other plugins. A failure here could halt the event pipeline.

See the example of how Analytics.js uses the [Event Validation plugin](https://github.com/segmentio/analytics-next/blob/master/packages/browser/src/plugins/validation/index.ts){:target="_blank"} to verify that every event has the correct shape. | + * **Non-critical Plugins**: Analytics.js can start event delivery before this plugin finishes loading. This means your plugin can fail to load independently from all other plugins. For example, every Analytics.js destination is a non-critical plugin. This makes it possible for Analytics.js to continue working if a partner destination fails to load, or if users have ad blockers turned on that are targeting specific destinations. > info "" > Non-critical plugins are only non-critical from a loading standpoint. For example, if the `before` plugin crashes, this can still halt the event delivery pipeline. -Non-critical plugins run through a timeline that executes in order of insertion based on the entry type. Segment has these five entry types of non-critical plugins: +Non-critical plugins run through a timeline that executes in order of insertion based on the entry type. Segment has these four entry types of non-critical plugins: | Type | Details | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `before` | Executes before event processing begins. These are plugins that run before any other plugins run.

For example, validating events before passing them along to other plugins. A failure here could halt the event pipeline.

See the example of how Analytics.js uses the [Event Validation plugin](https://github.com/segmentio/analytics-next/blob/master/packages/browser/src/plugins/validation/index.ts){:target="_blank"} to verify that every event has the correct shape. | | `enrichment` | Executes as the first level of event processing. These plugins modify an event.

See the example of how Analytics.js uses the [Page Enrichment plugin](https://github.com/segmentio/analytics-next/blob/master/packages/browser/src/plugins/page-enrichment/index.ts){:target="_blank"} to enrich every event with page information. | | `destination` | Executes as events begin to pass off to destinations.

This doesn't modify the event outside of the specific destination, and failure doesn't halt the execution. | | `after` | Executes after all event processing completes. You can use this to perform cleanup operations.

An example of this is the [Segment.io Plugin](https://github.com/segmentio/analytics-next/blob/master/packages/browser/src/plugins/segmentio/index.ts){:target="_blank"} which waits for destinations to succeed or fail so it can send it observability metrics. | diff --git a/src/connections/test-connections.md b/src/connections/test-connections.md index a7455fd321..a3a1e784d8 100644 --- a/src/connections/test-connections.md +++ b/src/connections/test-connections.md @@ -49,10 +49,14 @@ If you are receiving an error and are unsure how to fix the issue, visit the par ## FAQ -**Why can't I see the Event Tester when I log into my workspace?** +#### Why can't I see the Event Tester when I log into my workspace? The Event Tester is only accessible to users with write access in their Segment workspace (read-only users will not see the Event Tester in their workspace).  -**The Event Tester experienced an error when sending my event. Why did this happen?** +#### The Event Tester experienced an error when sending my event. Why did this happen? If you experience an error, [let Segment know](mailto:friends@segment.com) and the Segment team will help you troubleshoot the issue. + +#### Is this feature available for Data Lakes? + +The Event Tester is not available for Data Lakes. diff --git a/src/engage/audiences/index.md b/src/engage/audiences/index.md index 5e10055d9a..e6767db045 100644 --- a/src/engage/audiences/index.md +++ b/src/engage/audiences/index.md @@ -20,7 +20,12 @@ You can build an Audience from existing events, traits, computed traits, or othe ### Events -You can build an Audience from any events that are connected to Engage, including [Track](/docs/connections/spec/track), [Page](/docs/connections/spec/page), and [Screen](/docs/connections/spec/screen) calls. You can use the `property` button to refine the audience on specific event properties, as well. Select `and not who` to indicate users that have not performed an event. For example, you might want to look at all users that have viewed a product above a certain price point but not completed the order. +You can build an Audience from any events that are connected to Engage, including [Track](/docs/connections/spec/track), [Page](/docs/connections/spec/page), and [Screen](/docs/connections/spec/screen) calls. You can use the `property` button to refine the audience on specific event properties, as well. + +> info "" +> The Audience builder doesn't return every property value in the Constant value or Traits drop-downs. Segment displays a portion of values from the incoming data stream. However, if you don't see the value you're looking for, you can manually enter it. + +Select `and not who` to indicate users that have not performed an event. For example, you might want to look at all users that have viewed a product above a certain price point but not completed the order. ![Creating an Audience of users who viewed a product without buying it](/docs/engage/images/audience_builder.png) diff --git a/src/engage/audiences/sql-traits.md b/src/engage/audiences/sql-traits.md index 0a93e821c2..16cdf61e08 100644 --- a/src/engage/audiences/sql-traits.md +++ b/src/engage/audiences/sql-traits.md @@ -191,9 +191,9 @@ You can query based on `email`, `user_id`, or `anonymous_id`. If Segment doesn't Yes. The Engage engine sends an identify call if there is no match between the identifier you chose and an existing record. When this happens, Segment creates a new user profile. This identify call takes place in the back-end and doesn't show up in your Debugger. -### Does Engage send identify/group calls on every run? +### Does Engage send identify/track/group calls on every run? -No. Engage only sends an identify/group call if the values in a row have changed from previous runs. +No. Engage only sends an identify/track/group call if the values in a row have changed from previous runs. ### I have a large (1M+) query of users to import, should I be worried? diff --git a/src/engage/profiles/csv-upload.md b/src/engage/profiles/csv-upload.md index e39b46d0c6..5293954dc9 100644 --- a/src/engage/profiles/csv-upload.md +++ b/src/engage/profiles/csv-upload.md @@ -9,7 +9,11 @@ When you upload a CSV file, Engage adds new profiles and updates existing user p You can also [set subscription states](#set-user-subscriptions) for each email and phone number that you upload in the CSV. Subscription states help you track which email addresses and numbers you have permission to market to. > warning "" -> Uploading a CSV creates new profiles and updates existing profiles. These profile updates may lead to users entering existing audiences or message campaigns. +> Uploading a CSV creates new profiles and updates existing profiles. These profile updates may lead to users entering existing audiences or message campaigns. + +> info "" +> Using the CSV Uploader to upload user profiles to Engage will **not** increase your MTUs count. [Learn more](/docs/guides/usage-and-billing/mtus-and-throughput/#mtus-and-engage) about MTUs and Engage. + ## Upload a CSV file diff --git a/templates/partners/direct-destination.md b/templates/partners/direct-destination.md index 2d5ee30e44..3f4dc42baa 100644 --- a/templates/partners/direct-destination.md +++ b/templates/partners/direct-destination.md @@ -41,11 +41,7 @@ This destination is maintained by YOURINTEGRATION. For any issues with the desti > Update your company name (x2) and support email address. -## Getting Started - -> Do not remove this line. It will auto-populate the following information for your integration: - -{% include content/connection-modes.md %} +## Getting started > Include clear, succinct steps including hyperlinks to where customers can locate their API Key in your app. If there is an expected delay for a customer to see data flow into your integration, please make that explicit. @@ -114,4 +110,4 @@ Segment sends Track calls to YOURINTEGRATION as a `track` event. --- -> Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team via your designated Slack Channel and we’ll respond with updates when we publish it and your integration! \ No newline at end of file +> Congratulations! 🎉 You’ve finished the documentation for your Segment integration. If there’s any additional information or nuance which did not fit in the above template and that you want to share with our mutual customers, feel free to include these as a separate section for us to review. If not, you may now submit this doc to our team via your designated Slack Channel and we’ll respond with updates when we publish it and your integration!