diff --git a/scripts/catalog.js b/scripts/catalog.js index 9c1a31869b..b7979ca336 100644 --- a/scripts/catalog.js +++ b/scripts/catalog.js @@ -235,7 +235,23 @@ const updateDestinations = async () => { }) let url = `connections/destinations/catalog/${slug}` - + + let settings = destination.settings + settings.sort((a, b) => { + if(a.name < b.name) { return -1; } + if(a.name > b.name) { return 1; } + return 0; + }) + settings.forEach(setting => { + if (setting.settings.length > 0) { + setting.settings.sort((a, b) => { + if(a.name < b.name) { return -1; } + if(a.name > b.name) { return 1; } + return 0; + }) + } + }) + let updatedDestination = { display_name: destination.display_name, slug, @@ -255,7 +271,7 @@ const updateDestinations = async () => { platforms: destination.platforms, browserUnbundlingSupported: destination.browserUnbundlingSupported, browserUnbundlingPublic: destination.browserUnbundlingPublic, - settings: destination.settings, + settings, connection_modes, previous_names: destination.previous_names } diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index cc468ae3f0..01f0769683 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# destination categories last updated 2020-01-22 +# destination categories last updated 2020-01-28 items: - display_name: Email Marketing slug: email-marketing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 23c6e69fd6..1aeeec9aaf 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# destination data last updated 2020-01-22 +# destination data last updated 2020-01-28 items: - display_name: ActiveCampaign slug: activecampaign @@ -381,23 +381,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: setEventBufferingEnabled - display_name: Buffer and batch events sent to Adjust - type: BOOLEAN - deprecated: false - required: false - description: >- - **Device Mode Only**: This will save battery life by buffering and - batching events sent to Adjust. But during development it's nicer to see - events come through immediately. - settings: [] - - name: trackAttributionData - display_name: Track Attribution Data - type: BOOLEAN - deprecated: false - required: false - description: Send Adjust Attribution data to Segment and other tools as a `track` call. - settings: [] - name: appToken display_name: App Token type: STRING @@ -455,6 +438,23 @@ items: This will send all your data to your production environment on Adjust. If unchecked, data will flow to your sandbox environment on Adjust. settings: [] + - name: setEventBufferingEnabled + display_name: Buffer and batch events sent to Adjust + type: BOOLEAN + deprecated: false + required: false + description: >- + **Device Mode Only**: This will save battery life by buffering and + batching events sent to Adjust. But during development it's nicer to see + events come through immediately. + settings: [] + - name: trackAttributionData + display_name: Track Attribution Data + type: BOOLEAN + deprecated: false + required: false + description: Send Adjust Attribution data to Segment and other tools as a `track` call. + settings: [] connection_modes: device: web: false @@ -496,41 +496,14 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: reportSuiteId - display_name: Report Suite ID(s) - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your Report Suite ID in your Adobe Analytics Settings page. - Multiple report suite ids can be separated by commas: - `suite1,suite2,suite3`. - settings: [] - - name: trackingServerSecureUrl - display_name: Tracking Server Secure URL - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: This is the secure URL of your Adobe Analytics server. - settings: [] - - name: productIdentifier - display_name: Product Identifier - type: SELECT + - name: addBuildToAppId + display_name: Add application build to Adobe's App ID + type: BOOLEAN deprecated: false required: false - select_validators: - select_options: - - name - - sku - - id description: >- - Adobe Analytics only accepts a single [product - identifier](https://marketing.adobe.com/resources/help/en_US/sc/implement/products.html). - Use this option to choose whether we send product `name`, `id`, or `sku`. + If this setting is enable, we will add `context.app.build`, if present, to + Adobe's AppID, as ` ()`. settings: [] - name: contextValues display_name: Context Data Variables @@ -565,113 +538,127 @@ items: If you would like to prefix your Segment properties before sending them as contextData, enter a prefix here. settings: [] - - name: events - display_name: Events - type: MIXED - deprecated: false - required: false - description: Map your Segment events to custom Adobe events. - settings: [] - - name: props - display_name: Props + - name: customDelimiter + display_name: 'List Variable and Prop Custom Delimiter: Server-Side Only ' type: MAP deprecated: false required: false map_validators: regexp: '' min: 0 - max: 150 - map_prefix: prop - select_options: [] + max: 0 + map_prefix: '' + select_options: + - '|' + - ',' + - ':' + - ; + - / description: >- - Map your Adobe Analytics property names to the property names you’re using - in your Segment events. Enter a Segment property name on the left and an - Adobe Analytics property number on the right. You can view your Segment - events and properties in your Schema. + Add a custom delimiter to concatenate Adobe Analytics lVars or props sent + as an array. Note, if you do not specify a custom delimiter, arrays will + be concatenated with a comma. Please add the Adobe Analytics lVar or prop + on the left and select a custom delimiter on the right. lVars must be in + format 'list1', 'list2', etc. and props in format 'prop1', 'prop2', etc. + Must be all lowercase with no whitespace. settings: [] - - name: timestampOption - display_name: Timestamp Option - type: SELECT + - name: disableVisitorId + display_name: Drop Visitor ID + type: BOOLEAN deprecated: false required: false - select_validators: - select_options: - - enabled - - disabled - - hybrid - description: >- - Adobe Analytics can have Report Suites that will accept timestamped, - non-timestamped or hybrid data. Note that we can only play historical - data for timestamped or hybrid Report Suites. + description: This will disable Visitor ID from being passed to Adobe. settings: [] - - name: useSecureServerUrl - display_name: Use Secure URL for Server-side - type: BOOLEAN + - name: eVars + display_name: eVars + type: MAP deprecated: false required: false + map_validators: + regexp: '' + min: 0 + max: 250 + map_prefix: eVar + select_options: [] description: >- - Enable this option if you want to use the 'Tracking Server Secure URL' - endpoint instead of the normal URL for server-side and Cloud Mode calls. + Map your Adobe Analytics eVar names to the property names you’re using in + your Segment events. Enter a Segment property name on the left and an + Adobe Analytics eVar number on the right. You can view your Segment events + and properties in your Schema. settings: [] - - name: addBuildToAppId - display_name: Add application build to Adobe's App ID + - name: enableTrackPageName + display_name: Enable pageName for Track Events type: BOOLEAN deprecated: false required: false description: >- - If this setting is enable, we will add `context.app.build`, if present, to - Adobe's AppID, as ` ()`. + If you do not want to attach `pageName` for your `.track()` calls, you can + disable this option. settings: [] - - name: disableVisitorId - display_name: Drop Visitor ID - type: BOOLEAN + - name: events + display_name: Events + type: MIXED deprecated: false required: false - description: This will disable Visitor ID from being passed to Adobe. + description: Map your Segment events to custom Adobe events. settings: [] - - name: ssl - display_name: SSL - type: BOOLEAN + - name: eventsV2 + display_name: Events V2 (Bundled Mobile Only) + type: MAP deprecated: false required: false description: >- - Check this box if you would like your Adobe Heartbeat calls to be made - over HTTPS. + **Note**: If you are bundling our Adobe Analytics SDK on your mobile + device, you should map your events here. If you are sending via server + side you should use the `Events` option instead. Map your Adobe Analytics + property names on the left to Adobe event names on the right. Your events + MUST be set up in Adobe and mapped here in order to to be forwarded to the + destination. This setting only applies to Mobile integrations with Adobe. settings: [] - - name: utf8Charset - display_name: Use UTF-8 Charset - type: BOOLEAN + - name: hVars + display_name: Hierarchy Variables + type: MAP deprecated: false required: false + map_validators: + regexp: '' + min: 0 + max: 5 + map_prefix: hier + select_options: [] description: >- - Only applicable on server-side or cloud-mode. If this setting is enabled, - we will send the payload to Adobe Analytics with UTF-8 charset. Useful - when your events contains accents or other special characters. + Map your Adobe Analytics hVars to the property names you’re using in your + Segment page calls. Enter a Segment property name on the left and an Adobe + Analytics hVar number on the right. You can view your Segment page calls + and properties in your Schema. settings: [] - - name: preferVisitorId - display_name: Prefer VisitorID for Hybrid Timestamp Reporting - type: BOOLEAN + - name: heartbeatTrackingServerUrl + display_name: Heartbeat Tracking Server URL + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - If you enable this option and you also have a *Timestamp Optional* - reporting suite, you can opt to send your visitorID instead of the - timestamp since Adobe does not allow you to send both. If you care more - about your user attribution, you should enable this if you're using a - hybrid timestamp reporting suite. + This is the URL of your Adobe Heartbeat server. Please contact Adobe to + obtain this URL. settings: [] - - name: sendBothTimestampVisitorId - display_name: Send Both Timestamp and VisitorID for Timestamp Optional Reporting Suites - type: BOOLEAN + - name: lVars + display_name: List Variables + type: MAP deprecated: false required: false + map_validators: + regexp: '' + min: 0 + max: 3 + map_prefix: list + select_options: [] description: >- - If you have a *Timestamp Optional* Reporting Suite, you can opt to send - _both_ the timestamp and the visitorID in your XML when sending events - server side. However, note that this is *NOT* recommended by - [Adobe](https://marketing.adobe.com/resources/help/en_US/sc/implement/timestamps-overview.html) - as it may lead to out of order data. This setting will only work for - reporting suites that have optional timestamp setting enabled. + Map your Adobe Analytics list variables names to the property names you’re + using in your Segment events. Enter a Segment property name on the left + and an Adobe Analytics list variable number on the right. You can view + your Segment events and properties in your Schema. settings: [] - name: marketingCloudOrgId display_name: Marketing Cloud Organization Id @@ -703,161 +690,174 @@ items: required: false description: The name of the adobe event. settings: [] - - name: removeFallbackVisitorId - display_name: 'No Fallbacks for Visitor ID: Server-Side Only ' + - name: preferVisitorId + display_name: Prefer VisitorID for Hybrid Timestamp Reporting type: BOOLEAN deprecated: false required: false description: >- - Note: This setting is for Server-Side only, and only applies when the Drop - Visitor ID setting is disabled and you send a marketingCloudId in the - Adobe Analytics integration object. - - ​​ - - ​​Segment’s default behavior is to set the Adobe Analytics visitorID based - on the destination specific setting for visitorId​, falling back to - userId​ then anonymousId​. This setting removes the fallbacks. + If you enable this option and you also have a *Timestamp Optional* + reporting suite, you can opt to send your visitorID instead of the + timestamp since Adobe does not allow you to send both. If you care more + about your user attribution, you should enable this if you're using a + hybrid timestamp reporting suite. settings: [] - - name: sendFalseValues - display_name: Send False values - type: BOOLEAN + - name: productIdentifier + display_name: Product Identifier + type: SELECT deprecated: false required: false + select_validators: + select_options: + - name + - sku + - id description: >- - By default, we don't send properties with a `false` as value on cloud - mode. Enabling this setting will send any boolean property where value is - `false`. - settings: [] - - name: trackingServerUrl - display_name: Tracking Server URL - type: STRING + Adobe Analytics only accepts a single [product + identifier](https://marketing.adobe.com/resources/help/en_US/sc/implement/products.html). + Use this option to choose whether we send product `name`, `id`, or `sku`. + settings: [] + - name: props + display_name: Props + type: MAP deprecated: false required: false - string_validators: + map_validators: regexp: '' - description: This is the URL of your Adobe Analytics server. + min: 0 + max: 150 + map_prefix: prop + select_options: [] + description: >- + Map your Adobe Analytics property names to the property names you’re using + in your Segment events. Enter a Segment property name on the left and an + Adobe Analytics property number on the right. You can view your Segment + events and properties in your Schema. settings: [] - - name: useLegacyLinkName - display_name: Use Legacy LinkName + - name: removeFallbackVisitorId + display_name: 'No Fallbacks for Visitor ID: Server-Side Only ' type: BOOLEAN deprecated: false required: false description: >- - Before sending LinkName to Adobe Analytics, prepend the URL with `Link - Name - `. + Note: This setting is for Server-Side only, and only applies when the Drop + Visitor ID setting is disabled and you send a marketingCloudId in the + Adobe Analytics integration object. + ​​ - This setting enables a legacy behavior for backwards compatibility. You - probably want to keep this setting turned off. + ​​Segment’s default behavior is to set the Adobe Analytics visitorID based + on the destination specific setting for visitorId​, falling back to + userId​ then anonymousId​. This setting removes the fallbacks. settings: [] - - name: enableTrackPageName - display_name: Enable pageName for Track Events - type: BOOLEAN + - name: reportSuiteId + display_name: Report Suite ID(s) + type: STRING deprecated: false - required: false + required: true + string_validators: + regexp: '' description: >- - If you do not want to attach `pageName` for your `.track()` calls, you can - disable this option. + You can find your Report Suite ID in your Adobe Analytics Settings page. + Multiple report suite ids can be separated by commas: + `suite1,suite2,suite3`. settings: [] - - name: lVars - display_name: List Variables - type: MAP + - name: sendBothTimestampVisitorId + display_name: Send Both Timestamp and VisitorID for Timestamp Optional Reporting Suites + type: BOOLEAN deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 3 - map_prefix: list - select_options: [] description: >- - Map your Adobe Analytics list variables names to the property names you’re - using in your Segment events. Enter a Segment property name on the left - and an Adobe Analytics list variable number on the right. You can view - your Segment events and properties in your Schema. + If you have a *Timestamp Optional* Reporting Suite, you can opt to send + _both_ the timestamp and the visitorID in your XML when sending events + server side. However, note that this is *NOT* recommended by + [Adobe](https://marketing.adobe.com/resources/help/en_US/sc/implement/timestamps-overview.html) + as it may lead to out of order data. This setting will only work for + reporting suites that have optional timestamp setting enabled. settings: [] - - name: hVars - display_name: Hierarchy Variables - type: MAP + - name: sendFalseValues + display_name: Send False values + type: BOOLEAN deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 5 - map_prefix: hier - select_options: [] description: >- - Map your Adobe Analytics hVars to the property names you’re using in your - Segment page calls. Enter a Segment property name on the left and an Adobe - Analytics hVar number on the right. You can view your Segment page calls - and properties in your Schema. + By default, we don't send properties with a `false` as value on cloud + mode. Enabling this setting will send any boolean property where value is + `false`. settings: [] - - name: customDelimiter - display_name: 'List Variable and Prop Custom Delimiter: Server-Side Only ' - type: MAP + - name: ssl + display_name: SSL + type: BOOLEAN deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: - - '|' - - ',' - - ':' - - ; - - / description: >- - Add a custom delimiter to concatenate Adobe Analytics lVars or props sent - as an array. Note, if you do not specify a custom delimiter, arrays will - be concatenated with a comma. Please add the Adobe Analytics lVar or prop - on the left and select a custom delimiter on the right. lVars must be in - format 'list1', 'list2', etc. and props in format 'prop1', 'prop2', etc. - Must be all lowercase with no whitespace. + Check this box if you would like your Adobe Heartbeat calls to be made + over HTTPS. settings: [] - - name: eventsV2 - display_name: Events V2 (Bundled Mobile Only) - type: MAP + - name: timestampOption + display_name: Timestamp Option + type: SELECT deprecated: false required: false + select_validators: + select_options: + - enabled + - disabled + - hybrid description: >- - **Note**: If you are bundling our Adobe Analytics SDK on your mobile - device, you should map your events here. If you are sending via server - side you should use the `Events` option instead. Map your Adobe Analytics - property names on the left to Adobe event names on the right. Your events - MUST be set up in Adobe and mapped here in order to to be forwarded to the - destination. This setting only applies to Mobile integrations with Adobe. + Adobe Analytics can have Report Suites that will accept timestamped, + non-timestamped or hybrid data. Note that we can only play historical + data for timestamped or hybrid Report Suites. settings: [] - - name: eVars - display_name: eVars - type: MAP + - name: trackingServerSecureUrl + display_name: Tracking Server Secure URL + type: STRING deprecated: false required: false - map_validators: + string_validators: regexp: '' - min: 0 - max: 250 - map_prefix: eVar - select_options: [] - description: >- - Map your Adobe Analytics eVar names to the property names you’re using in - your Segment events. Enter a Segment property name on the left and an - Adobe Analytics eVar number on the right. You can view your Segment events - and properties in your Schema. + description: This is the secure URL of your Adobe Analytics server. settings: [] - - name: heartbeatTrackingServerUrl - display_name: Heartbeat Tracking Server URL + - name: trackingServerUrl + display_name: Tracking Server URL type: STRING deprecated: false required: false string_validators: regexp: '' + description: This is the URL of your Adobe Analytics server. + settings: [] + - name: useLegacyLinkName + display_name: Use Legacy LinkName + type: BOOLEAN + deprecated: false + required: false description: >- - This is the URL of your Adobe Heartbeat server. Please contact Adobe to - obtain this URL. + Before sending LinkName to Adobe Analytics, prepend the URL with `Link + Name - `. + + + This setting enables a legacy behavior for backwards compatibility. You + probably want to keep this setting turned off. + settings: [] + - name: useSecureServerUrl + display_name: Use Secure URL for Server-side + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this option if you want to use the 'Tracking Server Secure URL' + endpoint instead of the normal URL for server-side and Cloud Mode calls. + settings: [] + - name: utf8Charset + display_name: Use UTF-8 Charset + type: BOOLEAN + deprecated: false + required: false + description: >- + Only applicable on server-side or cloud-mode. If this setting is enabled, + we will send the payload to Adobe Analytics with UTF-8 charset. Useful + when your events contains accents or other special characters. settings: [] connection_modes: device: @@ -947,6 +947,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: Airship generated string identifying the Bearer token. + settings: [] - name: appKey display_name: App Key type: STRING @@ -958,15 +967,6 @@ items: Airship generated string identifying the app setup. Used in the application bundle. settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^.{8,}$' - description: Airship generated string identifying the Bearer token. - settings: [] connection_modes: device: web: false @@ -1062,23 +1062,23 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: region - display_name: Region + - name: accountId + display_name: AWS Account ID type: STRING deprecated: false required: true string_validators: regexp: '' - description: The EventBridge Firehose AWS region key. + description: The ID of the AWS Account you'd like us to send data to. settings: [] - - name: accountId - display_name: AWS Account ID + - name: region + display_name: Region type: STRING deprecated: false required: true string_validators: regexp: '' - description: The ID of the AWS Account you'd like us to send data to. + description: The EventBridge Firehose AWS region key. settings: [] connection_modes: device: @@ -1303,17 +1303,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: roleAddress - display_name: Role Address - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - The address of the AWS role that will be invoking Lambda (ex: - `arn:aws:iam::874699288871:role/example-role`). - settings: [] - name: clientContext display_name: Client Context type: MAP @@ -1392,6 +1381,17 @@ items: regexp: '' description: 'AWS Region where the lambda lives. E.G. `us-west-2`, `eu-west-3`' settings: [] + - name: roleAddress + display_name: Role Address + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + The address of the AWS role that will be invoking Lambda (ex: + `arn:aws:iam::874699288871:role/example-role`). + settings: [] connection_modes: device: web: false @@ -1444,22 +1444,19 @@ items: documentation](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) for more information. settings: [] - - name: logType - display_name: Log Type - type: SELECT + - name: externalId + display_name: External ID + type: STRING deprecated: false required: false - select_validators: - select_options: - - None - - Tail + string_validators: + regexp: '' description: >- - Lambda [log - type](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax). - By default `None`. - - - Select `Tail` if you would like to see detailed logs in Cloud Watch. + This is an optional string Segment will use to assume the role provided to + invoke the Lambda function. If this setting is not defined, we'll use the + Source ID. For more information about external IDs while assuming AWS + roles, check + [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). settings: [] - name: function display_name: Lambda @@ -1483,6 +1480,23 @@ items: You can append a version number or alias to any of the formats. settings: [] + - name: logType + display_name: Log Type + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - None + - Tail + description: >- + Lambda [log + type](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax). + By default `None`. + + + Select `Tail` if you would like to see detailed logs in Cloud Watch. + settings: [] - name: region display_name: Region type: STRING @@ -1505,20 +1519,6 @@ items: The address of the AWS role that will be invoking Lambda (ex: `arn:aws:iam::874699288871:role/example-role`). settings: [] - - name: externalId - display_name: External ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This is an optional string Segment will use to assume the role provided to - invoke the Lambda function. If this setting is not defined, we'll use the - Source ID. For more information about external IDs while assuming AWS - roles, check - [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). - settings: [] connection_modes: device: web: false @@ -1683,98 +1683,70 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: traitsToAppend - display_name: Traits to Append - type: LIST - deprecated: false - required: false - description: >- - Server-Side and Mobile Only. Configure values to be appended to the user - property array via identify.traits. - settings: [] - - name: useCustomAmplitudeProperties - display_name: Send Custom Language and Country Properties - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this option if you want to send additional 'language' and 'country' - parameters inside of event_properties. This is separate from the language - and country collected from your user's context. (For example, you want to - send the language that a video is played in). You can send these in your - properties, for example: `analytics.track('Video Played', {language: - 'Japanese'});` - settings: [] - - name: useLogRevenueV2 - display_name: Use Log Revenue V2 API - type: BOOLEAN + - name: apiKey + display_name: API Key + type: STRING deprecated: false - required: false + required: true + string_validators: + regexp: '^[a-z0-9]{32}$' description: >- - Use Amplitude's logRevenueV2 API, which allows for the tracking of event - properties with the revenue event. Track an event with "price" and - "quantity" properties, and it will log total revenue = price * quantity. - You may also set a revenueType property to designate the type of revenue - (ex: purchase, refund, etc). Negative prices can be used to indicate - revenue lost. + You can find your API Key on your Amplitude [Settings + page](https://amplitude.com/settings). settings: [] - - name: sendToBatchEndpoint - display_name: Send To Batch Endpoint - type: BOOLEAN + - name: appendFieldsToEventProps + display_name: Append Fields To Event Properties + type: MAP deprecated: false required: false description: >- - Server-Side Only. If true, events are sent to Amplitude's `batch` endpoint - rather than to their `httpapi` endpoint. Because Amplitude's `batch` - endpoint throttles traffic less restrictively than the Amplitude `httpapi` - endpoint, enabling this setting may help to reduce 429s - or throttling - errors - from Amplitude. Amplitude's `batch` endpoint throttles data only - when the rate of events sharing the same `user_id` or `device_id` exceeds - an average of 1,000/second over a 30-second period. More information about - Amplitude's throttling is available here in their docs: - https://developers.amplitude.com/#429s-in-depth. + Web and server-side only. Configure event fields to be appended to + `event_props` for all track calls. For example, entering + `context.page.title` on the left and `pageTitle` on the right will set the + value of `context.page.title` at `event_properties.pageTitle`. settings: [] - - name: trackProductsOnce - display_name: Track products once + - name: batchEvents + display_name: Batch Events type: BOOLEAN deprecated: false required: false description: >- - *Beta feature* Amplitude recently added support to submit an array of - products on "Order Completed" events. If this setting is set to true, we - will send all the products in one single event to Amplitude. + If true, events are batched together and uploaded only when the number of + unsent events is greater than or equal to `eventUploadThreshold` or after + `eventUploadPeriodMillis` milliseconds have passed since the first unsent + event was logged. settings: [] - - name: trackUtmProperties - display_name: Track UTM Properties to Amplitude. + - name: deviceIdFromUrlParam + display_name: Set Device ID From URL Parameter amp_device_id type: BOOLEAN deprecated: false required: false description: >- - This will track UTM properties found in the querystring to Amplitude (only - for Device mode). + If true, the SDK will parse device ID values from url parameter + `amp_device_id` if available. settings: [] - - name: trackAllPages - display_name: Track All Pages to Amplitude + - name: enableLocationListening + display_name: Enable Location Listening type: BOOLEAN deprecated: false required: false description: >- - This will track **Loaded a Page** events to Amplitude for all [`page` - method](https://segment.io/libraries/analytics.js#page) calls. We keep - this disabled by default, since Amplitude isn't generally used for - pageview tracking. + Mobile Only. If a user has granted your app location permissions, enable + this setting so that the SDK will also grab the location of the user. + Amplitude will never prompt the user for location permission, so this must + be done by your app. settings: [] - - name: trackRevenuePerProduct - display_name: Track Revenue Per Product - type: BOOLEAN + - name: eventUploadPeriodMillis + display_name: Event Upload Period Millis (for batching events) + type: NUMBER deprecated: false required: false + number_validators: + min: 0 + max: 0 description: >- - Client and server only. This setting allows you to specify whether you - would like to track an Amplitude Revenue event per individual product in a - user transaction or a single Revenue event for the combined revenue of all - products. This setting is only relevant if you are using our eCommerce - spec and passing us an Order Completed event with a list of products. + Amount of time in milliseconds that the SDK waits before uploading events + if `batchEvents` is `true`. settings: [] - name: eventUploadThreshold display_name: Event Upload Threshold (for batching events) @@ -1788,6 +1760,15 @@ items: Minimum number of events to batch together per request if `batchEvents` is `true`. settings: [] + - name: forceHttps + display_name: Force Https + type: BOOLEAN + deprecated: false + required: false + description: >- + If true, the events will always be uploaded to HTTPS endpoint. Otherwise + the SDK will use the embedding site's protocol. + settings: [] - name: groupTypeTrait display_name: Group Type Trait type: STRING @@ -1800,37 +1781,59 @@ items: calls. If, for example, you set this to be `industry`, then `traits["industry"]` will be sent as `groupType` to Amplitude. settings: [] - - name: secretKey - display_name: Secret Key + - name: groupValueTrait + display_name: Group Value Trait type: STRING deprecated: false required: false string_validators: regexp: '' - description: Your Amplitude Secret Key (Only needed for user deletion) + description: >- + What trait Segment should use as your Amplitude "group value" in group + calls. If, for example, you set this to be `plan`, then `traits["plan"]` + will be sent as `groupValue` to Amplitude. settings: [] - - name: trackCategorizedPages - display_name: Track Categorized Pages to Amplitude - type: BOOLEAN + - name: mapQueryParams + display_name: Map Query Params to Custom Property + type: MAP deprecated: false required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - user_properties + - event_properties description: >- - This will track events to Amplitude for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `category` associated with them. For example `page('Docs', 'Index')` would - translate to **Viewed Docs Page**. + When sending data via server side or Cloud Mode, you can send the custom + query params that are automatically collected by `analytics.js` (or + whatever you manually send under `context.page.search`), by entering a + custom property name you would like to map that under on the left hand + side. On the right hand side, please choose whether you want the query + params to be set on the user profile or event metadata level. Whatever you + put on the left hand side we will map the entire query parameters string + from the `context.page.url`. settings: [] - - name: eventUploadPeriodMillis - display_name: Event Upload Period Millis (for batching events) - type: NUMBER + - name: preferAnonymousIdForDeviceId + display_name: Prefer Anonymous ID for Device ID + type: BOOLEAN deprecated: false required: false - number_validators: - min: 0 - max: 0 description: >- - Amount of time in milliseconds that the SDK waits before uploading events - if `batchEvents` is `true`. + By default, Segment will use `context.device.id` as the Amplitude + `device_id`, using `anonymousId` if `context.device.id` isn't present. + + + Enable this setting to flip this behavior; `anonymousId` will be used as + the `device_id`, falling back to `context.device.id` if it isn't present. + + + In browsers, enabling this setting means the user's anonymous ID, which + you can set using `analytics.user().anonymousId('ID_GOES_HERE')`, will be + set as the Amplitude device ID. Otherwise, Amplitude's default logic for + determining device IDs will be used. settings: [] - name: saveParamsReferrerOncePerSession display_name: 'Save Referrer, URL Params, GCLID Once Per Session' @@ -1843,6 +1846,15 @@ items: during the middle of the user's session will be ignored. Set to false to always capture new values. settings: [] + - name: secretKey + display_name: Secret Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Your Amplitude Secret Key (Only needed for user deletion) + settings: [] - name: sendAlias display_name: Enable Alias type: BOOLEAN @@ -1855,123 +1867,62 @@ items: this setting is disabled, your Segment Amplitude destination will reject `alias` events as unsupported. settings: [] - - name: batchEvents - display_name: Batch Events + - name: sendToBatchEndpoint + display_name: Send To Batch Endpoint type: BOOLEAN deprecated: false required: false description: >- - If true, events are batched together and uploaded only when the number of - unsent events is greater than or equal to `eventUploadThreshold` or after - `eventUploadPeriodMillis` milliseconds have passed since the first unsent - event was logged. - settings: [] - - name: traitsToSetOnce - display_name: Traits to Set Once - type: LIST - deprecated: false - required: false - description: >- - Server-Side and Mobile Only. Configure values to be set only once via - identify.traits. + Server-Side Only. If true, events are sent to Amplitude's `batch` endpoint + rather than to their `httpapi` endpoint. Because Amplitude's `batch` + endpoint throttles traffic less restrictively than the Amplitude `httpapi` + endpoint, enabling this setting may help to reduce 429s - or throttling + errors - from Amplitude. Amplitude's `batch` endpoint throttles data only + when the rate of events sharing the same `user_id` or `device_id` exceeds + an average of 1,000/second over a 30-second period. More information about + Amplitude's throttling is available here in their docs: + https://developers.amplitude.com/#429s-in-depth. settings: [] - - name: unsetParamsReferrerOnNewSession - display_name: Unset Params Referrer On New Session + - name: trackAllPages + display_name: Track All Pages to Amplitude type: BOOLEAN deprecated: false required: false description: >- - If false, the existing referrer and `utm_parameter` values will be carried - through each new session. If set to true, the referrer and `utm_parameter` - user properties, which include `referrer`, `utm_source`, `utm_medium`, - `utm_campaign`, `utm_term`, and `utm_content`, will be set to null upon - instantiating a new session. **Note**: This only works if Track Referrer - or Track UTM Properties to Amplitude are set to true. + This will track **Loaded a Page** events to Amplitude for all [`page` + method](https://segment.io/libraries/analytics.js#page) calls. We keep + this disabled by default, since Amplitude isn't generally used for + pageview tracking. settings: [] - - name: useAdvertisingIdForDeviceId - display_name: Use AdvertisingId for DeviceId + - name: trackAllPagesV2 + display_name: Track All Screens type: BOOLEAN deprecated: false required: false description: >- - Mobile Only (will *not* work in cloud-mode). Allows users to use - advertisingIdentifier instead of identifierForVendor as the Device ID. - settings: [] - - name: versionName - display_name: Version Name - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Optional. You can assign a version name for your page, and we'll send it - to Amplitude for more detailed events. - settings: [] - - name: appendFieldsToEventProps - display_name: Append Fields To Event Properties - type: MAP - deprecated: false - required: false - description: >- - Web and server-side only. Configure event fields to be appended to - `event_props` for all track calls. For example, entering - `context.page.title` on the left and `pageTitle` on the right will set the - value of `context.page.title` at `event_properties.pageTitle`. - settings: [] - - name: mapQueryParams - display_name: Map Query Params to Custom Property - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: - - user_properties - - event_properties - description: >- - When sending data via server side or Cloud Mode, you can send the custom - query params that are automatically collected by `analytics.js` (or - whatever you manually send under `context.page.search`), by entering a - custom property name you would like to map that under on the left hand - side. On the right hand side, please choose whether you want the query - params to be set on the user profile or event metadata level. Whatever you - put on the left hand side we will map the entire query parameters string - from the `context.page.url`. + Mobile only. Sends a "Loaded Screen" event and the screen name as a + property to Amplitude. Moving forward, this is the preferred method of + tracking screen events in Amplitude. settings: [] - - name: preferAnonymousIdForDeviceId - display_name: Prefer Anonymous ID for Device ID + - name: trackCategorizedPages + display_name: Track Categorized Pages to Amplitude type: BOOLEAN deprecated: false required: false description: >- - By default, Segment will use `context.device.id` as the Amplitude - `device_id`, using `anonymousId` if `context.device.id` isn't present. - - - Enable this setting to flip this behavior; `anonymousId` will be used as - the `device_id`, falling back to `context.device.id` if it isn't present. - - - In browsers, enabling this setting means the user's anonymous ID, which - you can set using `analytics.user().anonymousId('ID_GOES_HERE')`, will be - set as the Amplitude device ID. Otherwise, Amplitude's default logic for - determining device IDs will be used. + This will track events to Amplitude for [`page` + method](https://segment.io/libraries/analytics.js#page) calls that have a + `category` associated with them. For example `page('Docs', 'Index')` would + translate to **Viewed Docs Page**. settings: [] - - name: groupValueTrait - display_name: Group Value Trait - type: STRING + - name: trackGclid + display_name: Track GCLID + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - What trait Segment should use as your Amplitude "group value" in group - calls. If, for example, you set this to be `plan`, then `traits["plan"]` - will be sent as `groupValue` to Amplitude. + If true, captures the gclid url parameter as well as the user's + initial_gclid via a set once operation. settings: [] - name: trackNamedPages display_name: Track Named Pages to Amplitude @@ -1986,46 +1937,36 @@ items: `page('Conversion', 'Signup')` would translate to a **Viewed Conversion Signup Page** event in Amplitude. settings: [] - - name: traitsToIncrement - display_name: Traits To Increment - type: LIST + - name: trackProductsOnce + display_name: Track products once + type: BOOLEAN deprecated: false required: false description: >- - Server-Side and Mobile Only. Configure `trait` to increment on identify. - If the trait is present, it will increment the trait given the numerical - value passed in when you call `identify` with the trait. - settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-z0-9]{32}$' - description: >- - You can find your API Key on your Amplitude [Settings - page](https://amplitude.com/settings). + *Beta feature* Amplitude recently added support to submit an array of + products on "Order Completed" events. If this setting is set to true, we + will send all the products in one single event to Amplitude. settings: [] - - name: deviceIdFromUrlParam - display_name: Set Device ID From URL Parameter amp_device_id + - name: trackReferrer + display_name: Track Referrer to Amplitude type: BOOLEAN deprecated: false required: false description: >- - If true, the SDK will parse device ID values from url parameter - `amp_device_id` if available. + Enabling this will send referrer information as a user property to + Amplitude when you call Segment's `page` method. settings: [] - - name: enableLocationListening - display_name: Enable Location Listening + - name: trackRevenuePerProduct + display_name: Track Revenue Per Product type: BOOLEAN deprecated: false required: false description: >- - Mobile Only. If a user has granted your app location permissions, enable - this setting so that the SDK will also grab the location of the user. - Amplitude will never prompt the user for location permission, so this must - be done by your app. + Client and server only. This setting allows you to specify whether you + would like to track an Amplitude Revenue event per individual product in a + user transaction or a single Revenue event for the combined revenue of all + products. This setting is only relevant if you are using our eCommerce + spec and passing us an Order Completed event with a list of products. settings: [] - name: trackSessionEvents display_name: Track Session Events to Amplitude @@ -2037,6 +1978,34 @@ items: mobile products. Amplitude's libraries track sessions automatically and this option is not necessary for session tracking. settings: [] + - name: trackUtmProperties + display_name: Track UTM Properties to Amplitude. + type: BOOLEAN + deprecated: false + required: false + description: >- + This will track UTM properties found in the querystring to Amplitude (only + for Device mode). + settings: [] + - name: traitsToAppend + display_name: Traits to Append + type: LIST + deprecated: false + required: false + description: >- + Server-Side and Mobile Only. Configure values to be appended to the user + property array via identify.traits. + settings: [] + - name: traitsToIncrement + display_name: Traits To Increment + type: LIST + deprecated: false + required: false + description: >- + Server-Side and Mobile Only. Configure `trait` to increment on identify. + If the trait is present, it will increment the trait given the numerical + value passed in when you call `identify` with the trait. + settings: [] - name: traitsToPrepend display_name: Traits to Prepend type: LIST @@ -2046,42 +2015,73 @@ items: Server-Side and Mobile Only. Configure values to be prepended to the user property array via identify.traits. settings: [] - - name: forceHttps - display_name: Force Https + - name: traitsToSetOnce + display_name: Traits to Set Once + type: LIST + deprecated: false + required: false + description: >- + Server-Side and Mobile Only. Configure values to be set only once via + identify.traits. + settings: [] + - name: unsetParamsReferrerOnNewSession + display_name: Unset Params Referrer On New Session type: BOOLEAN deprecated: false required: false description: >- - If true, the events will always be uploaded to HTTPS endpoint. Otherwise - the SDK will use the embedding site's protocol. + If false, the existing referrer and `utm_parameter` values will be carried + through each new session. If set to true, the referrer and `utm_parameter` + user properties, which include `referrer`, `utm_source`, `utm_medium`, + `utm_campaign`, `utm_term`, and `utm_content`, will be set to null upon + instantiating a new session. **Note**: This only works if Track Referrer + or Track UTM Properties to Amplitude are set to true. settings: [] - - name: trackGclid - display_name: Track GCLID + - name: useAdvertisingIdForDeviceId + display_name: Use AdvertisingId for DeviceId type: BOOLEAN deprecated: false required: false description: >- - If true, captures the gclid url parameter as well as the user's - initial_gclid via a set once operation. + Mobile Only (will *not* work in cloud-mode). Allows users to use + advertisingIdentifier instead of identifierForVendor as the Device ID. settings: [] - - name: trackReferrer - display_name: Track Referrer to Amplitude + - name: useCustomAmplitudeProperties + display_name: Send Custom Language and Country Properties type: BOOLEAN deprecated: false required: false description: >- - Enabling this will send referrer information as a user property to - Amplitude when you call Segment's `page` method. + Enable this option if you want to send additional 'language' and 'country' + parameters inside of event_properties. This is separate from the language + and country collected from your user's context. (For example, you want to + send the language that a video is played in). You can send these in your + properties, for example: `analytics.track('Video Played', {language: + 'Japanese'});` settings: [] - - name: trackAllPagesV2 - display_name: Track All Screens + - name: useLogRevenueV2 + display_name: Use Log Revenue V2 API type: BOOLEAN deprecated: false required: false description: >- - Mobile only. Sends a "Loaded Screen" event and the screen name as a - property to Amplitude. Moving forward, this is the preferred method of - tracking screen events in Amplitude. + Use Amplitude's logRevenueV2 API, which allows for the tracking of event + properties with the revenue event. Track an event with "price" and + "quantity" properties, and it will log total revenue = price * quantity. + You may also set a revenueType property to designate the type of revenue + (ex: purchase, refund, etc). Negative prices can be used to indicate + revenue lost. + settings: [] + - name: versionName + display_name: Version Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Optional. You can assign a version name for your page, and we'll send it + to Amplitude for more detailed events. settings: [] connection_modes: device: @@ -2123,16 +2123,6 @@ items: required: false description: Configure a pixel settings: - - name: parameters - display_name: Query Parameters - type: MAP - deprecated: false - required: false - description: >- - Enter any event properties you want to map to query parameters in the - AppNexus url. Two parameters are sent automatically: `order_id` and the - monetary `value`. - settings: [] - name: event display_name: Event Name type: STRING @@ -2147,6 +2137,16 @@ items: ticked we will track a `conversion` otherwise we will track a `segment` otherwise we will track a conversion. settings: [] + - name: parameters + display_name: Query Parameters + type: MAP + deprecated: false + required: false + description: >- + Enter any event properties you want to map to query parameters in the + AppNexus url. Two parameters are sent automatically: `order_id` and the + monetary `value`. + settings: [] - name: pixelId display_name: Pixel ID type: STRING @@ -2259,8 +2259,44 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: canOmitAppsFlyerId - display_name: Can Omit AppsFlyerId + - name: androidAppID + display_name: Android App ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Your Android App's ID. Find this in your AppsFlyer's 'My App' dashboard. + It should look something like 'com.appsflyer.myapp'. This is required for + Android projects if you want to send events using the server side + integration. + settings: [] + - name: appleAppID + display_name: Apple App ID (iOS) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^[0-9]*$' + description: >- + Your App's ID, which is accessible from iTunes or in AppsFlyer's 'My App' + dashboard. This is optional for Android projects, and only required for + iOS projects. + settings: [] + - name: appsFlyerDevKey + display_name: AppsFlyer Dev Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-zA-Z0-9]{10,30}$' + description: >- + Your unique developer ID from AppsFlyer, which is accessible from your + AppsFlyer account. + settings: [] + - name: canOmitAppsFlyerId + display_name: Can Omit AppsFlyerId type: BOOLEAN deprecated: false required: false @@ -2302,42 +2338,6 @@ items: Send attribution data to Segment and other tools as a track call (mobile libraries only). settings: [] - - name: androidAppID - display_name: Android App ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Your Android App's ID. Find this in your AppsFlyer's 'My App' dashboard. - It should look something like 'com.appsflyer.myapp'. This is required for - Android projects if you want to send events using the server side - integration. - settings: [] - - name: appleAppID - display_name: Apple App ID (iOS) - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^[0-9]*$' - description: >- - Your App's ID, which is accessible from iTunes or in AppsFlyer's 'My App' - dashboard. This is optional for Android projects, and only required for - iOS projects. - settings: [] - - name: appsFlyerDevKey - display_name: AppsFlyer Dev Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-zA-Z0-9]{10,30}$' - description: >- - Your unique developer ID from AppsFlyer, which is accessible from your - AppsFlyer account. - settings: [] connection_modes: device: web: false @@ -2749,19 +2749,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: gcmSenderID - display_name: GCM Sender ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Android only. You can find out how to get your GCM sender ID - [here](https://batch.com/doc/android/prerequisites.html#_getting-your-sender-id-and-server-api-key). - Note that you shouldn't change this value once you've set it: doing so - will end up in push delivery issues. - settings: [] - name: apiKey display_name: API Key type: STRING @@ -2791,6 +2778,19 @@ items: required: false description: Toggles whether Batch is allowed to collect advertising IDs settings: [] + - name: gcmSenderID + display_name: GCM Sender ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Android only. You can find out how to get your GCM sender ID + [here](https://batch.com/doc/android/prerequisites.html#_getting-your-sender-id-and-server-api-key). + Note that you shouldn't change this value once you've set it: doing so + will end up in push delivery issues. + settings: [] connection_modes: device: web: false @@ -2918,13 +2918,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: retarget - display_name: Retarget - type: BOOLEAN - deprecated: false - required: false - description: This will retarget page calls on the client-side - settings: [] - name: apiKey display_name: API Key type: STRING @@ -2934,6 +2927,13 @@ items: regexp: '' description: Your API key can be found in Account Profile > API Keys settings: [] + - name: retarget + display_name: Retarget + type: BOOLEAN + deprecated: false + required: false + description: This will retarget page calls on the client-side + settings: [] connection_modes: device: web: true @@ -3035,64 +3035,28 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: doNotLoadFontAwesome - display_name: Do Not Load Font Awesome - type: BOOLEAN - deprecated: false - required: false - description: >- - **Web Only:** Braze uses [FontAwesome](https://fontawesome.com/) for - in-app message icons. By default, Braze will automatically load - FontAwesome from - https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css. - To disable this behavior (e.g. because your site uses a customized version - of FontAwesome), set this option to true. Note that if you do this, you - are responsible for ensuring that FontAwesome is loaded on your site - - otherwise in-app messages may not render correctly. **This setting is only - applicable if you are using version 2 of the Braze Web SDK.** - settings: [] - - name: enableHtmlInAppMessages - display_name: Enable HTML In-App Messages - type: BOOLEAN - deprecated: false - required: false - description: >- - **Web only**: Enabling this option will allow Braze dashboard users to - write HTML In-App messages. Check out [Braze - Documentation](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.initialize) - for more information on this setting. **This setting is only applicable if - you are using version 2 of the Braze Web SDK.** - settings: [] - - name: openInAppMessagesInNewTab - display_name: Open In-App Messages In New Tab - type: BOOLEAN - deprecated: false - required: false - description: >- - By default, links from in-app message clicks load in the current tab or a - new tab as specified in the dashboard on a message-by-message basis. Set - this option to true to force all links from in-app message clicks open in - a new tab or window. **This setting is only applicable if you are using - version 2 of the Braze Web SDK.** - settings: [] - - name: trackNamedPages - display_name: Track Only Named Pages + - name: allowCrawlerActivity + display_name: Allow Crawler Activity type: BOOLEAN deprecated: false required: false description: >- - This will send only [`page` calls](https://segment.com/docs/spec/page/) to - Braze that have a `name` associated with them. For example, - `page('Signup')` would translate to **Viewed Signup Page** in Braze. + **Web Only:** By default, the Braze Web SDK ignores activity from known + spiders or web crawlers, such as Google, based on the user agent string. + This saves datapoints, makes analytics more accurate, and may improve page + rank. However, if you want Braze to log activity from these crawlers + instead, you may set this option to true. settings: [] - - name: updateExistingOnly - display_name: Update Existing Users Only - type: BOOLEAN + - name: apiKey + display_name: App Identifier + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - **Server Side only**: A flag to determine whether to update existing users - only, defaults to false + The API key found in your Braze dashboard, used to identify your + application as the app identifier. (Formerly 'API Key') settings: [] - name: appGroupId display_name: REST API Key @@ -3105,6 +3069,19 @@ items: This can be found in your Braze dashboard under App Settings > Developer Console. (Formerly 'App Group Identifier') settings: [] + - name: automatic_in_app_message_registration_enabled + display_name: Enable Automatic In-App Message Registration + type: BOOLEAN + deprecated: false + required: false + description: >- + **Mobile Only:** Every activity in your app must be registered with Braze + to allow it to add in-app message views to the view hierarchy. By default, + Braze's Segment integration automatically registers every activity. + However, if you would like to manually register activities, you may do so + by disabling this setting. For more information, see the Braze + [documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/android/in-app_messaging/integration/#step-1-braze-in-app-message-manager-registration). + settings: [] - name: automaticallyDisplayMessages display_name: Automatically Send In-App Messages type: BOOLEAN @@ -3129,6 +3106,70 @@ items: should look something like: sdk.api.appboy.eu. Otherwise, leave this blank. settings: [] + - name: datacenter + display_name: Appboy Datacenter + type: SELECT + deprecated: false + required: true + select_validators: + select_options: + - us + - us02 + - us03 + - us04 + - eu + description: 'Choose your Appboy Gateway (ie. US 01, US 02, EU 01, etc.).' + settings: [] + - name: doNotLoadFontAwesome + display_name: Do Not Load Font Awesome + type: BOOLEAN + deprecated: false + required: false + description: >- + **Web Only:** Braze uses [FontAwesome](https://fontawesome.com/) for + in-app message icons. By default, Braze will automatically load + FontAwesome from + https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css. + To disable this behavior (e.g. because your site uses a customized version + of FontAwesome), set this option to true. Note that if you do this, you + are responsible for ensuring that FontAwesome is loaded on your site - + otherwise in-app messages may not render correctly. **This setting is only + applicable if you are using version 2 of the Braze Web SDK.** + settings: [] + - name: enableHtmlInAppMessages + display_name: Enable HTML In-App Messages + type: BOOLEAN + deprecated: false + required: false + description: >- + **Web only**: Enabling this option will allow Braze dashboard users to + write HTML In-App messages. Check out [Braze + Documentation](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.initialize) + for more information on this setting. **This setting is only applicable if + you are using version 2 of the Braze Web SDK.** + settings: [] + - name: enableLogging + display_name: Enable Logging + type: BOOLEAN + deprecated: false + required: false + description: >- + **Web Only:** Set to true to enable logging by default. Note that this + will cause Braze to log to the javascript console, which is visible to all + users! You should probably remove this or provide an alternate logger with + [appboy.setLogger()](https://js.appboycdn.com/web-sdk/2.0/doc/module-appboy.html#.setLogger) + before you release your page to production. **This setting is only + applicable if you are using version 2 of the Braze Web SDK.** + settings: [] + - name: logPurchaseWhenRevenuePresent + display_name: Log Purchase when Revenue is present + type: BOOLEAN + deprecated: false + required: false + description: >- + When this option is enabled, all Track calls with a property called + `revenue` will trigger Braze's LogRevenue event. + settings: [] - name: minimumIntervalBetweenTriggerActionsInSeconds display_name: Minimum Interval Between Trigger Actions In Seconds type: NUMBER @@ -3145,94 +3186,28 @@ items: spamming the user with notifications. **This setting is only applicable if you are using version 2 of the Braze Web SDK.** settings: [] - - name: openNewsFeedCardsInNewTab - display_name: Open News Feed Cards In New Tab - type: BOOLEAN - deprecated: false - required: false - description: >- - By default, links from news feed cards load in the current tab or window. - Set this option to true to make links from news feed cards open in a new - tab or window. **This setting is only applicable if you are using version - 2 of the Braze Web SDK.** - settings: [] - - name: sessionTimeoutInSeconds - display_name: Session Timeout In Seconds - type: NUMBER - deprecated: false - required: false - number_validators: - min: 0 - max: 0 - description: > - **Web Only:** By default, sessions time out after 30 minutes of - inactivity. Provide a value for this configuration option to override that - default with a value of your own. **This setting is only applicable if you - are using version 2 of the Braze Web SDK.** - settings: [] - - name: version - display_name: Braze Web SDK Version - type: SELECT - deprecated: false - required: false - select_validators: - select_options: - - '1' - - '2' - description: >- - **Web Only:** The [major](https://semver.org/) version of the Braze web - SDK you would like to use. Please reference their - [changelog](https://github.com/Appboy/appboy-web-sdk/blob/master/CHANGELOG.md) - for more info. **Please ensure you read - [this](https://segment.com/docs/destinations/braze/#migrating-to-v2-of-the-braze-web-sdk) - section of our documentation carefully before changing this setting.** - settings: [] - - name: apiKey - display_name: App Identifier - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - The API key found in your Braze dashboard, used to identify your - application as the app identifier. (Formerly 'API Key') - settings: [] - - name: datacenter - display_name: Appboy Datacenter - type: SELECT - deprecated: false - required: true - select_validators: - select_options: - - us - - us02 - - us03 - - us04 - - eu - description: 'Choose your Appboy Gateway (ie. US 01, US 02, EU 01, etc.).' - settings: [] - - name: enableLogging - display_name: Enable Logging + - name: openInAppMessagesInNewTab + display_name: Open In-App Messages In New Tab type: BOOLEAN deprecated: false required: false description: >- - **Web Only:** Set to true to enable logging by default. Note that this - will cause Braze to log to the javascript console, which is visible to all - users! You should probably remove this or provide an alternate logger with - [appboy.setLogger()](https://js.appboycdn.com/web-sdk/2.0/doc/module-appboy.html#.setLogger) - before you release your page to production. **This setting is only - applicable if you are using version 2 of the Braze Web SDK.** + By default, links from in-app message clicks load in the current tab or a + new tab as specified in the dashboard on a message-by-message basis. Set + this option to true to force all links from in-app message clicks open in + a new tab or window. **This setting is only applicable if you are using + version 2 of the Braze Web SDK.** settings: [] - - name: logPurchaseWhenRevenuePresent - display_name: Log Purchase when Revenue is present + - name: openNewsFeedCardsInNewTab + display_name: Open News Feed Cards In New Tab type: BOOLEAN deprecated: false required: false description: >- - When this option is enabled, all Track calls with a property called - `revenue` will trigger Braze's LogRevenue event. + By default, links from news feed cards load in the current tab or window. + Set this option to true to make links from news feed cards open in a new + tab or window. **This setting is only applicable if you are using version + 2 of the Braze Web SDK.** settings: [] - name: restCustomEndpoint display_name: Custom REST API Endpoint @@ -3271,18 +3246,19 @@ items: documentation: https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html settings: [] - - name: automatic_in_app_message_registration_enabled - display_name: Enable Automatic In-App Message Registration - type: BOOLEAN + - name: sessionTimeoutInSeconds + display_name: Session Timeout In Seconds + type: NUMBER deprecated: false required: false - description: >- - **Mobile Only:** Every activity in your app must be registered with Braze - to allow it to add in-app message views to the view hierarchy. By default, - Braze's Segment integration automatically registers every activity. - However, if you would like to manually register activities, you may do so - by disabling this setting. For more information, see the Braze - [documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/android/in-app_messaging/integration/#step-1-braze-in-app-message-manager-registration). + number_validators: + min: 0 + max: 0 + description: > + **Web Only:** By default, sessions time out after 30 minutes of + inactivity. Provide a value for this configuration option to override that + default with a value of your own. **This setting is only applicable if you + are using version 2 of the Braze Web SDK.** settings: [] - name: trackAllPages display_name: Track All Pages @@ -3294,17 +3270,41 @@ items: Braze as a Loaded/Viewed a Page event. This option is disabled by default since Braze isn't generally used for page view tracking. settings: [] - - name: allowCrawlerActivity - display_name: Allow Crawler Activity + - name: trackNamedPages + display_name: Track Only Named Pages type: BOOLEAN deprecated: false required: false description: >- - **Web Only:** By default, the Braze Web SDK ignores activity from known - spiders or web crawlers, such as Google, based on the user agent string. - This saves datapoints, makes analytics more accurate, and may improve page - rank. However, if you want Braze to log activity from these crawlers - instead, you may set this option to true. + This will send only [`page` calls](https://segment.com/docs/spec/page/) to + Braze that have a `name` associated with them. For example, + `page('Signup')` would translate to **Viewed Signup Page** in Braze. + settings: [] + - name: updateExistingOnly + display_name: Update Existing Users Only + type: BOOLEAN + deprecated: false + required: false + description: >- + **Server Side only**: A flag to determine whether to update existing users + only, defaults to false + settings: [] + - name: version + display_name: Braze Web SDK Version + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - '1' + - '2' + description: >- + **Web Only:** The [major](https://semver.org/) version of the Braze web + SDK you would like to use. Please reference their + [changelog](https://github.com/Appboy/appboy-web-sdk/blob/master/CHANGELOG.md) + for more info. **Please ensure you read + [this](https://segment.com/docs/destinations/braze/#migrating-to-v2-of-the-braze-web-sdk) + section of our documentation carefully before changing this setting.** settings: [] connection_modes: device: @@ -3601,50 +3601,6 @@ items: server: true previous_names: - Callingly -- display_name: Calq - slug: calq - name: catalog/destinations/calq - description: Advanced custom analytics for mobile and web applications - hidden: true - url: connections/destinations/catalog/calq - status: PUBLIC - logo: - url: 'https://d3hotuclm6if1r.cloudfront.net/logos/calq-default.svg' - mark: - url: 'https://cdn.filepicker.io/api/file/lVoOHitVTsCb57PTPImA' - categories: - - Analytics - components: - - type: CLOUD - platforms: - browser: false - server: true - mobile: true - browserUnbundlingSupported: false - browserUnbundlingPublic: true - settings: - - name: writeKey - display_name: Write Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your Write Key in the top left corner of the page under - Project Settings - settings: [] - connection_modes: - device: - web: false - mobile: false - server: false - cloud: - web: false - mobile: true - server: true - previous_names: - - Calq - display_name: Candu slug: candu name: catalog/destinations/candu @@ -3768,20 +3724,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: publishableKey - display_name: API Publishable Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your publishable key under **Settings** in the Castle - dashboard. It should look something like this: - `pk_KmoUyttyEiHCdFTWSqhAF1SL1z9Fi1yg`. This is required and will be used - to initialize Castle's library on your device as well as when you make - mobile/server calls through our server side integration. - settings: [] - name: autoPageview display_name: Automatic Page tracking type: BOOLEAN @@ -3803,6 +3745,20 @@ items: If your authenticated area is located at a different domain, use the cookie domain setting to change on which url the cookie is set. settings: [] + - name: publishableKey + display_name: API Publishable Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + You can find your publishable key under **Settings** in the Castle + dashboard. It should look something like this: + `pk_KmoUyttyEiHCdFTWSqhAF1SL1z9Fi1yg`. This is required and will be used + to initialize Castle's library on your device as well as when you make + mobile/server calls through our server side integration. + settings: [] connection_modes: device: web: false @@ -4302,27 +4258,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiSecret - display_name: Project Id + - name: apiKey + display_name: API Key type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your Project Id in ClientSuccess under the top right menu, - Apps & Integrations > Usage + You can find your API key in ClientSuccess under the top right menu, Apps + & Integrations > Usage settings: [] - - name: apiKey - display_name: API Key + - name: apiSecret + display_name: Project Id type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your API key in ClientSuccess under the top right menu, Apps - & Integrations > Usage + You can find your Project Id in ClientSuccess under the top right menu, + Apps & Integrations > Usage settings: [] connection_modes: device: @@ -4412,6 +4368,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: account + display_name: Account + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your Convertro Account Name + settings: [] - name: clientName display_name: Client Name type: STRING @@ -4465,15 +4430,6 @@ items: If you'd like to send mobile data to Convertro's server side integration, please enter your Convertro Site ID settings: [] - - name: account - display_name: Account - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter your Convertro Account Name - settings: [] connection_modes: device: web: true @@ -4784,35 +4740,13 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: monitorWebView - display_name: Monitor Web View (iOS) - type: BOOLEAN + - name: appId + display_name: App ID + type: STRING deprecated: false - required: false - description: >- - Monitor network traffic generated by UIWebViews (iOS only). Check out the - [Crittercism - docs](http://docs.crittercism.com/ios/ios.html#monitoring-web-views) for - more info. - settings: [] - - name: shouldCollectLogcat - display_name: Collect Logcat Data (Android) - type: BOOLEAN - deprecated: false - required: false - description: >- - If you want to include system log data in your crash logs, enable this - setting (Android only). Check out the [Crittercism - docs](https://app.crittercism.com/developers/docs-optional-android#including_logcat) - for more info. - settings: [] - - name: appId - display_name: App ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^([a-z0-9]{40}|[a-z0-9]{24})$' + required: true + string_validators: + regexp: '^([a-z0-9]{40}|[a-z0-9]{24})$' description: >- You can find your App ID on the Crittercism [Settings page](https://app.crittercism.com/developers). It should be 24 characters @@ -4854,6 +4788,28 @@ items: docs](https://app.crittercism.com/developers/docs-optional-android#include_version_code) for more info. settings: [] + - name: monitorWebView + display_name: Monitor Web View (iOS) + type: BOOLEAN + deprecated: false + required: false + description: >- + Monitor network traffic generated by UIWebViews (iOS only). Check out the + [Crittercism + docs](http://docs.crittercism.com/ios/ios.html#monitoring-web-views) for + more info. + settings: [] + - name: shouldCollectLogcat + display_name: Collect Logcat Data (Android) + type: BOOLEAN + deprecated: false + required: false + description: >- + If you want to include system log data in your crash logs, enable this + setting (Android only). Check out the [Crittercism + docs](https://app.crittercism.com/developers/docs-optional-android#including_logcat) + for more info. + settings: [] connection_modes: device: web: false @@ -5043,6 +4999,20 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^([a-z0-9]{20})?([a-z0-9]{64})?$' + description: >- + You can find your API Key on the Customer.io [Integration + page](https://fly.customer.io/account/customerio_integration). It should + be 20 or 64 characters long, and look something like this: + `91837a6c9e8b49d0ef71`. An API Key is required if you're using our + server-side or mobile libraries. + settings: [] - name: convertToUnixTime display_name: Convert To Unix Time type: BOOLEAN @@ -5061,20 +5031,6 @@ items: You can find your Site ID on the Customer.io [Integration page](https://fly.customer.io/account/customerio_integration). settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^([a-z0-9]{20})?([a-z0-9]{64})?$' - description: >- - You can find your API Key on the Customer.io [Integration - page](https://fly.customer.io/account/customerio_integration). It should - be 20 or 64 characters long, and look something like this: - `91837a6c9e8b49d0ef71`. An API Key is required if you're using our - server-side or mobile libraries. - settings: [] connection_modes: device: web: true @@ -5230,29 +5186,18 @@ items: Use these fields to map your Segment event names to Floodlight tags. We'll only send Floodlight the conversion events you specify. settings: - - name: isSalesTag - display_name: Fire as Sales Tag - type: BOOLEAN - deprecated: false - required: false - description: >- - Check this box if this tag is a **Sales** tag. Leave it unchecked if - this is a **Counter** tag. - settings: [] - - name: ordKey - display_name: Set Ord Key + - name: cat + display_name: Floodlight Activity Tag type: STRING deprecated: false - required: false + required: true string_validators: regexp: '' description: >- - For **Sales** tags only, please specify which property value should be - used for the `ord`. You must enable reporting on `ord` inside - DoubleClick Floodlight if you decide to use this feature. A good example - key would be something like `properties.order_id`. Please include the - `properties.` prefix to the key to ensure we can find the associated - value in your properties object. + This should be the `cat` of your tag string, which Floodlight servers + use to identify the activity group to which the activity belongs. If you + leave this option blank, we will fall back to whatever you define in the + top level Activity Tag setting. settings: [] - name: customVariable display_name: Custom Variables @@ -5286,18 +5231,29 @@ items: Our Floodlight integration allows you to map the event names you track in Segment to Floodlight tags. settings: [] - - name: cat - display_name: Floodlight Activity Tag + - name: isSalesTag + display_name: Fire as Sales Tag + type: BOOLEAN + deprecated: false + required: false + description: >- + Check this box if this tag is a **Sales** tag. Leave it unchecked if + this is a **Counter** tag. + settings: [] + - name: ordKey + display_name: Set Ord Key type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' description: >- - This should be the `cat` of your tag string, which Floodlight servers - use to identify the activity group to which the activity belongs. If you - leave this option blank, we will fall back to whatever you define in the - top level Activity Tag setting. + For **Sales** tags only, please specify which property value should be + used for the `ord`. You must enable reporting on `ord` inside + DoubleClick Floodlight if you decide to use this feature. A good example + key would be something like `properties.order_id`. Please include the + `properties.` prefix to the key to ensure we can find the associated + value in your properties object. settings: [] - name: type display_name: Floodlight Group Tag @@ -5312,27 +5268,26 @@ items: leave this option blank, we will fall back to whatever you define in the top level Group Tag setting. settings: [] - - name: source - display_name: DoubleClick Advertiser ID - type: STRING + - name: getDoubleClickId + display_name: Get DoubleClick Id + type: BOOLEAN deprecated: false - required: true - string_validators: - regexp: '' + required: false description: >- - Your advertiser ID that is the source of the Floodlight activity. This - should be the `src` of your tag string. + Enable this setting if you would like to use Google's cookie matching + functionality. Please also ensure you provide a value in the Google + Network Id setting. settings: [] - - name: token - display_name: Authorization Token for server-to-server requests + - name: googleNetworkId + display_name: Google Network Id type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Please add the Token to send your conversions using the server-to-server - endpoint from DisplayVideo 360. + Provide your Google Network Id here if you have enabled cookie matching + (Get DoubleClick Id setting). settings: [] - name: groupTag display_name: Group Tag @@ -5358,26 +5313,27 @@ items: Set here the write key for this source. It's required if cookie matching is enabled. settings: [] - - name: getDoubleClickId - display_name: Get DoubleClick Id - type: BOOLEAN + - name: source + display_name: DoubleClick Advertiser ID + type: STRING deprecated: false - required: false + required: true + string_validators: + regexp: '' description: >- - Enable this setting if you would like to use Google's cookie matching - functionality. Please also ensure you provide a value in the Google - Network Id setting. + Your advertiser ID that is the source of the Floodlight activity. This + should be the `src` of your tag string. settings: [] - - name: googleNetworkId - display_name: Google Network Id + - name: token + display_name: Authorization Token for server-to-server requests type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Provide your Google Network Id here if you have enabled cookie matching - (Get DoubleClick Id setting). + Please add the Token to send your conversions using the server-to-server + endpoint from DisplayVideo 360. settings: [] connection_modes: device: @@ -5519,6 +5475,19 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: account + display_name: Account Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[0-9]{7,9}$' + description: >- + Your account ID can be found on your [Site + Setup](https://www.getdrip.com/settings/site) page under **3rd-Party + Integrations**. It should be a 7, 8, or 9 character numerical string, like + this: `83702741`. + settings: [] - name: campaignId display_name: Campaign ID type: STRING @@ -5548,19 +5517,6 @@ items: Settings](https://www.getdrip.com/user/edit). It should be 20 character alphanumeric string, like: `bmrdc6hczyn8yss8o8td`. settings: [] - - name: account - display_name: Account Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[0-9]{7,9}$' - description: >- - Your account ID can be found on your [Site - Setup](https://www.getdrip.com/settings/site) page under **3rd-Party - Integrations**. It should be a 7, 8, or 9 character numerical string, like - this: `83702741`. - settings: [] connection_modes: device: web: true @@ -5759,24 +5715,6 @@ items: `track` events and will reject `identify` events.* This is to reduce the number of potentially repetitive API calls sent downstream to Eloqua. settings: [] - - name: sendGroup - display_name: Create or Update Account on Group - type: BOOLEAN - deprecated: false - required: false - description: >- - *Server Side Only*: Enable this setting to create or update an Eloqua - account on a `group` event. - settings: [] - - name: username - display_name: Username - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter your login username - settings: [] - name: mappedEvents display_name: Map Track Events to Custom Objects type: MAP @@ -5836,6 +5774,15 @@ items: regexp: '' description: Enter your login passord settings: [] + - name: sendGroup + display_name: Create or Update Account on Group + type: BOOLEAN + deprecated: false + required: false + description: >- + *Server Side Only*: Enable this setting to create or update an Eloqua + account on a `group` event. + settings: [] - name: siteId display_name: Site ID type: STRING @@ -5845,6 +5792,15 @@ items: regexp: '' description: Enter your Site ID settings: [] + - name: username + display_name: Username + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your login username + settings: [] connection_modes: device: web: true @@ -5979,6 +5935,16 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: meta + display_name: Include custom user data with Errorception's error tracking + type: BOOLEAN + deprecated: false + required: false + description: >- + When this option is enabled we will store metadata about the user on + `identify` calls, using the [Errorception `meta` + API](http://blog.errorception.com/2012/11/capture-custom-data-with-your-errors.html). + settings: [] - name: projectId display_name: Project ID type: STRING @@ -5993,16 +5959,6 @@ items: out of your Errorception URL, `/projects/PROJECT_ID`. It should be 24 characters long and look something like this: `326b76b52f52c3f662000140`. settings: [] - - name: meta - display_name: Include custom user data with Errorception's error tracking - type: BOOLEAN - deprecated: false - required: false - description: >- - When this option is enabled we will store metadata about the user on - `identify` calls, using the [Errorception `meta` - API](http://blog.errorception.com/2012/11/capture-custom-data-with-your-errors.html). - settings: [] connection_modes: device: web: true @@ -6257,8 +6213,29 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: leads - display_name: Map Track Events as Lead Conversions to Event Set IDs + - name: completeRegistrations + display_name: Map Track Events as CompleteRegistration Conversions to Event Set IDs + type: MAP + deprecated: false + required: false + description: >- + Enter your Segment `.track()` event names on the left that you want to + send as `CompleteRegistration` conversions. On the right hand side, put + the ID of the Facebook Offline Event Set where you want to send these + conversions. + settings: [] + - name: events + display_name: Map Track Events to Event Set IDs + type: MAP + deprecated: false + required: false + description: >- + Enter your Segment `.track()` event names on the left that you want to + send as conversions. On the right hand side, put the ID of the Facebook + Offline Event Set where you want to send these conversions. + settings: [] + - name: leads + display_name: Map Track Events as Lead Conversions to Event Set IDs type: MAP deprecated: false required: false @@ -6288,27 +6265,6 @@ items: `Product List Viewed`, choose which Segment property you would like to map to Facebook's `value` property. settings: [] - - name: completeRegistrations - display_name: Map Track Events as CompleteRegistration Conversions to Event Set IDs - type: MAP - deprecated: false - required: false - description: >- - Enter your Segment `.track()` event names on the left that you want to - send as `CompleteRegistration` conversions. On the right hand side, put - the ID of the Facebook Offline Event Set where you want to send these - conversions. - settings: [] - - name: events - display_name: Map Track Events to Event Set IDs - type: MAP - deprecated: false - required: false - description: >- - Enter your Segment `.track()` event names on the left that you want to - send as conversions. On the right hand side, put the ID of the Facebook - Offline Event Set where you want to send these conversions. - settings: [] connection_modes: device: web: false @@ -6344,27 +6300,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: - - name: pixelId - display_name: Pixel ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Your Pixel ID, from the snippet created on the [Facebook Pixel creation - page](https://www.facebook.com/ads/manager/pixel/facebook_pixel/). - settings: [] - - name: standardEventsCustomProperties - display_name: Standard Events custom properties - type: LIST - deprecated: false - required: false - description: >- - Add here all the custom properties you want to send as part of your - Standard Events (Order Completed, Checkout Started, etc) as `property - name`. - settings: [] - name: blacklistPiiProperties display_name: Blacklist PII Properties type: MIXED @@ -6380,6 +6315,17 @@ items: setting to append to this default list. You can also use this setting to optionally hash any PII values instead of dropping them. settings: [] + - name: contentTypes + display_name: Map Categories to FB Content Types + type: MAP + deprecated: false + required: false + description: >- + Enter your category value on the left, and the Facebook content type to + map to on the right. Facebook recognizes certain event types that can help + deliver relevant ads. If no category values are mapped we'll default to + `product` and `product_group`, depending on the event. + settings: [] - name: initWithExistingTraits display_name: Enable Advanced Matching type: BOOLEAN @@ -6402,44 +6348,6 @@ items: will use the value of this trait to map it to Facebook Pixel's `external_id`. settings: [] - - name: valueIdentifier - display_name: Value Field Identifier - type: SELECT - deprecated: false - required: false - select_validators: - select_options: - - price - - value - description: >- - For pre-purchase events such as `Product Viewed` and `Product Added`, - choose which Segment property you would like to map to Facebook's value - property. - settings: [] - - name: whitelistPiiProperties - display_name: Whitelist PII Properties - type: LIST - deprecated: false - required: false - description: >- - By default, Segment will strip any PII from the properties of `track` - events that get sent to Facebook. If you would like to override this - functionality, you can input each property you would like to whitelist as - a line item in this setting. **Please reference our - [documentation](https://segment.com/docs/destinations/facebook-pixel/#pii-blacklisting) - for the exact property names we filter out.** - settings: [] - - name: contentTypes - display_name: Map Categories to FB Content Types - type: MAP - deprecated: false - required: false - description: >- - Enter your category value on the left, and the Facebook content type to - map to on the right. Facebook recognizes certain event types that can help - deliver relevant ads. If no category values are mapped we'll default to - `product` and `product_group`, depending on the event. - settings: [] - name: legacyEvents display_name: Legacy Conversion Pixel IDs type: MAP @@ -6454,6 +6362,17 @@ items: custom events inside their interface. Enter your event name in the left column and your pixel ID in the right column. settings: [] + - name: pixelId + display_name: Pixel ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your Pixel ID, from the snippet created on the [Facebook Pixel creation + page](https://www.facebook.com/ads/manager/pixel/facebook_pixel/). + settings: [] - name: standardEvents display_name: Map Your Events to Standard FB Events type: MAP @@ -6491,6 +6410,16 @@ items: Facebook event, we'll send the event by that name. Any unmapped events will still be sent as Custom Events. settings: [] + - name: standardEventsCustomProperties + display_name: Standard Events custom properties + type: LIST + deprecated: false + required: false + description: >- + Add here all the custom properties you want to send as part of your + Standard Events (Order Completed, Checkout Started, etc) as `property + name`. + settings: [] - name: userIdAsExternalId display_name: Use UserId or Anonymous Id as External Id type: BOOLEAN @@ -6500,6 +6429,33 @@ items: Enable this setting if you want to send, `userId` (or `anonymousId` if not present) as external Id to Facebook. settings: [] + - name: valueIdentifier + display_name: Value Field Identifier + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - price + - value + description: >- + For pre-purchase events such as `Product Viewed` and `Product Added`, + choose which Segment property you would like to map to Facebook's value + property. + settings: [] + - name: whitelistPiiProperties + display_name: Whitelist PII Properties + type: LIST + deprecated: false + required: false + description: >- + By default, Segment will strip any PII from the properties of `track` + events that get sent to Facebook. If you would like to override this + functionality, you can input each property you would like to whitelist as + a line item in this setting. **Please reference our + [documentation](https://segment.com/docs/destinations/facebook-pixel/#pii-blacklisting) + for the exact property names we filter out.** + settings: [] connection_modes: device: web: true @@ -6644,27 +6600,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: sessionContinueSeconds - display_name: Session Continue Seconds - type: NUMBER - deprecated: false - required: false - number_validators: - min: 1 - max: 10000 - description: >- - The number of seconds the app can be in the background before starting a - new Flurry session upon resume. Default from Flurry is 10 seconds. - settings: [] - - name: useHttps - display_name: Send Data to Flurry Over HTTPS - type: BOOLEAN - deprecated: false - required: false - description: >- - Enabling this will send data to Flurry securely. This option is ignored - for the latest versions of the Flurry SDK, which use HTTPS by default. - settings: [] - name: apiKey display_name: API Key type: STRING @@ -6701,6 +6636,27 @@ items: Enabling this will send data through screen calls as events (in addition to pageviews). settings: [] + - name: sessionContinueSeconds + display_name: Session Continue Seconds + type: NUMBER + deprecated: false + required: false + number_validators: + min: 1 + max: 10000 + description: >- + The number of seconds the app can be in the background before starting a + new Flurry session upon resume. Default from Flurry is 10 seconds. + settings: [] + - name: useHttps + display_name: Send Data to Flurry Over HTTPS + type: BOOLEAN + deprecated: false + required: false + description: >- + Enabling this will send data to Flurry securely. This option is ignored + for the latest versions of the Flurry SDK, which use HTTPS by default. + settings: [] connection_modes: device: web: false @@ -6926,16 +6882,18 @@ items: required: false description: Map your page calls to specific FriendBuy Widgets. settings: - - name: name - display_name: Page Name + - name: autoDelay + display_name: Widget Auto Delay type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' description: >- - Enter the `name` of your `.page()` calls. ie. `'Home'` if you are - calling `.page('Home')`. + This optional `auto_delay` property determines the auto-popup behavior + of a widget. It is specified as an integer with the number of + milliseconds to wait before the widget appears automatically. A value of + 0 indicates manual widget invocation. settings: [] - name: id display_name: Widget ID @@ -6948,29 +6906,16 @@ items: If you created a FriendBuy widget, you can enter your **Widget ID** here to load it onto your webpages. settings: [] - - name: autoDelay - display_name: Widget Auto Delay - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This optional `auto_delay` property determines the auto-popup behavior - of a widget. It is specified as an integer with the number of - milliseconds to wait before the widget appears automatically. A value of - 0 indicates manual widget invocation. - settings: [] - - name: selector - display_name: Widget Selector + - name: name + display_name: Page Name type: STRING deprecated: false - required: false + required: true string_validators: regexp: '' description: >- - The optional selector is an optional string identifying the HTML element - where the widget is to be placed. For example, `'div.my-widget'` + Enter the `name` of your `.page()` calls. ie. `'Home'` if you are + calling `.page('Home')`. settings: [] - name: parameters display_name: Widget Parameters @@ -6986,6 +6931,17 @@ items: `survey=false` dynamically, you can enter `'isSurvey': 'survey'` assuming `isSurvey` is a valid property on your `.page()` calls. settings: [] + - name: selector + display_name: Widget Selector + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + The optional selector is an optional string identifying the HTML element + where the widget is to be placed. For example, `'div.my-widget'` + settings: [] connection_modes: device: web: true @@ -7022,33 +6978,12 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: trackAllPages - display_name: Track All Pages + - name: debug + display_name: Enter FS debug mode type: BOOLEAN deprecated: false required: false - description: Sends all page calls as tracking events to FullStory. - settings: [] - - name: trackCategorizedPages - display_name: Track Categorized Pages - type: BOOLEAN - deprecated: false - required: false - description: 'Sends pages that specify a category to Fullstory as tracking events. ' - settings: [] - - name: trackNamedPages - display_name: Track Named Pages - type: BOOLEAN - deprecated: false - required: false - description: Sends pages with names to FullStory as tracking events. - settings: [] - - name: debug - display_name: Enter FS debug mode - type: BOOLEAN - deprecated: false - required: false - description: This will enable FullStory's debug mode + description: This will enable FullStory's debug mode settings: [] - name: org display_name: FS Org @@ -7062,6 +6997,27 @@ items: your account, clicking the settings icon on the bottom left, and looking in the recording snippet for window['_fs_org'] settings: [] + - name: trackAllPages + display_name: Track All Pages + type: BOOLEAN + deprecated: false + required: false + description: Sends all page calls as tracking events to FullStory. + settings: [] + - name: trackCategorizedPages + display_name: Track Categorized Pages + type: BOOLEAN + deprecated: false + required: false + description: 'Sends pages that specify a category to Fullstory as tracking events. ' + settings: [] + - name: trackNamedPages + display_name: Track Named Pages + type: BOOLEAN + deprecated: false + required: false + description: Sends pages with names to FullStory as tracking events. + settings: [] connection_modes: device: web: true @@ -7198,6 +7154,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: accessKey + display_name: Access Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-z0-9-]{36}$' + description: >- + It should be 36 characters long, and look something like this: + `35a84f9e-7084-47a1-b8a5-593444e9e862`. + settings: [] - name: events display_name: Whitelist Track Events type: MIXED @@ -7224,17 +7191,6 @@ items: those events through. Put the name of your `.track()` events here, ie. 'Order Completed' settings: [] - - name: accessKey - display_name: Access Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-z0-9-]{36}$' - description: >- - It should be 36 characters long, and look something like this: - `35a84f9e-7084-47a1-b8a5-593444e9e862`. - settings: [] connection_modes: device: web: false @@ -7371,33 +7327,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: trackLocal - display_name: Track Local - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable to track data on local pages/sites (using the `file://` protocol, - or on `localhost`). This helps prevent local development from polluting - your stats. - settings: [] - - name: trackParams - display_name: Track Parameters - type: BOOLEAN - deprecated: false - required: false - description: >- - Disable to ignore URL querystring parameters from the page URL, for - example `/home?my=query&string=true` will be tracked as `/home` if this is - set to disabled. - settings: [] - - name: useCookies - display_name: Use Cookies - type: BOOLEAN - deprecated: false - required: false - description: Disable this if you don't want to use cookies - settings: [] - name: anonymizeIP display_name: Anonymize IP type: BOOLEAN @@ -7407,6 +7336,17 @@ items: Enable if you need to anonymize the IP address of visitors to your website. settings: [] + - name: apiKey + display_name: API Key (Server-side) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Generate your server-side API key here: + https://www.gosquared.com/settings/api + settings: [] - name: apiSecret display_name: Site Token type: STRING @@ -7441,16 +7381,32 @@ items: Enable if you'd like page hashes to be tracked alongside the page URL. By default, `example.com/about#us` will be tracked as `example.com/about`. settings: [] - - name: apiKey - display_name: API Key (Server-side) - type: STRING + - name: trackLocal + display_name: Track Local + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - Generate your server-side API key here: - https://www.gosquared.com/settings/api + Enable to track data on local pages/sites (using the `file://` protocol, + or on `localhost`). This helps prevent local development from polluting + your stats. + settings: [] + - name: trackParams + display_name: Track Parameters + type: BOOLEAN + deprecated: false + required: false + description: >- + Disable to ignore URL querystring parameters from the page URL, for + example `/home?my=query&string=true` will be tracked as `/home` if this is + set to disabled. + settings: [] + - name: useCookies + display_name: Use Cookies + type: BOOLEAN + deprecated: false + required: false + description: Disable this if you don't want to use cookies settings: [] connection_modes: device: @@ -7488,36 +7444,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: trackAttributionData - display_name: Track Attribution Data - type: BOOLEAN - deprecated: false - required: false - description: >- - If this setting is enabled, Segment will send successfully attributed - `Application Installed` events from AdWords as `Install Attributed` events - back into this source. These events will contain data about the AdWords - campaign that lead to the conversion. You can learn more about these - events [here](https://segment.com/docs/spec/mobile/#install-attributed). - - - **Important:** this feature is only available if you are using the new - AdWords version. - settings: [] - - name: version - display_name: Version - type: SELECT - deprecated: false - required: false - select_validators: - select_options: - - '1' - - '2' - description: >- - The current version of your AdWords account. If you have migrated your - AdWords account to the **new** AdWords interface at any point, you are - using version 2. Otherwise, please select version 1. - settings: [] - name: conversionId display_name: Conversion ID type: STRING @@ -7546,6 +7472,15 @@ items: required: false description: AdWords behavior for each of your Segment Events is defined here. settings: + - name: conversionId + display_name: Conversion ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: You can opt to override the default conversion ID by setting one here + settings: [] - name: eventName display_name: Event Name type: STRING @@ -7568,15 +7503,6 @@ items: conversion, you'll need to map the event name to its corresponding label here. settings: [] - - name: conversionId - display_name: Conversion ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: You can opt to override the default conversion ID by setting one here - settings: [] - name: remarketing display_name: Send Remarketing Tag type: BOOLEAN @@ -7610,6 +7536,36 @@ items: required: false description: Enable this to send a remarketing tag with your page calls settings: [] + - name: trackAttributionData + display_name: Track Attribution Data + type: BOOLEAN + deprecated: false + required: false + description: >- + If this setting is enabled, Segment will send successfully attributed + `Application Installed` events from AdWords as `Install Attributed` events + back into this source. These events will contain data about the AdWords + campaign that lead to the conversion. You can learn more about these + events [here](https://segment.com/docs/spec/mobile/#install-attributed). + + + **Important:** this feature is only available if you are using the new + AdWords version. + settings: [] + - name: version + display_name: Version + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - '1' + - '2' + description: >- + The current version of your AdWords account. If you have migrated your + AdWords account to the **new** AdWords interface at any point, you are + using version 2. Otherwise, please select version 1. + settings: [] connection_modes: device: web: true @@ -7646,6 +7602,26 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: accountId + display_name: Google Conversion ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: ^AW-.+ + description: >- + Enter your GOOGLE-CONVERSION-ID. You can get this value from your global + site tag snippet. It should look something like `AW-901243031` + settings: [] + - name: clickConversions + display_name: Click Conversions + type: MIXED + deprecated: false + required: false + description: >- + You can map your `.track()` events to specific AdWords Click Conversions + by providing your event `name` and the Conversion ID. + settings: [] - name: conversionLinker display_name: Conversion Linker type: BOOLEAN @@ -7689,26 +7665,6 @@ items: conversions will be sent as remarketing hits which will allow you to create audiences based on those properties. settings: [] - - name: accountId - display_name: Google Conversion ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: ^AW-.+ - description: >- - Enter your GOOGLE-CONVERSION-ID. You can get this value from your global - site tag snippet. It should look something like `AW-901243031` - settings: [] - - name: clickConversions - display_name: Click Conversions - type: MIXED - deprecated: false - required: false - description: >- - You can map your `.track()` events to specific AdWords Click Conversions - by providing your event `name` and the Conversion ID. - settings: [] connection_modes: device: web: true @@ -7750,41 +7706,27 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: doubleClick - display_name: 'Remarketing, Display Ads and Demographic Reports.' + - name: anonymizeIp + display_name: Anonymize IP Addresses type: BOOLEAN deprecated: false required: false - description: Works with both Universal and Classic tracking methods. - settings: [] - - name: trackingId - display_name: Website Tracking ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: ^UA-\d+-\d+$ description: >- - Your website's Tracking ID is in the **Tracking Info** tab on the [Admin - Page](https://www.google.com/analytics/web/#management/Property) of Google - Analytics. Leave it blank if you don't have a website property. + For client side libraries. Read more about anonymizing IP addresses from + the [Google support + documentation](https://support.google.com/analytics/answer/2763052?hl=en). settings: [] - - name: useGoogleAmpClientId - display_name: Use Google AMP Client ID + - name: classic + display_name: Use Classic Analytics on Your Site type: BOOLEAN deprecated: false required: false description: >- - Google’s AMP Client ID API lets you uniquely identify users who engage - with your content on AMP and non-AMP pages. If you opt-in, Google - Analytics will use the user's AMP Client ID to determine that multiple - site events belong to the same user when those users visit AMP pages via a - [Google viewer](https://support.google.com/websearch/answer/7220196). - Associating events and users provides features like user counts and - session-based metrics. *Enabling this feature will affect your reporting.* - Please carefully reference Google's - [documentation](https://support.google.com/analytics/answer/7486764?hl=en&ref_topic=7378717) - for more info before you enable it. + **Important:** When creating your Google Analytics profile, you can choose + between **Classic** and **Universal** Analytics. After March 2013, new + profiles default to Universal, while earlier ones are Classic. An easy + test: if you see `_gaq.push` in your code you're using Classic, so enable + this. settings: [] - name: contentGroupings display_name: Content Groupings @@ -7805,197 +7747,141 @@ items: value of the property you designate as the value of the specified content grouping. settings: [] - - name: enhancedEcommerce - display_name: Enable Enhanced Ecommerce - type: BOOLEAN + - name: dimensions + display_name: Custom Dimensions + type: MAP deprecated: false required: false + map_validators: + regexp: '' + min: 0 + max: 200 + map_prefix: dimension + select_options: [] description: >- - If you want more detailed reports on ecommerce, you might want to enable - this feature. Read more about it - [here](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce). + Because Google Analytics cannot accept arbitrary data about users or + events, when you use `analytics.identify(userId, traits)` with custom + traits or `analytics.track('event', properties)` with custom properties, + you need to map those traits and properties to Google Analytics custom + dimensions if you want them to be sent to GA. Enter a trait or property + name on the left. Choose the Google Analytics dimension you want on the + right. Google Analytics only accepts numbered dimensions (e.g. + dimension3). We suggest using user-scoped dimensions for trait mappings + and hit-scoped dimensions for properties [Contact + us](https://segment.com/contact) if you need help! settings: [] - - name: identifyEventName - display_name: Server Side Identify Event Action + - name: domain + display_name: Cookie Domain Name type: STRING deprecated: false required: false string_validators: - regexp: '' - description: >- - If you have **Enabled Server Side Identify**, you can specify what the - event action will be since all custom metrics/dimensions for server side - `.identify()` calls will be sent via an event hit to GA. The default value - will be `'User Enriched'` - settings: [] - - name: siteSpeedSampleRate - display_name: Site Speed Sample Rate - type: NUMBER - deprecated: false - required: false - number_validators: - min: 1 - max: 100 + regexp: '^none$|^[a-zA-Z0-9_-]+\.[.a-zA-Z0-9_-]+$' description: >- - Defines the sample size for Site Speed data collection. If you have a - small number of visitors you might want to adjust the sampling to a larger - rate for your [site speed - stats](https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration?hl=en#_gat.GA_Tracker_._setSiteSpeedSampleRate). + _Only data sent from visitors on this domain_ will be recorded. By default + Google Analytics automatically resolves the domain name, so you should + **leave this blank unless you know you want otherwise**! This option is + useful if you need to ignore data from other domains, or explicitly set + the domain of your Google Analytics cookie. This is known as Override + Domain Name in [GA + Classic](https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingSite). + If you are testing locally, you can set the domain to `none`. [Read more + about this setting in our + docs](/docs/integrations/google-analytics/#cookie-domain-name). settings: [] - - name: trackNamedPages - display_name: Track Named Pages + - name: doubleClick + display_name: 'Remarketing, Display Ads and Demographic Reports.' type: BOOLEAN deprecated: false required: false - description: >- - Tracks events to Google Analytics for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `name` associated with them. E.g. `page('Signup')` translates to **Viewed - Signup Page**. + description: Works with both Universal and Classic tracking methods. settings: [] - - name: anonymizeIp - display_name: Anonymize IP Addresses + - name: enableServerIdentify + display_name: Enable Server Side Identify type: BOOLEAN deprecated: false required: false description: >- - For client side libraries. Read more about anonymizing IP addresses from - the [Google support - documentation](https://support.google.com/analytics/answer/2763052?hl=en). + If you are sending `.identify()` calls from your server side libraries or + have Segment Cloud Apps that send back `.identify()` calls with enriched + user traits, you can send that data to your GA account via custom + dimensions and metrics. Unlike the client side integration which has the + luxury of browsers and the global window `ga` tracker, for server side we + will check your `traits` and your settings for custom dimension/metric + mappings and send it with an explicit event. settings: [] - - name: ignoredReferrers - display_name: Ignored Referrers - type: MULTI_LINE_STRING + - name: enhancedEcommerce + display_name: Enable Enhanced Ecommerce + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - Add any domains you want to ignore, separated by line breaks. You might - use this if you want Google Analytics to ignore certain referral domains - (e.g. to prevent your subdomains from showing up as referrers in your - analytics). _Note: this only works for Classic profiles. Universal - profiles can_ [edit their ignored - referrers](https://support.google.com/analytics/answer/2795830?hl=en&ref_topic=2790009) - _directly inside Google Analytics._ + If you want more detailed reports on ecommerce, you might want to enable + this feature. Read more about it + [here](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce). settings: [] - - name: resetCustomDimensionsOnPage - display_name: Reset dimensions on Page calls - type: LIST + - name: enhancedLinkAttribution + display_name: Enable Enhanced Link Attribution + type: BOOLEAN deprecated: false required: false description: >- - If you have an SPA website, and need to reset custom dimensions between - page calls, add to this setting all the properties (already mapped as - custom dimensions) that need to be reset for each page call. + Provides more detailed reports on the links clicked on your site. Read + more about it in the [Google support + documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-link-attribution). settings: [] - - name: mobileTrackingId - display_name: Mobile Tracking ID + - name: identifyCategory + display_name: Server Side Identify Event Category type: STRING deprecated: false required: false string_validators: - regexp: ^UA-\d+-\d+$ + regexp: '' description: >- - Google Analytics tracks mobile apps separately, so you'll want to create a - separate Google Analytics mobile app property. Remember to only add a - mobile tracking ID if you're tracking from a mobile library. If you're - tracking from a hybrid app, fill in your website tracking ID instead. - Leave it blank if you don't have a mobile app property. + If you have **Enabled Server Side Identify**, you can specify the trait + you want to look up for setting the event category will be since all + custom metrics/dimensions for server side `.identify()` calls will be sent + via an event hit to GA. The default value will be `'All'`. For example, if + you are sending `traits.category`, you can put 'category' in the setting + above and we will send the value of this trait as the event category. settings: [] - - name: optimize - display_name: Optimize Container ID + - name: identifyEventName + display_name: Server Side Identify Event Action type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Integrate with Google Analytics Optimize plugin. Please enter your - Optimize Container ID - settings: [] - - name: reportUncaughtExceptions - display_name: Send Uncaught Exceptions to GA (Mobile) - type: BOOLEAN - deprecated: false - required: false - description: >- - This lets you study errors and exceptions in your iOS and Android apps in - Google Analytics. - settings: [] - - name: setAllMappedProps - display_name: Set Custom Dimensions & Metrics to the Page - type: BOOLEAN - deprecated: false - required: false - description: >- - Google Analytics allows users to either pass custom dimensions / metrics - as properties of specific events or as properties for all events on a - given page (or the lifetime of the global tracker object). The default - Segment behavior is the latter. Any metrics / dimensions that are mapped - to a given property will be set to the page and sent as properties of all - subsequent events on that page. You can disable this functionality with - this setting. If disabled, Segment will only pass custom dimensions / - metrics as part of the payload of the event with which they are explicitly - associated. Please reference the Google Analytics - [documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets#implementation) - for more info. - settings: [] - - name: sampleRate - display_name: Sample Rate - type: NUMBER - deprecated: false - required: false - number_validators: - min: 1 - max: 100 - description: >- - Specifies what percentage of users should be tracked. This defaults to 100 - (no users are sampled out) but large sites may need to use a lower sample - rate to stay within Google Analytics processing limits as [seen - here](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#sampleRate). - Currently only available in the browser - mobile coming soon. - settings: [] - - name: classic - display_name: Use Classic Analytics on Your Site - type: BOOLEAN - deprecated: false - required: false - description: >- - **Important:** When creating your Google Analytics profile, you can choose - between **Classic** and **Universal** Analytics. After March 2013, new - profiles default to Universal, while earlier ones are Classic. An easy - test: if you see `_gaq.push` in your code you're using Classic, so enable - this. + If you have **Enabled Server Side Identify**, you can specify what the + event action will be since all custom metrics/dimensions for server side + `.identify()` calls will be sent via an event hit to GA. The default value + will be `'User Enriched'` settings: [] - - name: domain - display_name: Cookie Domain Name - type: STRING + - name: ignoredReferrers + display_name: Ignored Referrers + type: MULTI_LINE_STRING deprecated: false required: false string_validators: - regexp: '^none$|^[a-zA-Z0-9_-]+\.[.a-zA-Z0-9_-]+$' + regexp: '' description: >- - _Only data sent from visitors on this domain_ will be recorded. By default - Google Analytics automatically resolves the domain name, so you should - **leave this blank unless you know you want otherwise**! This option is - useful if you need to ignore data from other domains, or explicitly set - the domain of your Google Analytics cookie. This is known as Override - Domain Name in [GA - Classic](https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingSite). - If you are testing locally, you can set the domain to `none`. [Read more - about this setting in our - docs](/docs/integrations/google-analytics/#cookie-domain-name). + Add any domains you want to ignore, separated by line breaks. You might + use this if you want Google Analytics to ignore certain referral domains + (e.g. to prevent your subdomains from showing up as referrers in your + analytics). _Note: this only works for Classic profiles. Universal + profiles can_ [edit their ignored + referrers](https://support.google.com/analytics/answer/2795830?hl=en&ref_topic=2790009) + _directly inside Google Analytics._ settings: [] - - name: enhancedLinkAttribution - display_name: Enable Enhanced Link Attribution + - name: includeSearch + display_name: Include the Querystring in Page Views type: BOOLEAN deprecated: false required: false description: >- - Provides more detailed reports on the links clicked on your site. Read - more about it in the [Google support - documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-link-attribution). + The querystring doesn't usually affect the content of the page in a + significant way (like sorting), so we disable this by default. settings: [] - name: metrics display_name: Custom Metrics @@ -8020,55 +7906,52 @@ items: hit-scoped metrics for properties. [Contact us](https://segment.com/contact) if you need help! settings: [] - - name: nonInteraction - display_name: Add the non-interaction flag to all events - type: BOOLEAN + - name: mobileTrackingId + display_name: Mobile Tracking ID + type: STRING deprecated: false required: false + string_validators: + regexp: ^UA-\d+-\d+$ description: >- - Adds a _noninteraction: true flag_ to every event tracked to Google - Analytics. If you're seeing unusually low bounce rates this will solve - that issue. + Google Analytics tracks mobile apps separately, so you'll want to create a + separate Google Analytics mobile app property. Remember to only add a + mobile tracking ID if you're tracking from a mobile library. If you're + tracking from a hybrid app, fill in your website tracking ID instead. + Leave it blank if you don't have a mobile app property. settings: [] - - name: trackCategorizedPages - display_name: Track Categorized Pages + - name: nameTracker + display_name: Name Tracker type: BOOLEAN deprecated: false required: false description: >- - Tracks events to Google Analytics for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `category` associated with them. E.g. `page('Docs', 'Index')` translates - to **Viewed Docs Page**. + Name the tracker 'segmentGATracker'. Enable this if you're working with + additional Google Analytics trackers and want to ensure that your Segment + tracker has a distinct name. If this is enabled you must prepend this + tracker name to any native Google Analytics (except for create) that you + call, e.g. 'segmentGATracker.require(....)' settings: [] - - name: enableServerIdentify - display_name: Enable Server Side Identify + - name: nonInteraction + display_name: Add the non-interaction flag to all events type: BOOLEAN deprecated: false required: false description: >- - If you are sending `.identify()` calls from your server side libraries or - have Segment Cloud Apps that send back `.identify()` calls with enriched - user traits, you can send that data to your GA account via custom - dimensions and metrics. Unlike the client side integration which has the - luxury of browsers and the global window `ga` tracker, for server side we - will check your `traits` and your settings for custom dimension/metric - mappings and send it with an explicit event. + Adds a _noninteraction: true flag_ to every event tracked to Google + Analytics. If you're seeing unusually low bounce rates this will solve + that issue. settings: [] - - name: identifyCategory - display_name: Server Side Identify Event Category + - name: optimize + display_name: Optimize Container ID type: STRING deprecated: false required: false string_validators: regexp: '' - description: >- - If you have **Enabled Server Side Identify**, you can specify the trait - you want to look up for setting the event category will be since all - custom metrics/dimensions for server side `.identify()` calls will be sent - via an event hit to GA. The default value will be `'All'`. For example, if - you are sending `traits.category`, you can put 'category' in the setting - above and we will send the value of this trait as the event category. + description: >- + Integrate with Google Analytics Optimize plugin. Please enter your + Optimize Container ID settings: [] - name: protocolMappings display_name: Map Traits or Properties to Measurement Protocol Params @@ -8089,6 +7972,40 @@ items: traits or properties to known [measurement protocol params](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters). settings: [] + - name: reportUncaughtExceptions + display_name: Send Uncaught Exceptions to GA (Mobile) + type: BOOLEAN + deprecated: false + required: false + description: >- + This lets you study errors and exceptions in your iOS and Android apps in + Google Analytics. + settings: [] + - name: resetCustomDimensionsOnPage + display_name: Reset dimensions on Page calls + type: LIST + deprecated: false + required: false + description: >- + If you have an SPA website, and need to reset custom dimensions between + page calls, add to this setting all the properties (already mapped as + custom dimensions) that need to be reset for each page call. + settings: [] + - name: sampleRate + display_name: Sample Rate + type: NUMBER + deprecated: false + required: false + number_validators: + min: 1 + max: 100 + description: >- + Specifies what percentage of users should be tracked. This defaults to 100 + (no users are sampled out) but large sites may need to use a lower sample + rate to stay within Google Analytics processing limits as [seen + here](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#sampleRate). + Currently only available in the browser - mobile coming soon. + settings: [] - name: sendUserId display_name: Send User-ID to GA type: BOOLEAN @@ -8127,60 +8044,99 @@ items: in your app send data to Google Analytics server side, since Segment sends data to them via our own servers. settings: [] - - name: typeOverride - display_name: Send Segment "Product List" Events to GA as "Event" Hits + - name: setAllMappedProps + display_name: Set Custom Dimensions & Metrics to the Page type: BOOLEAN deprecated: false required: false description: >- - By default, Segment sends "Product List Viewed" and "Product List - Filtered" ecommerce events to GA as "pageview" hit types. Enable this - setting to instead map these two specced Segment track events to GA as - "event" hit types. + Google Analytics allows users to either pass custom dimensions / metrics + as properties of specific events or as properties for all events on a + given page (or the lifetime of the global tracker object). The default + Segment behavior is the latter. Any metrics / dimensions that are mapped + to a given property will be set to the page and sent as properties of all + subsequent events on that page. You can disable this functionality with + this setting. If disabled, Segment will only pass custom dimensions / + metrics as part of the payload of the event with which they are explicitly + associated. Please reference the Google Analytics + [documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets#implementation) + for more info. settings: [] - - name: dimensions - display_name: Custom Dimensions - type: MAP + - name: siteSpeedSampleRate + display_name: Site Speed Sample Rate + type: NUMBER deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 200 - map_prefix: dimension - select_options: [] + number_validators: + min: 1 + max: 100 description: >- - Because Google Analytics cannot accept arbitrary data about users or - events, when you use `analytics.identify(userId, traits)` with custom - traits or `analytics.track('event', properties)` with custom properties, - you need to map those traits and properties to Google Analytics custom - dimensions if you want them to be sent to GA. Enter a trait or property - name on the left. Choose the Google Analytics dimension you want on the - right. Google Analytics only accepts numbered dimensions (e.g. - dimension3). We suggest using user-scoped dimensions for trait mappings - and hit-scoped dimensions for properties [Contact - us](https://segment.com/contact) if you need help! + Defines the sample size for Site Speed data collection. If you have a + small number of visitors you might want to adjust the sampling to a larger + rate for your [site speed + stats](https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration?hl=en#_gat.GA_Tracker_._setSiteSpeedSampleRate). settings: [] - - name: includeSearch - display_name: Include the Querystring in Page Views + - name: trackCategorizedPages + display_name: Track Categorized Pages type: BOOLEAN deprecated: false required: false description: >- - The querystring doesn't usually affect the content of the page in a - significant way (like sorting), so we disable this by default. + Tracks events to Google Analytics for [`page` + method](https://segment.io/libraries/analytics.js#page) calls that have a + `category` associated with them. E.g. `page('Docs', 'Index')` translates + to **Viewed Docs Page**. settings: [] - - name: nameTracker - display_name: Name Tracker + - name: trackNamedPages + display_name: Track Named Pages type: BOOLEAN deprecated: false required: false description: >- - Name the tracker 'segmentGATracker'. Enable this if you're working with - additional Google Analytics trackers and want to ensure that your Segment - tracker has a distinct name. If this is enabled you must prepend this - tracker name to any native Google Analytics (except for create) that you - call, e.g. 'segmentGATracker.require(....)' + Tracks events to Google Analytics for [`page` + method](https://segment.io/libraries/analytics.js#page) calls that have a + `name` associated with them. E.g. `page('Signup')` translates to **Viewed + Signup Page**. + settings: [] + - name: trackingId + display_name: Website Tracking ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: ^UA-\d+-\d+$ + description: >- + Your website's Tracking ID is in the **Tracking Info** tab on the [Admin + Page](https://www.google.com/analytics/web/#management/Property) of Google + Analytics. Leave it blank if you don't have a website property. + settings: [] + - name: typeOverride + display_name: Send Segment "Product List" Events to GA as "Event" Hits + type: BOOLEAN + deprecated: false + required: false + description: >- + By default, Segment sends "Product List Viewed" and "Product List + Filtered" ecommerce events to GA as "pageview" hit types. Enable this + setting to instead map these two specced Segment track events to GA as + "event" hit types. + settings: [] + - name: useGoogleAmpClientId + display_name: Use Google AMP Client ID + type: BOOLEAN + deprecated: false + required: false + description: >- + Google’s AMP Client ID API lets you uniquely identify users who engage + with your content on AMP and non-AMP pages. If you opt-in, Google + Analytics will use the user's AMP Client ID to determine that multiple + site events belong to the same user when those users visit AMP pages via a + [Google viewer](https://support.google.com/websearch/answer/7220196). + Associating events and users provides features like user counts and + session-based metrics. *Enabling this feature will affect your reporting.* + Please carefully reference Google's + [documentation](https://support.google.com/analytics/answer/7486764?hl=en&ref_topic=7378717) + for more info before you enable it. settings: [] connection_modes: device: @@ -8318,6 +8274,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: containerId + display_name: Container ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + You can find your Container ID in your [Accounts + page](https://www.google.com/tagmanager/web/#management/Accounts/). + settings: [] - name: environment display_name: Environment type: STRING @@ -8363,17 +8330,6 @@ items: `name` associated with them. For example `page('Signup')` would translate to **Viewed Signup Page**. settings: [] - - name: containerId - display_name: Container ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your Container ID in your [Accounts - page](https://www.google.com/tagmanager/web/#management/Accounts/). - settings: [] connection_modes: device: web: true @@ -8697,9 +8653,9 @@ items: url: connections/destinations/catalog/hotjar status: PUBLIC logo: - url: 'https://www.hotjar.com/hs-fs/hubfs/Image/logo.png' + url: 'https://cdn.filepicker.io/api/file/3I0NmHbUQM6JST09h0fy' mark: - url: 'https://cdn.filepicker.io/api/file/8LXFsmQVQq2tbURxFWyo' + url: 'https://cdn.filepicker.io/api/file/517mam1rRdeWj0Obnb4o' categories: - Heatmaps & Recordings components: @@ -8772,7 +8728,7 @@ items: server: true mobile: true browserUnbundlingSupported: false - browserUnbundlingPublic: true + browserUnbundlingPublic: false settings: - name: apiKey display_name: API Key @@ -8824,7 +8780,7 @@ items: mobile: false server: false cloud: - web: true + web: false mobile: true server: true previous_names: @@ -8966,42 +8922,6 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: false settings: - - name: campaignId - display_name: Campaign ID - type: NUMBER - deprecated: false - required: true - number_validators: - min: 1 - max: 0 - description: >- - Each Segment data source needs to be associated with an Impact Campaign - ID. This ID can be found in the top right corner of your Impact dashboard. - It is the number next to the name of your Impact project. - settings: [] - - name: mobileEvents - display_name: Mobile Events - type: MIXED - deprecated: false - required: false - description: >- - This setting is used to map your Segment events to your Mobile App Events - in Impact. Each mapping consists of the Segment event name and the - corresponding App ID and Event Code you would like to map it to. Please - reference our documentation for more info. - settings: [] - - name: trackingDomain - display_name: Tracking Domain - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Your Impact tracking domain is used to properly attribute conversion - events. To find yours, from your Impact dashboard click on Tracking - Settings > General. It should look like `projectname.sjv.io`. - settings: [] - name: accountSid display_name: Account SID type: STRING @@ -9039,6 +8959,42 @@ items: **Auth Token**). Please contact your Impact support team if your are having issues finding this. settings: [] + - name: campaignId + display_name: Campaign ID + type: NUMBER + deprecated: false + required: true + number_validators: + min: 1 + max: 0 + description: >- + Each Segment data source needs to be associated with an Impact Campaign + ID. This ID can be found in the top right corner of your Impact dashboard. + It is the number next to the name of your Impact project. + settings: [] + - name: mobileEvents + display_name: Mobile Events + type: MIXED + deprecated: false + required: false + description: >- + This setting is used to map your Segment events to your Mobile App Events + in Impact. Each mapping consists of the Segment event name and the + corresponding App ID and Event Code you would like to map it to. Please + reference our documentation for more info. + settings: [] + - name: trackingDomain + display_name: Tracking Domain + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your Impact tracking domain is used to properly attribute conversion + events. To find yours, from your Impact dashboard click on Tracking + Settings > General. It should look like `projectname.sjv.io`. + settings: [] connection_modes: device: web: false @@ -9075,27 +9031,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: projectId - display_name: Project ID + - name: domain + display_name: Domain type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your Improvely project id in your Improvely analytics code - snippet as `im_project_id`. + You can find your Improvely domain in your Improvely analytics code + snippet as `im_domain`. settings: [] - - name: domain - display_name: Domain + - name: projectId + display_name: Project ID type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your Improvely domain in your Improvely analytics code - snippet as `im_domain`. + You can find your Improvely project id in your Improvely analytics code + snippet as `im_project_id`. settings: [] connection_modes: device: @@ -9282,6 +9238,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: >- + Enter your S3 credentials or your Azure Blob Storage Shared Access + Signature (SAS). + settings: [] - name: bucketContainerUrl display_name: BUCKET CONTAINER URL type: STRING @@ -9302,17 +9269,6 @@ items: regexp: '' description: Enter 'AWS' or 'Azure' settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^.{8,}$' - description: >- - Enter your S3 credentials or your Azure Blob Storage Shared Access - Signature (SAS). - settings: [] connection_modes: device: web: false @@ -9355,29 +9311,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: oauth - display_name: OAuth - type: BOOLEAN - deprecated: false - required: false - description: >- - Intercom uses an OAuth-like interface for reading/writing to their system. - This option stores the various values that are needed by Intercom to - validate requests (replaces API keys), and the user-specific values for UI - display (e.g. user's email, avatar, list of accounts, etc.). These fields - are unique to Intercom, and are cleared out en masse when disconnecting - (revoking authorization). - settings: [] - - name: richLinkProperties - display_name: Rich Link Properties - type: LIST - deprecated: false - required: false - description: >- - To use Intercom's Rich Link object, list the name of the exact Segment - property name and make sure the value of those properties only include - `url` and `value` keys. - settings: [] - name: activator display_name: Custom Inbox Button Selector type: STRING @@ -9443,6 +9376,29 @@ items: regexp: '' description: 'Note: this is **required** to send data to Intercom from your mobile apps.' settings: [] + - name: oauth + display_name: OAuth + type: BOOLEAN + deprecated: false + required: false + description: >- + Intercom uses an OAuth-like interface for reading/writing to their system. + This option stores the various values that are needed by Intercom to + validate requests (replaces API keys), and the user-specific values for UI + display (e.g. user's email, avatar, list of accounts, etc.). These fields + are unique to Intercom, and are cleared out en masse when disconnecting + (revoking authorization). + settings: [] + - name: richLinkProperties + display_name: Rich Link Properties + type: LIST + deprecated: false + required: false + description: >- + To use Intercom's Rich Link object, list the name of the exact Segment + property name and make sure the value of those properties only include + `url` and `value` keys. + settings: [] connection_modes: device: web: true @@ -9546,6 +9502,18 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + You can find your iterable API key under your "API Configuration + Settings". It should look something like this: + 42f187310705012194bd0bd694905664ae. + settings: [] - name: mapAllPagesToSingleEventName display_name: Map All Pages to Single Event Name type: BOOLEAN @@ -9582,18 +9550,6 @@ items: required: false description: Send an event for every page or screen with a name. settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your iterable API key under your "API Configuration - Settings". It should look something like this: - 42f187310705012194bd0bd694905664ae. - settings: [] connection_modes: device: web: false @@ -9775,12 +9731,16 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: uaAddon - display_name: UserAgent Addon + - name: initialPageview + display_name: Track an Initial Pageview type: BOOLEAN deprecated: false required: false - description: Enable this to use the Keen's data enrichment to parse UserAgent strings. + description: >- + This will send an intial 'Loaded a Page' event to Keen when the page is + loaded. We disable this by default since Keen is generally used for custom + event tracking, not pageviews. _Note: you must also have the **Send + Pageview Events** setting enabled for this to work._ settings: [] - name: ipAddon display_name: Geo IP Addon @@ -9802,6 +9762,36 @@ items: Your project ID. It should be 24 characters long, and look something like this: `9181bcd23843312d87000000`. settings: [] + - name: readKey + display_name: Read Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you are a Keen Pro user, enter your read key in the advanced settings + tab of your dashboard. It should be a minimum of 32 characters long and + made up of numbers and letters only. + settings: [] + - name: referrerAddon + display_name: Referrer Parsing Addon + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this to use the Keen IO's data enrichment feature for parsing + referrer URLs into their source. + settings: [] + - name: trackAllPages + display_name: Track All Pages to Keen + type: BOOLEAN + deprecated: false + required: false + description: >- + This will track **Loaded a Page** events to Keen for all [`page` + method](https://segment.io/libraries/analytics.js#page) calls. + settings: [] - name: trackCategorizedPages display_name: Track Categorized Pages to Keen type: BOOLEAN @@ -9824,6 +9814,13 @@ items: `name` associated with them. For example `page('Signup')` would translate to **Viewed Signup Page**. settings: [] + - name: uaAddon + display_name: UserAgent Addon + type: BOOLEAN + deprecated: false + required: false + description: Enable this to use the Keen's data enrichment to parse UserAgent strings. + settings: [] - name: urlAddon display_name: URL Parsing Addon type: BOOLEAN @@ -9845,47 +9842,6 @@ items: Your write key should be a minimum of 32 characters long and made up of numbers and letters only. settings: [] - - name: initialPageview - display_name: Track an Initial Pageview - type: BOOLEAN - deprecated: false - required: false - description: >- - This will send an intial 'Loaded a Page' event to Keen when the page is - loaded. We disable this by default since Keen is generally used for custom - event tracking, not pageviews. _Note: you must also have the **Send - Pageview Events** setting enabled for this to work._ - settings: [] - - name: readKey - display_name: Read Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - If you are a Keen Pro user, enter your read key in the advanced settings - tab of your dashboard. It should be a minimum of 32 characters long and - made up of numbers and letters only. - settings: [] - - name: referrerAddon - display_name: Referrer Parsing Addon - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this to use the Keen IO's data enrichment feature for parsing - referrer URLs into their source. - settings: [] - - name: trackAllPages - display_name: Track All Pages to Keen - type: BOOLEAN - deprecated: false - required: false - description: >- - This will track **Loaded a Page** events to Keen for all [`page` - method](https://segment.io/libraries/analytics.js#page) calls. - settings: [] connection_modes: device: web: true @@ -9979,34 +9935,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: sendAnonymous - display_name: Fallback on Anonymous ID - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this option to fallback on `anonymousId` if `userId` is not - available when sending server side events. Note that this option may - result in superfluous user profiles in Klaviyo and is generally not - recommend. If this option is unchecked, we will only accept server side - events that includes the `userId`. - settings: [] - - name: useSegmentSpec - display_name: Send Placed Order Events as Order Completed - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this setting if you'd like to send `Order Completed` events as is - rather than changing the event name to `Placed Order` on the server side - (client side always sends Order Completed). It is recommended that you - keep this setting enabled so that both client and server side Klaviyo - integration sends the same event for `Order Completed`. Klaviyo does not - treat the event names differently in their backend feature wise. This - option was introduced to bridge the existing disparity between our client - and server side integration regarding how this event name is sent without - forcibly breaking the current behavior. - settings: [] - name: apiKey display_name: API Key type: STRING @@ -10064,6 +9992,34 @@ items: to Klaviyo's UI and clicking Account > Settings > API Keys > Create API Key settings: [] + - name: sendAnonymous + display_name: Fallback on Anonymous ID + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this option to fallback on `anonymousId` if `userId` is not + available when sending server side events. Note that this option may + result in superfluous user profiles in Klaviyo and is generally not + recommend. If this option is unchecked, we will only accept server side + events that includes the `userId`. + settings: [] + - name: useSegmentSpec + display_name: Send Placed Order Events as Order Completed + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this setting if you'd like to send `Order Completed` events as is + rather than changing the event name to `Placed Order` on the server side + (client side always sends Order Completed). It is recommended that you + keep this setting enabled so that both client and server side Klaviyo + integration sends the same event for `Order Completed`. Klaviyo does not + treat the event names differently in their backend feature wise. This + option was introduced to bridge the existing disparity between our client + and server side integration regarding how this event name is sent without + forcibly breaking the current behavior. + settings: [] connection_modes: device: web: true @@ -10240,6 +10196,37 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: appId + display_name: Leanplum Application Id + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + The application ID. To find yours, select your app in the navigation + column, and click Edit Apps. Under Keys, click Show. + settings: [] + - name: clientKey + display_name: Leanplum Client Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Either the Production or Development keys, depending on which API call you + want to make. + settings: [] + - name: devMode + display_name: Use Leanplum in Development Mode + type: BOOLEAN + deprecated: false + required: false + description: >- + To use development mode, you must also input your Development key as the + client key. + settings: [] - name: gcmSenderId display_name: GCM Sender ID type: STRING @@ -10272,37 +10259,6 @@ items: use Leanplum's built in sender ID instead. If you have set your own GCM Sender ID and enable this setting, both IDs will be used. settings: [] - - name: appId - display_name: Leanplum Application Id - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - The application ID. To find yours, select your app in the navigation - column, and click Edit Apps. Under Keys, click Show. - settings: [] - - name: clientKey - display_name: Leanplum Client Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Either the Production or Development keys, depending on which API call you - want to make. - settings: [] - - name: devMode - display_name: Use Leanplum in Development Mode - type: BOOLEAN - deprecated: false - required: false - description: >- - To use development mode, you must also input your Development key as the - client key. - settings: [] connection_modes: device: web: false @@ -10559,17 +10515,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: setOrganizationScope - display_name: Use Organization Scope for Attributes - type: BOOLEAN - deprecated: false - required: false - description: >- - This allows a user to set the `profileScope` of attributes within - Localytics to Organization. If this is enabled, the attributes that you - set for a user will be available across all of your apps in Localytics. If - it's unchecked, we'll use the default SDK behavior of Application scoping. - settings: [] - name: appKey display_name: App Key type: STRING @@ -10634,6 +10579,17 @@ items: If an App stays in the background for more than this many seconds, start a new session when it returns to foreground. settings: [] + - name: setOrganizationScope + display_name: Use Organization Scope for Attributes + type: BOOLEAN + deprecated: false + required: false + description: >- + This allows a user to set the `profileScope` of attributes within + Localytics to Organization. If this is enabled, the attributes that you + set for a user will be available across all of your apps in Localytics. If + it's unchecked, we'll use the default SDK behavior of Application scoping. + settings: [] connection_modes: device: web: true @@ -10719,6 +10675,27 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^\w{10,30}$' + description: >- + Your API key should be a series of numbers and letters, like + `3daDLlqb4ANg7l0rf4cfl6xF`. This is only required if you are using the + Lytics server side integration. + settings: [] + - name: blockload + display_name: Ensure Entity + type: BOOLEAN + deprecated: false + required: false + description: >- + If `true`, ensures entity returned from Lytics personalization api + reflects all events from current page view. + settings: [] - name: cid display_name: CID type: STRING @@ -10748,27 +10725,6 @@ items: A brief, but informative name for organizating your data in Lytics. Only necessary when you are tracking multiple websites. settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^\w{10,30}$' - description: >- - Your API key should be a series of numbers and letters, like - `3daDLlqb4ANg7l0rf4cfl6xF`. This is only required if you are using the - Lytics server side integration. - settings: [] - - name: blockload - display_name: Ensure Entity - type: BOOLEAN - deprecated: false - required: false - description: >- - If `true`, ensures entity returned from Lytics personalization api - reflects all events from current page view. - settings: [] connection_modes: device: web: true @@ -10925,25 +10881,25 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: listId - display_name: List ID + - name: apiKey + display_name: Authentication key type: STRING deprecated: false required: true string_validators: regexp: '' - description: >- - Please provide the default list id for which contacts will be associated - with + description: Your Mailjet Authentication key settings: [] - - name: apiKey - display_name: Authentication key + - name: listId + display_name: List ID type: STRING deprecated: false required: true string_validators: regexp: '' - description: Your Mailjet Authentication key + description: >- + Please provide the default list id for which contacts will be associated + with settings: [] connection_modes: device: @@ -11097,6 +11053,38 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: + - name: accountId + display_name: Munchkin Account ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + You can find your Account ID under **Admin > Integration > Munchkin > + Tracking Code** in your [Marketo account](https://login.marketo.com/). + settings: [] + - name: anonymousActivity + display_name: Track Anonymous Activity + type: BOOLEAN + deprecated: false + required: false + description: >- + **Cloud Mode Only:** Our Marketo Integration allows you to choose whether + you'd like to track anonymous Leads in Marketo. If you don't want to track + anonymous Leads in Marketo, you must pass a User ID in your event. + settings: [] + - name: beta + display_name: Send Track Events Server Side + type: BOOLEAN + deprecated: false + required: false + description: >- + **Applicable only if you are using Marketo in Device Mode**. This setting + will route all of your Track events through our server-side integration + with Marketo's REST API. Page and Identify events will still be sent using + our client side integration with the Marketo JavaScript SDK. + settings: [] - name: clientId display_name: Client ID type: STRING @@ -11214,18 +11202,6 @@ items: Use these fields for Marketo Lead fields that you'd like mapped to your Segment Identify Traits. settings: - - name: segmentTrait - display_name: Segment Trait Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Our Marketo integration allows you to map your Identify traits to Lead - fields in Marketo. This is case sensitive so make sure the name matches - exactly how you are passing it in your .identify() call. - settings: [] - name: marketoFieldName display_name: Marketo Field Name type: STRING @@ -11250,38 +11226,18 @@ items: - string description: The Marketo Field type for this trait. settings: [] - - name: accountId - display_name: Munchkin Account ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your Account ID under **Admin > Integration > Munchkin > - Tracking Code** in your [Marketo account](https://login.marketo.com/). - settings: [] - - name: anonymousActivity - display_name: Track Anonymous Activity - type: BOOLEAN - deprecated: false - required: false - description: >- - **Cloud Mode Only:** Our Marketo Integration allows you to choose whether - you'd like to track anonymous Leads in Marketo. If you don't want to track - anonymous Leads in Marketo, you must pass a User ID in your event. - settings: [] - - name: beta - display_name: Send Track Events Server Side - type: BOOLEAN - deprecated: false - required: false - description: >- - **Applicable only if you are using Marketo in Device Mode**. This setting - will route all of your Track events through our server-side integration - with Marketo's REST API. Page and Identify events will still be sent using - our client side integration with the Marketo JavaScript SDK. - settings: [] + - name: segmentTrait + display_name: Segment Trait Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Our Marketo integration allows you to map your Identify traits to Lead + fields in Marketo. This is case sensitive so make sure the name matches + exactly how you are passing it in your .identify() call. + settings: [] connection_modes: device: web: true @@ -11348,50 +11304,29 @@ items: required: false description: Configure a conversion pixel settings: - - name: vParameters - display_name: V-Parameters - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 10 - map_prefix: v - select_options: [] - description: >- - Map event properties to vParameters and we'll insert the value of that - property in the corresponding query parameter of the MediaMath Pixel. - Email [friends@segment.io](mailto:friends@segment.io) if you need help! - settings: [] - - name: sParameters - display_name: S-Parameters - type: MAP + - name: event + display_name: Event Name + type: STRING deprecated: false - required: false - map_validators: + required: true + string_validators: regexp: '' - min: 0 - max: 10 - map_prefix: s - select_options: [] description: >- - Map event properties to sParameters and we'll insert the value of that - property in the corresponding query parameter of the MediaMath Pixel. - Email [friends@segment.io](mailto:friends@segment.io) if you need help! + Mediamath allows you to track conversions. When you `analytics.track('my + event')` we will map that event to the `mt_id` and `mt_adid` that you + provide. We'll map other data like properties to s and v parameters + below. settings: [] - - name: event - display_name: Event Name + - name: mtAdId + display_name: mt_adid type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' description: >- - Mediamath allows you to track conversions. When you `analytics.track('my - event')` we will map that event to the `mt_id` and `mt_adid` that you - provide. We'll map other data like properties to s and v parameters - below. + Enter the `mt_adid` that you want us to send when this conversion event + is triggered. settings: [] - name: mtId display_name: mt_id @@ -11404,16 +11339,37 @@ items: Enter the `mt_id` that you want us to send when this conversion event is triggered. settings: [] - - name: mtAdId - display_name: mt_adid - type: STRING + - name: sParameters + display_name: S-Parameters + type: MAP deprecated: false required: false - string_validators: + map_validators: regexp: '' + min: 0 + max: 10 + map_prefix: s + select_options: [] description: >- - Enter the `mt_adid` that you want us to send when this conversion event - is triggered. + Map event properties to sParameters and we'll insert the value of that + property in the corresponding query parameter of the MediaMath Pixel. + Email [friends@segment.io](mailto:friends@segment.io) if you need help! + settings: [] + - name: vParameters + display_name: V-Parameters + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 10 + map_prefix: v + select_options: [] + description: >- + Map event properties to vParameters and we'll insert the value of that + property in the corresponding query parameter of the MediaMath Pixel. + Email [friends@segment.io](mailto:friends@segment.io) if you need help! settings: [] connection_modes: device: @@ -11501,33 +11457,16 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: secureCookie - display_name: Secure Cookie - type: BOOLEAN - deprecated: false - required: false - description: >- - This will mark the Mixpanel cookie as secure, meaning it will only be - transmitted over https - settings: [] - - name: setAllTraitsByDefault - display_name: Automatically set all Traits as Super Properties and People Properties - type: BOOLEAN - deprecated: false - required: false - description: >- - While this is checked, our integration automatically sets all traits on - identify calls as super properties and people properties if Mixpanel - People is checked as well. - settings: [] - - name: superProperties - display_name: Properties to send as Super Properties - type: LIST + - name: apiKey + display_name: API Secret + type: STRING deprecated: false required: false + string_validators: + regexp: '^[a-f0-9]{32}$' description: >- - If you want to see and segment by Super Properties in Mixpanel, then list - the properties you want to see as Super Properties here. + You can find your API Secret under **Settings > Project Settings** in the + upper right of the [Mixpanel interface](https://mixpanel.com). settings: [] - name: consolidatedPageCalls display_name: Track All Pages to Mixpanel with a Consolidated Event Name @@ -11541,25 +11480,23 @@ items: method](https://segment.io/libraries/ios#screen) calls. We enable this by default as it's how Mixpanel suggests sending these calls. settings: [] - - name: groupTraitsToSetOnce - display_name: Group Traits to Set Once - type: LIST + - name: crossSubdomainCookie + display_name: Cross Subdomain Cookie + type: BOOLEAN deprecated: false required: false - description: Group traits to be set only once using Mixpanel's `$set_once` operator. + description: >- + This will allow the Mixpanel cookie to persist between different pages of + your application. settings: [] - - name: persistence - display_name: Persistence Type - type: SELECT + - name: enableEuropeanUnionEndpoint + display_name: Enable European Union Endpoint + type: BOOLEAN deprecated: false required: false - select_validators: - select_options: - - cookie - - localStorage description: >- - This will allow the Mixpanel cookie to persist between different pages of - your application. + Enable this setting to send your events to Mixpanel's [EU + endpoint](https://developer.mixpanel.com/docs/implement-mixpanel#section-implementing-mixpanel-in-the-european-union-eu). settings: [] - name: eventIncrements display_name: Events to increment in People @@ -11574,6 +11511,24 @@ items: 2. List the events you want to see in People here. settings: [] + - name: groupIdentifierTraits + display_name: Group Identifier Traits + type: LIST + deprecated: false + required: false + description: >- + What trait Segment should use as your Mixpanel "group key" in group calls. + If, for example, you set this to be `company`, then "company" will be sent + as `group_key` and the value of `traits["company"]` will be sent as the + `group_id`. + settings: [] + - name: groupTraitsToSetOnce + display_name: Group Traits to Set Once + type: LIST + deprecated: false + required: false + description: Group traits to be set only once using Mixpanel's `$set_once` operator. + settings: [] - name: legacySuperProperties display_name: Legacy Super Properties type: BOOLEAN @@ -11593,45 +11548,80 @@ items: [identify](https://segment.io/docs/methods/identify) calls to Mixpanel's People feature. settings: [] - - name: sourceName - display_name: Source Name - type: STRING + - name: peopleProperties + display_name: Traits to set as People Properties + type: LIST deprecated: false required: false - string_validators: - regexp: '' description: >- - This value, if it's not blank, will be sent as `segment_source_name` to - Mixpanel for every `event`/`page`/`screen` call. + If you only want to set specific traits as People Properties in Mixpanel + People, you will need to: + + - Enable the "Use Mixpanel People" setting. + + - List the traits you want to see in People here. settings: [] - - name: apiKey - display_name: API Secret - type: STRING + - name: persistence + display_name: Persistence Type + type: SELECT deprecated: false required: false - string_validators: - regexp: '^[a-f0-9]{32}$' + select_validators: + select_options: + - cookie + - localStorage description: >- - You can find your API Secret under **Settings > Project Settings** in the - upper right of the [Mixpanel interface](https://mixpanel.com). + This will allow the Mixpanel cookie to persist between different pages of + your application. settings: [] - - name: crossSubdomainCookie - display_name: Cross Subdomain Cookie + - name: propIncrements + display_name: Properties to increment in People + type: LIST + deprecated: false + required: false + description: >- + If you want to see and segment by event counts and last event date in + Mixpanel people, enable people, and then list the events you want to see + in People here. + settings: [] + - name: secureCookie + display_name: Secure Cookie type: BOOLEAN deprecated: false required: false description: >- - This will allow the Mixpanel cookie to persist between different pages of - your application. + This will mark the Mixpanel cookie as secure, meaning it will only be + transmitted over https settings: [] - - name: enableEuropeanUnionEndpoint - display_name: Enable European Union Endpoint + - name: setAllTraitsByDefault + display_name: Automatically set all Traits as Super Properties and People Properties type: BOOLEAN deprecated: false required: false description: >- - Enable this setting to send your events to Mixpanel's [EU - endpoint](https://developer.mixpanel.com/docs/implement-mixpanel#section-implementing-mixpanel-in-the-european-union-eu). + While this is checked, our integration automatically sets all traits on + identify calls as super properties and people properties if Mixpanel + People is checked as well. + settings: [] + - name: sourceName + display_name: Source Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + This value, if it's not blank, will be sent as `segment_source_name` to + Mixpanel for every `event`/`page`/`screen` call. + settings: [] + - name: superProperties + display_name: Properties to send as Super Properties + type: LIST + deprecated: false + required: false + description: >- + If you want to see and segment by Super Properties in Mixpanel, then list + the properties you want to see as Super Properties here. settings: [] - name: token display_name: Token @@ -11654,15 +11644,16 @@ items: method](https://segment.io/libraries/analytics.js#page) calls. We keep this disabled by default. settings: [] - - name: propIncrements - display_name: Properties to increment in People - type: LIST + - name: trackCategorizedPages + display_name: Track Categorized Pages to Mixpanel + type: BOOLEAN deprecated: false required: false description: >- - If you want to see and segment by event counts and last event date in - Mixpanel people, enable people, and then list the events you want to see - in People here. + This will track events to Mixpanel for [`page` + method](https://segment.io/libraries/analytics.js#page) calls that have a + `category` associated with them. For example `page('Docs', 'Index')` would + translate to **Viewed Docs Index Page**. settings: [] - name: trackNamedPages display_name: Track Named Pages to Mixpanel @@ -11675,41 +11666,6 @@ items: `name` associated with them. For example `page('Signup')` would translate to **Viewed Signup Page**. settings: [] - - name: groupIdentifierTraits - display_name: Group Identifier Traits - type: LIST - deprecated: false - required: false - description: >- - What trait Segment should use as your Mixpanel "group key" in group calls. - If, for example, you set this to be `company`, then "company" will be sent - as `group_key` and the value of `traits["company"]` will be sent as the - `group_id`. - settings: [] - - name: peopleProperties - display_name: Traits to set as People Properties - type: LIST - deprecated: false - required: false - description: >- - If you only want to set specific traits as People Properties in Mixpanel - People, you will need to: - - - Enable the "Use Mixpanel People" setting. - - - List the traits you want to see in People here. - settings: [] - - name: trackCategorizedPages - display_name: Track Categorized Pages to Mixpanel - type: BOOLEAN - deprecated: false - required: false - description: >- - This will track events to Mixpanel for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `category` associated with them. For example `page('Docs', 'Index')` would - translate to **Viewed Docs Index Page**. - settings: [] connection_modes: device: web: true @@ -12040,16 +11996,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: mouseflowHtmlDelay - display_name: Mouseflow HTML Delay - type: NUMBER - deprecated: false - required: false - number_validators: - min: 0 - max: 0 - description: HTML Delay - settings: [] - name: apiKey display_name: Site ID type: STRING @@ -12059,6 +12005,16 @@ items: regexp: '' description: Your Mouseflow site ID. settings: [] + - name: mouseflowHtmlDelay + display_name: Mouseflow HTML Delay + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: HTML Delay + settings: [] connection_modes: device: web: true @@ -12192,28 +12148,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: fbAppId - display_name: Facebook App ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - You can find your Facebook App ID in your Nanigans pixel; it's the xxx - part of the fb_app_id=xxx parameter. - settings: [] - - name: isMobile - display_name: Send Events to Mobile Endpoint - type: BOOLEAN - deprecated: false - required: false - description: >- - Select this option to send your data to Nanigans' mobile endpoint. Most - projects (even mobile ones) don't need this option enabled; if you're - unsure, check with your Nanigans contact. Note that if you set this - option, you must also set your Facebook App ID. - settings: [] - name: appId display_name: App ID type: STRING @@ -12234,28 +12168,6 @@ items: Use these fields to map your Segment event names to Nanigans event names. We'll only send Nanigans the conversion events you specify. settings: - - name: name - display_name: Nanigans Event Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter a Nanigans event name. - settings: [] - - name: type - display_name: Nanigans Event Type - type: SELECT - deprecated: false - required: true - select_validators: - select_options: - - user - - visit - - purchase - - install - description: The Nanigans event type for this event. - settings: [] - name: customParameters display_name: Custom Parameters type: MAP @@ -12279,6 +12191,50 @@ items: Our Nanigans integration allows you to map the event names you track in Segment to Nanigans events of name and type. settings: [] + - name: name + display_name: Nanigans Event Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter a Nanigans event name. + settings: [] + - name: type + display_name: Nanigans Event Type + type: SELECT + deprecated: false + required: true + select_validators: + select_options: + - user + - visit + - purchase + - install + description: The Nanigans event type for this event. + settings: [] + - name: fbAppId + display_name: Facebook App ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + You can find your Facebook App ID in your Nanigans pixel; it's the xxx + part of the fb_app_id=xxx parameter. + settings: [] + - name: isMobile + display_name: Send Events to Mobile Endpoint + type: BOOLEAN + deprecated: false + required: false + description: >- + Select this option to send your data to Nanigans' mobile endpoint. Most + projects (even mobile ones) don't need this option enabled; if you're + unsure, check with your Nanigans contact. Note that if you set this + option, you must also set your Facebook App ID. + settings: [] connection_modes: device: web: true @@ -12445,34 +12401,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: insertKey - display_name: Insert Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: Put your New Relic Insert Key - settings: [] - - name: sendContext - display_name: Send Device Context - type: BOOLEAN - deprecated: false - required: false - description: >- - If you enable this setting, we will flatten all your `context` fields - delimited by a period and send it to New Relic. This is recommended as - getting rich device context is useful inside New Relic. - settings: [] - - name: sendIds - display_name: Send UserId and AnonymousId - type: BOOLEAN - deprecated: false - required: false - description: >- - If you want to send your Segment `userId` and `anonymousId`, enabling this - option will do so. - settings: [] - name: accountId display_name: Account ID type: STRING @@ -12503,6 +12431,34 @@ items: Enter your Segment `.track()` event names on the left and their respective eventType (table name) in New Relic. settings: [] + - name: insertKey + display_name: Insert Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Put your New Relic Insert Key + settings: [] + - name: sendContext + display_name: Send Device Context + type: BOOLEAN + deprecated: false + required: false + description: >- + If you enable this setting, we will flatten all your `context` fields + delimited by a period and send it to New Relic. This is recommended as + getting rich device context is useful inside New Relic. + settings: [] + - name: sendIds + display_name: Send UserId and AnonymousId + type: BOOLEAN + deprecated: false + required: false + description: >- + If you want to send your Segment `userId` and `anonymousId`, enabling this + option will do so. + settings: [] connection_modes: device: web: false @@ -12539,17 +12495,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: nolDevDebug - display_name: Enable Debug Mode - type: BOOLEAN - deprecated: false - required: false - description: >- - Check this setting if you would like to activate the Debug flag. Once the - flag is active, it logs each API call made and the data passed. - - Note: DO NOT: activate the Debug flag in a production environment. - settings: [] - name: adAssetIdPropertyName display_name: Custom Ad Asset Id Property Name type: STRING @@ -12571,32 +12516,6 @@ items: regexp: '' description: Enter your Nielsen DCR App ID. settings: [] - - name: instanceName - display_name: Instance Name - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - You can optionally define the explicit name of the Nielsen instance we - initialize its SDK with. - settings: [] - - name: subbrandPropertyName - display_name: Subbrand Property Name - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - By default, clientid and subbrand are setup in Nielsen backend - configuration to capture brand and sub-brand information. The fields get - populated from backend for a registered client appid. But if an app - contains multiple brands and sub-brands and client is willing to give - credit to another brand or sub-brand then please indicate which property - value from your payload you want to use to override `subbrand`. - settings: [] - name: clientIdPropertyName display_name: Client Id Property Name type: STRING @@ -12636,6 +12555,28 @@ items: by default. If you would like to set up a custom property mapping please indicate the name of the property here. settings: [] + - name: instanceName + display_name: Instance Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + You can optionally define the explicit name of the Nielsen instance we + initialize its SDK with. + settings: [] + - name: nolDevDebug + display_name: Enable Debug Mode + type: BOOLEAN + deprecated: false + required: false + description: >- + Check this setting if you would like to activate the Debug flag. Once the + flag is active, it logs each API call made and the data passed. + + Note: DO NOT: activate the Debug flag in a production environment. + settings: [] - name: sfCode display_name: Enable Production Mode type: BOOLEAN @@ -12645,6 +12586,21 @@ items: By default we will use production mode. Uncheck this setting if you are developing or testing this integration. settings: [] + - name: subbrandPropertyName + display_name: Subbrand Property Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + By default, clientid and subbrand are setup in Nielsen backend + configuration to capture brand and sub-brand information. The fields get + populated from backend for a registered client appid. But if an app + contains multiple brands and sub-brands and client is willing to give + credit to another brand or sub-brand then please indicate which property + value from your payload you want to use to override `subbrand`. + settings: [] connection_modes: device: web: true @@ -12783,38 +12739,12 @@ items: components: - type: WEB platforms: - browser: true - server: false - mobile: false - browserUnbundlingSupported: false - browserUnbundlingPublic: true - settings: - - name: page - display_name: Log pageviews to the Olark chat console - type: BOOLEAN - deprecated: false - required: false - description: Log pageviews to the Olark chat console - settings: [] - - name: siteId - display_name: Site ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: ^\d+-\d+-\d+-\d+$ - description: >- - You can find your Site ID on the [Olark Install - page](https://www.olark.com/install?r=qhl4tltg). It should look something - like this: `9385-174-10-1457`. - settings: [] - - name: track - display_name: Log custom events from analytics.track() to the Olark chat console - type: BOOLEAN - deprecated: false - required: false - description: Log custom events from analytics.track() to the Olark chat console - settings: [] + browser: true + server: false + mobile: false + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: - name: groupId display_name: Group ID type: STRING @@ -12851,6 +12781,32 @@ items: Automatically send Live Chat message events, conversation starts and ends to other tools you have enabled. settings: [] + - name: page + display_name: Log pageviews to the Olark chat console + type: BOOLEAN + deprecated: false + required: false + description: Log pageviews to the Olark chat console + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: ^\d+-\d+-\d+-\d+$ + description: >- + You can find your Site ID on the [Olark Install + page](https://www.olark.com/install?r=qhl4tltg). It should look something + like this: `9385-174-10-1457`. + settings: [] + - name: track + display_name: Log custom events from analytics.track() to the Olark chat console + type: BOOLEAN + deprecated: false + required: false + description: Log custom events from analytics.track() to the Olark chat console + settings: [] connection_modes: device: web: true @@ -12931,6 +12887,52 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: + - name: accountId + display_name: Account ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + In order to use Optimizely X via _server side_, you must enter your + **Account ID** from your Optimizely account. You can find this ID by + visiting https://app.optimizely.com/v2/accountsettings/account/plan + settings: [] + - name: cacheExp + display_name: Cache Exp + type: NUMBER + deprecated: false + required: false + number_validators: + min: 300 + max: 0 + description: >- + To optimize the server side integration, we will cache the fetched + *Datafile* that you have provided for this amount of time (in seconds) in + Redis. Since the datafile should not change unless you modified the + conditions or variation rules of your experiments, it is advised to have a + minimum floor of 300 seconds (5 minutes). + settings: [] + - name: datafileUrl + display_name: Datafile URL + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + In order to use Optimizely X _server side_, you must enter the entire URL + for your datafile. It should look something like + `https://cdn.optimizely.com/json/9218021209.json` + settings: [] + - name: fallbackToAnonymousId + display_name: Fall Back To Anonymous Id + type: BOOLEAN + deprecated: false + required: false + description: Optionally fall back to `anonymousId` when `userId` is not present. + settings: [] - name: listen display_name: >- Sends the experiment and variation information as properties on a track @@ -12963,52 +12965,6 @@ items: activateExperiment:False]; ``` settings: [] - - name: useOptimizely3 - display_name: Use Optimizely 3 - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this setting to instantiate an Optimizely client using v3.2.2 of - Optimizely's SDK. The default Optimizely client version Segment - instantiates is v2.1.3. NOTE: Do not enable this setting if the SDK - version you are using to activate users into your Optimizely experiments - is less than 3.0. You can find more information on how migrating from - Optimizely 2.x to 3.x will affect your experiment tracking in Optimizely's - documentation: - https://docs.developers.optimizely.com/full-stack/docs/changelog#section-may-2019 - settings: [] - - name: useOptimizelyUserId - display_name: Use Optimizely User ID - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this if you want the server side integration to use Optimizely User - ID instead of User ID or anonymous ID in your calls - settings: [] - - name: cacheExp - display_name: Cache Exp - type: NUMBER - deprecated: false - required: false - number_validators: - min: 300 - max: 0 - description: >- - To optimize the server side integration, we will cache the fetched - *Datafile* that you have provided for this amount of time (in seconds) in - Redis. Since the datafile should not change unless you modified the - conditions or variation rules of your experiments, it is advised to have a - minimum floor of 300 seconds (5 minutes). - settings: [] - - name: fallbackToAnonymousId - display_name: Fall Back To Anonymous Id - type: BOOLEAN - deprecated: false - required: false - description: Optionally fall back to `anonymousId` when `userId` is not present. - settings: [] - name: nonInteraction display_name: >- Specifies the Experiment Viewed as a non-interaction event for Google @@ -13029,38 +12985,38 @@ items: the `userId` to Optimizely. *Important*: This setting only applies if you are bundling this integration for mobile sources. settings: [] - - name: useUserId - display_name: Use User ID + - name: useOptimizely3 + display_name: Use Optimizely 3 type: BOOLEAN deprecated: false required: false description: >- - Enable this if you want the server side integration to use User ID instead - of anonymous ID in your identify calls + Enable this setting to instantiate an Optimizely client using v3.2.2 of + Optimizely's SDK. The default Optimizely client version Segment + instantiates is v2.1.3. NOTE: Do not enable this setting if the SDK + version you are using to activate users into your Optimizely experiments + is less than 3.0. You can find more information on how migrating from + Optimizely 2.x to 3.x will affect your experiment tracking in Optimizely's + documentation: + https://docs.developers.optimizely.com/full-stack/docs/changelog#section-may-2019 settings: [] - - name: accountId - display_name: Account ID - type: STRING + - name: useOptimizelyUserId + display_name: Use Optimizely User ID + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - In order to use Optimizely X via _server side_, you must enter your - **Account ID** from your Optimizely account. You can find this ID by - visiting https://app.optimizely.com/v2/accountsettings/account/plan + Enable this if you want the server side integration to use Optimizely User + ID instead of User ID or anonymous ID in your calls settings: [] - - name: datafileUrl - display_name: Datafile URL - type: STRING + - name: useUserId + display_name: Use User ID + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - In order to use Optimizely X _server side_, you must enter the entire URL - for your datafile. It should look something like - `https://cdn.optimizely.com/json/9218021209.json` + Enable this if you want the server side integration to use User ID instead + of anonymous ID in your identify calls settings: [] connection_modes: device: @@ -13104,27 +13060,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: trackNamedPages - display_name: Track Named Pages - type: BOOLEAN - deprecated: false - required: false - description: >- - This will track events to Optimizely for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have - either a `name` or `category` associated with them. For example - `page('Signup', 'Home')` would translate to **Viewed Home Signup Page**. - settings: [] - - name: variations - display_name: Send experiment data to other tools as an identify call (not recommended) - type: BOOLEAN - deprecated: false - required: false - description: >- - The reason this is not recommended is because if you're running lots of - experiments, this could lead to loads of unwanted properties in end tools - as well as unwanted columns in Segment connected databases. - settings: [] - name: customCampaignProperties display_name: Custom Campaign Properties type: MAP @@ -13197,6 +13132,27 @@ items: `category` associated with them. For example `page('Docs', 'Index')` would translate to **Viewed Docs Page**. settings: [] + - name: trackNamedPages + display_name: Track Named Pages + type: BOOLEAN + deprecated: false + required: false + description: >- + This will track events to Optimizely for [`page` + method](https://segment.io/libraries/analytics.js#page) calls that have + either a `name` or `category` associated with them. For example + `page('Signup', 'Home')` would translate to **Viewed Home Signup Page**. + settings: [] + - name: variations + display_name: Send experiment data to other tools as an identify call (not recommended) + type: BOOLEAN + deprecated: false + required: false + description: >- + The reason this is not recommended is because if you're running lots of + experiments, this could lead to loads of unwanted properties in end tools + as well as unwanted columns in Segment connected databases. + settings: [] connection_modes: device: web: true @@ -13234,33 +13190,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: piCId - display_name: Campaign ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: ^\d+$ - description: >- - This setting is only used in the client side `analytics.js` integration - with Pardot and will not be used if you are sending data from a server - side source. You can find your Campaign ID (or `piCId`) under **Marketing - > Campaigns** in your [Pardot account](https://pi.pardot.com/campaign). - After selecting your desired website campaign, press **View Tracking - Code**. Note: you can still use a URL query parameter of `pi_campaign_id` - to override this on specific pages. - settings: [] - - name: userKey - display_name: User Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^[a-f0-9]{32}$' - description: >- - You can find your User Key on under **User Settings** in your [Pardot - account](https://pi.pardot.com/account). - settings: [] - name: apiVersion display_name: API Version type: SELECT @@ -13330,17 +13259,44 @@ items: under **Admin > Users and Groups > Add User**, so that you don't have to tell us your actual password. settings: [] - - name: piAId - display_name: Account ID + - name: piAId + display_name: Account ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: ^\d+$ + description: >- + You can find your Account ID (or `piAId`) under **Marketing > Campaigns** + in your [Pardot account](https://pi.pardot.com/campaign). After selecting + your desired website campaign, press **View Tracking Code**. + settings: [] + - name: piCId + display_name: Campaign ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: ^\d+$ + description: >- + This setting is only used in the client side `analytics.js` integration + with Pardot and will not be used if you are sending data from a server + side source. You can find your Campaign ID (or `piCId`) under **Marketing + > Campaigns** in your [Pardot account](https://pi.pardot.com/campaign). + After selecting your desired website campaign, press **View Tracking + Code**. Note: you can still use a URL query parameter of `pi_campaign_id` + to override this on specific pages. + settings: [] + - name: userKey + display_name: User Key type: STRING deprecated: false - required: true + required: false string_validators: - regexp: ^\d+$ + regexp: '^[a-f0-9]{32}$' description: >- - You can find your Account ID (or `piAId`) under **Marketing > Campaigns** - in your [Pardot account](https://pi.pardot.com/campaign). After selecting - your desired website campaign, press **View Tracking Code**. + You can find your User Key on under **User Settings** in your [Pardot + account](https://pi.pardot.com/account). settings: [] connection_modes: device: @@ -13378,25 +13334,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: inPixelMetadata - display_name: Enable In-Pixel Metadata - type: BOOLEAN - deprecated: false - required: false - description: "If you enable In-Pixel Metadata, Segment will map page properties to Parsely's `metadata` format, allowing you to eschew their out-of-band metadata crawling. This has tradeoffs and is not the recommended approach—\_please be sure to check with your Parsely rep prior to enabling this setting. Requires Dynamic Tracking to be set to `true`." - settings: [] - - name: trackEvents - display_name: Track Events - type: BOOLEAN - deprecated: false - required: false - description: >- - Parsely can track custom events, but does not surface these events in - their Dashboard or UI. If you'd like your Segment `track()` calls to flow - to Parsely's Raw Data Pipeline product, enable this setting. [See - here](https://www.parsely.com/help/integration/dynamic/) for more - information. - settings: [] - name: apiKey display_name: Domain type: STRING @@ -13430,6 +13367,25 @@ items: here](https://www.parsely.com/help/integration/dynamic/) for more information. settings: [] + - name: inPixelMetadata + display_name: Enable In-Pixel Metadata + type: BOOLEAN + deprecated: false + required: false + description: "If you enable In-Pixel Metadata, Segment will map page properties to Parsely's `metadata` format, allowing you to eschew their out-of-band metadata crawling. This has tradeoffs and is not the recommended approach—\_please be sure to check with your Parsely rep prior to enabling this setting. Requires Dynamic Tracking to be set to `true`." + settings: [] + - name: trackEvents + display_name: Track Events + type: BOOLEAN + deprecated: false + required: false + description: >- + Parsely can track custom events, but does not surface these events in + their Dashboard or UI. If you'd like your Segment `track()` calls to flow + to Parsely's Raw Data Pipeline product, enable this setting. [See + here](https://www.parsely.com/help/integration/dynamic/) for more + information. + settings: [] connection_modes: device: web: true @@ -13859,6 +13815,18 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: customVariableLimit + display_name: Custom Variable Limit + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: >- + If you have manually changed your Piwik custom variable limit, please + enter your new value here. The Piwik default is 5. + settings: [] - name: goals display_name: Goals type: MAP @@ -13889,18 +13857,6 @@ items: You can find your Server URL in your snippet, we will append `/piwik.php` to the URL automatically. settings: [] - - name: customVariableLimit - display_name: Custom Variable Limit - type: NUMBER - deprecated: false - required: false - number_validators: - min: 0 - max: 0 - description: >- - If you have manually changed your Piwik custom variable limit, please - enter your new value here. The Piwik default is 5. - settings: [] connection_modes: device: web: true @@ -14297,6 +14253,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: advertise + display_name: Advertise + type: BOOLEAN + deprecated: false + required: false + description: >- + By default data will be sent to Quantcast Measure, enable this option to + send to Quantcast Advertise + settings: [] - name: advertiseProducts display_name: Advertise Products type: BOOLEAN @@ -14329,15 +14294,6 @@ items: You can find your P-Code in the right-hand column under **Your P-Code** after you login to [Quantcast](https://www.quantcast.com/). settings: [] - - name: advertise - display_name: Advertise - type: BOOLEAN - deprecated: false - required: false - description: >- - By default data will be sent to Quantcast Measure, enable this option to - send to Quantcast Advertise - settings: [] connection_modes: device: web: true @@ -14375,6 +14331,24 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: clientId + display_name: ClientID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your QuanticMind account manager will provide your ClientID. + settings: [] + - name: domain + display_name: Domain + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'Your QuanticMind account manager will provide your Domain, if needed.' + settings: [] - name: events display_name: Events type: MAP @@ -14404,24 +14378,6 @@ items: but instead to a conversion through the conversion's `orderId`. Only use if instructed specifically by your InsideVault account manager. settings: [] - - name: clientId - display_name: ClientID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Your QuanticMind account manager will provide your ClientID. - settings: [] - - name: domain - display_name: Domain - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: 'Your QuanticMind account manager will provide your Domain, if needed.' - settings: [] connection_modes: device: web: true @@ -14571,23 +14527,23 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: organization_id - display_name: Organization Id + - name: apiKey + display_name: API Key type: STRING deprecated: false required: false string_validators: regexp: '' - description: Your Ramen organization id + description: Your Ramen API key for the server-side integration settings: [] - - name: apiKey - display_name: API Key + - name: organization_id + display_name: Organization Id type: STRING deprecated: false required: false string_validators: regexp: '' - description: Your Ramen API key for the server-side integration + description: Your Ramen organization id settings: [] connection_modes: device: @@ -14723,122 +14679,51 @@ items: server: true mobile: true browserUnbundlingSupported: false - browserUnbundlingPublic: true - settings: - - name: repeatKeys - display_name: Write Keys - type: LIST - deprecated: false - required: false - description: This is the array of source write keys you want to repeat data into. - settings: [] - connection_modes: - device: - web: false - mobile: false - server: false - cloud: - web: true - mobile: true - server: true - previous_names: - - Repeater -- display_name: Responsys - slug: responsys - name: catalog/destinations/responsys - description: >- - Responsys can help your customers resolve this 'campaign crisis' managing - and orchestrating marketing interactions across email, mobile, social, - display and the web. - hidden: false - url: connections/destinations/catalog/responsys - status: PUBLIC - logo: - url: 'https://cdn.filepicker.io/api/file/wxsQlEJ2TowQG9MSLLgk' - mark: - url: '' - categories: - - Email Marketing - components: - - type: CLOUD - platforms: - browser: true - server: true - mobile: true - browserUnbundlingSupported: false - browserUnbundlingPublic: true - settings: - - name: pod - display_name: Pod - type: SELECT - deprecated: false - required: true - select_validators: - select_options: - - '2' - - '5' - - '8' - - '9' - description: >- - The pod that hosts your Responsys account. Simply check your url during - your login screen. This is required to any requests to your account. The - default is `interact2`. - settings: [] - - name: folderName - display_name: Folder Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Please enter the default Folder Name that holds the provided Profile List - and Profile Extension Table. - settings: [] - - name: optOutEmailTrait - display_name: Email Permission Status Trait Mapping - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Please enter the trait you would like to be mapped to - `EMAIL_PEERMISSION_STATUS_`. This will allow you to track users who opt in - and out of marketing communications in your apps and websites. The value - of this trait MUST be a boolean. - settings: [] - - name: optOutMobileTrait - display_name: Mobile Permission Status Trait Mapping - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Please enter the trait youw would like to be mapped to - MOBILE_PERMISSION_STATUS_. This will allow you to track users who opt in - and out of marketing communications in your apps and websites. The value - of this trait MUST be a boolean. - settings: [] - - name: password - display_name: Password - type: PASSWORD - deprecated: false - required: true - string_validators: - regexp: '' - description: Please enter your account's password. - settings: [] - - name: petName - display_name: Profile Extension Table - type: STRING + browserUnbundlingPublic: true + settings: + - name: repeatKeys + display_name: Write Keys + type: LIST deprecated: false required: false - string_validators: - regexp: '' - description: Please enter the name of your default Profile Extension Table. + description: This is the array of source write keys you want to repeat data into. settings: [] + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: true + mobile: true + server: true + previous_names: + - Repeater +- display_name: Responsys + slug: responsys + name: catalog/destinations/responsys + description: >- + Responsys can help your customers resolve this 'campaign crisis' managing + and orchestrating marketing interactions across email, mobile, social, + display and the web. + hidden: false + url: connections/destinations/catalog/responsys + status: PUBLIC + logo: + url: 'https://cdn.filepicker.io/api/file/wxsQlEJ2TowQG9MSLLgk' + mark: + url: '' + categories: + - Email Marketing + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: - name: events display_name: Events type: MIXED @@ -14897,26 +14782,27 @@ items: required: false description: Mark this property as a Primary Key in Responsys. settings: [] - - name: useSegmentMsgId - display_name: Use Segment Message ID - type: BOOLEAN + - name: event + display_name: Segment Event Name + type: STRING deprecated: false - required: false - description: >- - Use Segment's `messageId` as one of the four Primary Keys to easily - ensure that you do not overwrite historical records in your Supplemental - Tables. + required: true + string_validators: + regexp: '' + description: Enter the Segment Event Name. settings: [] - - name: mapUserId - display_name: Map Segment UserId - type: BOOLEAN + - name: folderName + display_name: Responsys Folder Name + type: STRING deprecated: false - required: false + required: true + string_validators: + regexp: '' description: >- - Check this box if you want to automatically create and or map Segment's - `userId` field as a column in Responsys. Highly **recommended** if you - want to connect records in your Profile Lists/Extension Tables with - records in this Supplemental Table. + Optional. Enter a Responsys Folder Name where this Supplemental exists + or where you'd like one to be created. If this input is left blank, we + will fallback on the default Folder Name you've provided at the top + level settings. settings: [] - name: mapEmail display_name: Map Email @@ -14930,14 +14816,16 @@ items: `.identify()` with an `email` trait for anonymous users without `userId`s. settings: [] - - name: event - display_name: Segment Event Name - type: STRING + - name: mapUserId + display_name: Map Segment UserId + type: BOOLEAN deprecated: false - required: true - string_validators: - regexp: '' - description: Enter the Segment Event Name. + required: false + description: >- + Check this box if you want to automatically create and or map Segment's + `userId` field as a column in Responsys. Highly **recommended** if you + want to connect records in your Profile Lists/Extension Tables with + records in this Supplemental Table. settings: [] - name: suppName display_name: Responsys Supplemental Table Name @@ -14948,19 +14836,27 @@ items: regexp: '' description: Enter a Responsys Supplemental Table Name. settings: [] - - name: folderName - display_name: Responsys Folder Name - type: STRING + - name: useSegmentMsgId + display_name: Use Segment Message ID + type: BOOLEAN deprecated: false - required: true - string_validators: - regexp: '' + required: false description: >- - Optional. Enter a Responsys Folder Name where this Supplemental exists - or where you'd like one to be created. If this input is left blank, we - will fallback on the default Folder Name you've provided at the top - level settings. + Use Segment's `messageId` as one of the four Primary Keys to easily + ensure that you do not overwrite historical records in your Supplemental + Tables. settings: [] + - name: folderName + display_name: Folder Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Please enter the default Folder Name that holds the provided Profile List + and Profile Extension Table. + settings: [] - name: listName display_name: Profile List Name type: STRING @@ -14972,6 +14868,32 @@ items: Please enter the default Profile List. Make sure that the Profile List is inside the provided Folder Name. settings: [] + - name: optOutEmailTrait + display_name: Email Permission Status Trait Mapping + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Please enter the trait you would like to be mapped to + `EMAIL_PEERMISSION_STATUS_`. This will allow you to track users who opt in + and out of marketing communications in your apps and websites. The value + of this trait MUST be a boolean. + settings: [] + - name: optOutMobileTrait + display_name: Mobile Permission Status Trait Mapping + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Please enter the trait youw would like to be mapped to + MOBILE_PERMISSION_STATUS_. This will allow you to track users who opt in + and out of marketing communications in your apps and websites. The value + of this trait MUST be a boolean. + settings: [] - name: optin display_name: Set Default Permission Setting to OPTIN type: BOOLEAN @@ -14981,6 +14903,40 @@ items: Choose whether records added to Profile Lists should be `'OPTIN'` rather than the default `'OPTOUT'` settings: [] + - name: password + display_name: Password + type: PASSWORD + deprecated: false + required: true + string_validators: + regexp: '' + description: Please enter your account's password. + settings: [] + - name: petName + display_name: Profile Extension Table + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Please enter the name of your default Profile Extension Table. + settings: [] + - name: pod + display_name: Pod + type: SELECT + deprecated: false + required: true + select_validators: + select_options: + - '2' + - '5' + - '8' + - '9' + description: >- + The pod that hosts your Responsys account. Simply check your url during + your login screen. This is required to any requests to your account. The + default is `interact2`. + settings: [] - name: username display_name: Username type: STRING @@ -15074,15 +15030,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: guessUncaughtFrames - display_name: Guess Uncaught Frames - type: BOOLEAN - deprecated: false - required: false - description: >- - When this option is enabled, Rollbar will guess which frames the error was - thrown from when the browser does not provide line and column numbers. - settings: [] - name: accessToken display_name: Access Token type: STRING @@ -15099,37 +15046,6 @@ items: required: false description: Record uncaught exceptions from `window.onerror`. settings: [] - - name: environment - display_name: Environment - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: The environment the code is running in. - settings: [] - - name: ignoredMessages - display_name: Ignored Messages - type: LIST - deprecated: false - required: false - description: >- - If you want to ignore a specific exception message, say for a third-party - browser plugin that is throwing errors, you can add them here and Rollbar - will ignore exceptions matching those messages. - settings: [] - - name: sourceMapEnabled - display_name: Enable Source Map - type: BOOLEAN - deprecated: false - required: false - description: >- - When this option is enabled, we'll let Rollbar know you have source maps - enabled. Be sure to implement either Option A or B in [these - instructions](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map) - to set up source maps with Rollbar as well as fill out Code Version in you - Rollbar Integration settings in your Segment source. - settings: [] - name: captureUnhandledRejections display_name: Capture Unhandled Rejections type: BOOLEAN @@ -15150,14 +15066,54 @@ items: If you have enabled Source Maps, this is a version string, such as a version number or git sha settings: [] + - name: environment + display_name: Environment + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: The environment the code is running in. + settings: [] + - name: guessUncaughtFrames + display_name: Guess Uncaught Frames + type: BOOLEAN + deprecated: false + required: false + description: >- + When this option is enabled, Rollbar will guess which frames the error was + thrown from when the browser does not provide line and column numbers. + settings: [] - name: identify display_name: Include custom user data with Rollbar's error tracking type: BOOLEAN deprecated: false required: false description: >- - When this option is enabled we will store metadata about the user on - `identify` calls. + When this option is enabled we will store metadata about the user on + `identify` calls. + settings: [] + - name: ignoredMessages + display_name: Ignored Messages + type: LIST + deprecated: false + required: false + description: >- + If you want to ignore a specific exception message, say for a third-party + browser plugin that is throwing errors, you can add them here and Rollbar + will ignore exceptions matching those messages. + settings: [] + - name: sourceMapEnabled + display_name: Enable Source Map + type: BOOLEAN + deprecated: false + required: false + description: >- + When this option is enabled, we'll let Rollbar know you have source maps + enabled. Be sure to implement either Option A or B in [these + instructions](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map) + to set up source maps with Rollbar as well as fill out Code Version in you + Rollbar Integration settings in your Segment source. settings: [] connection_modes: device: @@ -15301,6 +15257,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The API key found in your Sailthru dashboard. + settings: [] - name: customerId display_name: Customer Id type: STRING @@ -15371,15 +15336,6 @@ items: regexp: '' description: The Shared Secret found in your Sailthru dashboard. settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: The API key found in your Sailthru dashboard. - settings: [] connection_modes: device: web: false @@ -15420,6 +15376,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: Login to www.salescamp.app and go to setting - > integration -> segment + settings: [] - name: events display_name: 'Events ' type: LIST @@ -15430,15 +15395,6 @@ items: recommend you to add event in below list that important for your sales process (ex. "Demo Request Placed", "Order Placed" etc.) settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^.{8,}$' - description: Login to www.salescamp.app and go to setting - > integration -> segment - settings: [] connection_modes: device: web: false @@ -15475,18 +15431,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: username - display_name: Account Email - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Enter your Salesforce account email. We recommend creating a separate - account just for Segment so that you don't need to use your actual - password. - settings: [] - name: actions display_name: Actions type: MIXED @@ -15506,6 +15450,15 @@ items: Conditions](https://segment.com/docs/legal/first-access-beta-preview/). By using this feature, you agree to these terms. settings: [] + - name: alwaysEnabled + display_name: Always Enabled + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this to send *every* event to Salesforce, bypassing the need to set + `'Salesforce': true` in your track calls. + settings: [] - name: billing display_name: Send Address as Billing Address type: BOOLEAN @@ -15533,33 +15486,6 @@ items: with another field **you need to explicitly define that as a row in this setting**. settings: [] - - name: sandbox - display_name: Sandbox - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this setting if the Salesforce instance you are integrating with is - a Sandbox environment. - settings: [] - - name: shipping - display_name: Send Address as Shipping Address - type: BOOLEAN - deprecated: false - required: false - description: >- - This will map address traits in your group calls as Shipping Address for - your Account Objects. - settings: [] - - name: alwaysEnabled - display_name: Always Enabled - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this to send *every* event to Salesforce, bypassing the need to set - `'Salesforce': true` in your track calls. - settings: [] - name: password display_name: Account Password type: PASSWORD @@ -15574,6 +15500,15 @@ items: password. You can do that under **Setup > Administration Setup > Users > New User**. settings: [] + - name: sandbox + display_name: Sandbox + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this setting if the Salesforce instance you are integrating with is + a Sandbox environment. + settings: [] - name: securityToken display_name: Security Token type: STRING @@ -15586,6 +15521,27 @@ items: Personal Information > [Reset My Security Token](https://na15.salesforce.com/_ui/system/security/ResetApiTokenEdit)**. settings: [] + - name: shipping + display_name: Send Address as Shipping Address + type: BOOLEAN + deprecated: false + required: false + description: >- + This will map address traits in your group calls as Shipping Address for + your Account Objects. + settings: [] + - name: username + display_name: Account Email + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Enter your Salesforce account email. We recommend creating a separate + account just for Segment so that you don't need to use your actual + password. + settings: [] - name: version display_name: Version type: SELECT @@ -15637,6 +15593,44 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: apiEvents + display_name: API Events + type: MIXED + deprecated: false + required: false + description: >- + Trigger API Events in SFMC in response to Segment events. + + + **This setting is a Beta release.** You can read more about Beta features + in [Segment First Access and Beta Terms and + Conditions](https://segment.com/docs/legal/first-access-beta-preview/). By + using this feature, you agree to these terms. + settings: [] + - name: clientId + display_name: Client ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your Salesforce Marketing Cloud Client ID. For instructions on how to find + your Client ID, check out our + [documentation](https://segment.com/docs/destinations/salesforce-marketing-cloud/). + settings: [] + - name: clientSecret + display_name: Client Secret + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your Salesforce Marketing Cloud Client Secret. For instructions on how to + find your Client Secret, check out our + [documentation](https://segment.com/docs/integrations/salesforce-marketing-cloud). + settings: [] - name: doNotCreateOrUpdateContacts display_name: Do Not Create or Update Contacts type: BOOLEAN @@ -15727,44 +15721,6 @@ items: `mc563885gzs27c5t9-63k636ttgm.rest.marketingcloudapis.com`, the subdomain is `mc563885gzs27c5t9-63k636ttgm` settings: [] - - name: apiEvents - display_name: API Events - type: MIXED - deprecated: false - required: false - description: >- - Trigger API Events in SFMC in response to Segment events. - - - **This setting is a Beta release.** You can read more about Beta features - in [Segment First Access and Beta Terms and - Conditions](https://segment.com/docs/legal/first-access-beta-preview/). By - using this feature, you agree to these terms. - settings: [] - - name: clientId - display_name: Client ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Your Salesforce Marketing Cloud Client ID. For instructions on how to find - your Client ID, check out our - [documentation](https://segment.com/docs/destinations/salesforce-marketing-cloud/). - settings: [] - - name: clientSecret - display_name: Client Secret - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Your Salesforce Marketing Cloud Client Secret. For instructions on how to - find your Client Secret, check out our - [documentation](https://segment.com/docs/integrations/salesforce-marketing-cloud). - settings: [] connection_modes: device: web: false @@ -16072,6 +16028,42 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: config + display_name: Public DSN + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + You can find your Public DSN by going to Sentry and clicking Projects & + Teams > Any Project > Settings > Client Keys (DSN). This should be the + PUBLIC DSN since it does not contain a secret. + settings: [] + - name: customVersionProperty + display_name: Set Release by Property + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Dynamically track the version of your application in Sentry. If the + property you set here is on the global window object (example: you input + 'my_custom_version', and window.my_custom_version = '2.4.5') then we will + use that version. If not, we will default to the manually-set Release + property. We recommend that this value is unique to prevent it from being + overwritten by other integrations. + settings: [] + - name: ignoreErrors + display_name: Ignore Errors + type: LIST + deprecated: false + required: false + description: >- + A list of these messages to be filtered out before being sent to Sentry as + either regular expressions or strings. + settings: [] - name: ignoreUrls display_name: Ignore Urls type: LIST @@ -16081,6 +16073,27 @@ items: The inverse of whitelistUrls and similar to ignoreErrors, but will ignore errors from whole urls matching a regex pattern or an exact string. settings: [] + - name: includePaths + display_name: Include Paths + type: LIST + deprecated: false + required: false + description: >- + An array of regex patterns to indicate which urls are a part of your app + in the stack trace. All other frames will appear collapsed inside Sentry + to make it easier to discern between frames that happened in your code vs + other code. It’d be suggested to add the current page url, and the host + for your CDN. + settings: [] + - name: logger + display_name: Logger + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: The name of the logger used by Sentry. + settings: [] - name: maxMessageLength display_name: Maximum Message Length type: NUMBER @@ -16114,30 +16127,6 @@ items: platforms. Instead you may use something like the device ID, as it indicates the host which the client is running on. settings: [] - - name: customVersionProperty - display_name: Set Release by Property - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Dynamically track the version of your application in Sentry. If the - property you set here is on the global window object (example: you input - 'my_custom_version', and window.my_custom_version = '2.4.5') then we will - use that version. If not, we will default to the manually-set Release - property. We recommend that this value is unique to prevent it from being - overwritten by other integrations. - settings: [] - - name: ignoreErrors - display_name: Ignore Errors - type: LIST - deprecated: false - required: false - description: >- - A list of these messages to be filtered out before being sent to Sentry as - either regular expressions or strings. - settings: [] - name: whitelistUrls display_name: Whitelist Urls type: LIST @@ -16150,39 +16139,6 @@ items: only if you are inlining code inside