diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index dc6f1e1143..b8acfb64ba 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -379,6 +379,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: appToken + display_name: App Token + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your Adjust app token can be retrieved from your [Adjust + account](https://next.adjust.com/#/) in the app's Settings. + settings: [] - name: customEvents display_name: Map Your Events to Custom Adjust Event Tokens type: MAP @@ -442,17 +453,6 @@ items: 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 - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Your Adjust app token can be retrieved from your [Adjust - account](https://next.adjust.com/#/) in the app's Settings. - settings: [] connection_modes: device: web: false @@ -494,69 +494,40 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: customDataPrefix - display_name: Context Data Property Prefix - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - If you would like to prefix your Segment properties before sending them as - contextData, enter a prefix here. - settings: [] - - name: productIdentifier - display_name: Product Identifier - type: SELECT - 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`. - settings: [] - - name: heartbeatTrackingServerUrl - display_name: Heartbeat Tracking Server URL - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This is the URL of your Adobe Heartbeat server. Please contact Adobe to - obtain this URL. - 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: eVars - display_name: eVars + - name: lVars + display_name: List Variables type: MAP deprecated: false required: false map_validators: regexp: '' min: 0 - max: 250 - map_prefix: eVar + max: 3 + map_prefix: list 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. + 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: merchEvents + display_name: 'Merchandising Events ' + type: MIXED + deprecated: false + required: false + description: |- + Configure merchandising event, such as purchase or currency events. + + This is currently in Beta Testing and not generally available. + settings: + - name: merchEvents + display_name: merchEvents + type: MIXED + deprecated: false + required: false + description: The name of the adobe event. + settings: [] - name: enableTrackPageName display_name: Enable pageName for Track Events type: BOOLEAN @@ -566,27 +537,6 @@ items: If you do not want to attach `pageName` for your `.track()` calls, you can disable this option. settings: [] - - name: preferVisitorId - display_name: Prefer VisitorID for Hybrid Timestamp Reporting - type: BOOLEAN - deprecated: false - required: false - 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. - 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: eventsV2 display_name: Events V2 (Bundled Mobile Only) type: MAP @@ -600,58 +550,29 @@ items: 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: merchEvents - display_name: 'Merchandising Events ' - type: MIXED - deprecated: false - required: false - description: |- - Configure merchandising event, such as purchase or currency events. - - This is currently in Beta Testing and not generally available. - settings: - - name: merchEvents - display_name: merchEvents - type: MIXED - deprecated: false - required: false - description: The name of the adobe event. - settings: [] - - name: props - display_name: Props - type: MAP + - name: preferVisitorId + display_name: Prefer VisitorID for Hybrid Timestamp Reporting + type: BOOLEAN deprecated: false required: false - map_validators: - regexp: '' - 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. + 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: trackingServerUrl - display_name: Tracking Server URL + - name: reportSuiteId + display_name: Report Suite ID(s) type: STRING deprecated: false - required: false + required: true string_validators: regexp: '' - description: This is the URL of your Adobe Analytics server. - 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. + 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: contextValues display_name: Context Data Variables @@ -675,25 +596,12 @@ items: **NOTE**: By default we send all your `properties` as Context Data Variables so you do not need to map them again here. settings: [] - - name: disableVisitorId - display_name: Drop Visitor ID - type: BOOLEAN - deprecated: false - required: false - description: This will disable Visitor ID from being passed to Adobe. - settings: [] - - name: marketingCloudOrgId - display_name: Marketing Cloud Organization Id - type: STRING + - name: events + display_name: Events + type: MIXED deprecated: false required: false - string_validators: - regexp: '' - description: >- - If you would like to use the Marketing Cloud Id Service and use - visitorAPI.js, please enter your Marketing Cloud Organization ID. If you - do not know your organization ID, you can find it on the Marketing Cloud - administration page. It should look something like '1234567ABC@AdobeOrg'. + description: Map your Segment events to custom Adobe events. settings: [] - name: removeFallbackVisitorId display_name: 'No Fallbacks for Visitor ID: Server-Side Only ' @@ -711,54 +619,64 @@ items: on the destination specific setting for visitorId​, falling back to userId​ then anonymousId​. This setting removes the fallbacks. settings: [] - - name: sendFalseValues - display_name: Send False values + - name: ssl + display_name: SSL type: BOOLEAN deprecated: false required: false 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`. + Check this box if you would like your Adobe Heartbeat calls to be made + over HTTPS. settings: [] - - name: customDelimiter - display_name: 'List Variable and Prop Custom Delimiter: Server-Side Only ' - type: MAP + - name: trackingServerSecureUrl + display_name: Tracking Server Secure URL + type: STRING deprecated: false required: false - map_validators: + string_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. + description: This is the secure URL of your Adobe Analytics server. settings: [] - - name: events - display_name: Events - type: MIXED + - name: useLegacyLinkName + display_name: Use Legacy LinkName + type: BOOLEAN deprecated: false required: false - description: Map your Segment events to custom Adobe events. + description: >- + 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: hVars - display_name: Hierarchy Variables - type: MAP + - name: disableVisitorId + display_name: Drop Visitor ID + type: BOOLEAN deprecated: false required: false - map_validators: - regexp: '' + description: This will disable Visitor ID from being passed to Adobe. + settings: [] + - name: marketingCloudOrgId + display_name: Marketing Cloud Organization Id + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you would like to use the Marketing Cloud Id Service and use + visitorAPI.js, please enter your Marketing Cloud Organization ID. If you + do not know your organization ID, you can find it on the Marketing Cloud + administration page. It should look something like '1234567ABC@AdobeOrg'. + settings: [] + - name: hVars + display_name: Hierarchy Variables + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' min: 0 max: 5 map_prefix: hier @@ -769,58 +687,65 @@ items: Analytics hVar number on the right. You can view your Segment page calls and properties in your Schema. settings: [] - - name: timestampOption - display_name: Timestamp Option - type: SELECT + - name: heartbeatTrackingServerUrl + display_name: Heartbeat Tracking Server URL + type: STRING deprecated: false required: false - select_validators: - select_options: - - enabled - - disabled - - hybrid + string_validators: + regexp: '' 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. + This is the URL of your Adobe Heartbeat server. Please contact Adobe to + obtain this URL. settings: [] - - name: addBuildToAppId - display_name: Add application build to Adobe's App ID - type: BOOLEAN + - name: productIdentifier + display_name: Product Identifier + type: SELECT deprecated: false required: false + select_validators: + select_options: + - name + - sku + - id description: >- - If this setting is enable, we will add `context.app.build`, if present, to - Adobe's AppID, as ` ()`. + 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: lVars - display_name: List Variables + - name: eVars + display_name: eVars type: MAP deprecated: false required: false map_validators: regexp: '' min: 0 - max: 3 - map_prefix: list + max: 250 + map_prefix: eVar 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. + 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: reportSuiteId - display_name: Report Suite ID(s) - type: STRING + - name: props + display_name: Props + type: MAP deprecated: false - required: true - string_validators: + required: false + map_validators: regexp: '' + min: 0 + max: 150 + map_prefix: prop + select_options: [] 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`. + 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: sendBothTimestampVisitorId display_name: Send Both Timestamp and VisitorID for Timestamp Optional Reporting Suites @@ -835,27 +760,102 @@ items: 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: ssl - display_name: SSL + - 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: customDelimiter + display_name: 'List Variable and Prop Custom Delimiter: Server-Side Only ' + type: MAP + 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. + settings: [] + - name: customDataPrefix + display_name: Context Data Property Prefix + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you would like to prefix your Segment properties before sending them as + contextData, enter a prefix here. + settings: [] + - name: sendFalseValues + display_name: Send False values type: BOOLEAN deprecated: false required: false description: >- - Check this box if you would like your Adobe Heartbeat calls to be made - over HTTPS. + 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: useLegacyLinkName - display_name: Use Legacy LinkName + - name: timestampOption + display_name: Timestamp Option + type: SELECT + 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. + settings: [] + - name: useSecureServerUrl + display_name: Use Secure URL for Server-side type: BOOLEAN deprecated: false required: false description: >- - 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. + 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: addBuildToAppId + display_name: Add application build to Adobe's App ID + 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 ` ()`. + 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: @@ -1214,26 +1214,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: mappedStreams - display_name: Map Segment Events to Firehose Delivery Streams - type: MIXED - deprecated: false - required: false - description: >- - Please input the Segment **event names** or **event types** on the left - and the desired Firehose delivery stream destinations on the right. This - mapping is required for all events you would like in Firehose - settings: - - name: mappings - display_name: Map Segment Events to Firehose Delivery Streams - type: MAP - deprecated: false - required: false - description: >- - Please input the Segment **event names** or **event types** on the left - and the desired Firehose delivery stream destinations on the right. This - mapping is required for all events you would like in Firehose - settings: [] - name: region display_name: AWS Kinesis Firehose Region type: STRING @@ -1265,6 +1245,26 @@ items: The External ID to your IAM role. This value is a secret and should be treated as a password. settings: [] + - name: mappedStreams + display_name: Map Segment Events to Firehose Delivery Streams + type: MIXED + deprecated: false + required: false + description: >- + Please input the Segment **event names** or **event types** on the left + and the desired Firehose delivery stream destinations on the right. This + mapping is required for all events you would like in Firehose + settings: + - name: mappings + display_name: Map Segment Events to Firehose Delivery Streams + type: MAP + deprecated: false + required: false + description: >- + Please input the Segment **event names** or **event types** on the left + and the desired Firehose delivery stream destinations on the right. This + mapping is required for all events you would like in Firehose + settings: [] connection_modes: device: web: false @@ -1301,58 +1301,25 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: function - display_name: Lambda + - name: region + display_name: Region type: STRING deprecated: false required: true string_validators: regexp: '' - description: >- - The name of the Lambda function to invoke. These are the supported name - formats: - - - * Function name (`my-function`) or with alias (`my-function:v1`). - - * Function ARN - (`arn:aws:lambda:us-west-2:123456789012:function:my-function`). - - * Partial ARN (`123456789012:function:my-function`). - - - You can append a version number or alias to any of the formats. + description: 'AWS Region where the lambda lives. E.G. `us-west-2`, `eu-west-3`' 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: externalId - display_name: External ID + - name: roleAddress + display_name: Role Address type: STRING deprecated: false - required: false + required: true 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). + 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 @@ -1370,25 +1337,58 @@ items: documentation](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) for more information. settings: [] - - name: region - display_name: Region + - name: externalId + display_name: External ID type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' - description: 'AWS Region where the lambda lives. E.G. `us-west-2`, `eu-west-3`' + 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: [] - - name: roleAddress - display_name: Role Address + - name: function + display_name: Lambda 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`). + The name of the Lambda function to invoke. These are the supported name + formats: + + + * Function name (`my-function`) or with alias (`my-function:v1`). + + * Function ARN + (`arn:aws:lambda:us-west-2:123456789012:function:my-function`). + + * Partial ARN (`123456789012:function:my-function`). + + + 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: [] connection_modes: device: @@ -1426,22 +1426,32 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: logType - display_name: Log Type - type: SELECT + - name: region + display_name: Region + 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. + AWS Region where the lambda lives. If it is not defined, we'll use + `us-west-2` by default. + settings: [] + - name: clientContext + display_name: Client Context + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: [] + description: >- + An optional map to pass to the Lambda function. See [AWS Lambda + documentation](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) + for more information. settings: [] - name: externalId display_name: External ID @@ -1479,32 +1489,22 @@ items: You can append a version number or alias to any of the formats. settings: [] - - name: region - display_name: Region - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - AWS Region where the lambda lives. If it is not defined, we'll use - `us-west-2` by default. - settings: [] - - name: clientContext - display_name: Client Context - type: MAP + - name: logType + display_name: Log Type + type: SELECT deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: [] + select_validators: + select_options: + - None + - Tail description: >- - An optional map to pass to the Lambda function. See [AWS Lambda - documentation](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) - for more information. + 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: roleAddress display_name: Role Address @@ -1607,17 +1607,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: events - display_name: Events - type: MAP - deprecated: false - required: false - description: >- - A mapping of custom events you'd like to pass through to Ambassador to the - corresponding Ambassador event type. For example, if you want to track an - Ambassador conversion, add your event name on the left and "conversion" on - the right. - settings: [] - name: uid display_name: Client ID type: STRING @@ -1642,6 +1631,17 @@ items: Each campaign runs at a specific url like /share or /invite. Map that url on the left to the Ambassador campaign for that page on the right. settings: [] + - name: events + display_name: Events + type: MAP + deprecated: false + required: false + description: >- + A mapping of custom events you'd like to pass through to Ambassador to the + corresponding Ambassador event type. For example, if you want to track an + Ambassador conversion, add your event name on the left and "conversion" on + the right. + settings: [] connection_modes: device: web: true @@ -1681,50 +1681,82 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: appendFieldsToEventProps - display_name: Append Fields To Event Properties - type: MAP + - name: groupTypeTrait + display_name: Group Type Trait + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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`. + What trait Segment should use as your Amplitude "group type" in group + calls. If, for example, you set this to be `industry`, then + `traits["industry"]` will be sent as `groupType` to Amplitude. settings: [] - - name: eventUploadPeriodMillis - display_name: Event Upload Period Millis (for batching events) - type: NUMBER + - name: groupValueTrait + display_name: Group Value Trait + type: STRING deprecated: false required: false - number_validators: - min: 0 - max: 0 + string_validators: + regexp: '' description: >- - Amount of time in milliseconds that the SDK waits before uploading events - if `batchEvents` is `true`. + 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 + - name: preferAnonymousIdForDeviceId + display_name: Prefer Anonymous ID for Device ID + 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. + settings: [] + - name: trackNamedPages + display_name: Track Named Pages to Amplitude type: BOOLEAN deprecated: false required: false 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**. + `name` associated with them. For example `page('Signup')` would translate + to **Viewed Signup Page**. Remember that `name` includes `category`, so + `page('Conversion', 'Signup')` would translate to a **Viewed Conversion + Signup Page** event in Amplitude. settings: [] - - name: batchEvents - display_name: Batch Events + - name: trackSessionEvents + display_name: Track Session Events to Amplitude 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. + (Optional) This enables the sending of start and end session events for + mobile products. Amplitude's libraries track sessions automatically and + this option is not necessary for session tracking. + 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: deviceIdFromUrlParam display_name: Set Device ID From URL Parameter amp_device_id @@ -1735,129 +1767,117 @@ items: If true, the SDK will parse device ID values from url parameter `amp_device_id` if available. settings: [] - - name: enableLocationListening - display_name: Enable Location Listening - type: BOOLEAN + - name: eventUploadThreshold + display_name: Event Upload Threshold (for batching events) + type: NUMBER deprecated: false required: false + number_validators: + min: 0 + max: 0 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. + Minimum number of events to batch together per request if `batchEvents` is + `true`. settings: [] - - name: trackAllPagesV2 - display_name: Track All Screens + - name: unsetParamsReferrerOnNewSession + display_name: Unset Params Referrer On New Session 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. + 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: trackProductsOnce - display_name: Track products once + - name: enableLocationListening + display_name: Enable Location Listening 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. + 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: trackSessionEvents - display_name: Track Session Events to Amplitude + - name: useLogRevenueV2 + display_name: Use Log Revenue V2 API type: BOOLEAN deprecated: false required: false description: >- - (Optional) This enables the sending of start and end session events for - mobile products. Amplitude's libraries track sessions automatically and - this option is not necessary for session tracking. - settings: [] - - name: groupValueTrait - display_name: Group Value Trait - type: STRING - 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. + 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: trackGclid - display_name: Track GCLID - type: BOOLEAN + - name: traitsToPrepend + display_name: Traits to Prepend + type: LIST 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. + Server-Side and Mobile Only. Configure values to be prepended to the user + property array via identify.traits. settings: [] - - name: trackNamedPages - display_name: Track Named Pages to Amplitude + - name: useAdvertisingIdForDeviceId + display_name: Use AdvertisingId for DeviceId type: BOOLEAN deprecated: false required: false description: >- - This will track events to Amplitude for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `name` associated with them. For example `page('Signup')` would translate - to **Viewed Signup Page**. Remember that `name` includes `category`, so - `page('Conversion', 'Signup')` would translate to a **Viewed Conversion - Signup Page** event in Amplitude. + Mobile Only (will *not* work in cloud-mode). Allows users to use + advertisingIdentifier instead of identifierForVendor as the Device ID. settings: [] - - name: preferAnonymousIdForDeviceId - display_name: Prefer Anonymous ID for Device ID - type: BOOLEAN + - name: traitsToAppend + display_name: Traits to Append + type: LIST 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. + Server-Side and Mobile Only. Configure values to be appended to the user + property array via identify.traits. settings: [] - - name: secretKey - display_name: Secret Key + - name: versionName + display_name: Version Name type: STRING deprecated: false required: false string_validators: regexp: '' - description: Your Amplitude Secret Key (Only needed for user deletion) + description: >- + Optional. You can assign a version name for your page, and we'll send it + to Amplitude for more detailed events. settings: [] - - name: trackReferrer - display_name: Track Referrer to Amplitude - type: BOOLEAN + - name: apiKey + display_name: API Key + type: STRING deprecated: false - required: false + required: true + string_validators: + regexp: '^[a-z0-9]{32}$' description: >- - Enabling this will send referrer information as a user property to - Amplitude when you call Segment's `page` method. + You can find your API Key on your Amplitude [Settings + page](https://amplitude.com/settings). settings: [] - - name: useAdvertisingIdForDeviceId - display_name: Use AdvertisingId for DeviceId + - name: batchEvents + display_name: Batch Events 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. + 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: eventUploadThreshold - display_name: Event Upload Threshold (for batching events) + - name: eventUploadPeriodMillis + display_name: Event Upload Period Millis (for batching events) type: NUMBER deprecated: false required: false @@ -1865,17 +1885,20 @@ items: min: 0 max: 0 description: >- - Minimum number of events to batch together per request if `batchEvents` is - `true`. + Amount of time in milliseconds that the SDK waits before uploading events + if `batchEvents` is `true`. settings: [] - - name: forceHttps - display_name: Force Https + - name: trackRevenuePerProduct + display_name: Track Revenue Per Product 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. + 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: saveParamsReferrerOncePerSession display_name: 'Save Referrer, URL Params, GCLID Once Per Session' @@ -1888,88 +1911,36 @@ items: during the middle of the user's session will be ignored. Set to false to always capture new values. settings: [] - - name: useLogRevenueV2 - display_name: Use Log Revenue V2 API + - name: trackAllPages + display_name: Track All Pages to Amplitude type: BOOLEAN deprecated: false required: false 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. - 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: groupTypeTrait - display_name: Group Type Trait - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - What trait Segment should use as your Amplitude "group type" in group - calls. If, for example, you set this to be `industry`, then - `traits["industry"]` will be sent as `groupType` to Amplitude. + 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: sendAlias - display_name: Enable Alias + - name: trackCategorizedPages + display_name: Track Categorized Pages to Amplitude type: BOOLEAN deprecated: false required: false description: >- - Server-Side Only. Enabling this setting allows your Amplitude destination - instance to send `alias` events to Amplitude's `usermap` endpoint. By - default, Segment's Amplitude integration does not support `alias`, so when - this setting is disabled, your Segment Amplitude destination will reject - `alias` events as unsupported. + 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: traitsToPrepend - display_name: Traits to Prepend + - name: traitsToSetOnce + display_name: Traits to Set Once type: LIST deprecated: false required: false description: >- - Server-Side and Mobile Only. Configure values to be prepended to the user - property array via identify.traits. - settings: [] - - name: unsetParamsReferrerOnNewSession - display_name: Unset Params Referrer On New Session - 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. - 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'});` + Server-Side and Mobile Only. Configure values to be set only once via + identify.traits. settings: [] - name: mapQueryParams display_name: Map Query Params to Custom Property @@ -1994,6 +1965,25 @@ items: put on the left hand side we will map the entire query parameters string from the `context.page.url`. settings: [] + - name: trackAllPagesV2 + display_name: Track All Screens + 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. + settings: [] + - name: trackReferrer + display_name: Track Referrer to Amplitude + 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. + settings: [] - name: sendToBatchEndpoint display_name: Send To Batch Endpoint type: BOOLEAN @@ -2010,76 +2000,86 @@ items: Amplitude's throttling is available here in their docs: https://developers.amplitude.com/#429s-in-depth. settings: [] - - name: trackAllPages - display_name: Track All Pages to Amplitude + - name: trackGclid + display_name: Track GCLID 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. + If true, captures the gclid url parameter as well as the user's + initial_gclid via a set once operation. settings: [] - - name: trackRevenuePerProduct - display_name: Track Revenue Per Product - type: BOOLEAN + - name: traitsToIncrement + display_name: Traits To Increment + type: LIST deprecated: false required: false 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. + 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: trackUtmProperties - display_name: Track UTM Properties to Amplitude. + - name: forceHttps + display_name: Force Https 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 events will always be uploaded to HTTPS endpoint. Otherwise + the SDK will use the embedding site's protocol. settings: [] - - name: traitsToAppend - display_name: Traits to Append - type: LIST + - 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 deprecated: false required: false description: >- - Server-Side and Mobile Only. Configure values to be appended to the user - property array via identify.traits. + Server-Side Only. Enabling this setting allows your Amplitude destination + instance to send `alias` events to Amplitude's `usermap` endpoint. By + default, Segment's Amplitude integration does not support `alias`, so when + this setting is disabled, your Segment Amplitude destination will reject + `alias` events as unsupported. 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. + *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: apiKey - display_name: API Key - type: STRING + - name: trackUtmProperties + display_name: Track UTM Properties to Amplitude. + type: BOOLEAN deprecated: false - required: true - string_validators: - regexp: '^[a-z0-9]{32}$' + required: false description: >- - You can find your API Key on your Amplitude [Settings - page](https://amplitude.com/settings). + This will track UTM properties found in the querystring to Amplitude (only + for Device mode). settings: [] - - name: traitsToSetOnce - display_name: Traits to Set Once - type: LIST + - name: useCustomAmplitudeProperties + display_name: Send Custom Language and Country Properties + type: BOOLEAN deprecated: false required: false description: >- - Server-Side and Mobile Only. Configure values to be set only once via - identify.traits. + 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: [] connection_modes: device: @@ -2245,6 +2245,7 @@ items: url: 'https://cdn.filepicker.io/api/file/AnJUEBvxRouLLOvIeQuK' categories: - Attribution + - Deep Linking components: - type: IOS - type: ANDROID @@ -2256,31 +2257,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: rokuAppID - display_name: Roku App ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - **IMPORTANT**: In order to send Roku data, you **must** contact your - AppsFlyer representative as this type of data stream requires a full - server to server integration which is available but is gated as a - AppsFlyer Enterprise Customer feature. Without AppsFlyer's consent we are - unable to forward your Roku data. Your Roku App's ID. Find this in your - AppsFlyer's 'My App' dashboard. This is required for Roku projects if you - want to send events using the server side integration. - settings: [] - - name: trackAttributionData - display_name: Track Attribution Data - type: BOOLEAN - deprecated: false - required: false - description: >- - 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 @@ -2335,6 +2311,31 @@ items: required: false description: 'If selected, HTTPS calls will fallback on HTTP' settings: [] + - name: rokuAppID + display_name: Roku App ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + **IMPORTANT**: In order to send Roku data, you **must** contact your + AppsFlyer representative as this type of data stream requires a full + server to server integration which is available but is gated as a + AppsFlyer Enterprise Customer feature. Without AppsFlyer's consent we are + unable to forward your Roku data. Your Roku App's ID. Find this in your + AppsFlyer's 'My App' dashboard. This is required for Roku projects if you + want to send events using the server side integration. + settings: [] + - name: trackAttributionData + display_name: Track Attribution Data + type: BOOLEAN + deprecated: false + required: false + description: >- + Send attribution data to Segment and other tools as a track call (mobile + libraries only). + settings: [] connection_modes: device: web: false @@ -2479,15 +2480,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: allowedDomains - display_name: Allowed Domains - type: LIST - deprecated: false - required: false - description: >- - Track errors and performance metrics only from specific domains. If this - blacklist is empty, all domains will track metrics. - settings: [] - name: apiKey display_name: API Key type: STRING @@ -2524,6 +2516,15 @@ items: Enable offline errors and metrics tracking when network connectivity is not available. settings: [] + - name: allowedDomains + display_name: Allowed Domains + type: LIST + deprecated: false + required: false + description: >- + Track errors and performance metrics only from specific domains. If this + blacklist is empty, all domains will track metrics. + settings: [] connection_modes: device: web: true @@ -2746,6 +2747,26 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: canUseAdvertisingID + display_name: Allow advertising ID collection. + type: BOOLEAN + deprecated: false + 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: [] - name: apiKey display_name: API Key type: STRING @@ -2768,26 +2789,6 @@ items: strict privacy rules. If disabled, some targeting options in your Batch.com dashboard will stop working correctly. settings: [] - - name: canUseAdvertisingID - display_name: Allow advertising ID collection. - type: BOOLEAN - deprecated: false - 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 @@ -2969,27 +2970,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: branch_key - display_name: Branch Key + - name: apiSecret + display_name: Branch Secret type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' description: >- - Your Branch app key can be retrieved on the settings page of the [Branch + Required for server-side calls. Your Branch secret can be retrieved on the + settings page of the [Branch dashboard](https://dashboard.branch.io/#/settings). settings: [] - - name: apiSecret - display_name: Branch Secret + - name: branch_key + display_name: Branch Key type: STRING deprecated: false - required: false + required: true string_validators: regexp: '' description: >- - Required for server-side calls. Your Branch secret can be retrieved on the - settings page of the [Branch + Your Branch app key can be retrieved on the settings page of the [Branch dashboard](https://dashboard.branch.io/#/settings). settings: [] connection_modes: @@ -3032,84 +3033,40 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true 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: allowCrawlerActivity - display_name: Allow Crawler Activity - 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. - settings: [] - - name: datacenter - display_name: Appboy Datacenter - type: SELECT + - name: appGroupId + display_name: REST API Key + type: STRING 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.).' + string_validators: + regexp: '' + description: >- + This can be found in your Braze dashboard under App Settings > Developer + Console. (Formerly 'App Group Identifier') settings: [] - - name: enableLogging - display_name: Enable Logging + - name: automaticallyDisplayMessages + display_name: Automatically Send In-App Messages 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.** + **Web Only**: When this is enabled, all In-App Messages that a user is + eligible for are automatically delivered to the user. If you'd like to + register your own display subscribers or send soft push notifications to + your users, make sure to disable this option. settings: [] - - name: logPurchaseWhenRevenuePresent - display_name: Log Purchase when Revenue is present - type: BOOLEAN + - name: customEndpoint + display_name: Custom API Endpoint + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - When this option is enabled, all Track calls with a property called - `revenue` will trigger Braze's LogRevenue event. + If you've been assigned an API endpoint by the Braze team specifically for + use with their Mobile or Javascript SDKs, please input that here. It + should look something like: sdk.api.appboy.eu. Otherwise, leave this + blank. settings: [] - name: safariWebsitePushId display_name: Safari Website Push ID @@ -3124,6 +3081,32 @@ items: bullet points [here](https://www.braze.com/documentation/Web/#step-5-configure-safari-push). 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: 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: apiKey display_name: App Identifier type: STRING @@ -3135,21 +3118,18 @@ items: The API key found in your Braze dashboard, used to identify your application as the app identifier. (Formerly 'API Key') settings: [] - - name: doNotLoadFontAwesome - display_name: Do Not Load Font Awesome + - name: automatic_in_app_message_registration_enabled + display_name: Enable Automatic In-App Message Registration 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.** + **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: enableHtmlInAppMessages display_name: Enable HTML In-App Messages @@ -3163,6 +3143,22 @@ items: for more information on this setting. **This setting is only applicable if you are using version 2 of the Braze Web SDK.** settings: [] + - name: minimumIntervalBetweenTriggerActionsInSeconds + display_name: Minimum Interval Between Trigger Actions In Seconds + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: >- + **Web Only:** By default, a trigger action will only fire if at least 30 + seconds have elapsed since the last trigger action. Provide a value for + this configuration option to override that default with a value of your + own. We do not recommend making this value any smaller than 10 to avoid + spamming the user with notifications. **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 @@ -3185,40 +3181,42 @@ 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: appGroupId - display_name: REST API Key - type: STRING + - name: sessionTimeoutInSeconds + display_name: Session Timeout In Seconds + type: NUMBER deprecated: false - required: true - string_validators: - regexp: '' - description: >- - This can be found in your Braze dashboard under App Settings > Developer - Console. (Formerly 'App Group Identifier') + 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: automatic_in_app_message_registration_enabled - display_name: Enable Automatic In-App Message Registration - type: BOOLEAN + - name: datacenter + display_name: Appboy Datacenter + type: SELECT 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). + 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: automaticallyDisplayMessages - display_name: Automatically Send In-App Messages + - name: logPurchaseWhenRevenuePresent + display_name: Log Purchase when Revenue is present type: BOOLEAN deprecated: false required: false description: >- - **Web Only**: When this is enabled, all In-App Messages that a user is - eligible for are automatically delivered to the user. If you'd like to - register your own display subscribers or send soft push notifications to - your users, make sure to disable this option. + When this option is enabled, all Track calls with a property called + `revenue` will trigger Braze's LogRevenue event. settings: [] - name: openNewsFeedCardsInNewTab display_name: Open News Feed Cards In New Tab @@ -3231,77 +3229,80 @@ items: 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 - type: BOOLEAN + - name: restCustomEndpoint + display_name: Custom REST API Endpoint + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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. + If you've been assigned an API endpoint by the Braze team specifically for + use with their REST API, please input that here. It should look something + like "https://foo.bar.braze.com". Otherwise, leave this blank. settings: [] - - name: updateExistingOnly - display_name: Update Existing Users Only - type: BOOLEAN + - name: serviceWorkerLocation + display_name: Service Worker Location + 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 + Specify your `serviceWorkerLocation` as defined in the Braze Web SDK + documentation: + https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html settings: [] - - name: customEndpoint - display_name: Custom API Endpoint - type: STRING + - name: allowCrawlerActivity + display_name: Allow Crawler Activity + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - If you've been assigned an API endpoint by the Braze team specifically for - use with their Mobile or Javascript SDKs, please input that here. It - should look something like: sdk.api.appboy.eu. Otherwise, leave this - blank. + **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: minimumIntervalBetweenTriggerActionsInSeconds - display_name: Minimum Interval Between Trigger Actions In Seconds - type: NUMBER + - name: doNotLoadFontAwesome + display_name: Do Not Load Font Awesome + type: BOOLEAN deprecated: false required: false - number_validators: - min: 0 - max: 0 description: >- - **Web Only:** By default, a trigger action will only fire if at least 30 - seconds have elapsed since the last trigger action. Provide a value for - this configuration option to override that default with a value of your - own. We do not recommend making this value any smaller than 10 to avoid - spamming the user with notifications. **This setting is only applicable if - you are using version 2 of the Braze Web SDK.** + **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: restCustomEndpoint - display_name: Custom REST API Endpoint - type: STRING + - name: enableLogging + display_name: Enable Logging + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - If you've been assigned an API endpoint by the Braze team specifically for - use with their REST API, please input that here. It should look something - like "https://foo.bar.braze.com". Otherwise, leave this blank. + **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: serviceWorkerLocation - display_name: Service Worker Location - type: STRING + - name: trackNamedPages + display_name: Track Only Named Pages + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - Specify your `serviceWorkerLocation` as defined in the Braze Web SDK - documentation: - https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html + 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: [] connection_modes: device: @@ -3454,13 +3455,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: useSSL - display_name: Use SSL - type: BOOLEAN - deprecated: false - required: false - description: Use SSL When Sending Data to Bugsnag - settings: [] - name: apiKey display_name: API Key type: STRING @@ -3483,6 +3477,13 @@ items: Distinguish errors that happen in different stages of your app's release process e.g 'production', 'development', etc. settings: [] + - name: useSSL + display_name: Use SSL + type: BOOLEAN + deprecated: false + required: false + description: Use SSL When Sending Data to Bugsnag + settings: [] connection_modes: device: web: true @@ -3713,6 +3714,13 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: + - name: customFields + display_name: Custom Fields + type: LIST + deprecated: false + required: false + description: 'Segment traits to be imported as custom fields (e.g. "age,phone,username")' + settings: [] - name: apiKey display_name: API Key type: STRING @@ -3724,13 +3732,6 @@ items: You can find your API Key in the Segment Integration page in your admin settings. settings: [] - - name: customFields - display_name: Custom Fields - type: LIST - deprecated: false - required: false - description: 'Segment traits to be imported as custom fields (e.g. "age,phone,username")' - settings: [] connection_modes: device: web: false @@ -4183,6 +4184,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: clevertap_account_id + display_name: Account ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Add your CleverTap Account ID which you can find in the CleverTap + Dashboard under Settings. + settings: [] - name: clevertap_account_token display_name: Account Token type: STRING @@ -4206,17 +4218,6 @@ items: - sg. description: '**Server Only**: Your dedicated Clevertap region.' settings: [] - - name: clevertap_account_id - display_name: Account ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Add your CleverTap Account ID which you can find in the CleverTap - Dashboard under Settings. - settings: [] connection_modes: device: web: true @@ -4410,6 +4411,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: hybridAttributionModel + display_name: Hybrid Attribution Model + type: BOOLEAN + deprecated: false + required: false + description: >- + This will make **Completed Order** events always send a `sale` event in + addition to a `sale.new` or `sale.repeat` event if it has a boolean + `repeat` property. + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + 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 @@ -4451,27 +4473,6 @@ items: you want to send to Convertro, put the event name you send to Segment on the left, and the name you want Convertro to receive it as on the right. settings: [] - - name: hybridAttributionModel - display_name: Hybrid Attribution Model - type: BOOLEAN - deprecated: false - required: false - description: >- - This will make **Completed Order** events always send a `sale` event in - addition to a `sale.new` or `sale.repeat` event if it has a boolean - `repeat` property. - settings: [] - - name: siteId - display_name: Site ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - If you'd like to send mobile data to Convertro's server side integration, - please enter your Convertro Site ID - settings: [] connection_modes: device: web: true @@ -4782,19 +4783,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: customVersionName - display_name: Custom Version Name (Android) - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Override the default version name of your app that is reported to - Crittercism (Android only). Check out the [Crittercism - docs](http://docs.crittercism.com/android/android.html#customizing-the-version-reported-to-crittercism) - for more info. - settings: [] - name: enableServiceMonitoring display_name: Enable Service Monitoring (Android) type: BOOLEAN @@ -4852,6 +4840,19 @@ items: page](https://app.crittercism.com/developers). It should be 24 characters long, and look something like this: `93ac1026a7928a581c000002`. settings: [] + - name: customVersionName + display_name: Custom Version Name (Android) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Override the default version name of your app that is reported to + Crittercism (Android only). Check out the [Crittercism + docs](http://docs.crittercism.com/android/android.html#customizing-the-version-reported-to-crittercism) + for more info. + settings: [] connection_modes: device: web: false @@ -5041,6 +5042,13 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: + - name: convertToUnixTime + display_name: Convert To Unix Time + type: BOOLEAN + deprecated: false + required: false + description: 'If true, timestamps are converted to Unix Time.' + settings: [] - name: siteId display_name: Site ID type: STRING @@ -5066,13 +5074,6 @@ items: `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 - deprecated: false - required: false - description: 'If true, timestamps are converted to Unix Time.' - settings: [] connection_modes: device: web: true @@ -5206,6 +5207,28 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: source + display_name: DoubleClick Advertiser ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your advertiser ID that is the source of the Floodlight activity. This + should be the `src` of your tag string. + settings: [] + - name: token + display_name: Authorization Token for server-to-server requests + 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. + settings: [] - name: groupTag display_name: Group Tag type: STRING @@ -5219,16 +5242,29 @@ items: same value for this parameter across all conversion events or you can define this value for each of your conversion event mappings below. settings: [] - - name: source - display_name: DoubleClick Advertiser ID + - name: segmentWriteKey + display_name: Segment Write Key type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' description: >- - Your advertiser ID that is the source of the Floodlight activity. This - should be the `src` of your tag string. + Set here the write key for this source. It's required if cookie matching + is enabled. + settings: [] + - name: activityTag + display_name: Activity Tag + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + This setting maps to the Doubleclick Floodlight container activity tag (or + `cat`) string. You can choose to use this setting to define the same value + for this parameter across all conversion events or you can define this + value for each of your conversion event mappings below. settings: [] - name: events display_name: Conversion events @@ -5239,6 +5275,30 @@ 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: event + display_name: Segment Event Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + 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 + type: STRING + deprecated: false + required: true + 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. + settings: [] - name: type display_name: Floodlight Group Tag type: STRING @@ -5293,33 +5353,9 @@ items: corresponding Floodlight custom variables like `u1,u2,..etc` (on the *right*). You may also define the event properties you would like to use using JSON style dot notation accessors wrapped as handlebars style - expressions. For example `{{context.campaign.name}}` or - `{{context.userAgent}}`. Please reference our - [docs](/docs/destinations/doubleclick-floodlight/) for more info. - settings: [] - - name: event - display_name: Segment Event Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - 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 - type: STRING - deprecated: false - required: true - 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. + expressions. For example `{{context.campaign.name}}` or + `{{context.userAgent}}`. Please reference our + [docs](/docs/destinations/doubleclick-floodlight/) for more info. settings: [] - name: getDoubleClickId display_name: Get DoubleClick Id @@ -5342,41 +5378,6 @@ items: Provide your Google Network Id here if you have enabled cookie matching (Get DoubleClick Id setting). settings: [] - - name: activityTag - display_name: Activity Tag - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This setting maps to the Doubleclick Floodlight container activity tag (or - `cat`) string. You can choose to use this setting to define the same value - for this parameter across all conversion events or you can define this - value for each of your conversion event mappings below. - settings: [] - - name: segmentWriteKey - display_name: Segment Write Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Set here the write key for this source. It's required if cookie matching - is enabled. - settings: [] - - name: token - display_name: Authorization Token for server-to-server requests - 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. - settings: [] connection_modes: device: web: true @@ -5736,14 +5737,14 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: sendGroup - display_name: Create or Update Account on Group - type: BOOLEAN + - name: siteId + display_name: Site ID + type: STRING deprecated: false - required: false - description: >- - *Server Side Only*: Enable this setting to create or update an Eloqua - account on a `group` event. + required: true + string_validators: + regexp: '' + description: Enter your Site ID settings: [] - name: username display_name: Username @@ -5763,55 +5764,57 @@ items: regexp: '' description: Enter your login company name settings: [] - - name: password - display_name: Password - type: PASSWORD - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter your login passord - settings: [] - - name: mappedGroupTraits - display_name: Map Custom Traits to Accounts + - name: mappedEvents + display_name: Map Track Events to Custom Objects type: MAP deprecated: false required: false description: >- - Please input the Segment trait names on the left and their corresponding - Eloqua Custom Account Field names on the right. The traits must be set up - in the Eloqua dashboard prior to instantiating this mapping. + Please input the Segment event names on the left and their corresponding + Eloqua Custom Object names on the right. This mapping is required for all + events you would like in Eloqua as Custom Objects. - **Note:** If you have set up Custom Account Fields in Eloqua, please - ensure the corresponding Segment payload property values are of the same - data type specified in Eloqua's dashboard. Eloqua will reject any event - containing a Custom Account Field with an incorrect data type. + **Note:** If you have set up Custom Object Fields in Eloqua, please ensure + the corresponding Segment payload property values are of the same data + type specified in Eloqua's dashboard. Eloqua will reject any event + containing a Custom Object Field with an incorrect data type. Segment + automatically attempts to match property names to Custom Object Field + names in Eloqua. settings: [] - - name: mappedIdentifyTraits - display_name: Map Custom Traits to Contacts + - name: mappedGroupTraits + display_name: Map Custom Traits to Accounts type: MAP deprecated: false required: false description: >- Please input the Segment trait names on the left and their corresponding - Eloqua Custom Contact Field names on the right. The traits must be set up + Eloqua Custom Account Field names on the right. The traits must be set up in the Eloqua dashboard prior to instantiating this mapping. - **Note:** If you have set up Custom Contact Fields in Eloqua, please + **Note:** If you have set up Custom Account Fields in Eloqua, please ensure the corresponding Segment payload property values are of the same data type specified in Eloqua's dashboard. Eloqua will reject any event - containing a Custom Contact Field with an incorrect data type. + containing a Custom Account Field with an incorrect data type. settings: [] - - name: siteId - display_name: Site ID - type: STRING + - name: password + display_name: Password + type: PASSWORD deprecated: false required: true string_validators: regexp: '' - description: Enter your Site ID + 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: createContactOnTrack display_name: Create or Update Contact on Track @@ -5825,23 +5828,21 @@ 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: mappedEvents - display_name: Map Track Events to Custom Objects + - name: mappedIdentifyTraits + display_name: Map Custom Traits to Contacts type: MAP deprecated: false required: false description: >- - Please input the Segment event names on the left and their corresponding - Eloqua Custom Object names on the right. This mapping is required for all - events you would like in Eloqua as Custom Objects. + Please input the Segment trait names on the left and their corresponding + Eloqua Custom Contact Field names on the right. The traits must be set up + in the Eloqua dashboard prior to instantiating this mapping. - **Note:** If you have set up Custom Object Fields in Eloqua, please ensure - the corresponding Segment payload property values are of the same data - type specified in Eloqua's dashboard. Eloqua will reject any event - containing a Custom Object Field with an incorrect data type. Segment - automatically attempts to match property names to Custom Object Field - names in Eloqua. + **Note:** If you have set up Custom Contact Fields in Eloqua, please + ensure the corresponding Segment payload property values are of the same + data type specified in Eloqua's dashboard. Eloqua will reject any event + containing a Custom Contact Field with an incorrect data type. settings: [] connection_modes: device: @@ -5977,6 +5978,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 @@ -5991,16 +6002,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 @@ -6094,70 +6095,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: trackScreenEvents - display_name: Use Screen Events as Track Events - type: BOOLEAN - deprecated: false - required: false - description: >- - This setting allows you to track your Segment screen events as though they - were track events. If enabled, we will being routing screen events from - this source to Facebook App Events formatted as Viewed `name` Screen - (where `name` is the [screen name](https://segment.com/docs/spec/screen/) - you specify). - settings: [] - - name: appEvents - display_name: Map your events to Standard FB App Events - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: - - fb_mobile_level_achieved - - fb_mobile_activate_app - - fb_mobile_add_payment_info - - fb_mobile_add_to_cart - - fb_mobile_add_to_wishlist - - fb_mobile_complete_registration - - fb_mobile_tutorial_completion - - fb_mobile_initiated_checkout - - fb_mobile_purchase - - fb_mobile_rate - - fb_mobile_search - - fb_mobile_spent_credits - - fb_mobile_achievement_unlocked - - 'fb_mobile_content_view ' - - Subscribe - - StartTrial - - AdClick - - AdImpression - description: >- - Enter your events on the left and the Facebook standard event to map to on - the right. Facebook recognizes certain [standard - events](https://developers.facebook.com/docs/marketing-api/app-event-api/v2.6) - that can be used across Custom Audiences, custom conversions, conversion - tracking, and conversion optimization. When you map an event to a standard - Facebook event, we'll send the event by that name. Any unmapped events - will still be sent as Custom Events. - - - - **Facebook Recommended Events** - - - The most important events that can help advertisers improve campaign ROI - are the conversion events or events closest to the conversion. Those - events are marked with an *. - - - In addition, there are special requirements for dynamic ads. These events - are marked with "m" for dynamic ads for mobile, and "t" for dynamic ads - for travel. - settings: [] - name: appId display_name: App ID type: STRING @@ -6204,19 +6141,83 @@ items: category: fb_content_type - The version of your app: _appVersion + The version of your app: _appVersion + + The timestamp of the event: _logTime + + query: fb_search_string + + quantity: fb_num_items + + number of items in products: fb_num_items + + list of ids in products: fb_content_id + + ``` + settings: [] + - name: trackScreenEvents + display_name: Use Screen Events as Track Events + type: BOOLEAN + deprecated: false + required: false + description: >- + This setting allows you to track your Segment screen events as though they + were track events. If enabled, we will being routing screen events from + this source to Facebook App Events formatted as Viewed `name` Screen + (where `name` is the [screen name](https://segment.com/docs/spec/screen/) + you specify). + settings: [] + - name: appEvents + display_name: Map your events to Standard FB App Events + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - fb_mobile_level_achieved + - fb_mobile_activate_app + - fb_mobile_add_payment_info + - fb_mobile_add_to_cart + - fb_mobile_add_to_wishlist + - fb_mobile_complete_registration + - fb_mobile_tutorial_completion + - fb_mobile_initiated_checkout + - fb_mobile_purchase + - fb_mobile_rate + - fb_mobile_search + - fb_mobile_spent_credits + - fb_mobile_achievement_unlocked + - 'fb_mobile_content_view ' + - Subscribe + - StartTrial + - AdClick + - AdImpression + description: >- + Enter your events on the left and the Facebook standard event to map to on + the right. Facebook recognizes certain [standard + events](https://developers.facebook.com/docs/marketing-api/app-event-api/v2.6) + that can be used across Custom Audiences, custom conversions, conversion + tracking, and conversion optimization. When you map an event to a standard + Facebook event, we'll send the event by that name. Any unmapped events + will still be sent as Custom Events. + - The timestamp of the event: _logTime - query: fb_search_string + **Facebook Recommended Events** - quantity: fb_num_items - number of items in products: fb_num_items + The most important events that can help advertisers improve campaign ROI + are the conversion events or events closest to the conversion. Those + events are marked with an *. - list of ids in products: fb_content_id - ``` + In addition, there are special requirements for dynamic ads. These events + are marked with "m" for dynamic ads for mobile, and "t" for dynamic ads + for travel. settings: [] connection_modes: device: @@ -6342,18 +6343,20 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: - - name: keyForExternalId - display_name: 'Client-Side Only: Advanced Match Trait Key for External ID' - type: STRING + - name: blacklistPiiProperties + display_name: Blacklist PII Properties + type: MIXED deprecated: false required: false - string_validators: - regexp: '' description: >- - Please indicated a user trait key which you would like Segment to use to - send an `external_id` to Facebook Pixel using advanced matching. Segment - will use the value of this trait to map it to Facebook Pixel's - `external_id`. + Facebook has a strict policy prohibiting any personally identifiable + information (PII) from being sent as properties of events to their API. By + default, this integration will scan `track` events for + [these](https://segment.com/docs/destinations/facebook-pixel/#pii-blacklisting) + properties and strip them from the payload that gets sent to Facebook. If + your events contain other properties with PII values, you can use this + 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: legacyEvents display_name: Legacy Conversion Pixel IDs @@ -6379,15 +6382,6 @@ items: 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 - deprecated: false - required: false - description: >- - 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 @@ -6402,6 +6396,28 @@ items: 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: userIdAsExternalId + display_name: Use UserId or Anonymous Id as External Id + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this setting if you want to send, `userId` (or `anonymousId` if not + present) as external Id to Facebook. + settings: [] - name: contentTypes display_name: Map Categories to FB Content Types type: MAP @@ -6413,18 +6429,27 @@ items: deliver relevant ads. If no category values are mapped we'll default to `product` and `product_group`, depending on the event. settings: [] - - name: whitelistPiiProperties - display_name: Whitelist PII Properties - type: LIST + - name: initWithExistingTraits + display_name: Enable Advanced Matching + type: BOOLEAN 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.** + If true, we will initialize Facebook Pixel with any user traits that's + been cached in the Segment cookies from your previous `.identify()` calls. + settings: [] + - name: keyForExternalId + display_name: 'Client-Side Only: Advanced Match Trait Key for External ID' + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Please indicated a user trait key which you would like Segment to use to + send an `external_id` to Facebook Pixel using advanced matching. Segment + will use the value of this trait to map it to Facebook Pixel's + `external_id`. settings: [] - name: pixelId display_name: Pixel ID @@ -6474,30 +6499,6 @@ items: Facebook event, we'll send the event by that name. Any unmapped events will still be sent as Custom Events. settings: [] - - name: blacklistPiiProperties - display_name: Blacklist PII Properties - type: MIXED - deprecated: false - required: false - description: >- - Facebook has a strict policy prohibiting any personally identifiable - information (PII) from being sent as properties of events to their API. By - default, this integration will scan `track` events for - [these](https://segment.com/docs/destinations/facebook-pixel/#pii-blacklisting) - properties and strip them from the payload that gets sent to Facebook. If - your events contain other properties with PII values, you can use this - 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: initWithExistingTraits - display_name: Enable Advanced Matching - type: BOOLEAN - deprecated: false - required: false - description: >- - If true, we will initialize Facebook Pixel with any user traits that's - been cached in the Segment cookies from your previous `.identify()` calls. - settings: [] connection_modes: device: web: true @@ -6642,6 +6643,27 @@ 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 @@ -6678,27 +6700,6 @@ 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 @@ -6924,17 +6925,6 @@ items: required: false description: Map your page calls to specific FriendBuy Widgets. settings: - - name: name - display_name: Page Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Enter the `name` of your `.page()` calls. ie. `'Home'` if you are - calling `.page('Home')`. - settings: [] - name: id display_name: Widget ID type: STRING @@ -6984,6 +6974,17 @@ items: `survey=false` dynamically, you can enter `'isSurvey': 'survey'` assuming `isSurvey` is a valid property on your `.page()` calls. settings: [] + - name: name + display_name: Page Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Enter the `name` of your `.page()` calls. ie. `'Home'` if you are + calling `.page('Home')`. + settings: [] connection_modes: device: web: true @@ -7020,20 +7021,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true 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 - settings: [] - name: org display_name: FS Org type: STRING @@ -7060,6 +7047,20 @@ items: 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 + settings: [] connection_modes: device: web: true @@ -7196,17 +7197,6 @@ 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 @@ -7233,6 +7223,17 @@ 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 @@ -7369,25 +7370,25 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: anonymizeIP - display_name: Anonymize IP + - name: trackLocal + display_name: Track Local type: BOOLEAN deprecated: false required: false description: >- - Enable if you need to anonymize the IP address of visitors to your - website. + 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: apiKey - display_name: API Key (Server-side) - type: STRING + - name: trackParams + display_name: Track Parameters + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - Generate your server-side API key here: - https://www.gosquared.com/settings/api + 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: apiSecret display_name: Site Token @@ -7401,28 +7402,14 @@ items: guide](https://www.gosquared.com/integration/). It should look something like `GSN-123456-A`. settings: [] - - name: cookieDomain - display_name: Cookie Domain - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^[.a-zA-Z0-9_-]+\.[.a-zA-Z0-9_-]+$' - description: >- - Use this if you wish to share GoSquared’s tracking cookies across - subdomains, `.example.com` will enable shared tracking across all - example’s subdomains. By default, cookies are set on the current domain - (including subdomain) only. - settings: [] - - name: trackLocal - display_name: Track Local + - name: trackHash + display_name: Track Hash 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. + 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: useCookies display_name: Use Cookies @@ -7431,24 +7418,38 @@ items: required: false description: Disable this if you don't want to use cookies settings: [] - - name: trackHash - display_name: Track Hash + - name: anonymizeIP + display_name: Anonymize IP type: BOOLEAN deprecated: false required: false description: >- - 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`. + Enable if you need to anonymize the IP address of visitors to your + website. settings: [] - - name: trackParams - display_name: Track Parameters - type: BOOLEAN + - name: apiKey + display_name: API Key (Server-side) + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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. + Generate your server-side API key here: + https://www.gosquared.com/settings/api + settings: [] + - name: cookieDomain + display_name: Cookie Domain + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^[.a-zA-Z0-9_-]+\.[.a-zA-Z0-9_-]+$' + description: >- + Use this if you wish to share GoSquared’s tracking cookies across + subdomains, `.example.com` will enable shared tracking across all + example’s subdomains. By default, cookies are set on the current domain + (including subdomain) only. settings: [] connection_modes: device: @@ -7486,18 +7487,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: conversionId - display_name: Conversion ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Your AdWords conversion identifier. It looks like `983265867`. You can opt - to override this on a per-event basis but at the very least this - conversion ID will serve as the ID used in page calls. - settings: [] - name: correctLat display_name: Correct LAT Behavior type: BOOLEAN @@ -7608,6 +7597,18 @@ items: 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 + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Your AdWords conversion identifier. It looks like `983265867`. You can opt + to override this on a per-event basis but at the very least this + conversion ID will serve as the ID used in page calls. + settings: [] connection_modes: device: web: true @@ -7644,17 +7645,6 @@ 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 @@ -7707,6 +7697,17 @@ 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: [] connection_modes: device: web: true @@ -7748,150 +7749,38 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true 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: sendUserId - display_name: Send User-ID to GA - type: BOOLEAN - deprecated: false - required: false - description: >- - User-ID enables the analysis of groups of sessions across devices, using a - unique and persistent ID. This only works with Google Analytics Universal. - IMPORTANT: Sending email or other personally identifiable information - (PII) violates Google Analytics Terms of Service. - settings: [] - - name: metrics - display_name: Custom Metrics - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 200 - map_prefix: metric - select_options: [] - description: >- - Because Google Analytics cannot accept arbitrary data about users or - events, when you use `analytics.identify(userId, traits)` with custom - numerical traits or `analytics.track('event', properties)` with custom - numerical properties, you need to map those traits and properties to - Google Analytics custom metrics if you want them to be sent to GA. Enter a - trait or property name on the left. Choose the Google Analytics metric you - want on the right. Google Analytics only accepts numbered metrics (e.g. - metric3). We suggest using user-scoped metrics for trait mappings and - hit-scoped metrics for properties. [Contact - us](https://segment.com/contact) if you need help! - settings: [] - - name: includeSearch - display_name: Include the Querystring in Page Views - 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. - 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: identifyCategory - display_name: Server Side Identify Event Category - 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. - settings: [] - - name: identifyEventName - display_name: Server Side Identify Event Action - 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: 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: serversideTrackingId - display_name: Serverside Tracking ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: ^UA-\d+-\d+$ description: >- - Your Serverside Tracking ID is the UA code for the Google Analytics - property you want to send server-side calls to. Leave it blank if you - don't have a server-side client library that you want to send data from. - Remember that data tracked from mobile integrations that are not bundled - in your app send data to Google Analytics server side, since Segment sends - data to them via our own servers. + 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: classic - display_name: Use Classic Analytics on Your Site + - name: enableServerIdentify + display_name: Enable Server Side Identify 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. - settings: [] - - name: mobileTrackingId - display_name: Mobile Tracking ID - type: STRING + 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: reportUncaughtExceptions + display_name: Send Uncaught Exceptions to GA (Mobile) + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: ^UA-\d+-\d+$ 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. + 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 @@ -7903,40 +7792,52 @@ items: 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: trackingId - display_name: Website Tracking ID - type: STRING + - name: trackNamedPages + display_name: Track Named Pages + type: BOOLEAN 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. + 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: dimensions - display_name: Custom Dimensions + - 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: [] + - name: contentGroupings + display_name: Content Groupings type: MAP deprecated: false required: false map_validators: regexp: '' min: 0 - max: 200 - map_prefix: dimension + max: 5 + map_prefix: contentGroup select_options: [] 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! + Enter a property name on the left. Choose the Google Analytics content + grouping you want on the right. Google Analytics only accepts numbered + content groupings (e.g. contentGrouping3). When you use + `analytics.page(name, properties)` with custom properties, we'll use the + value of the property you designate as the value of the specified content + grouping. settings: [] - name: ignoredReferrers display_name: Ignored Referrers @@ -7954,6 +7855,18 @@ items: referrers](https://support.google.com/analytics/answer/2795830?hl=en&ref_topic=2790009) _directly inside Google Analytics._ settings: [] + - name: serversideClassic + display_name: Use Classic Analytics for Your Serverside Tracking + 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 profiles are Classic. An easy + test: if you see `_gaq.push` in your code you're using Classic, so enable + this. + settings: [] - name: trackCategorizedPages display_name: Track Categorized Pages type: BOOLEAN @@ -7965,26 +7878,61 @@ items: `category` associated with them. E.g. `page('Docs', 'Index')` translates to **Viewed Docs Page**. settings: [] - - name: trackNamedPages - display_name: Track Named Pages - type: BOOLEAN + - name: identifyCategory + display_name: Server Side Identify Event Category + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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**. + 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: enhancedLinkAttribution - display_name: Enable Enhanced Link Attribution + - name: mobileTrackingId + display_name: Mobile Tracking ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: ^UA-\d+-\d+$ + 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. + settings: [] + - name: serversideTrackingId + display_name: Serverside Tracking ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: ^UA-\d+-\d+$ + description: >- + Your Serverside Tracking ID is the UA code for the Google Analytics + property you want to send server-side calls to. Leave it blank if you + don't have a server-side client library that you want to send data from. + Remember that data tracked from mobile integrations that are not bundled + in your app send data to Google Analytics server side, since Segment sends + data to them via our own servers. + settings: [] + - name: classic + display_name: Use Classic Analytics on Your Site 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). + **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: domain display_name: Cookie Domain Name @@ -8005,38 +7953,15 @@ items: about this setting in our docs](/docs/integrations/google-analytics/#cookie-domain-name). settings: [] - - name: enableServerIdentify - display_name: Enable Server Side Identify + - name: enhancedLinkAttribution + display_name: Enable Enhanced Link Attribution 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. - settings: [] - - name: protocolMappings - display_name: Map Traits or Properties to Measurement Protocol Params - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: - - plt - - pdt - - gclid - description: >- - If you are using the *server side* GA integration, you can map your custom - traits or properties to known [measurement protocol - params](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters). + 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: siteSpeedSampleRate display_name: Site Speed Sample Rate @@ -8052,41 +7977,77 @@ items: rate for your [site speed stats](https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration?hl=en#_gat.GA_Tracker_._setSiteSpeedSampleRate). settings: [] - - name: useGoogleAmpClientId - display_name: Use Google AMP Client ID + - name: doubleClick + display_name: 'Remarketing, Display Ads and Demographic Reports.' + type: BOOLEAN + deprecated: false + required: false + description: Works with both Universal and Classic tracking methods. + settings: [] + - name: nameTracker + display_name: Name Tracker 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. + 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: anonymizeIp - display_name: Anonymize IP Addresses + - name: optimize + display_name: Optimize Container ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Integrate with Google Analytics Optimize plugin. Please enter your + Optimize Container ID + settings: [] + - name: enhancedEcommerce + display_name: Enable Enhanced Ecommerce 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 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: reportUncaughtExceptions - display_name: Send Uncaught Exceptions to GA (Mobile) + - name: identifyEventName + display_name: Server Side Identify Event Action + 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: nonInteraction + display_name: Add the non-interaction flag to all events type: BOOLEAN deprecated: false required: false description: >- - This lets you study errors and exceptions in your iOS and Android apps in - Google Analytics. + 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: includeSearch + display_name: Include the Querystring in Page Views + 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. settings: [] - name: setAllMappedProps display_name: Set Custom Dimensions & Metrics to the Page @@ -8106,79 +8067,119 @@ items: [documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets#implementation) for more info. settings: [] - - name: enhancedEcommerce - display_name: Enable Enhanced Ecommerce + - name: sendUserId + display_name: Send User-ID to GA type: BOOLEAN deprecated: false required: false 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). + User-ID enables the analysis of groups of sessions across devices, using a + unique and persistent ID. This only works with Google Analytics Universal. + IMPORTANT: Sending email or other personally identifiable information + (PII) violates Google Analytics Terms of Service. settings: [] - - name: nameTracker - display_name: Name Tracker - type: BOOLEAN + - name: trackingId + display_name: Website Tracking ID + type: STRING deprecated: false required: false + string_validators: + regexp: ^UA-\d+-\d+$ 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(....)' + 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: nonInteraction - display_name: Add the non-interaction flag to all events + - name: typeOverride + display_name: Send Segment "Product List" Events to GA as "Event" Hits type: BOOLEAN deprecated: false required: false 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. + 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: optimize - display_name: Optimize Container ID - type: STRING + - name: dimensions + display_name: Custom Dimensions + type: MAP deprecated: false required: false - string_validators: + map_validators: regexp: '' + min: 0 + max: 200 + map_prefix: dimension + select_options: [] description: >- - Integrate with Google Analytics Optimize plugin. Please enter your - Optimize Container ID + 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: serversideClassic - display_name: Use Classic Analytics for Your Serverside Tracking - type: BOOLEAN + - name: metrics + display_name: Custom Metrics + type: MAP deprecated: false required: false + map_validators: + regexp: '' + min: 0 + max: 200 + map_prefix: metric + select_options: [] 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 profiles are Classic. An easy - test: if you see `_gaq.push` in your code you're using Classic, so enable - this. + Because Google Analytics cannot accept arbitrary data about users or + events, when you use `analytics.identify(userId, traits)` with custom + numerical traits or `analytics.track('event', properties)` with custom + numerical properties, you need to map those traits and properties to + Google Analytics custom metrics if you want them to be sent to GA. Enter a + trait or property name on the left. Choose the Google Analytics metric you + want on the right. Google Analytics only accepts numbered metrics (e.g. + metric3). We suggest using user-scoped metrics for trait mappings and + hit-scoped metrics for properties. [Contact + us](https://segment.com/contact) if you need help! settings: [] - - name: contentGroupings - display_name: Content Groupings + - name: protocolMappings + display_name: Map Traits or Properties to Measurement Protocol Params type: MAP deprecated: false required: false map_validators: regexp: '' min: 0 - max: 5 - map_prefix: contentGroup - select_options: [] + max: 0 + map_prefix: '' + select_options: + - plt + - pdt + - gclid description: >- - Enter a property name on the left. Choose the Google Analytics content - grouping you want on the right. Google Analytics only accepts numbered - content groupings (e.g. contentGrouping3). When you use - `analytics.page(name, properties)` with custom properties, we'll use the - value of the property you designate as the value of the specified content - grouping. + If you are using the *server side* GA integration, you can map your custom + traits or properties to known [measurement protocol + params](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters). + 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: [] connection_modes: device: @@ -8316,17 +8317,6 @@ 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 @@ -8372,6 +8362,17 @@ 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 @@ -8709,16 +8710,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: hjPlaceholderPolyfill - display_name: IE9 Placeholder Polyfill - type: BOOLEAN - deprecated: false - required: false - description: >- - HotJar loads a polyfill for placeholder tags on input fields for IE9. - Disable this if you already use a placeholder plugin. - https://docs.hotjar.com/v1.0/docs/disabling-placeholder-polyfill - settings: [] - name: hjid display_name: Site ID type: STRING @@ -8730,6 +8721,16 @@ items: This is your site ID for HotJar. It should be a whole number, such as `123456`. settings: [] + - name: hjPlaceholderPolyfill + display_name: IE9 Placeholder Polyfill + type: BOOLEAN + deprecated: false + required: false + description: >- + HotJar loads a polyfill for placeholder tags on input fields for IE9. + Disable this if you already use a placeholder plugin. + https://docs.hotjar.com/v1.0/docs/disabling-placeholder-polyfill + settings: [] connection_modes: device: web: true @@ -8769,6 +8770,18 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: portalId + display_name: Hub ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: ^\d+$ + description: >- + You can find your Hub ID on the **Settings** page of your [HubSpot + account](http://help.hubspot.com/articles/KCS_Article/Account/Where-can-I-find-my-HUB-ID). + It should be a series of numbers, like `997086`. + settings: [] - name: apiKey display_name: API Key type: STRING @@ -8801,18 +8814,6 @@ items: [analytics.ready](https://segment.com/docs/sources/website/analytics.js/#ready) callback. settings: [] - - name: portalId - display_name: Hub ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: ^\d+$ - description: >- - You can find your Hub ID on the **Settings** page of your [HubSpot - account](http://help.hubspot.com/articles/KCS_Article/Account/Where-can-I-find-my-HUB-ID). - It should be a series of numbers, like `997086`. - settings: [] connection_modes: device: web: true @@ -8961,6 +8962,30 @@ 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 @@ -9010,30 +9035,6 @@ 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: [] connection_modes: device: web: false @@ -9268,26 +9269,15 @@ items: - Analytics - Attribution - Customer Success - - Raw Data - components: [] - platforms: - browser: true - server: true - mobile: true - 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: [] + - Raw Data + components: [] + platforms: + browser: true + server: true + mobile: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: - name: bucketContainerUrl display_name: BUCKET CONTAINER URL type: STRING @@ -9308,6 +9298,17 @@ 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 @@ -9350,20 +9351,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: appId - display_name: App ID (required for analytics.js and mobile) - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^([a-zA-Z0-9]{7,8}|[a-zA-Z0-9]{40})$' - description: >- - Note: this is **required** to send data to Intercom from your browser or - mobile app. You can find your App ID after activating your account under - the **Gear Menu > App Settings > API Keys** at - [Intercom.io](https://intercom.io). It should look something like this: - `9iefb489.` - settings: [] - name: collectContext display_name: Include Context with Identify Calls type: BOOLEAN @@ -9438,6 +9425,20 @@ items: Note: this is **deprecated** . Intercom requires events hitting their server-side api authenticated via OAuth. settings: [] + - name: appId + display_name: App ID (required for analytics.js and mobile) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^([a-zA-Z0-9]{7,8}|[a-zA-Z0-9]{40})$' + description: >- + Note: this is **required** to send data to Intercom from your browser or + mobile app. You can find your App ID after activating your account under + the **Gear Menu > App Settings > API Keys** at + [Intercom.io](https://intercom.io). It should look something like this: + `9iefb489.` + settings: [] connection_modes: device: web: true @@ -9541,6 +9542,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: trackAllPages + display_name: Track All Pages + type: BOOLEAN + deprecated: false + required: false + description: Send an event for every page or screen event. + settings: [] + - name: trackCategorizedPages + display_name: Track Categorized Pages + type: BOOLEAN + deprecated: false + required: false + description: Send an event for every page or screen with a category. + settings: [] + - name: trackNamedPages + display_name: Track Named Pages + type: BOOLEAN + deprecated: false + required: false + description: Send an event for every page or screen with a name. + settings: [] - name: apiKey display_name: API Key type: STRING @@ -9568,27 +9590,6 @@ items: Pages will be sent as "Loaded a Page". Screens will be sent as "Loaded a Screen". settings: [] - - name: trackAllPages - display_name: Track All Pages - type: BOOLEAN - deprecated: false - required: false - description: Send an event for every page or screen event. - settings: [] - - name: trackCategorizedPages - display_name: Track Categorized Pages - type: BOOLEAN - deprecated: false - required: false - description: Send an event for every page or screen with a category. - settings: [] - - name: trackNamedPages - display_name: Track Named Pages - type: BOOLEAN - deprecated: false - required: false - description: Send an event for every page or screen with a name. - settings: [] connection_modes: device: web: false @@ -9770,23 +9771,35 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: referrerAddon - display_name: Referrer Parsing Addon + - name: initialPageview + display_name: Track an Initial Pageview 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. + 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: trackAllPages - display_name: Track All Pages to Keen + - name: ipAddon + display_name: Geo IP Addon 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. + Enable this to use Keen's data enrichment feature to add geographic + information based on IP. + settings: [] + - name: urlAddon + display_name: URL Parsing Addon + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this to use the Keen's data enrichment feature for parsing URLs + into its components for easier filtering. Note that `userAgent` is only + collected on Android, not on iOS. settings: [] - name: writeKey display_name: Write Key @@ -9799,26 +9812,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: ipAddon - display_name: Geo IP Addon - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this to use Keen's data enrichment feature to add geographic - information based on IP. - settings: [] - name: projectId display_name: Project ID type: STRING @@ -9842,6 +9835,24 @@ items: 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 @@ -9871,16 +9882,6 @@ items: 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 - deprecated: false - required: false - description: >- - Enable this to use the Keen's data enrichment feature for parsing URLs - into its components for easier filtering. Note that `userAgent` is only - collected on Android, not on iOS. - settings: [] connection_modes: device: web: true @@ -9974,6 +9975,46 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: privateKey + display_name: Enter your Private Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Note: this is **required** to use the List API. You can find this by going + 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: [] - name: apiKey display_name: API Key type: STRING @@ -10019,46 +10060,6 @@ items: Insert the ID of the default list that you'd like to subscribe users to when you call `.identify()`. settings: [] - - name: privateKey - display_name: Enter your Private Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Note: this is **required** to use the List API. You can find this by going - 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 @@ -10235,6 +10236,28 @@ 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 @@ -10276,28 +10299,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: [] connection_modes: device: web: false @@ -10482,6 +10483,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: group + display_name: Group + type: STRING + deprecated: false + required: false + string_validators: + regexp: ^\d+$ + description: >- + You can divide LiveChat agents into different groups such as "Billing" or + "Support" + settings: [] - name: license display_name: License type: STRING @@ -10503,17 +10515,6 @@ items: Automatically send Live Chat message events, conversation starts and ends to other tools you have enabled. settings: [] - - name: group - display_name: Group - type: STRING - deprecated: false - required: false - string_validators: - regexp: ^\d+$ - description: >- - You can divide LiveChat agents into different groups such as "Billing" or - "Support" - settings: [] connection_modes: device: web: true @@ -10554,18 +10555,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: appKey - display_name: App Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: >- - ^[a-z0-9]{23}-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$ - description: >- - You can find your App Key in your Localytics [Settings - page](http://www.localytics.com/). - settings: [] - name: dimensions display_name: Custom Dimensions type: MAP @@ -10629,6 +10618,18 @@ items: 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 + deprecated: false + required: true + string_validators: + regexp: >- + ^[a-z0-9]{23}-[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$ + description: >- + You can find your App Key in your Localytics [Settings + page](http://www.localytics.com/). + settings: [] connection_modes: device: web: true @@ -10714,6 +10715,18 @@ 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 @@ -10752,18 +10765,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: [] connection_modes: device: web: true @@ -10841,18 +10842,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: listId - display_name: Audience ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-z0-9]+$' - description: >- - You can find your Audience ID in your Mailchimp Settings pane under the - Audiences tab. Go to Manage Audiences > Settings and click on Audience - Name & Defaults. The Audience ID will be on the right side. - settings: [] - name: apiKey display_name: API Key type: STRING @@ -10885,6 +10874,18 @@ items: An optional flag to control whether a double opt-in confirmation message is sent when subscribing new users. settings: [] + - name: listId + display_name: Audience ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-z0-9]+$' + description: >- + You can find your Audience ID in your Mailchimp Settings pane under the + Audiences tab. Go to Manage Audiences > Settings and click on Audience + Name & Defaults. The Audience ID will be on the right side. + settings: [] connection_modes: device: web: false @@ -11020,41 +11021,41 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: clientId - display_name: Client ID + - name: endpoint + display_name: Endpoint type: STRING deprecated: false required: true string_validators: regexp: '' - description: Your Marketo REST API Client ID. + description: Your Marketo REST API Endpoint. settings: [] - - name: clientSecret - display_name: Client Secret + - name: folder + display_name: Folder type: STRING deprecated: false required: true string_validators: regexp: '' - description: Your Marketo REST API Client Secret. + description: Name of the folder in which to create static lists. settings: [] - - name: endpoint - display_name: Endpoint + - name: clientId + display_name: Client ID type: STRING deprecated: false required: true string_validators: regexp: '' - description: Your Marketo REST API Endpoint. + description: Your Marketo REST API Client ID. settings: [] - - name: folder - display_name: Folder + - name: clientSecret + display_name: Client Secret type: STRING deprecated: false required: true string_validators: regexp: '' - description: Name of the folder in which to create static lists. + description: Your Marketo REST API Client Secret. settings: [] connection_modes: device: @@ -11092,6 +11093,15 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: + - name: clientId + display_name: Client ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Marketo REST API Client ID. + settings: [] - name: clientSecret display_name: Client Secret type: STRING @@ -11137,6 +11147,13 @@ items: required: false description: Map your Segment properties to the Marketo Activity Fields settings: + - name: primaryKey + display_name: Set as Primary Key + type: BOOLEAN + deprecated: false + required: false + description: Mark this property as the Primary field in Marketo. + settings: [] - name: segmentProperty display_name: Segment Property Name type: STRING @@ -11172,13 +11189,6 @@ items: - date description: Enter the Marketo Field type. settings: [] - - name: primaryKey - display_name: Set as Primary Key - type: BOOLEAN - deprecated: false - required: false - description: Mark this property as the Primary field in Marketo. - settings: [] - name: privateKey display_name: API Private Key type: STRING @@ -11268,15 +11278,6 @@ items: 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 - deprecated: false - required: true - string_validators: - regexp: '' - description: Your Marketo REST API Client ID. - settings: [] connection_modes: device: web: true @@ -11343,19 +11344,6 @@ items: required: false description: Configure a conversion pixel settings: - - name: event - display_name: Event Name - type: STRING - deprecated: false - required: true - 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. - settings: [] - name: mtId display_name: mt_id type: STRING @@ -11410,6 +11398,19 @@ items: property in the corresponding query parameter of the MediaMath Pixel. Email [friends@segment.io](mailto:friends@segment.io) if you need help! settings: [] + - name: event + display_name: Event Name + type: STRING + deprecated: false + required: true + 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. + settings: [] connection_modes: device: web: true @@ -11496,57 +11497,46 @@ 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: sourceName - display_name: Source Name + - name: token + display_name: Token type: STRING deprecated: false - required: false + required: true string_validators: - regexp: '' + regexp: '^[a-f0-9]{32}$' description: >- - This value, if it's not blank, will be sent as `segment_source_name` to - Mixpanel for every `event`/`page`/`screen` call. + You can find your token under **Account** in the upper-right of the + [Mixpanel interface](https://mixpanel.com). settings: [] - - name: superProperties - display_name: Properties to send as Super Properties - type: LIST + - name: trackAllPages + display_name: Track All Pages to Mixpanel + type: BOOLEAN 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. + This will track **Loaded a Page** events to Mixpanel for all [`page` + method](https://segment.io/libraries/analytics.js#page) calls. We keep + this disabled by default. settings: [] - - name: token - display_name: Token + - name: apiKey + display_name: API Secret type: STRING deprecated: false - required: true + required: false string_validators: regexp: '^[a-f0-9]{32}$' description: >- - You can find your token under **Account** in the upper-right of the - [Mixpanel interface](https://mixpanel.com). + 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 + - name: crossSubdomainCookie + display_name: Cross Subdomain Cookie type: BOOLEAN deprecated: false required: false description: >- - This will track **Loaded a Page** events to Mixpanel for all [`page` - method](https://segment.io/libraries/analytics.js#page) calls and **Loaded - a Screen** events for all [`screen` - method](https://segment.io/libraries/ios#screen) calls. We enable this by - default as it's how Mixpanel suggests sending these calls. + This will allow the Mixpanel cookie to persist between different pages of + your application. settings: [] - name: groupIdentifierTraits display_name: Group Identifier Traits @@ -11578,48 +11568,48 @@ items: Mixpanel people, enable people, and then list the events you want to see in People here. settings: [] - - name: trackAllPages - display_name: Track All Pages to Mixpanel + - name: trackCategorizedPages + display_name: Track Categorized Pages to Mixpanel type: BOOLEAN deprecated: false required: false description: >- - This will track **Loaded a Page** events to Mixpanel for all [`page` - method](https://segment.io/libraries/analytics.js#page) calls. We keep - this disabled by default. + 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 - type: BOOLEAN + - name: sourceName + display_name: Source Name + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - This will track events to Mixpanel for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `name` associated with them. For example `page('Signup')` would translate - to **Viewed Signup Page**. + This value, if it's not blank, will be sent as `segment_source_name` to + Mixpanel for every `event`/`page`/`screen` call. settings: [] - - name: peopleProperties - display_name: Traits to set as People Properties + - name: superProperties + display_name: Properties to send as Super 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. + 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: crossSubdomainCookie - display_name: Cross Subdomain Cookie + - name: consolidatedPageCalls + display_name: Track All Pages to Mixpanel with a Consolidated Event Name type: BOOLEAN deprecated: false required: false description: >- - This will allow the Mixpanel cookie to persist between different pages of - your application. + This will track **Loaded a Page** events to Mixpanel for all [`page` + method](https://segment.io/libraries/analytics.js#page) calls and **Loaded + a Screen** events for all [`screen` + method](https://segment.io/libraries/ios#screen) calls. We enable this by + default as it's how Mixpanel suggests sending these calls. settings: [] - name: eventIncrements display_name: Events to increment in People @@ -11634,6 +11624,17 @@ items: 2. List the events you want to see in People here. settings: [] + - name: trackNamedPages + display_name: Track Named 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 + `name` associated with them. For example `page('Signup')` would translate + to **Viewed Signup Page**. + settings: [] - name: groupTraitsToSetOnce display_name: Group Traits to Set Once type: LIST @@ -11641,16 +11642,28 @@ items: required: false description: Group traits to be set only once using Mixpanel's `$set_once` operator. settings: [] - - name: apiKey - display_name: API Secret - type: STRING + - name: people + display_name: Use Mixpanel People + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '^[a-f0-9]{32}$' description: >- - You can find your API Secret under **Settings > Project Settings** in the - upper right of the [Mixpanel interface](https://mixpanel.com). + This will send all of your + [identify](https://segment.io/docs/methods/identify) calls to Mixpanel's + People feature. + 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: persistence display_name: Persistence Type @@ -11665,15 +11678,14 @@ items: This will allow the Mixpanel cookie to persist between different pages of your application. settings: [] - - name: people - display_name: Use Mixpanel People + - name: secureCookie + display_name: Secure Cookie type: BOOLEAN deprecated: false required: false description: >- - This will send all of your - [identify](https://segment.io/docs/methods/identify) calls to Mixpanel's - People feature. + 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 @@ -11685,17 +11697,6 @@ items: identify calls as super properties and people properties if Mixpanel People is checked as well. 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 @@ -12178,17 +12179,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: appId - display_name: App ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your App ID in your Nanigans pixel; it's the xxx part of the - app_id=xxx parameter. - settings: [] - name: events display_name: Conversion events type: MIXED @@ -12265,6 +12255,17 @@ items: 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 + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + You can find your App ID in your Nanigans pixel; it's the xxx part of the + app_id=xxx parameter. + settings: [] connection_modes: device: web: true @@ -12300,18 +12301,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: authKey - display_name: Auth Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - To retrieve your Auth Key first navigate to Sources > List Sources. Select - your source, and then click the 'Select View' dropdown, and select 'View - Settings'. - settings: [] - name: endpointRegion display_name: Endpoint Region type: SELECT @@ -12338,6 +12327,18 @@ items: your source, and then click the 'Select View' dropdown, and select 'View Settings'. settings: [] + - name: authKey + display_name: Auth Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + To retrieve your Auth Key first navigate to Sources > List Sources. Select + your source, and then click the 'Select View' dropdown, and select 'View + Settings'. + settings: [] connection_modes: device: web: false @@ -12431,6 +12432,24 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: events + display_name: Map Track Events to Custom Tables + type: MAP + deprecated: false + required: false + description: >- + 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 @@ -12471,24 +12490,6 @@ items: 'Segment'. You can define another custom eventType name to be used instead of that here. settings: [] - - name: events - display_name: Map Track Events to Custom Tables - type: MAP - deprecated: false - required: false - description: >- - 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: [] connection_modes: device: web: false @@ -12525,47 +12526,52 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: subbrandPropertyName - display_name: Subbrand Property Name + - name: appId + display_name: AppID 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`. + description: Enter your Nielsen DCR App ID. settings: [] - - name: appId - display_name: AppID + - name: contentAssetIdPropertyName + display_name: Custom Content Asset Id Property Name type: STRING deprecated: false required: false string_validators: regexp: '' - description: Enter your Nielsen DCR App ID. + description: >- + Segment will map our `asset_id` property to Nielsen's `assetId` field. If + you would like to set up a custom property mapping for content asset ids + please indicate the name of the property here. settings: [] - - name: clientIdPropertyName - display_name: Client Id Property Name + - name: contentLengthPropertyName + display_name: Content Length 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 `clientId`. + Segment will map our `total_length` property to Nielsen's `length` field + by default. If you would like to set up a custom property mapping please + indicate the name of the property here. settings: [] - - name: contentAssetIdPropertyName - display_name: Custom Content Asset Id Property Name + - 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 deprecated: false required: false @@ -12573,20 +12579,23 @@ items: regexp: '' description: >- Segment will map our `asset_id` property to Nielsen's `assetId` field. If - you would like to set up a custom property mapping for content asset ids - please indicate the name of the property here. + you would like to set up a custom property mapping for ad asset ids please + indicate the name of the property here. settings: [] - - name: contentLengthPropertyName - display_name: Content Length Property Name + - name: clientIdPropertyName + display_name: Client Id Property Name type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Segment will map our `total_length` property to Nielsen's `length` field - by default. If you would like to set up a custom property mapping please - indicate the name of the property here. + 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 `clientId`. settings: [] - name: instanceName display_name: Instance Name @@ -12599,17 +12608,6 @@ items: 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 @@ -12619,17 +12617,20 @@ items: By default we will use production mode. Uncheck this setting if you are developing or testing this integration. settings: [] - - name: adAssetIdPropertyName - display_name: Custom Ad Asset Id Property Name + - name: subbrandPropertyName + display_name: Subbrand Property Name type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Segment will map our `asset_id` property to Nielsen's `assetId` field. If - you would like to set up a custom property mapping for ad asset ids please - indicate the name of the property here. + 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: @@ -12717,26 +12718,26 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: clientApiKey - display_name: Javascript API Key + - name: apiKey + display_name: Server-side API Key type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - Your Javascript API Key can be found in your Nudgespot dashboard under + Your Server-side API Key can be found in your Nudgespot dashboard under Settings settings: [] - - name: apiKey - display_name: Server-side API Key + - name: clientApiKey + display_name: Javascript API Key type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - Your Server-side API Key can be found in your Nudgespot dashboard under + Your Javascript API Key can be found in your Nudgespot dashboard under Settings settings: [] connection_modes: @@ -12775,6 +12776,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: groupId + display_name: Group ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you want to use Olark across multiple different websites under the same + account, create an Olark Group and add the ID here. + settings: [] - name: identify display_name: Show the user's name or email chat console type: BOOLEAN @@ -12826,17 +12838,6 @@ items: required: false description: Log custom events from analytics.track() to the Olark chat console settings: [] - - name: groupId - display_name: Group ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - If you want to use Olark across multiple different websites under the same - account, create an Olark Group and add the ID here. - settings: [] connection_modes: device: web: true @@ -12917,12 +12918,29 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: - - name: fallbackToAnonymousId - display_name: Fall Back To Anonymous Id - type: BOOLEAN + - name: accountId + display_name: Account ID + type: STRING deprecated: false required: false - description: Optionally fall back to `anonymousId` when `userId` is not present. + 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: 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: listen display_name: >- @@ -12956,43 +12974,14 @@ items: activateExperiment: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: trackKnownUsers - display_name: Only Track Known Users + - name: nonInteraction + display_name: >- + Specifies the Experiment Viewed as a non-interaction event for Google + Analytics type: BOOLEAN deprecated: false required: false - description: >- - Optimizely does not alias known and unknown users. By default, Segment - will only send the `anonymousId` to Optimizely. Enable this to only send - the `userId` to Optimizely. *Important*: This setting only applies if you - are bundling this integration for mobile sources. + description: Send `Experiment Viewed` as a non-interaction event settings: [] - name: useOptimizely3 display_name: Use Optimizely 3 @@ -13018,35 +13007,47 @@ items: 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: useUserId - display_name: Use User ID - type: BOOLEAN + - name: cacheExp + display_name: Cache Exp + type: NUMBER deprecated: false required: false + number_validators: + min: 300 + max: 0 description: >- - Enable this if you want the server side integration to use User ID instead - of anonymous ID in your identify calls + 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 + - 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: trackKnownUsers + display_name: Only Track Known Users + 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` + Optimizely does not alias known and unknown users. By default, Segment + will only send the `anonymousId` to Optimizely. Enable this to only send + the `userId` to Optimizely. *Important*: This setting only applies if you + are bundling this integration for mobile sources. settings: [] - - name: nonInteraction - display_name: >- - Specifies the Experiment Viewed as a non-interaction event for Google - Analytics + - name: useUserId + display_name: Use User ID type: BOOLEAN deprecated: false required: false - description: Send `Experiment Viewed` as a non-interaction event + description: >- + 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: @@ -13090,6 +13091,27 @@ 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: listen display_name: Send experiment data to other tools (as a track call) type: BOOLEAN @@ -13128,27 +13150,6 @@ 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 @@ -13186,25 +13187,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiVersion - display_name: API Version - type: SELECT - deprecated: false - required: false - select_validators: - select_options: - - '3' - - '4' - description: >- - Please choose which version of the Pardot API you are using. If you are - unsure, please reference this - [guide](http://developer.pardot.com/kb/api-version-4/) to verify. If your - account **allows** multiple prospects with the same email address, you are - using version 4. Otherwise, you are using version 3. **Important:** If you - are selecting version 4, please read our - [documentation](https://segment.com/docs/integrations/pardot) thoroughly - before proceeding. - settings: [] - name: email display_name: Pardot Account Email type: STRING @@ -13294,6 +13276,25 @@ items: 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 + deprecated: false + required: false + select_validators: + select_options: + - '3' + - '4' + description: >- + Please choose which version of the Pardot API you are using. If you are + unsure, please reference this + [guide](http://developer.pardot.com/kb/api-version-4/) to verify. If your + account **allows** multiple prospects with the same email address, you are + using version 4. Otherwise, you are using version 3. **Important:** If you + are selecting version 4, please read our + [documentation](https://segment.com/docs/integrations/pardot) thoroughly + before proceeding. + settings: [] connection_modes: device: web: true @@ -13417,7 +13418,7 @@ items: browser: true server: true mobile: false - browserUnbundlingSupported: false + browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - name: apiKey @@ -13439,7 +13440,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -13717,17 +13718,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: useEnhancedMatchLoad - display_name: Enable Enhanced Match to on Page Load - type: BOOLEAN - deprecated: false - required: false - description: >- - If this setting is enabled, the Pinterest tag will be loaded with the - existing traits of the logged user (if available). See [the official - documentation](https://developers.pinterest.com/docs/ad-tools/enhanced-match/?) - for more information. - settings: [] - name: pinterestCustomProperties display_name: Custom Properties type: LIST @@ -13774,6 +13764,17 @@ items: Enter your Pinterest Tag ID. It should be a series of numbers, like `123456789`. settings: [] + - name: useEnhancedMatchLoad + display_name: Enable Enhanced Match to on Page Load + type: BOOLEAN + deprecated: false + required: false + description: >- + If this setting is enabled, the Pinterest tag will be loaded with the + existing traits of the logged user (if available). See [the official + documentation](https://developers.pinterest.com/docs/ad-tools/enhanced-match/?) + for more information. + settings: [] connection_modes: device: web: true @@ -13811,6 +13812,26 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your Site ID in your piwik snippet. + settings: [] + - name: url + display_name: Server URL + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + 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 @@ -13833,26 +13854,6 @@ items: `event` to a goal ID, enter event names on the left and goal ID's on the right. settings: [] - - name: siteId - display_name: Site ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: You can find your Site ID in your piwik snippet. - settings: [] - - name: url - display_name: Server URL - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your Server URL in your snippet, we will append `/piwik.php` - to the URL automatically. - settings: [] connection_modes: device: web: true @@ -14249,6 +14250,24 @@ 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 + deprecated: false + required: false + description: >- + When sending data for eCommerce events, Segment will also include labels + corresponding to the products included in the event. + settings: [] - name: apiKey display_name: API Key type: STRING @@ -14272,24 +14291,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: [] - - name: advertiseProducts - display_name: Advertise Products - type: BOOLEAN - deprecated: false - required: false - description: >- - When sending data for eCommerce events, Segment will also include labels - corresponding to the products included in the event. - settings: [] connection_modes: device: web: true @@ -14729,6 +14730,18 @@ items: Use these fields to map your Segment event names to Responsys Supplemental Tables. We'll only send events and properties that you specify. settings: + - name: mapEmail + display_name: Map Email + type: BOOLEAN + deprecated: false + required: false + description: >- + Check this box if you want to automatically create and or map Segment's + `email` property (in `context.traits.email` or `properties.email`) as a + column in Responsys. Highly **recommended** if you are calling + `.identify()` with an `email` trait for anonymous users without + `userId`s. + settings: [] - name: event display_name: Segment Event Name type: STRING @@ -14830,29 +14843,6 @@ items: want to connect records in your Profile Lists/Extension Tables with records in this Supplemental Table. settings: [] - - name: mapEmail - display_name: Map Email - type: BOOLEAN - deprecated: false - required: false - description: >- - Check this box if you want to automatically create and or map Segment's - `email` property (in `context.traits.email` or `properties.email`) as a - column in Responsys. Highly **recommended** if you are calling - `.identify()` with an `email` trait for anonymous users without - `userId`s. - 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: password display_name: Password type: PASSWORD @@ -14878,6 +14868,26 @@ items: your login screen. This is required to any requests to your account. The default is `interact2`. settings: [] + - name: username + display_name: Username + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Please enter your account's username. + 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 @@ -14933,15 +14943,6 @@ items: regexp: '' description: Please enter the name of your default Profile Extension Table. settings: [] - - name: username - display_name: Username - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Please enter your account's username. - settings: [] connection_modes: device: web: false @@ -15026,24 +15027,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true 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 @@ -15074,22 +15057,6 @@ items: regexp: '' description: Your Rollbar access token settings: [] - - name: captureUncaught - display_name: Capture uncaught exceptions - type: BOOLEAN - deprecated: false - required: false - description: Record uncaught exceptions from `window.onerror`. - settings: [] - - name: captureUnhandledRejections - display_name: Capture Unhandled Rejections - type: BOOLEAN - deprecated: false - required: false - description: >- - Catch and report unhandled Promise rejections, such as Promise failures - that do not have a corresponding `.then(null, function(e) {})` handler. - settings: [] - name: codeVersion display_name: Code Version type: STRING @@ -15101,6 +15068,24 @@ 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: ignoredMessages display_name: Ignored Messages type: LIST @@ -15111,6 +15096,22 @@ items: browser plugin that is throwing errors, you can add them here and Rollbar will ignore exceptions matching those messages. settings: [] + - name: captureUncaught + display_name: Capture uncaught exceptions + type: BOOLEAN + deprecated: false + required: false + description: Record uncaught exceptions from `window.onerror`. + settings: [] + - name: captureUnhandledRejections + display_name: Capture Unhandled Rejections + type: BOOLEAN + deprecated: false + required: false + description: >- + Catch and report unhandled Promise rejections, such as Promise failures + that do not have a corresponding `.then(null, function(e) {})` handler. + settings: [] connection_modes: device: web: true @@ -15253,6 +15254,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: sharedSecret + display_name: Shared Secret + type: PASSWORD + deprecated: false + required: true + string_validators: + regexp: '' + description: The Shared Secret found in your Sailthru dashboard. + settings: [] - name: apiKey display_name: API Key type: STRING @@ -15316,21 +15326,12 @@ items: select_validators: select_options: - none - - all - - basic - - blast - description: >- - Select whether to opt out users from email campaigns. The default status - is `none`. - settings: [] - - name: sharedSecret - display_name: Shared Secret - type: PASSWORD - deprecated: false - required: true - string_validators: - regexp: '' - description: The Shared Secret found in your Sailthru dashboard. + - all + - basic + - blast + description: >- + Select whether to opt out users from email campaigns. The default status + is `none`. settings: [] connection_modes: device: @@ -15427,6 +15428,43 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: actions + display_name: Actions + type: MIXED + deprecated: false + required: false + description: >- + Trigger actions in Salesforce when a specific Segment event is received. + + + **This setting is a Beta release.** This means, among other things, that + events mapped here may be less reliable and prone to breakage than + standard Segment track events. + + + 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: 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 + deprecated: false + required: false + description: >- + This will map address traits in your group calls as Billing Address for + your Account Objects. + settings: [] - name: shipping display_name: Send Address as Shipping Address type: BOOLEAN @@ -15468,24 +15506,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: billing - display_name: Send Address as Billing Address - type: BOOLEAN - deprecated: false - required: false - description: >- - This will map address traits in your group calls as Billing Address for - your Account Objects. - settings: [] - name: password display_name: Account Password type: PASSWORD @@ -15500,6 +15520,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 @@ -15524,34 +15553,6 @@ items: account just for Segment so that you don't need to use your actual password. settings: [] - - name: actions - display_name: Actions - type: MIXED - deprecated: false - required: false - description: >- - Trigger actions in Salesforce when a specific Segment event is received. - - - **This setting is a Beta release.** This means, among other things, that - events mapped here may be less reliable and prone to breakage than - standard Segment track events. - - - 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: 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: [] connection_modes: device: web: false @@ -15589,27 +15590,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true 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 - deprecated: false - required: false - description: >- - By default, `identify` events will create or update contacts in SFMC. If - you would like to disable this functionality, set this option to true. - settings: [] - name: events display_name: Conversion events type: MIXED @@ -15620,16 +15600,6 @@ items: Cloud Data Extensions. We'll only send SMC the conversion events you specify. settings: - - name: uuidPrimaryKey - display_name: UUID Primary Key - type: BOOLEAN - deprecated: false - required: false - description: >- - If this is checked then we will generate a UUID and pass it through to - SMC as the value for *Primary Key* for this event called 'Uuid'. *This - will override the above Primary Key field.* - settings: [] - name: event display_name: Event Name type: STRING @@ -15663,6 +15633,16 @@ items: The target Data Extension's *Primary Key*. If a value is not provided, defaults to "Contact Key". settings: [] + - name: uuidPrimaryKey + display_name: UUID Primary Key + type: BOOLEAN + deprecated: false + required: false + description: >- + If this is checked then we will generate a UUID and pass it through to + SMC as the value for *Primary Key* for this event called 'Uuid'. *This + will override the above Primary Key field.* + settings: [] - name: identifyExtensionExternalKey display_name: Identify Data Extension External Key type: STRING @@ -15717,6 +15697,27 @@ items: 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 + deprecated: false + required: false + description: >- + By default, `identify` events will create or update contacts in SFMC. If + you would like to disable this functionality, set this option to true. + settings: [] connection_modes: device: web: false @@ -15812,33 +15813,33 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key + - name: token + display_name: Token type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - To connect SatisMeter with Segment first create a project in your - Satismeter dashboard and then navigate to Settings / Install and click the - green button 'Enable with Segment'. You can also manually copy Settings / - Integrations / API keys / Write key and use it as the api key. The api key + This is a legacy setting, and now known as the apiKey. To connect + SatisMeter with Segment first create a project in your Satismeter + dashboard and then navigate to Settings / Install and click the green + button 'Enable with Segment'. You can also manually copy Settings / + Integrations / API keys / Write key and use it as the token. The tokeny should look like urC2RuBlt7utBCzu. settings: [] - - name: token - display_name: Token + - name: apiKey + display_name: API Key type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - This is a legacy setting, and now known as the apiKey. To connect - SatisMeter with Segment first create a project in your Satismeter - dashboard and then navigate to Settings / Install and click the green - button 'Enable with Segment'. You can also manually copy Settings / - Integrations / API keys / Write key and use it as the token. The tokeny + To connect SatisMeter with Segment first create a project in your + Satismeter dashboard and then navigate to Settings / Install and click the + green button 'Enable with Segment'. You can also manually copy Settings / + Integrations / API keys / Write key and use it as the api key. The api key should look like urC2RuBlt7utBCzu. settings: [] connection_modes: @@ -16024,41 +16025,35 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: customVersionProperty - display_name: Set Release by Property - type: STRING + - name: ignoreErrors + display_name: Ignore Errors + type: LIST 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. + A list of these messages to be filtered out before being sent to Sentry as + either regular expressions or strings. settings: [] - - name: logger - display_name: Logger - type: STRING + - name: includePaths + display_name: Include Paths + type: LIST deprecated: false required: false - string_validators: - regexp: '' - description: The name of the logger used by Sentry. + 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: serverName - display_name: Server Name + - name: release + display_name: Release type: STRING deprecated: false required: false string_validators: regexp: '' - description: >- - Typically this would be the server name, but that doesn’t exist on all - platforms. Instead you may use something like the device ID, as it - indicates the host which the client is running on. + description: Track the version of your application in Sentry. settings: [] - name: whitelistUrls display_name: Whitelist Urls @@ -16084,35 +16079,20 @@ items: Teams > Any Project > Settings > Client Keys (DSN). This should be the PUBLIC DSN since it does not contain a secret. 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 - deprecated: false - required: false - description: >- - 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 + - name: customVersionProperty + display_name: Set Release by Property + type: STRING 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. + 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: maxMessageLength display_name: Maximum Message Length @@ -16126,14 +16106,35 @@ items: By default, Raven does not truncate messages. If you need to truncate characters for whatever reason, you may set this to limit the length. settings: [] - - name: release - display_name: Release + - name: serverName + display_name: Server Name type: STRING deprecated: false required: false string_validators: regexp: '' - description: Track the version of your application in Sentry. + description: >- + Typically this would be the server name, but that doesn’t exist on all + platforms. Instead you may use something like the device ID, as it + indicates the host which the client is running on. + settings: [] + - name: ignoreUrls + display_name: Ignore Urls + type: LIST + deprecated: false + required: false + description: >- + 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: logger + display_name: Logger + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: The name of the logger used by Sentry. settings: [] connection_modes: device: @@ -16219,16 +16220,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: useTotalAsAmount - display_name: Use total as amount - type: BOOLEAN - deprecated: false - required: false - description: >- - By default, we set the `amount` as the subtotal without the discount, but - this might cause problems for sources like Shopify. If you need to provide - the amount in the total property directly, enable this setting. - settings: [] - name: createLeads display_name: Create Leads type: BOOLEAN @@ -16248,6 +16239,16 @@ items: regexp: '' description: The `merchantId` given to you by your ShareASale account manager. settings: [] + - name: useTotalAsAmount + display_name: Use total as amount + type: BOOLEAN + deprecated: false + required: false + description: >- + By default, we set the `amount` as the subtotal without the discount, but + this might cause problems for sources like Shopify. If you need to provide + the amount in the total property directly, enable this setting. + settings: [] connection_modes: device: web: true @@ -16437,12 +16438,12 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: channels - display_name: Event Channels + - name: templates + display_name: Event Templates type: MIXED deprecated: false required: false - description: Use these fields to map your Segment event names to Slack channels. + description: Use these fields to map your Segment event names to Slack event names. settings: - name: eventName display_name: Segment Event Name @@ -16454,23 +16455,21 @@ items: description: >- Enter the event name here. You can also enter a regular expression pattern and check the box below if you want to map multiple event names - to your channel. + to your template. settings: [] - - name: channel - display_name: Event Channels + - name: template + display_name: Event Template type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Specify the channel a specific event is sent to. By default, events are - sent to the channel specified when creating the incoming webhook in - Slack but here you can send events to a specific channel (#channel) or - DM a user (@user). For example, `Completed Order` as event name and - #orders as channel will send `Completed Order` events to the #orders - Slack channel. To disable sending an event to Slack completely, use the - filters in your Schema. + Use 'handlebarsjs' templating to format messages sent to Slack. The + default template is '{{properties.email}} did {{event}}.'. For another + example, consider an event Adopted Dog, with '{{properties.owner}} + adopted a {{properties.type}}' as the template. For every 'Adopted Dog' + event, this would send a message like 'Han adopted a Husky'. settings: [] - name: regex display_name: Regex Matching @@ -16481,28 +16480,33 @@ items: If you entered a regex pattern instead of a specific event name, please check this box. settings: [] - - name: identifyTemplate - display_name: Identify Template + - name: webhookUrl + display_name: Incoming Webhook URL type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Use "handlebarsjs" templating to format messages sent to Slack. The - default template is "Identified {{name}}. - - {{traits}}". You do not need to append ‘traits’, as this template is - specific to `.identify()` calls only and thus is assumed. Make sure - whatever trait you try to use in your template, you send as a trait in - your `.identify()` calls, otherwise we will reject the message. + Your Slack [incoming webhook + URL](https://my.slack.com/services/new/incoming-webhook/). settings: [] - - name: templates - display_name: Event Templates + - name: whiteListedTraits + display_name: Whitelisted Traits + type: LIST + deprecated: false + required: false + description: >- + List the traits you want to forward to Slack. If you do not list any + traits, we will not forward any `.identify()` calls! Whitelist the traits + you want catch and forward to Slack. + settings: [] + - name: channels + display_name: Event Channels type: MIXED deprecated: false required: false - description: Use these fields to map your Segment event names to Slack event names. + description: Use these fields to map your Segment event names to Slack channels. settings: - name: eventName display_name: Segment Event Name @@ -16514,21 +16518,23 @@ items: description: >- Enter the event name here. You can also enter a regular expression pattern and check the box below if you want to map multiple event names - to your template. + to your channel. settings: [] - - name: template - display_name: Event Template + - name: channel + display_name: Event Channels type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Use 'handlebarsjs' templating to format messages sent to Slack. The - default template is '{{properties.email}} did {{event}}.'. For another - example, consider an event Adopted Dog, with '{{properties.owner}} - adopted a {{properties.type}}' as the template. For every 'Adopted Dog' - event, this would send a message like 'Han adopted a Husky'. + Specify the channel a specific event is sent to. By default, events are + sent to the channel specified when creating the incoming webhook in + Slack but here you can send events to a specific channel (#channel) or + DM a user (@user). For example, `Completed Order` as event name and + #orders as channel will send `Completed Order` events to the #orders + Slack channel. To disable sending an event to Slack completely, use the + filters in your Schema. settings: [] - name: regex display_name: Regex Matching @@ -16539,26 +16545,21 @@ items: If you entered a regex pattern instead of a specific event name, please check this box. settings: [] - - name: webhookUrl - display_name: Incoming Webhook URL + - name: identifyTemplate + display_name: Identify Template type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Your Slack [incoming webhook - URL](https://my.slack.com/services/new/incoming-webhook/). - settings: [] - - name: whiteListedTraits - display_name: Whitelisted Traits - type: LIST - deprecated: false - required: false - description: >- - List the traits you want to forward to Slack. If you do not list any - traits, we will not forward any `.identify()` calls! Whitelist the traits - you want catch and forward to Slack. + Use "handlebarsjs" templating to format messages sent to Slack. The + default template is "Identified {{name}}. + + {{traits}}". You do not need to append ‘traits’, as this template is + specific to `.identify()` calls only and thus is assumed. Make sure + whatever trait you try to use in your template, you send as a trait in + your `.identify()` calls, otherwise we will reject the message. settings: [] connection_modes: device: @@ -17055,22 +17056,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: productAttributeMapping - display_name: Custom Item Attributes - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 5 - map_prefix: attribute_sub - select_options: [] - description: >- - If you have any product properties that you would like to map to - item-scoped custom attributes inside `site_event_items` for your ecommerce - events, please specify them here. - settings: [] - name: advertiserId display_name: Advertiser ID type: STRING @@ -17091,6 +17076,17 @@ items: If you have any event properties that you would like to map to TUNE custom event attributes on a per-event basis, you can specify them here. settings: + - name: event + display_name: Event Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + The event for which you'd like to specify property -> custom attribute + mappings. + settings: [] - name: mapping display_name: Custom Event Attributes type: MAP @@ -17106,17 +17102,6 @@ items: If you have any event properties that you would like to map to TUNE custom event attributes for the event above, please specify them here. settings: [] - - name: event - display_name: Event Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - The event for which you'd like to specify property -> custom attribute - mappings. - settings: [] - name: consumerKey display_name: Consumer Key type: STRING @@ -17207,6 +17192,22 @@ items: will not be included in the request. Please contact your TUNE account manager to get your private key. settings: [] + - name: productAttributeMapping + display_name: Custom Item Attributes + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 5 + map_prefix: attribute_sub + select_options: [] + description: >- + If you have any product properties that you would like to map to + item-scoped custom attributes inside `site_event_items` for your ecommerce + events, please specify them here. + settings: [] connection_modes: device: web: false @@ -17243,18 +17244,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: trackWhitelist - display_name: Event Whitelist - type: LIST - deprecated: false - required: false - description: >- - This is where you will define which specific events, when sent via - analytics.track(your_event_name, ...) will be sent to TVSquared. For - example, if you want analytics.track('Order Completed') and - analytics.track('Sale') events to be sent, then add Order Completed and - Sale to this list. - settings: [] - name: brandId display_name: Brand Id type: STRING @@ -17285,6 +17274,18 @@ items: Add any additional custom properties you'd like to check, separated by a line break. settings: [] + - name: trackWhitelist + display_name: Event Whitelist + type: LIST + deprecated: false + required: false + description: >- + This is where you will define which specific events, when sent via + analytics.track(your_event_name, ...) will be sent to TVSquared. For + example, if you want analytics.track('Order Completed') and + analytics.track('Sale') events to be sent, then add Order Completed and + Sale to this list. + settings: [] connection_modes: device: web: true @@ -17320,18 +17321,42 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: device - display_name: Device Sizing + - name: iframeWidth + display_name: IFrame Width type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - What device should it be sized for? If you're not sure see this [Help + Your IFrame Width, if you're not sure see this [Help + Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) + from Talkable. + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your Site ID, if you can't find it see this [Help Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) from Talkable. settings: [] + - name: customUrl + display_name: Custom Script URL + type: STRING + deprecated: false + required: false + string_validators: + regexp: ^// + description: >- + If Talkable supplies a custom URL from which to load your script, enter it + here and we'll use that instead of the default. Please include the `//` + prefix. + settings: [] - name: iframeBorder display_name: IFrame Border type: STRING @@ -17356,17 +17381,6 @@ items: Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) from Talkable. settings: [] - - name: insertIntoId - display_name: ID to Insert Talkable - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - The ID of the HTML element where you would like to insert the Talkable - IFrame. - settings: [] - name: responsive display_name: Use a Responsive IFrame type: BOOLEAN @@ -17395,41 +17409,28 @@ items: Each campaign runs at a specific url like /share or /invite. Map that url to the Talkable campaign_tags for that page. settings: [] - - name: iframeWidth - display_name: IFrame Width + - name: device + display_name: Device Sizing type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Your IFrame Width, if you're not sure see this [Help - Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) - from Talkable. - settings: [] - - name: siteId - display_name: Site ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Your Site ID, if you can't find it see this [Help + What device should it be sized for? If you're not sure see this [Help Page](https://talkable.helpjuice.com/questions/45313-Where-do-I-find-my-site-ID) from Talkable. settings: [] - - name: customUrl - display_name: Custom Script URL + - name: insertIntoId + display_name: ID to Insert Talkable type: STRING deprecated: false required: false string_validators: - regexp: ^// + regexp: '' description: >- - If Talkable supplies a custom URL from which to load your script, enter it - here and we'll use that instead of the default. Please include the `//` - prefix. + The ID of the HTML element where you would like to insert the Talkable + IFrame. settings: [] connection_modes: device: @@ -17651,6 +17652,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: trackNamedPages + display_name: Track Named Pages to Tapstream + type: BOOLEAN + deprecated: false + required: false + description: >- + This will track events to Tapstream for [`page` + method](https://segment.io/libraries/analytics.js#page) calls that have a + `name` associated with them. For example `page('Signup')` would translate + to **Viewed Signup Page**. + settings: [] - name: accountName display_name: Account Name type: STRING @@ -17691,17 +17703,6 @@ items: `category` associated with them. For example `page('Docs', 'Index')` would translate to **Viewed Docs Page**. settings: [] - - name: trackNamedPages - display_name: Track Named Pages to Tapstream - type: BOOLEAN - deprecated: false - required: false - description: >- - This will track events to Tapstream for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `name` associated with them. For example `page('Signup')` would translate - to **Viewed Signup Page**. - settings: [] connection_modes: device: web: true @@ -17739,16 +17740,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: disableHeartbeat - display_name: Disable the Totango Heartbeat - type: BOOLEAN - deprecated: false - required: false - description: >- - By default Totango's Javascript pings its servers once a minute to see if - the user has left the page. If you don't want that to happen, enable this - setting. - settings: [] - name: serviceId display_name: Service ID type: STRING @@ -17782,6 +17773,16 @@ items: `name` associated with them. For example `page('Signup')` would translate to **Viewed Signup Page**. settings: [] + - name: disableHeartbeat + display_name: Disable the Totango Heartbeat + type: BOOLEAN + deprecated: false + required: false + description: >- + By default Totango's Javascript pings its servers once a minute to see if + the user has left the page. If you don't want that to happen, enable this + setting. + settings: [] connection_modes: device: web: true @@ -17817,16 +17818,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: callbackEnabled - display_name: Callback Enabled - type: BOOLEAN - deprecated: false - required: false - description: >- - Whether TrackJS should watch for errors on host-function callbacks, such - as addEventListener, and setTimeout. Disabling this greatly decreases the - likelihood of recording a stacktrace for an error. - settings: [] - name: consoleEnabled display_name: Console Enabled type: BOOLEAN @@ -17843,16 +17834,16 @@ items: required: false description: Whether TrackJS should transmit errors on calls to console.error. settings: [] - - name: token - display_name: Token - type: STRING + - name: networkError + display_name: Network Error + type: BOOLEAN deprecated: false - required: true - string_validators: - regexp: '^[a-z0-9A-Z]{32}$' + required: false description: >- - You can find your token under Track JS [setup - page](https://my.trackjs.com/customer/setup#install-locally). + Whether TrackJS should transmit errors when an AJAX call completes with a + 'failing' status code, 400 or greater. If you wish to customize the list + of status codes you want to capture errors from, set this to true and + filter out status codes using the onError callback. settings: [] - name: visitorEnabled display_name: Visitor Enabled @@ -17863,36 +17854,15 @@ items: Whether TrackJS should watch visitor interaction events, such as clicks and field input. settings: [] - - name: windowEnabled - display_name: Window Enabled - type: BOOLEAN - deprecated: false - required: false - description: Whether TrackJS should watch window.onerror for global errors - settings: [] - - name: application - display_name: Application Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Optional. The name of the section of your application that this Segment - project encompasses. For more info [see - here](https://docs.trackjs.com/Examples/Multiple_Applications) - settings: [] - - name: callbackBindStack - display_name: Callback BindStack + - name: callbackEnabled + display_name: Callback Enabled type: BOOLEAN deprecated: false required: false description: >- - Whether TrackJS should record the stacktrace for how a callback came to be - bound, allowing the creation of an 'async stacktrace' in the TrackJS UI. - This gives you more context of how the application arrived at the function - that failed. Enabling this has a nontrivial performance penalty, test - before enabling in production + Whether TrackJS should watch for errors on host-function callbacks, such + as addEventListener, and setTimeout. Disabling this greatly decreases the + likelihood of recording a stacktrace for an error. settings: [] - name: consoleDisplay display_name: Console Display @@ -17922,16 +17892,47 @@ items: Whether TrackJS should wrap and watch AJAX calls. If disabled, network events will not appear in your Telemetry Timeline. settings: [] - - name: networkError - display_name: Network Error + - name: token + display_name: Token + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-z0-9A-Z]{32}$' + description: >- + You can find your token under Track JS [setup + page](https://my.trackjs.com/customer/setup#install-locally). + settings: [] + - name: windowEnabled + display_name: Window Enabled + type: BOOLEAN + deprecated: false + required: false + description: Whether TrackJS should watch window.onerror for global errors + settings: [] + - name: application + display_name: Application Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Optional. The name of the section of your application that this Segment + project encompasses. For more info [see + here](https://docs.trackjs.com/Examples/Multiple_Applications) + settings: [] + - name: callbackBindStack + display_name: Callback BindStack type: BOOLEAN deprecated: false required: false description: >- - Whether TrackJS should transmit errors when an AJAX call completes with a - 'failing' status code, 400 or greater. If you wish to customize the list - of status codes you want to capture errors from, set this to true and - filter out status codes using the onError callback. + Whether TrackJS should record the stacktrace for how a callback came to be + bound, allowing the creation of an 'async stacktrace' in the TrackJS UI. + This gives you more context of how the application arrived at the function + that failed. Enabling this has a nontrivial performance penalty, test + before enabling in production settings: [] connection_modes: device: @@ -18119,23 +18120,23 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Write Key + - name: databaseName + display_name: Database Name type: STRING deprecated: false required: true string_validators: regexp: '' - description: You can find your write key in your Treasure Data Account Settings + description: The database name you want to send data to in Treasure Data. settings: [] - - name: databaseName - display_name: Database Name + - name: apiKey + display_name: API Write Key type: STRING deprecated: false required: true string_validators: regexp: '' - description: The database name you want to send data to in Treasure Data. + description: You can find your write key in your Treasure Data Account Settings settings: [] connection_modes: device: @@ -18527,25 +18528,16 @@ items: - feedback description: Select Mode settings: [] - - name: forumId - display_name: Forum ID (Classic) - type: STRING - deprecated: false - required: false - string_validators: - regexp: ^\d+$ - description: >- - Your Forum ID appears in the JavaScript code snippet as `forum_id: - YOUR_FORUM_ID`. - settings: [] - - name: tabColor - display_name: Tab Color (Classic) + - name: triggerBackgroundColor + display_name: Trigger Background Color type: COLOR deprecated: false required: false string_validators: regexp: '' - description: 'The `tabColor` setting defaults to "#cc6d00".' + description: >- + This will change the background color of the trigger. It defaults to a + translucent gray. settings: [] - name: triggerPosition display_name: Trigger Position @@ -18555,61 +18547,40 @@ items: select_validators: select_options: - top-right - - top-left - - bottom-right - - bottom-left - description: The `triggerPosition` setting defaults to `bottom-right` - settings: [] - - name: apiKey - display_name: Javascript API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-zA-Z0-9]+$' - description: >- - Your API Key appears in the javascript snippet URL as - widget.uservoice.com/APIKEY.js. This setting is required. - settings: [] - - name: showWidget - display_name: Show the UserVoice Widget on Page Load - type: BOOLEAN - deprecated: false - required: false - description: Show the UserVoice Widget on Page Load - settings: [] - - name: smartvote - display_name: Enable SmartVote - type: BOOLEAN - deprecated: false - required: false - description: Enable SmartVote - settings: [] - - name: tabPosition - display_name: Tab Position (Classic) - type: SELECT - deprecated: false - required: false - select_validators: - select_options: - - top-right - - top-left - - middle-right - - middle-left + - top-left - bottom-right - bottom-left - description: The `tabPosition` setting defaults to "middle-right". + description: The `triggerPosition` setting defaults to `bottom-right` settings: [] - - name: trigger - display_name: Custom Trigger Selector - type: STRING + - name: tabColor + display_name: Tab Color (Classic) + type: COLOR deprecated: false required: false string_validators: regexp: '' + description: 'The `tabColor` setting defaults to "#cc6d00".' + settings: [] + - name: apiKey + display_name: Javascript API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-zA-Z0-9]+$' description: >- - If you want to have your own custom UserVoice trigger, add the CSS - selector for the trigger here. It might look like: `#uservoice-trigger`. + Your API Key appears in the javascript snippet URL as + widget.uservoice.com/APIKEY.js. This setting is required. + settings: [] + - name: classic + display_name: Use the Classic Widget + type: BOOLEAN + deprecated: false + required: false + description: >- + If you want to use the classic version of the UserVoice widget make sure + to enable this setting, and customize it using the any of the **classic + options** below. settings: [] - name: primaryColor display_name: Primary Widget Color (Classic) @@ -18620,6 +18591,24 @@ items: regexp: '' description: 'The primaryColor setting defaults to "#cc6d00".' settings: [] + - name: smartvote + display_name: Enable SmartVote + type: BOOLEAN + deprecated: false + required: false + description: Enable SmartVote + settings: [] + - name: forumId + display_name: Forum ID (Classic) + type: STRING + deprecated: false + required: false + string_validators: + regexp: ^\d+$ + description: >- + Your Forum ID appears in the JavaScript code snippet as `forum_id: + YOUR_FORUM_ID`. + settings: [] - name: screenshotEnabled display_name: Enable Screenshots type: BOOLEAN @@ -18645,6 +18634,21 @@ items: regexp: '' description: The `tabLabel` setting defaults to "Feedback & Support". settings: [] + - name: tabPosition + display_name: Tab Position (Classic) + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - top-right + - top-left + - middle-right + - middle-left + - bottom-right + - bottom-left + description: The `tabPosition` setting defaults to "middle-right". + settings: [] - name: ticketCustomFields display_name: Custom Ticket Fields type: MAP @@ -18654,17 +18658,6 @@ items: This will allow you to set field value pairs for ticket custom fields (set via your admin console). settings: [] - - name: triggerColor - display_name: Trigger Foreground Color - type: COLOR - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This will change the color of the text on the trigger, including the - question mark. - settings: [] - name: accentColor display_name: Accent Color type: COLOR @@ -18695,26 +18688,34 @@ items: - satisfaction description: The mode setting defaults to "full". settings: [] - - name: triggerBackgroundColor - display_name: Trigger Background Color - type: COLOR + - name: showWidget + display_name: Show the UserVoice Widget on Page Load + type: BOOLEAN + deprecated: false + required: false + description: Show the UserVoice Widget on Page Load + settings: [] + - name: trigger + display_name: Custom Trigger Selector + type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - This will change the background color of the trigger. It defaults to a - translucent gray. + If you want to have your own custom UserVoice trigger, add the CSS + selector for the trigger here. It might look like: `#uservoice-trigger`. settings: [] - - name: classic - display_name: Use the Classic Widget - type: BOOLEAN + - name: triggerColor + display_name: Trigger Foreground Color + type: COLOR deprecated: false required: false + string_validators: + regexp: '' description: >- - If you want to use the classic version of the UserVoice widget make sure - to enable this setting, and customize it using the any of the **classic - options** below. + This will change the color of the text on the trigger, including the + question mark. settings: [] connection_modes: device: @@ -18971,31 +18972,6 @@ items: required: false description: Sends the experiment id and variation name as traits on the identify call. settings: [] - - name: useAsyncSmartCode - display_name: Use Async Smart Code - type: BOOLEAN - deprecated: false - required: false - description: >- - If you would like to utilize VWO's asynchronous smart code, toggle on this - feature. This means you will not need to include VWO's native snippet on - your page as Segment will do this on your behalf. If this feature is - toggled off, you will need to include VWO's native smart code on your - webpage. - settings: [] - - name: useExistingJQuery - display_name: Use Existing JQuery - type: BOOLEAN - deprecated: false - required: false - description: >- - If your page already includes JQuery, you can set this to "true". - Otherwise, VWO will include JQuery onto the page for you. VWO needs JQuery - on the page to function correctly. - - - This setting is only effective if "Use Async Smart Code" is enabled. - settings: [] - name: settingsTolerance display_name: Settings Tolerance type: NUMBER @@ -19011,15 +18987,6 @@ items: This setting is only effective if "Use Async Smart Code" is set to "true". settings: [] - - name: trackOnlyAbExperiments - display_name: Track Only AB Experiments - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this setting if you only want to send to VWO events on A/B - Experiments. If disabled, we'll send events for all experiments. - settings: [] - name: accountId display_name: Account ID type: STRING @@ -19075,6 +19042,40 @@ items: Sends the experiment and variation information as properties on a track call. settings: [] + - name: trackOnlyAbExperiments + display_name: Track Only AB Experiments + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this setting if you only want to send to VWO events on A/B + Experiments. If disabled, we'll send events for all experiments. + settings: [] + - name: useAsyncSmartCode + display_name: Use Async Smart Code + type: BOOLEAN + deprecated: false + required: false + description: >- + If you would like to utilize VWO's asynchronous smart code, toggle on this + feature. This means you will not need to include VWO's native snippet on + your page as Segment will do this on your behalf. If this feature is + toggled off, you will need to include VWO's native smart code on your + webpage. + settings: [] + - name: useExistingJQuery + display_name: Use Existing JQuery + type: BOOLEAN + deprecated: false + required: false + description: >- + If your page already includes JQuery, you can set this to "true". + Otherwise, VWO will include JQuery onto the page for you. VWO needs JQuery + on the page to function correctly. + + + This setting is only effective if "Use Async Smart Code" is enabled. + settings: [] connection_modes: device: web: true @@ -19247,17 +19248,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - **Required** if you are sending data to WebEngage via their server-side - component. - settings: [] - name: licenseCode display_name: License Code type: STRING @@ -19270,6 +19260,17 @@ items: browser or via the bundled mobile SDKs. You can find your License Code in your WebEngage account. settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + **Required** if you are sending data to WebEngage via their server-side + component. + settings: [] connection_modes: device: web: true @@ -19306,6 +19307,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: globalHook + display_name: Webhook URL + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + The full URL (with http/https protocol) that we can send data to. eg. + https://webhooks.company.com/analytics. + settings: [] - name: hooks display_name: Webhooks (max 5) type: MIXED @@ -19347,17 +19359,6 @@ items: payload. See our webhook documentation for more detail. https://segment.com/docs/integrations/webhooks/#authentication settings: [] - - name: globalHook - display_name: Webhook URL - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - The full URL (with http/https protocol) that we can send data to. eg. - https://webhooks.company.com/analytics. - settings: [] connection_modes: device: web: false @@ -19535,27 +19536,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: Tracking Key + - name: siteId + display_name: Merchant ID type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - To find your Tracking Key, log into Wishpond, click on your account name - in the top right corner, and then on 'API Keys' in the dropdown menu. + To find your Merchant ID, log into Wishpond, click on your account name in + the top right corner, and then on 'API Keys' in the dropdown menu. settings: [] - - name: siteId - display_name: Merchant ID + - name: apiKey + display_name: Tracking Key type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - To find your Merchant ID, log into Wishpond, click on your account name in - the top right corner, and then on 'API Keys' in the dropdown menu. + To find your Tracking Key, log into Wishpond, click on your account name + in the top right corner, and then on 'API Keys' in the dropdown menu. settings: [] connection_modes: device: @@ -19594,22 +19595,51 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: cookieName + display_name: Cookie Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Name of the cookie to identify the visitor. + settings: [] - name: downloadTracking display_name: Download Tracking type: BOOLEAN deprecated: false required: false - description: Track downloads on the web page + description: Track downloads on the web page + settings: [] + - name: ping + display_name: Ping + type: BOOLEAN + deprecated: false + required: false + description: Ping Woopra servers to ensure that the visitor is still on the webpage + settings: [] + - name: cookieDomain + display_name: Cookie Domain + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Domain scope of the Woopra cookie settings: [] - - name: hideCampaign - display_name: Hide Campaign - type: BOOLEAN + - name: domain + display_name: Domain + type: STRING deprecated: false - required: false - description: Enable if you want woopra to hide campaign properties from the URL + required: true + string_validators: + regexp: ^(?!www\.) + description: >- + This is the name of your project in Woopra. settings: [] - - name: outgoingPause - display_name: Outgoing Pause + - name: downloadPause + display_name: Download Pause type: NUMBER deprecated: false required: false @@ -19618,14 +19648,14 @@ items: max: 0 description: >- Time in millisecond to pause the browser to ensure that the event is - tracked when visitor clicks on an outgoing url. + tracked when visitor clicks on a download url. settings: [] - - name: outgoingTracking - display_name: Outgoing Tracking + - name: hideCampaign + display_name: Hide Campaign type: BOOLEAN deprecated: false required: false - description: Track external links clicks on the web page + description: Enable if you want woopra to hide campaign properties from the URL settings: [] - name: pingInterval display_name: Ping Interval @@ -19637,8 +19667,8 @@ items: max: 0 description: Time interval in milliseconds between each ping settings: [] - - name: downloadPause - display_name: Download Pause + - name: outgoingPause + display_name: Outgoing Pause type: NUMBER deprecated: false required: false @@ -19647,41 +19677,16 @@ items: max: 0 description: >- Time in millisecond to pause the browser to ensure that the event is - tracked when visitor clicks on a download url. - settings: [] - - name: outgoingIgnoreSubdomains - display_name: Outgoing Ignore Subdomains - type: BOOLEAN - deprecated: false - required: false - description: Do not include links to subdomains as outgoing links - settings: [] - - name: ignoreQueryUrl - display_name: Ignore Query URL - type: BOOLEAN - deprecated: false - required: false - description: Ignores the querystring when you `page()` + tracked when visitor clicks on an outgoing url. settings: [] - - name: cookieName - display_name: Cookie Name + - name: cookiePath + display_name: Cookie Path type: STRING deprecated: false required: false string_validators: regexp: '' - description: Name of the cookie to identify the visitor. - settings: [] - - name: domain - display_name: Domain - type: STRING - deprecated: false - required: true - string_validators: - regexp: ^(?!www\.) - description: >- - This is the name of your project in Woopra. + description: Directory scope of the Woopra cookie settings: [] - name: idleTimeout display_name: Idle Timeout @@ -19693,30 +19698,26 @@ items: max: 0 description: Idle time after which the user is considered offline settings: [] - - name: cookieDomain - display_name: Cookie Domain - type: STRING + - name: ignoreQueryUrl + display_name: Ignore Query URL + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' - description: Domain scope of the Woopra cookie + description: Ignores the querystring when you `page()` settings: [] - - name: ping - display_name: Ping + - name: outgoingIgnoreSubdomains + display_name: Outgoing Ignore Subdomains type: BOOLEAN deprecated: false required: false - description: Ping Woopra servers to ensure that the visitor is still on the webpage + description: Do not include links to subdomains as outgoing links settings: [] - - name: cookiePath - display_name: Cookie Path - type: STRING + - name: outgoingTracking + display_name: Outgoing Tracking + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' - description: Directory scope of the Woopra cookie + description: Track external links clicks on the web page settings: [] connection_modes: device: @@ -19756,6 +19757,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: clientSecret + display_name: Client Secret + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + **Only required for the Wootric mobile integration**. You can find your + Client Secret in your Wootric Settings. + settings: [] - name: accountToken display_name: Account Token type: STRING @@ -19778,17 +19790,6 @@ items: **Only required for the Wootric mobile integration**. You can find your Client ID in your Wootric Settings. settings: [] - - name: clientSecret - display_name: Client Secret - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - **Only required for the Wootric mobile integration**. You can find your - Client Secret in your Wootric Settings. - settings: [] connection_modes: device: web: true @@ -19826,15 +19827,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: workspaceSlug - display_name: Workspace Slug - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: Your workspace's slug - settings: [] - name: name display_name: Name type: STRING @@ -19864,6 +19856,15 @@ items: regexp: '' description: 'Your SQL username, so that Xplenty can connect to the database.' settings: [] + - name: workspaceSlug + display_name: Workspace Slug + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Your workspace's slug + settings: [] connection_modes: device: web: false @@ -20217,15 +20218,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: zaps - display_name: Event Zaps - type: MAP - deprecated: false - required: false - description: >- - Enter the Zaps you want track events to go to. Enter an event name on the - left, and a Zap URL on the right. - settings: [] - name: defaultZap display_name: Zap type: STRING @@ -20244,6 +20236,15 @@ items: Enter the Zaps you want page/screen events to go to. Enter an page/screen name on the left, and a Zap URL on the right. settings: [] + - name: zaps + display_name: Event Zaps + type: MAP + deprecated: false + required: false + description: >- + Enter the Zaps you want track events to go to. Enter an event name on the + left, and a Zap URL on the right. + settings: [] connection_modes: device: web: false @@ -20279,6 +20280,18 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: subdomain + display_name: Subdomain + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Your Zendesk subdomain, not including `.zendesk.com`. **Please do not + directly edit this setting. To update your subdomain, please + re-authenticate using the oAuth process.** + settings: [] - name: verified display_name: Create Users as Verified type: BOOLEAN @@ -20316,18 +20329,6 @@ items: Zendesk's 3rd Party Interaction History Beta. Once you've been accepted to the beta, add the events you'd like to send to Zendesk here by event name. settings: [] - - name: subdomain - display_name: Subdomain - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Your Zendesk subdomain, not including `.zendesk.com`. **Please do not - directly edit this setting. To update your subdomain, please - re-authenticate using the oAuth process.** - settings: [] connection_modes: device: web: false @@ -20485,24 +20486,42 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: publisherSecret - display_name: Publisher Secret - type: STRING + - name: beaconParamMap + display_name: Beacon Param Map + type: MAP deprecated: false required: false - string_validators: + map_validators: regexp: '' + min: 0 + max: 0 + map_prefix: c + select_options: [] + description: Map Segment event properties to comScore Beacon parameters. + settings: [] + - name: c2 + display_name: c2 ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: ^\d+$ description: >- - You can find your `Publisher Secret` option when you enter your domain and - press **Get Tag** at [comScore - Direct](http://direct.comscore.com/clients/Default.aspx). + You can find your `c2` option when you enter your domain and press **Get + Tag** at [comScore + Direct](http://direct.comscore.com/clients/Default.aspx). The `c2` option + is on line 4 of the **Tag Code**. settings: [] - - name: useHTTPS - display_name: Use HTTPS - type: BOOLEAN + - name: comscorekw + display_name: Comscore Keyword + type: STRING deprecated: false required: false - description: 'If true, this will ensure all data is sent to comScore via HTTPS.' + string_validators: + regexp: '' + description: >- + (Web/A.js Only) Add your Comscore Keyword value. This will be added to the + query string as `comscorekw={value}`. settings: [] - name: appName display_name: App Name @@ -20547,42 +20566,24 @@ items: provide a user experience from the background, like Push Notifications, then you'll want to set this to false. settings: [] - - name: beaconParamMap - display_name: Beacon Param Map - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: c - select_options: [] - description: Map Segment event properties to comScore Beacon parameters. - settings: [] - - name: c2 - display_name: c2 ID + - name: publisherSecret + display_name: Publisher Secret type: STRING deprecated: false - required: true + required: false string_validators: - regexp: ^\d+$ + regexp: '' description: >- - You can find your `c2` option when you enter your domain and press **Get - Tag** at [comScore - Direct](http://direct.comscore.com/clients/Default.aspx). The `c2` option - is on line 4 of the **Tag Code**. + You can find your `Publisher Secret` option when you enter your domain and + press **Get Tag** at [comScore + Direct](http://direct.comscore.com/clients/Default.aspx). settings: [] - - name: comscorekw - display_name: Comscore Keyword - type: STRING + - name: useHTTPS + display_name: Use HTTPS + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' - description: >- - (Web/A.js Only) Add your Comscore Keyword value. This will be added to the - query string as `comscorekw={value}`. + description: 'If true, this will ensure all data is sent to comScore via HTTPS.' settings: [] connection_modes: device: