diff --git a/scripts/catalog.js b/scripts/catalog.js index 1072e578fd..b6b723542d 100644 --- a/scripts/catalog.js +++ b/scripts/catalog.js @@ -20,6 +20,7 @@ const slugify = (displayName) => { if (slug === '-net') slug = 'net' if (slug === 'roku-alpha') slug = 'roku' if (slug === 'shopify-by-littledata') slug = 'shopify-littledata' + if (slug === 'talon-one') slug = 'talonone' return slug } @@ -82,7 +83,7 @@ const getConnectionModes = (destination) => { if (destination.platforms.server) { connectionModes.cloud.server = true } - if (destination.platforms.browser && destination.browserUnbundlingSupported && destination.browserUnbundlingPublic) { + if (destination.platforms.browser && destination.browserUnbundlingPublic) { connectionModes.cloud.web = true } break diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index b8acfb64ba..803eb93189 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -52,7 +52,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -189,30 +189,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: _version - display_name: _version - type: NUMBER - deprecated: false - required: false - number_validators: - min: 0 - max: 0 - description: '' - settings: [] - - name: advId - display_name: Advertiser ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[A-Z0-9]{22}$' - description: >- - You can find your Advertiser ID in your AdRoll dashboard by clicking the - **green or red dot** in the lower-left corner. In the Javascript snippet, - the Advertiser ID appears as `adroll_avd_id = 'XXXXXXX'` on line 2. It - should be 22 characters long and look something like this: - `WYJD6WNIAJC2XG6PT7UK4B`. - settings: [] - name: events display_name: Events type: MAP @@ -237,6 +213,30 @@ items: be 22 characters long, and look something like this: `6UUA5LKILFESVE44XH6SVX`. settings: [] + - name: _version + display_name: _version + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: '' + settings: [] + - name: advId + display_name: Advertiser ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[A-Z0-9]{22}$' + description: >- + You can find your Advertiser ID in your AdRoll dashboard by clicking the + **green or red dot** in the lower-left corner. In the Javascript snippet, + the Advertiser ID appears as `adroll_avd_id = 'XXXXXXX'` on line 2. It + should be 22 characters long and look something like this: + `WYJD6WNIAJC2XG6PT7UK4B`. + settings: [] connection_modes: device: web: true @@ -494,6 +494,117 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true 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: sendBothTimestampVisitorId + display_name: Send Both Timestamp and VisitorID for Timestamp Optional Reporting Suites + type: BOOLEAN + deprecated: false + required: false + description: >- + If you have a *Timestamp Optional* Reporting Suite, you can opt to send + _both_ the timestamp and the visitorID in your XML when sending events + server side. However, note that this is *NOT* recommended by + [Adobe](https://marketing.adobe.com/resources/help/en_US/sc/implement/timestamps-overview.html) + as it may lead to out of order data. This setting will only work for + reporting suites that have optional timestamp setting enabled. + settings: [] + - name: ssl + display_name: SSL + type: BOOLEAN + deprecated: false + required: false + description: >- + Check this box if you would like your Adobe Heartbeat calls to be made + over HTTPS. + 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: useLegacyLinkName + display_name: Use Legacy LinkName + 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. + 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: removeFallbackVisitorId + display_name: 'No Fallbacks for Visitor ID: Server-Side Only ' + type: BOOLEAN + deprecated: false + required: false + description: >- + Note: This setting is for Server-Side only, and only applies when the Drop + Visitor ID setting is disabled and you send a marketingCloudId in the + Adobe Analytics integration object. + + ​​ + + ​​Segment’s default behavior is to set the Adobe Analytics visitorID based + on the destination specific setting for visitorId​, falling back to + userId​ then anonymousId​. This setting removes the fallbacks. + settings: [] + - name: contextValues + display_name: Context Data Variables + type: MAP + deprecated: false + required: false + description: >- + Map values you pass into the context object to [Context Data + Variables](https://marketing.adobe.com/resources/help/en_US/sc/implement/context_data_variables.html) + in Adobe Analytics. Then you can use processing rules to map you Context + Data Variables in Adobe to other variables with Adobe Analytics Processing + Rules. In the box on the left, put your Segment context key. The box on + the right is what Context Data Variable you'd like it to be mapper to in + Adobe. + + + If you have a nested object, separate the name with a `.` For example if + you wanted to map the page referrer, you would put: page.referrer. + + + **NOTE**: By default we send all your `properties` as Context Data + Variables so you do not need to map them again here. + settings: [] + - name: enableTrackPageName + display_name: Enable pageName for Track Events + type: BOOLEAN + deprecated: false + required: false + description: >- + If you do not want to attach `pageName` for your `.track()` calls, you can + disable this option. + settings: [] - name: lVars display_name: List Variables type: MAP @@ -528,14 +639,32 @@ items: required: false description: The name of the adobe event. settings: [] - - name: enableTrackPageName - display_name: Enable pageName for Track Events + - name: utf8Charset + display_name: Use UTF-8 Charset type: BOOLEAN deprecated: false required: false description: >- - If you do not want to attach `pageName` for your `.track()` calls, you can - disable this option. + 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: [] + - name: eVars + display_name: eVars + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 250 + map_prefix: eVar + select_options: [] + description: >- + Map your Adobe Analytics eVar names to the property names you’re using in + your Segment events. Enter a Segment property name on the left and an + Adobe Analytics eVar number on the right. You can view your Segment events + and properties in your Schema. settings: [] - name: eventsV2 display_name: Events V2 (Bundled Mobile Only) @@ -562,6 +691,67 @@ items: about your user attribution, you should enable this if you're using a hybrid timestamp reporting suite. settings: [] + - name: props + display_name: Props + type: MAP + 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. + settings: [] + - 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: 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: 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 + 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: reportSuiteId display_name: Report Suite ID(s) type: STRING @@ -574,200 +764,14 @@ items: Multiple report suite ids can be separated by commas: `suite1,suite2,suite3`. settings: [] - - name: contextValues - display_name: Context Data Variables - type: MAP + - name: useSecureServerUrl + display_name: Use Secure URL for Server-side + type: BOOLEAN deprecated: false required: false description: >- - Map values you pass into the context object to [Context Data - Variables](https://marketing.adobe.com/resources/help/en_US/sc/implement/context_data_variables.html) - in Adobe Analytics. Then you can use processing rules to map you Context - Data Variables in Adobe to other variables with Adobe Analytics Processing - Rules. In the box on the left, put your Segment context key. The box on - the right is what Context Data Variable you'd like it to be mapper to in - Adobe. - - - If you have a nested object, separate the name with a `.` For example if - you wanted to map the page referrer, you would put: page.referrer. - - - **NOTE**: By default we send all your `properties` as Context Data - Variables so you do not need to map them again here. - settings: [] - - name: events - display_name: Events - type: MIXED - deprecated: false - required: false - description: Map your Segment events to custom Adobe events. - settings: [] - - name: removeFallbackVisitorId - display_name: 'No Fallbacks for Visitor ID: Server-Side Only ' - type: BOOLEAN - deprecated: false - required: false - description: >- - Note: This setting is for Server-Side only, and only applies when the Drop - Visitor ID setting is disabled and you send a marketingCloudId in the - Adobe Analytics integration object. - - ​​ - - ​​Segment’s default behavior is to set the Adobe Analytics visitorID based - on the destination specific setting for visitorId​, falling back to - userId​ then anonymousId​. This setting removes the fallbacks. - settings: [] - - name: ssl - display_name: SSL - type: BOOLEAN - deprecated: false - required: false - description: >- - Check this box if you would like your Adobe Heartbeat calls to be made - over HTTPS. - 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: useLegacyLinkName - display_name: Use Legacy LinkName - 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. - 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 - 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 - select_options: [] - description: >- - Map your Adobe Analytics hVars to the property names you’re using in your - Segment page calls. Enter a Segment property name on the left and an Adobe - Analytics hVar number on the right. You can view your Segment page calls - and properties in your Schema. - 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: 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: eVars - display_name: eVars - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 250 - map_prefix: eVar - select_options: [] - description: >- - Map your Adobe Analytics eVar names to the property names you’re using in - your Segment events. Enter a Segment property name on the left and an - Adobe Analytics eVar number on the right. You can view your Segment events - and properties in your Schema. - settings: [] - - name: props - display_name: Props - type: MAP - 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. - settings: [] - - name: sendBothTimestampVisitorId - display_name: Send Both Timestamp and VisitorID for Timestamp Optional Reporting Suites - type: BOOLEAN - deprecated: false - required: false - description: >- - If you have a *Timestamp Optional* Reporting Suite, you can opt to send - _both_ the timestamp and the visitorID in your XML when sending events - server side. However, note that this is *NOT* recommended by - [Adobe](https://marketing.adobe.com/resources/help/en_US/sc/implement/timestamps-overview.html) - as it may lead to out of order data. This setting will only work for - reporting suites that have optional timestamp setting enabled. - settings: [] - - 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. + 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: customDelimiter display_name: 'List Variable and Prop Custom Delimiter: Server-Side Only ' @@ -793,16 +797,20 @@ items: 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 + - name: productIdentifier + display_name: Product Identifier + type: SELECT deprecated: false required: false - string_validators: - regexp: '' + select_validators: + select_options: + - name + - sku + - id description: >- - If you would like to prefix your Segment properties before sending them as - contextData, enter a prefix here. + 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: sendFalseValues display_name: Send False values @@ -814,48 +822,40 @@ items: mode. Enabling this setting will send any boolean property where value is `false`. settings: [] - - 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 + - name: events + display_name: Events + type: MIXED 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. + description: Map your Segment events to custom Adobe events. settings: [] - - name: addBuildToAppId - display_name: Add application build to Adobe's App ID - type: BOOLEAN + - name: hVars + display_name: Hierarchy Variables + type: MAP deprecated: false required: false + map_validators: + regexp: '' + min: 0 + max: 5 + map_prefix: hier + select_options: [] description: >- - If this setting is enable, we will add `context.app.build`, if present, to - Adobe's AppID, as ` ()`. + Map your Adobe Analytics hVars to the property names you’re using in your + Segment page calls. Enter a Segment property name on the left and an Adobe + Analytics hVar number on the right. You can view your Segment page calls + and properties in your Schema. settings: [] - - name: utf8Charset - display_name: Use UTF-8 Charset - type: BOOLEAN + - name: heartbeatTrackingServerUrl + display_name: Heartbeat Tracking Server URL + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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. + This is the URL of your Adobe Heartbeat server. Please contact Adobe to + obtain this URL. settings: [] connection_modes: device: @@ -912,7 +912,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -1002,27 +1002,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: account - display_name: Account ID + - name: domain + display_name: Domain type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your Account ID in the Javascript snippet, it appears as - `atrk_acct: 'XXXXXXX'`. + You can find your Domain in the Javascript snippet, it appears as `domain: + 'example.com'` settings: [] - - name: domain - display_name: Domain + - name: account + display_name: Account ID type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your Domain in the Javascript snippet, it appears as `domain: - 'example.com'` + You can find your Account ID in the Javascript snippet, it appears as + `atrk_acct: 'XXXXXXX'`. settings: [] connection_modes: device: @@ -1084,7 +1084,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -1177,7 +1177,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -1214,6 +1214,26 @@ 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 @@ -1245,33 +1265,13 @@ 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 mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -1301,25 +1301,52 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: region - display_name: Region + - name: roleAddress + display_name: Role Address type: STRING deprecated: false required: true string_validators: regexp: '' - description: 'AWS Region where the lambda lives. E.G. `us-west-2`, `eu-west-3`' + description: >- + The address of the AWS role that will be invoking Lambda (ex: + `arn:aws:iam::874699288871:role/example-role`). + settings: [] + - name: function + display_name: Lambda + 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. settings: [] - - name: roleAddress - display_name: Role Address + - name: externalId + display_name: External ID type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' description: >- - The address of the AWS role that will be invoking Lambda (ex: - `arn:aws:iam::874699288871:role/example-role`). + 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: clientContext display_name: Client Context @@ -1337,41 +1364,14 @@ items: 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 - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This is an optional string Segment will use to assume the role provided to - invoke the Lambda function. If this setting is not defined, we'll use the - Source ID. For more information about external IDs while assuming AWS - roles, check - [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). - settings: [] - - 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 @@ -1396,7 +1396,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -1426,6 +1426,28 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: function + display_name: Lambda + 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. + settings: [] - name: region display_name: Region type: STRING @@ -1467,28 +1489,6 @@ items: roles, check [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). settings: [] - - name: function - display_name: Lambda - 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. - settings: [] - name: logType display_name: Log Type type: SELECT @@ -1523,7 +1523,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -1622,65 +1622,181 @@ items: 32 characters long, and look something like this: 012345ab-c0d1-110e-1f0g-h1234ij5kl6m. settings: [] - - name: campaigns - display_name: Campaigns - type: MAP + - name: campaigns + display_name: Campaigns + type: MAP + deprecated: false + required: false + description: >- + 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 + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + previous_names: + - Ambassador +- display_name: Amplitude + slug: amplitude + name: catalog/destinations/amplitude + description: >- + Amplitude is an event tracking and segmentation platform for your web and + mobile apps. By analyzing the actions your users perform, you can gain a + better understanding to drive retention, engagement, and conversion. + hidden: false + url: connections/destinations/catalog/amplitude + status: PUBLIC + logo: + url: 'https://d3hotuclm6if1r.cloudfront.net/logos/amplitude-default.svg' + mark: + url: 'https://cdn.filepicker.io/api/file/Nmj7LgOQR62rdAmlbnLO' + categories: + - Analytics + components: + - type: WEB + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + browserUnbundlingSupported: true + browserUnbundlingPublic: true + settings: + - name: batchEvents + display_name: Batch Events + type: BOOLEAN + deprecated: false + required: false + description: >- + If true, events are batched together and uploaded only when the number of + unsent events is greater than or equal to `eventUploadThreshold` or after + `eventUploadPeriodMillis` milliseconds have passed since the first unsent + event was logged. + settings: [] + - name: 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. + settings: [] + - name: mapQueryParams + display_name: Map Query Params to Custom Property + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - user_properties + - event_properties + description: >- + When sending data via server side or Cloud Mode, you can send the custom + query params that are automatically collected by `analytics.js` (or + whatever you manually send under `context.page.search`), by entering a + custom property name you would like to map that under on the left hand + side. On the right hand side, please choose whether you want the query + params to be set on the user profile or event metadata level. Whatever you + put on the left hand side we will map the entire query parameters string + from the `context.page.url`. + settings: [] + - name: trackGclid + display_name: Track GCLID + type: BOOLEAN + deprecated: false + required: false + description: >- + If true, captures the gclid url parameter as well as the user's + initial_gclid via a set once operation. + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-z0-9]{32}$' + description: >- + You can find your API Key on your Amplitude [Settings + page](https://amplitude.com/settings). + settings: [] + - name: eventUploadPeriodMillis + display_name: Event Upload Period Millis (for batching events) + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: >- + Amount of time in milliseconds that the SDK waits before uploading events + if `batchEvents` is `true`. + settings: [] + - 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: traitsToIncrement + display_name: Traits To Increment + type: LIST deprecated: false required: false description: >- - 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. + 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: events - display_name: Events - type: MAP + - name: deviceIdFromUrlParam + display_name: Set Device ID From URL Parameter amp_device_id + type: BOOLEAN 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. + If true, the SDK will parse device ID values from url parameter + `amp_device_id` if available. settings: [] - connection_modes: - device: - web: true - mobile: false - server: false - cloud: - web: false - mobile: false - server: false - previous_names: - - Ambassador -- display_name: Amplitude - slug: amplitude - name: catalog/destinations/amplitude - description: >- - Amplitude is an event tracking and segmentation platform for your web and - mobile apps. By analyzing the actions your users perform, you can gain a - better understanding to drive retention, engagement, and conversion. - hidden: false - url: connections/destinations/catalog/amplitude - status: PUBLIC - logo: - url: 'https://d3hotuclm6if1r.cloudfront.net/logos/amplitude-default.svg' - mark: - url: 'https://cdn.filepicker.io/api/file/Nmj7LgOQR62rdAmlbnLO' - categories: - - Analytics - components: - - type: WEB - - type: IOS - - type: ANDROID - - type: CLOUD - platforms: - browser: true - server: true - mobile: true - browserUnbundlingSupported: true - browserUnbundlingPublic: true - settings: - name: groupTypeTrait display_name: Group Type Trait type: STRING @@ -1693,79 +1809,68 @@ items: calls. If, for example, you set this to be `industry`, then `traits["industry"]` will be sent as `groupType` to Amplitude. settings: [] - - name: groupValueTrait - display_name: Group Value Trait + - name: secretKey + display_name: Secret Key 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. + description: Your Amplitude Secret Key (Only needed for user deletion) settings: [] - - name: preferAnonymousIdForDeviceId - display_name: Prefer Anonymous ID for Device ID + - name: trackRevenuePerProduct + display_name: Track Revenue Per Product 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. + 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: 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: trackSessionEvents - display_name: Track Session Events to Amplitude + - name: sendAlias + display_name: Enable Alias 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. + 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: appendFieldsToEventProps - display_name: Append Fields To Event Properties - type: MAP + - name: trackAllPages + display_name: Track All Pages to Amplitude + type: BOOLEAN 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`. + 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: deviceIdFromUrlParam - display_name: Set Device ID From URL Parameter amp_device_id + - name: trackProductsOnce + display_name: Track products once type: BOOLEAN deprecated: false required: false description: >- - If true, the SDK will parse device ID values from url parameter - `amp_device_id` if available. + *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: eventUploadThreshold display_name: Event Upload Threshold (for batching events) @@ -1779,60 +1884,35 @@ items: Minimum number of events to batch together per request if `batchEvents` is `true`. 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: enableLocationListening - display_name: Enable Location Listening + - name: saveParamsReferrerOncePerSession + display_name: 'Save Referrer, URL Params, GCLID Once Per Session' type: BOOLEAN deprecated: false required: false description: >- - Mobile Only. If a user has granted your app location permissions, enable - this setting so that the SDK will also grab the location of the user. - Amplitude will never prompt the user for location permission, so this must - be done by your app. + If true then includeGclid, includeReferrer, and includeUtm will only track + their respective properties once per session. New values that come in + 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: trackAllPagesV2 + display_name: Track All Screens 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: traitsToPrepend - display_name: Traits to Prepend - 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. + 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: useAdvertisingIdForDeviceId - display_name: Use AdvertisingId for DeviceId + - name: trackReferrer + display_name: Track Referrer to Amplitude 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. + Enabling this will send referrer information as a user property to + Amplitude when you call Segment's `page` method. settings: [] - name: traitsToAppend display_name: Traits to Append @@ -1850,139 +1930,79 @@ items: 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: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-z0-9]{32}$' - description: >- - You can find your API Key on your Amplitude [Settings - page](https://amplitude.com/settings). - settings: [] - - name: batchEvents - display_name: Batch Events - type: BOOLEAN - deprecated: false - required: false - description: >- - If true, events are batched together and uploaded only when the number of - unsent events is greater than or equal to `eventUploadThreshold` or after - `eventUploadPeriodMillis` milliseconds have passed since the first unsent - event was logged. - settings: [] - - name: eventUploadPeriodMillis - display_name: Event Upload Period Millis (for batching events) - type: NUMBER - deprecated: false - required: false - number_validators: - min: 0 - max: 0 - description: >- - Amount of time in milliseconds that the SDK waits before uploading events - if `batchEvents` is `true`. - settings: [] - - name: trackRevenuePerProduct - display_name: Track Revenue Per Product - type: BOOLEAN - 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. - settings: [] - - name: saveParamsReferrerOncePerSession - display_name: 'Save Referrer, URL Params, GCLID Once Per Session' - type: BOOLEAN - deprecated: false - required: false - description: >- - If true then includeGclid, includeReferrer, and includeUtm will only track - their respective properties once per session. New values that come in - during the middle of the user's session will be ignored. Set to false to - always capture new values. + description: >- + Optional. You can assign a version name for your page, and we'll send it + to Amplitude for more detailed events. settings: [] - - name: trackAllPages - display_name: Track All Pages to Amplitude - type: BOOLEAN + - name: appendFieldsToEventProps + display_name: Append Fields To Event Properties + type: MAP 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. + 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: trackCategorizedPages - display_name: Track Categorized Pages to Amplitude + - name: enableLocationListening + display_name: Enable Location Listening 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**. + 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: 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: [] - - name: mapQueryParams - display_name: Map Query Params to Custom Property - type: MAP + - name: useLogRevenueV2 + display_name: Use Log Revenue V2 API + type: BOOLEAN deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: - - user_properties - - event_properties description: >- - When sending data via server side or Cloud Mode, you can send the custom - query params that are automatically collected by `analytics.js` (or - whatever you manually send under `context.page.search`), by entering a - custom property name you would like to map that under on the left hand - side. On the right hand side, please choose whether you want the query - params to be set on the user profile or event metadata level. Whatever you - put on the left hand side we will map the entire query parameters string - from the `context.page.url`. + 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: 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: trackReferrer - display_name: Track Referrer to Amplitude + - name: forceHttps + display_name: Force Https 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. + If true, the events will always be uploaded to HTTPS endpoint. Otherwise + the SDK will use the embedding site's protocol. settings: [] - name: sendToBatchEndpoint display_name: Send To Batch Endpoint @@ -2000,86 +2020,66 @@ items: Amplitude's throttling is available here in their docs: https://developers.amplitude.com/#429s-in-depth. settings: [] - - name: trackGclid - display_name: Track GCLID + - name: trackSessionEvents + display_name: Track Session Events to Amplitude type: BOOLEAN deprecated: false required: false description: >- - If true, captures the gclid url parameter as well as the user's - initial_gclid via a set once operation. - settings: [] - - name: traitsToIncrement - display_name: Traits To Increment - type: LIST - deprecated: false - required: false - description: >- - Server-Side and Mobile Only. Configure `trait` to increment on identify. - If the trait is present, it will increment the trait given the numerical - value passed in when you call `identify` with the trait. + (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: forceHttps - display_name: Force Https + - name: trackUtmProperties + display_name: Track UTM Properties to Amplitude. type: BOOLEAN deprecated: false required: false description: >- - If true, the events will always be uploaded to HTTPS endpoint. Otherwise - the SDK will use the embedding site's protocol. - settings: [] - - name: secretKey - display_name: Secret Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: Your Amplitude Secret Key (Only needed for user deletion) + This will track UTM properties found in the querystring to Amplitude (only + for Device mode). settings: [] - - name: sendAlias - display_name: Enable Alias - type: BOOLEAN + - name: traitsToPrepend + display_name: Traits to Prepend + type: LIST 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. + Server-Side and Mobile Only. Configure values to be prepended to the user + property array via identify.traits. settings: [] - - name: trackProductsOnce - display_name: Track products once - type: BOOLEAN + - name: traitsToSetOnce + display_name: Traits to Set Once + type: LIST 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. + Server-Side and Mobile Only. Configure values to be set only once via + identify.traits. settings: [] - - name: trackUtmProperties - display_name: Track UTM Properties to Amplitude. + - name: trackCategorizedPages + display_name: Track Categorized Pages to Amplitude type: BOOLEAN deprecated: false required: false description: >- - This will track UTM properties found in the querystring to Amplitude (only - for Device mode). + 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: useCustomAmplitudeProperties - display_name: Send Custom Language and Country Properties + - name: trackNamedPages + display_name: Track Named Pages to Amplitude 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'});` + 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. settings: [] connection_modes: device: @@ -2121,6 +2121,16 @@ items: required: false description: Configure a pixel settings: + - name: parameters + display_name: Query Parameters + type: MAP + deprecated: false + required: false + description: >- + Enter any event properties you want to map to query parameters in the + AppNexus url. Two parameters are sent automatically: `order_id` and the + monetary `value`. + settings: [] - name: event display_name: Event Name type: STRING @@ -2153,16 +2163,6 @@ items: regexp: '' description: Enter a Segment ID that you want us to map to the custom event settings: [] - - name: parameters - display_name: Query Parameters - type: MAP - deprecated: false - required: false - description: >- - Enter any event properties you want to map to query parameters in the - AppNexus url. Two parameters are sent automatically: `order_id` and the - monetary `value`. - settings: [] connection_modes: device: web: true @@ -2227,7 +2227,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -2480,17 +2480,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - To find your API Key, create a project in your Atatus dashboard. The key - should look something like this: `16ae323d8b3244733a981215c9d66e67d` - settings: [] - name: disableAjaxMonitoring display_name: Disable AJAX Monitoring type: BOOLEAN @@ -2525,6 +2514,17 @@ items: 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 + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + To find your API Key, create a project in your Atatus dashboard. The key + should look something like this: `16ae323d8b3244733a981215c9d66e67d` + settings: [] connection_modes: device: web: true @@ -2575,7 +2575,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -2667,7 +2667,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -2716,7 +2716,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -2747,6 +2747,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: canUseAdvancedDeviceInformation + display_name: Allow collection of advanced device information. + type: BOOLEAN + deprecated: false + required: false + description: >- + Toggles whether Batch can use all of the device information it supports. + All of this info is anonymous, but some might want to disable it under + 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 @@ -2778,17 +2789,6 @@ items: You can find your API Key in your app's settings, in the [Batch.com dashboard](https://dashboard.batch.com) settings: [] - - name: canUseAdvancedDeviceInformation - display_name: Allow collection of advanced device information. - type: BOOLEAN - deprecated: false - required: false - description: >- - Toggles whether Batch can use all of the device information it supports. - All of this info is anonymous, but some might want to disable it under - strict privacy rules. If disabled, some targeting options in your - Batch.com dashboard will stop working correctly. - settings: [] connection_modes: device: web: false @@ -2884,7 +2884,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -2938,7 +2938,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -3033,30 +3033,63 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: appGroupId - display_name: REST API Key + - name: safariWebsitePushId + display_name: Safari Website Push ID type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' description: >- - This can be found in your Braze dashboard under App Settings > Developer - Console. (Formerly 'App Group Identifier') + **Web Only**: To send push notifications on Safari, Braze needs your + Website Push Id. To get your Webite Push ID, check out the first two + bullet points + [here](https://www.braze.com/documentation/Web/#step-5-configure-safari-push). settings: [] - - name: automaticallyDisplayMessages - display_name: Automatically Send In-App Messages + - name: allowCrawlerActivity + display_name: Allow Crawler Activity 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. + **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: customEndpoint - display_name: Custom API Endpoint + - name: datacenter + display_name: Appboy Datacenter + type: SELECT + deprecated: false + required: true + select_validators: + select_options: + - us + - us02 + - us03 + - us04 + - eu + description: 'Choose your Appboy Gateway (ie. US 01, US 02, EU 01, etc.).' + settings: [] + - name: 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: restCustomEndpoint + display_name: Custom REST API Endpoint type: STRING deprecated: false required: false @@ -3064,22 +3097,27 @@ items: 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. + 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: safariWebsitePushId - display_name: Safari Website Push ID - type: STRING + - name: trackAllPages + display_name: Track All Pages + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - **Web Only**: To send push notifications on Safari, Braze needs your - Website Push Id. To get your Webite Push ID, check out the first two - bullet points - [here](https://www.braze.com/documentation/Web/#step-5-configure-safari-push). + This will send all [`page` calls](https://segment.com/docs/spec/page/) to + 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: updateExistingOnly + display_name: Update Existing Users Only + type: BOOLEAN + deprecated: false + required: false + description: >- + **Server Side only**: A flag to determine whether to update existing users + only, defaults to false settings: [] - name: version display_name: Braze Web SDK Version @@ -3098,116 +3136,92 @@ items: [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 + - name: automatic_in_app_message_registration_enabled + display_name: Enable Automatic In-App Message Registration type: BOOLEAN deprecated: false required: false description: >- - **Server Side only**: A flag to determine whether to update existing users - only, defaults to false + **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: apiKey - display_name: App Identifier + - name: customEndpoint + display_name: Custom API Endpoint type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - The API key found in your Braze dashboard, used to identify your - application as the app identifier. (Formerly 'API Key') + 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: automatic_in_app_message_registration_enabled - display_name: Enable Automatic In-App Message Registration + - name: enableLogging + display_name: Enable Logging type: BOOLEAN deprecated: false required: false description: >- - **Mobile Only:** Every activity in your app must be registered with Braze - to allow it to add in-app message views to the view hierarchy. By default, - Braze's Segment integration automatically registers every activity. - However, if you would like to manually register activities, you may do so - by disabling this setting. For more information, see the Braze - [documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/android/in-app_messaging/integration/#step-1-braze-in-app-message-manager-registration). + **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: enableHtmlInAppMessages - display_name: Enable HTML In-App Messages + - name: openNewsFeedCardsInNewTab + display_name: Open News Feed Cards In New Tab type: BOOLEAN deprecated: false required: false description: >- - **Web only**: Enabling this option will allow Braze dashboard users to - write HTML In-App messages. Check out [Braze - Documentation](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.initialize) - for more information on this setting. **This setting is only applicable if - you are using version 2 of the Braze Web SDK.** + By default, links from news feed cards load in the current tab or window. + Set this option to true to make links from news feed cards open in a new + tab or window. **This setting is only applicable if you are using version + 2 of the Braze Web SDK.** settings: [] - - name: minimumIntervalBetweenTriggerActionsInSeconds - display_name: Minimum Interval Between Trigger Actions In Seconds - type: NUMBER + - name: appGroupId + display_name: REST API Key + type: STRING deprecated: false - required: false - number_validators: - min: 0 - max: 0 + required: true + string_validators: + regexp: '' 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.** + This can be found in your Braze dashboard under App Settings > Developer + Console. (Formerly 'App Group Identifier') settings: [] - - name: openInAppMessagesInNewTab - display_name: Open In-App Messages In New Tab + - name: doNotLoadFontAwesome + display_name: Do Not Load Font Awesome type: BOOLEAN deprecated: false required: false description: >- - By default, links from in-app message clicks load in the current tab or a - new tab as specified in the dashboard on a message-by-message basis. Set - this option to true to force all links from in-app message clicks open in - a new tab or window. **This setting is only applicable if you are using - version 2 of the Braze Web SDK.** + **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: trackAllPages - display_name: Track All Pages + - name: trackNamedPages + display_name: Track Only Named Pages type: BOOLEAN deprecated: false required: false description: >- - This will send all [`page` calls](https://segment.com/docs/spec/page/) to - 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: 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: datacenter - display_name: Appboy Datacenter - type: SELECT - deprecated: false - required: true - select_validators: - select_options: - - us - - us02 - - us03 - - us04 - - eu - description: 'Choose your Appboy Gateway (ie. US 01, US 02, EU 01, etc.).' + This will send only [`page` calls](https://segment.com/docs/spec/page/) to + Braze that have a `name` associated with them. For example, + `page('Signup')` would translate to **Viewed Signup Page** in Braze. settings: [] - name: logPurchaseWhenRevenuePresent display_name: Log Purchase when Revenue is present @@ -3218,28 +3232,17 @@ items: 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 + - name: openInAppMessagesInNewTab + display_name: Open In-App Messages In New Tab type: BOOLEAN deprecated: false required: false description: >- - By default, links from news feed cards load in the current tab or window. - Set this option to true to make links from news feed cards open in a new - tab or window. **This setting is only applicable if you are using version - 2 of the Braze Web SDK.** - settings: [] - - name: restCustomEndpoint - display_name: Custom REST API Endpoint - type: STRING - 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. + By default, links from in-app message clicks load in the current tab or a + new tab as specified in the dashboard on a message-by-message basis. Set + this option to true to force all links from in-app message clicks open in + a new tab or window. **This setting is only applicable if you are using + version 2 of the Braze Web SDK.** settings: [] - name: serviceWorkerLocation display_name: Service Worker Location @@ -3253,56 +3256,53 @@ items: documentation: https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html settings: [] - - name: allowCrawlerActivity - display_name: Allow Crawler Activity - type: BOOLEAN + - name: sessionTimeoutInSeconds + display_name: Session Timeout In Seconds + type: NUMBER 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. + 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: doNotLoadFontAwesome - display_name: Do Not Load Font Awesome - type: BOOLEAN + - name: apiKey + display_name: App Identifier + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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.** + The API key found in your Braze dashboard, used to identify your + application as the app identifier. (Formerly 'API Key') 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: trackNamedPages - display_name: Track Only Named Pages + - name: enableHtmlInAppMessages + display_name: Enable HTML In-App Messages type: BOOLEAN deprecated: false required: false description: >- - This will send only [`page` calls](https://segment.com/docs/spec/page/) to - Braze that have a `name` associated with them. For example, - `page('Signup')` would translate to **Viewed Signup Page** in Braze. + **Web only**: Enabling this option will allow Braze dashboard users to + write HTML In-App messages. Check out [Braze + Documentation](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.initialize) + for more information on this setting. **This setting is only applicable if + you are using version 2 of the Braze Web SDK.** settings: [] connection_modes: device: @@ -3544,7 +3544,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -3594,7 +3594,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -3654,8 +3654,7 @@ items: url: connections/destinations/catalog/candu status: PUBLIC_BETA logo: - url: >- - https://public-segment-devcenter-production.s3.amazonaws.com/809b7fb8-9644-44f1-8396-817ab2b74929.svg + url: 'https://cdn.filepicker.io/api/file/531aEP0LQpW4mKpxhOfx' mark: url: >- https://public-segment-devcenter-production.s3.amazonaws.com/03f0c75f-6fa8-44e9-96b2-8c6a13ea24f3.svg @@ -3686,7 +3685,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -3714,13 +3713,6 @@ 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 @@ -3732,6 +3724,13 @@ 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 @@ -3808,7 +3807,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -3863,7 +3862,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -3998,7 +3997,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -4048,7 +4047,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -4095,7 +4094,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -4149,7 +4148,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -4224,7 +4223,7 @@ items: mobile: true server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -4329,7 +4328,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -4479,7 +4478,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -4616,6 +4615,32 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: + - name: supportingPageData + display_name: Supporting Page Data + type: MAP + deprecated: false + required: false + description: >- + Specify the property names of your Segment page event on the left and the + corresponding Criteo data parameter you would like us to map it to on the + right. Please reference our + [documentation](/docs/integrations/criteo/#extra-data) for more info on + this feature. **Please note, this setting is only applicable if you are + using our web integration with Criteo which is currently in beta.** + settings: [] + - name: supportingUserData + display_name: Supporting User Data + type: MAP + deprecated: false + required: false + description: >- + Specify the Segment trait names on the left and the corresponding Criteo + data parameter you would like us to map it to on the right. Please + reference our [documentation](/docs/integrations/criteo/#extra-data) for + more info on this feature. **Please note, this setting is only applicable + if you are using our web integration with Criteo which is currently in + beta.** + settings: [] - name: account display_name: Account ID type: STRING @@ -4660,32 +4685,6 @@ items: if the path of your home url is not the standard root path (ie. '/'). Navigation to this page will trigger Criteo's viewHome tag. settings: [] - - name: supportingPageData - display_name: Supporting Page Data - type: MAP - deprecated: false - required: false - description: >- - Specify the property names of your Segment page event on the left and the - corresponding Criteo data parameter you would like us to map it to on the - right. Please reference our - [documentation](/docs/integrations/criteo/#extra-data) for more info on - this feature. **Please note, this setting is only applicable if you are - using our web integration with Criteo which is currently in beta.** - settings: [] - - name: supportingUserData - display_name: Supporting User Data - type: MAP - deprecated: false - required: false - description: >- - Specify the Segment trait names on the left and the corresponding Criteo - data parameter you would like us to map it to on the right. Please - reference our [documentation](/docs/integrations/criteo/#extra-data) for - more info on this feature. **Please note, this setting is only applicable - if you are using our web integration with Criteo which is currently in - beta.** - settings: [] connection_modes: device: web: true @@ -4783,18 +4782,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: enableServiceMonitoring - display_name: Enable Service Monitoring (Android) - type: BOOLEAN - deprecated: false - required: false - description: >- - Whenever an app makes a network call, Crittercism monitors and captures - certain information automatically (Android only). Check out the - [Crittercism - docs](http://docs.crittercism.com/overview/overview.html#service-monitoring) - for more info. - settings: [] - name: includeVersionCode display_name: Include the Version Code (Android) type: BOOLEAN @@ -4853,6 +4840,18 @@ items: 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 + deprecated: false + required: false + description: >- + Whenever an app makes a network call, Crittercism monitors and captures + certain information automatically (Android only). Check out the + [Crittercism + docs](http://docs.crittercism.com/overview/overview.html#service-monitoring) + for more info. + settings: [] connection_modes: device: web: false @@ -4911,7 +4910,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -5042,6 +5041,20 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^([a-z0-9]{20})?([a-z0-9]{64})?$' + description: >- + You can find your API Key on the Customer.io [Integration + page](https://fly.customer.io/account/customerio_integration). It should + be 20 or 64 characters long, and look something like this: + `91837a6c9e8b49d0ef71`. An API Key is required if you're using our + server-side or mobile libraries. + settings: [] - name: convertToUnixTime display_name: Convert To Unix Time type: BOOLEAN @@ -5060,20 +5073,6 @@ items: You can find your Site ID on the Customer.io [Integration page](https://fly.customer.io/account/customerio_integration). settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^([a-z0-9]{20})?([a-z0-9]{64})?$' - description: >- - You can find your API Key on the Customer.io [Integration - page](https://fly.customer.io/account/customerio_integration). It should - be 20 or 64 characters long, and look something like this: - `91837a6c9e8b49d0ef71`. An API Key is required if you're using our - server-side or mobile libraries. - settings: [] connection_modes: device: web: true @@ -5130,7 +5129,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -5176,7 +5175,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -5207,51 +5206,37 @@ 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 + - name: getDoubleClickId + display_name: Get DoubleClick Id + type: BOOLEAN 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. + Enable this setting if you would like to use Google's cookie matching + functionality. Please also ensure you provide a value in the Google + Network Id setting. settings: [] - - name: groupTag - display_name: Group Tag + - name: segmentWriteKey + display_name: Segment Write Key type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - This setting maps to the Doubleclick Floodlight container group tag (the - `type` parameter) 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. + Set here the write key for this source. It's required if cookie matching + is enabled. settings: [] - - name: segmentWriteKey - display_name: Segment Write Key + - name: source + display_name: DoubleClick Advertiser ID type: STRING deprecated: false - required: false + required: true string_validators: regexp: '' description: >- - Set here the write key for this source. It's required if cookie matching - is enabled. + Your advertiser ID that is the source of the Floodlight activity. This + should be the `src` of your tag string. settings: [] - name: activityTag display_name: Activity Tag @@ -5352,21 +5337,11 @@ items: variables and we'll insert the value of that property in the 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: getDoubleClickId - display_name: Get DoubleClick Id - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this setting if you would like to use Google's cookie matching - functionality. Please also ensure you provide a value in the Google - Network Id setting. - settings: [] + 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: googleNetworkId display_name: Google Network Id type: STRING @@ -5378,13 +5353,37 @@ items: Provide your Google Network Id here if you have enabled cookie matching (Get DoubleClick Id setting). settings: [] + - name: groupTag + display_name: Group Tag + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + This setting maps to the Doubleclick Floodlight container group tag (the + `type` parameter) 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: 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 mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -5431,7 +5430,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -5459,8 +5458,8 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key + - name: embedId + display_name: Embed ID type: STRING deprecated: false required: true @@ -5470,8 +5469,8 @@ items: Head right to this page in [Drift](https://app.drift.com/setup/segment) and click connect to setup Drift in Segment. settings: [] - - name: embedId - display_name: Embed ID + - name: apiKey + display_name: API Key type: STRING deprecated: false required: true @@ -5518,6 +5517,18 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: token + display_name: API Token + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^[a-zA-Z0-9]{20}$|[a-zA-Z0-9]{32}' + description: >- + Your API Token can be found in your [User + Settings](https://www.getdrip.com/user/edit). It should be 20 character + alphanumeric string, like: `bmrdc6hczyn8yss8o8td`. + settings: [] - name: account display_name: Account Key type: STRING @@ -5548,25 +5559,13 @@ items: you put a value in here, we will by default try to subscribe every user to this campaign ID. settings: [] - - name: token - display_name: API Token - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^[a-zA-Z0-9]{20}$|[a-zA-Z0-9]{32}' - description: >- - Your API Token can be found in your [User - Settings](https://www.getdrip.com/user/edit). It should be 20 character - alphanumeric string, like: `bmrdc6hczyn8yss8o8td`. - settings: [] connection_modes: device: web: true mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -5616,7 +5615,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -5665,7 +5664,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -5737,51 +5736,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: siteId - display_name: Site ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter your Site ID - settings: [] - - name: username - display_name: Username - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter your login username - settings: [] - - name: companyName - display_name: Company Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter your login company name - settings: [] - - name: mappedEvents - display_name: Map Track Events to Custom Objects - 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. - - - **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: mappedGroupTraits display_name: Map Custom Traits to Accounts type: MAP @@ -5798,15 +5752,6 @@ items: data type specified in Eloqua's dashboard. Eloqua will reject any event containing a Custom Account Field with an incorrect data type. settings: [] - - name: password - display_name: Password - type: PASSWORD - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter your login passord - settings: [] - name: sendGroup display_name: Create or Update Account on Group type: BOOLEAN @@ -5816,6 +5761,15 @@ items: *Server Side Only*: Enable this setting to create or update an Eloqua account on a `group` event. settings: [] + - name: companyName + display_name: Company Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your login company name + settings: [] - name: createContactOnTrack display_name: Create or Update Contact on Track type: BOOLEAN @@ -5828,6 +5782,51 @@ 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: password + display_name: Password + type: PASSWORD + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your login passord + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your Site ID + settings: [] + - name: username + display_name: Username + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your login username + settings: [] + - name: mappedEvents + display_name: Map Track Events to Custom Objects + 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. + + + **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 type: MAP @@ -5850,7 +5849,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -5948,7 +5947,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -6059,42 +6058,94 @@ items: regexp: '' description: Your Evergage Dataset settings: [] - connection_modes: - device: - web: true - mobile: false - server: false - cloud: - web: false - mobile: false - server: false - previous_names: - - Evergage -- display_name: Facebook App Events - slug: facebook-app-events - name: catalog/destinations/facebook-app-events - description: Facebook is the world's leading ad publisher for mobile app marketers. - hidden: false - url: connections/destinations/catalog/facebook-app-events - status: PUBLIC - logo: - url: >- - https://d3hotuclm6if1r.cloudfront.net/logos/facebook-app-events-default.svg - mark: - url: 'https://cdn.filepicker.io/api/file/k1fi9InSu6eint2IHilP' - categories: - - Advertising - - Analytics - components: - - type: IOS - - type: CLOUD - platforms: - browser: false - server: true - mobile: true - browserUnbundlingSupported: false - browserUnbundlingPublic: true - settings: + connection_modes: + device: + web: true + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + previous_names: + - Evergage +- display_name: Facebook App Events + slug: facebook-app-events + name: catalog/destinations/facebook-app-events + description: Facebook is the world's leading ad publisher for mobile app marketers. + hidden: false + url: connections/destinations/catalog/facebook-app-events + status: PUBLIC + logo: + url: >- + https://d3hotuclm6if1r.cloudfront.net/logos/facebook-app-events-default.svg + mark: + url: 'https://cdn.filepicker.io/api/file/k1fi9InSu6eint2IHilP' + categories: + - Advertising + - Analytics + components: + - type: IOS + - type: CLOUD + platforms: + browser: false + server: true + mobile: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + 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 @@ -6167,58 +6218,6 @@ items: (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: [] connection_modes: device: web: false @@ -6343,21 +6342,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false 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: legacyEvents display_name: Legacy Conversion Pixel IDs type: MAP @@ -6372,51 +6356,16 @@ items: custom events inside their interface. Enter your event name in the left column and your pixel ID in the right column. settings: [] - - name: standardEventsCustomProperties - display_name: Standard Events custom properties - type: LIST - deprecated: false - required: false - description: >- - Add here all the custom properties you want to send as part of your - Standard Events (Order Completed, Checkout Started, etc) as `property - name`. - settings: [] - - name: valueIdentifier - display_name: Value Field Identifier - type: SELECT - deprecated: false - required: false - select_validators: - select_options: - - price - - value - description: >- - For pre-purchase events such as `Product Viewed` and `Product Added`, - choose which Segment property you would like to map to Facebook's value - property. - settings: [] - - name: whitelistPiiProperties - display_name: Whitelist PII Properties - type: LIST - deprecated: false - required: false - description: >- - By default, Segment will strip any PII from the properties of `track` - events that get sent to Facebook. If you would like to override this - functionality, you can input each property you would like to whitelist as - a line item in this setting. **Please reference our - [documentation](https://segment.com/docs/destinations/facebook-pixel/#pii-blacklisting) - for the exact property names we filter out.** - settings: [] - - name: userIdAsExternalId - display_name: Use UserId or Anonymous Id as External Id - type: BOOLEAN + - name: pixelId + display_name: Pixel ID + type: STRING deprecated: false - required: false + required: true + string_validators: + regexp: '' description: >- - Enable this setting if you want to send, `userId` (or `anonymousId` if not - present) as external Id to Facebook. + Your Pixel ID, from the snippet created on the [Facebook Pixel creation + page](https://www.facebook.com/ads/manager/pixel/facebook_pixel/). settings: [] - name: contentTypes display_name: Map Categories to FB Content Types @@ -6429,15 +6378,6 @@ items: deliver relevant ads. If no category values are mapped we'll default to `product` and `product_group`, depending on the event. settings: [] - - name: initWithExistingTraits - display_name: Enable Advanced Matching - type: BOOLEAN - 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: [] - name: keyForExternalId display_name: 'Client-Side Only: Advanced Match Trait Key for External ID' type: STRING @@ -6451,17 +6391,6 @@ items: will use the value of this trait to map it to Facebook Pixel's `external_id`. settings: [] - - name: pixelId - display_name: Pixel ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Your Pixel ID, from the snippet created on the [Facebook Pixel creation - page](https://www.facebook.com/ads/manager/pixel/facebook_pixel/). - settings: [] - name: standardEvents display_name: Map Your Events to Standard FB Events type: MAP @@ -6499,6 +6428,76 @@ items: Facebook event, we'll send the event by that name. Any unmapped events will still be sent as Custom Events. settings: [] + - name: standardEventsCustomProperties + display_name: Standard Events custom properties + type: LIST + deprecated: false + required: false + description: >- + Add here all the custom properties you want to send as part of your + Standard Events (Order Completed, Checkout Started, etc) as `property + name`. + settings: [] + - name: userIdAsExternalId + display_name: Use UserId or Anonymous Id as External Id + type: BOOLEAN + 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 + deprecated: false + required: false + select_validators: + select_options: + - price + - value + description: >- + For pre-purchase events such as `Product Viewed` and `Product Added`, + choose which Segment property you would like to map to Facebook's value + property. + settings: [] + - name: 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: [] + - name: whitelistPiiProperties + display_name: Whitelist PII Properties + type: LIST + deprecated: false + required: false + description: >- + By default, Segment will strip any PII from the properties of `track` + events that get sent to Facebook. If you would like to override this + functionality, you can input each property you would like to whitelist as + a line item in this setting. **Please reference our + [documentation](https://segment.com/docs/destinations/facebook-pixel/#pii-blacklisting) + for the exact property names we filter out.** + settings: [] connection_modes: device: web: true @@ -6534,6 +6533,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: publishableApiKey + display_name: Publishable API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Enter a description. + settings: [] - name: apiKey display_name: API Key type: STRING @@ -6545,15 +6553,6 @@ items: Go to https://app.factors.ai/#/settings/segment. Choose your Project on the top dropdown. Enable Segment and Copy the API Key. settings: [] - - name: publishableApiKey - display_name: Publishable API Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: Enter a description. - settings: [] connection_modes: device: web: true @@ -6643,6 +6642,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: screenTracksEvents + display_name: Screen Tracks As Events + type: BOOLEAN + deprecated: false + required: false + description: >- + Enabling this will send data through screen calls as events (in addition + to pageviews). + settings: [] - name: sessionContinueSeconds display_name: Session Continue Seconds type: NUMBER @@ -6691,15 +6699,6 @@ items: Enabling this will send tell the Flurry SDK to automatically collect the user location. settings: [] - - name: screenTracksEvents - display_name: Screen Tracks As Events - type: BOOLEAN - deprecated: false - required: false - description: >- - Enabling this will send data through screen calls as events (in addition - to pageviews). - settings: [] connection_modes: device: web: false @@ -6807,7 +6806,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -6866,7 +6865,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -6925,6 +6924,17 @@ 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 @@ -6974,17 +6984,6 @@ 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 @@ -7021,6 +7020,13 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true 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 @@ -7054,13 +7060,6 @@ items: 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 @@ -7197,6 +7196,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: accessKey + display_name: Access Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-z0-9-]{36}$' + description: >- + It should be 36 characters long, and look something like this: + `35a84f9e-7084-47a1-b8a5-593444e9e862`. + settings: [] - name: events display_name: Whitelist Track Events type: MIXED @@ -7223,24 +7233,13 @@ 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 mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -7370,16 +7369,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: trackLocal - display_name: Track Local - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable to track data on local pages/sites (using the `file://` protocol, - or on `localhost`). This helps prevent local development from polluting - your stats. - settings: [] - name: trackParams display_name: Track Parameters type: BOOLEAN @@ -7390,27 +7379,6 @@ items: example `/home?my=query&string=true` will be tracked as `/home` if this is set to disabled. settings: [] - - name: apiSecret - display_name: Site Token - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^GSN-\d{6}-[A-Z]$' - description: >- - You can find your Site Token by viewing the GoSquared [Integration - guide](https://www.gosquared.com/integration/). It should look something - like `GSN-123456-A`. - settings: [] - - name: trackHash - display_name: Track Hash - 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`. - settings: [] - name: useCookies display_name: Use Cookies type: BOOLEAN @@ -7438,111 +7406,86 @@ items: Generate your server-side API key here: https://www.gosquared.com/settings/api settings: [] - - name: cookieDomain - display_name: Cookie Domain - type: STRING + - name: trackHash + display_name: Track Hash + type: BOOLEAN 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. + 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: [] - connection_modes: - device: - web: true - mobile: false - server: false - cloud: - web: false - mobile: true - server: true - previous_names: - - GoSquared -- display_name: Google Ads (Classic) - slug: google-ads-classic - name: catalog/destinations/adwords - description: >- - Advertise on Google and put your message in front of potential customers - right when they're searching for what you have to offer. - hidden: false - url: connections/destinations/catalog/google-ads-classic - status: PUBLIC - logo: - url: 'https://cdn.filepicker.io/api/file/O54PEswFQAC7ZZDLSBZ5' - mark: - url: '' - categories: - - Advertising - components: - - type: WEB - - type: CLOUD - platforms: - browser: true - server: true - mobile: true - browserUnbundlingSupported: false - browserUnbundlingPublic: true - settings: - - name: correctLat - display_name: Correct LAT Behavior + - name: trackLocal + display_name: Track Local type: BOOLEAN deprecated: false required: false description: >- - Enable this to set Limit Ad Tracking to `true` when - context.device.adTrackingEnabled is `false`. + 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: eventMappings - display_name: Event Mappings - type: MIXED + - name: apiSecret + display_name: Site Token + type: STRING deprecated: false required: false - description: AdWords behavior for each of your Segment Events is defined here. - settings: - - name: eventName - display_name: Event Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Segment Event Name - settings: [] - - name: label - display_name: Label - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - AdWords recognizes labels, not custom events. When you - analytics.track(event, properties) an event that represents an AdWords - conversion, you'll need to map the event name to its corresponding label - here. - settings: [] - - name: conversionId - display_name: Conversion ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: You can opt to override the default conversion ID by setting one here - settings: [] - - name: remarketing - display_name: Send Remarketing Tag - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this to send a remarketing tag in addition to the conversion tag - (if you leave the label field blank only a remarketing tag will be sent) - settings: [] + string_validators: + regexp: '^GSN-\d{6}-[A-Z]$' + description: >- + You can find your Site Token by viewing the GoSquared [Integration + 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: [] + connection_modes: + device: + web: true + mobile: false + server: false + cloud: + web: true + mobile: true + server: true + previous_names: + - GoSquared +- display_name: Google Ads (Classic) + slug: google-ads-classic + name: catalog/destinations/adwords + description: >- + Advertise on Google and put your message in front of potential customers + right when they're searching for what you have to offer. + hidden: false + url: connections/destinations/catalog/google-ads-classic + status: PUBLIC + logo: + url: 'https://cdn.filepicker.io/api/file/O54PEswFQAC7ZZDLSBZ5' + mark: + url: '' + categories: + - Advertising + components: + - type: WEB + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: - name: linkId display_name: Link Id type: STRING @@ -7609,13 +7552,69 @@ items: 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 + deprecated: false + required: false + description: >- + Enable this to set Limit Ad Tracking to `true` when + context.device.adTrackingEnabled is `false`. + settings: [] + - name: eventMappings + display_name: Event Mappings + type: MIXED + deprecated: false + required: false + description: AdWords behavior for each of your Segment Events is defined here. + settings: + - name: eventName + display_name: Event Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Segment Event Name + settings: [] + - name: label + display_name: Label + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + AdWords recognizes labels, not custom events. When you + analytics.track(event, properties) an event that represents an AdWords + conversion, you'll need to map the event name to its corresponding label + here. + settings: [] + - name: conversionId + display_name: Conversion ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: You can opt to override the default conversion ID by setting one here + settings: [] + - name: remarketing + display_name: Send Remarketing Tag + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this to send a remarketing tag in addition to the conversion tag + (if you leave the label field blank only a remarketing tag will be sent) + settings: [] connection_modes: device: web: true mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -7645,6 +7644,17 @@ 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 @@ -7697,17 +7707,6 @@ items: conversions will be sent as remarketing hits which will allow you to create audiences based on those properties. settings: [] - - name: accountId - display_name: Google Conversion ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: ^AW-.+ - description: >- - Enter your GOOGLE-CONVERSION-ID. You can get this value from your global - site tag snippet. It should look something like `AW-901243031` - settings: [] connection_modes: device: web: true @@ -7749,48 +7748,76 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: anonymizeIp - display_name: Anonymize IP Addresses + - name: includeSearch + display_name: Include the Querystring in Page Views 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). + 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: enableServerIdentify - display_name: Enable Server Side Identify + - name: setAllMappedProps + display_name: Set Custom Dimensions & Metrics to the Page 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. + Google Analytics allows users to either pass custom dimensions / metrics + as properties of specific events or as properties for all events on a + given page (or the lifetime of the global tracker object). The default + Segment behavior is the latter. Any metrics / dimensions that are mapped + to a given property will be set to the page and sent as properties of all + subsequent events on that page. You can disable this functionality with + this setting. If disabled, Segment will only pass custom dimensions / + metrics as part of the payload of the event with which they are explicitly + associated. Please reference the Google Analytics + [documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets#implementation) + for more info. settings: [] - - name: reportUncaughtExceptions - display_name: Send Uncaught Exceptions to GA (Mobile) + - name: contentGroupings + display_name: Content Groupings + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 5 + map_prefix: contentGroup + select_options: [] + 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. + settings: [] + - name: enhancedLinkAttribution + display_name: Enable Enhanced Link Attribution type: BOOLEAN deprecated: false required: false description: >- - This lets you study errors and exceptions in your iOS and Android apps in - Google Analytics. + 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: resetCustomDimensionsOnPage - display_name: Reset dimensions on Page calls - type: LIST + - name: identifyCategory + display_name: Server Side Identify Event Category + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - If you have an SPA website, and need to reset custom dimensions between - page calls, add to this setting all the properties (already mapped as - custom dimensions) that need to be reset for each page call. + 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: trackNamedPages display_name: Track Named Pages @@ -7803,6 +7830,17 @@ items: `name` associated with them. E.g. `page('Signup')` translates to **Viewed Signup Page**. settings: [] + - name: typeOverride + display_name: Send Segment "Product List" Events to GA as "Event" Hits + type: BOOLEAN + deprecated: false + required: false + description: >- + By default, Segment sends "Product List Viewed" and "Product List + Filtered" ecommerce events to GA as "pageview" hit types. Enable this + setting to instead map these two specced Segment track events to GA as + "event" hit types. + settings: [] - name: useGoogleAmpClientId display_name: Use Google AMP Client ID type: BOOLEAN @@ -7820,92 +7858,58 @@ items: [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 + - name: dimensions + display_name: Custom Dimensions type: MAP deprecated: false required: false map_validators: regexp: '' min: 0 - max: 5 - map_prefix: contentGroup - select_options: [] - 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. - settings: [] - - name: ignoredReferrers - display_name: Ignored Referrers - type: MULTI_LINE_STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Add any domains you want to ignore, separated by line breaks. You might - use this if you want Google Analytics to ignore certain referral domains - (e.g. to prevent your subdomains from showing up as referrers in your - analytics). _Note: this only works for Classic profiles. Universal - profiles can_ [edit their ignored - referrers](https://support.google.com/analytics/answer/2795830?hl=en&ref_topic=2790009) - _directly inside Google Analytics._ - 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 - deprecated: false - required: false + max: 200 + map_prefix: dimension + select_options: [] description: >- - Tracks events to Google Analytics for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `category` associated with them. E.g. `page('Docs', 'Index')` translates - to **Viewed Docs Page**. + 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: identifyCategory - display_name: Server Side Identify Event Category + - name: optimize + display_name: Optimize Container ID type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - If you have **Enabled Server Side Identify**, you can specify the trait - you want to look up for setting the event category will be since all - custom metrics/dimensions for server side `.identify()` calls will be sent - via an event hit to GA. The default value will be `'All'`. For example, if - you are sending `traits.category`, you can put 'category' in the setting - above and we will send the value of this trait as the event category. + Integrate with Google Analytics Optimize plugin. Please enter your + Optimize Container ID settings: [] - - name: mobileTrackingId - display_name: Mobile Tracking ID - type: STRING + - name: resetCustomDimensionsOnPage + display_name: Reset dimensions on Page calls + type: LIST 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. + If you have an SPA website, and need to reset custom dimensions between + page calls, add to this setting all the properties (already mapped as + custom dimensions) that need to be reset for each page call. + settings: [] + - name: reportUncaughtExceptions + display_name: Send Uncaught Exceptions to GA (Mobile) + type: BOOLEAN + deprecated: false + required: false + description: >- + This lets you study errors and exceptions in your iOS and Android apps in + Google Analytics. settings: [] - name: serversideTrackingId display_name: Serverside Tracking ID @@ -7922,60 +7926,59 @@ items: 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 + - name: trackCategorizedPages + display_name: Track Categorized Pages 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. + Tracks events to Google Analytics for [`page` + method](https://segment.io/libraries/analytics.js#page) calls that have a + `category` associated with them. E.g. `page('Docs', 'Index')` translates + to **Viewed Docs Page**. settings: [] - - name: domain - display_name: Cookie Domain Name - type: STRING + - name: enableServerIdentify + display_name: Enable Server Side Identify + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '^none$|^[a-zA-Z0-9_-]+\.[.a-zA-Z0-9_-]+$' description: >- - _Only data sent from visitors on this domain_ will be recorded. By default - Google Analytics automatically resolves the domain name, so you should - **leave this blank unless you know you want otherwise**! This option is - useful if you need to ignore data from other domains, or explicitly set - the domain of your Google Analytics cookie. This is known as Override - Domain Name in [GA - Classic](https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingSite). - If you are testing locally, you can set the domain to `none`. [Read more - about this setting in our - docs](/docs/integrations/google-analytics/#cookie-domain-name). + 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: enhancedLinkAttribution - display_name: Enable Enhanced Link Attribution - type: BOOLEAN + - name: identifyEventName + display_name: Server Side Identify Event Action + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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). + If you have **Enabled Server Side Identify**, you can specify what the + event action will be since all custom metrics/dimensions for server side + `.identify()` calls will be sent via an event hit to GA. The default value + will be `'User Enriched'` settings: [] - - name: siteSpeedSampleRate - display_name: Site Speed Sample Rate - type: NUMBER + - name: ignoredReferrers + display_name: Ignored Referrers + type: MULTI_LINE_STRING deprecated: false required: false - number_validators: - min: 1 - max: 100 + string_validators: + regexp: '' description: >- - Defines the sample size for Site Speed data collection. If you have a - small number of visitors you might want to adjust the sampling to a larger - rate for your [site speed - stats](https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration?hl=en#_gat.GA_Tracker_._setSiteSpeedSampleRate). + Add any domains you want to ignore, separated by line breaks. You might + use this if you want Google Analytics to ignore certain referral domains + (e.g. to prevent your subdomains from showing up as referrers in your + analytics). _Note: this only works for Classic profiles. Universal + profiles can_ [edit their ignored + referrers](https://support.google.com/analytics/answer/2795830?hl=en&ref_topic=2790009) + _directly inside Google Analytics._ settings: [] - name: doubleClick display_name: 'Remarketing, Display Ads and Demographic Reports.' @@ -7984,51 +7987,58 @@ items: required: false description: Works with both Universal and Classic tracking methods. settings: [] - - name: nameTracker - display_name: Name Tracker + - name: serversideClassic + display_name: Use Classic Analytics for Your Serverside Tracking type: BOOLEAN deprecated: false required: false description: >- - Name the tracker 'segmentGATracker'. Enable this if you're working with - additional Google Analytics trackers and want to ensure that your Segment - tracker has a distinct name. If this is enabled you must prepend this - tracker name to any native Google Analytics (except for create) that you - call, e.g. 'segmentGATracker.require(....)' + **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: optimize - display_name: Optimize Container ID - type: STRING + - name: anonymizeIp + display_name: Anonymize IP Addresses + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - Integrate with Google Analytics Optimize plugin. Please enter your - Optimize Container ID + 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: enhancedEcommerce - display_name: Enable Enhanced Ecommerce + - name: classic + display_name: Use Classic Analytics on Your Site 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). + **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: identifyEventName - display_name: Server Side Identify Event Action - type: STRING + - name: protocolMappings + display_name: Map Traits or Properties to Measurement Protocol Params + type: MAP deprecated: false required: false - string_validators: + map_validators: regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - plt + - pdt + - gclid 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'` + 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: nonInteraction display_name: Add the non-interaction flag to all events @@ -8040,43 +8050,19 @@ items: 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 - type: BOOLEAN - deprecated: false - required: false - description: >- - Google Analytics allows users to either pass custom dimensions / metrics - as properties of specific events or as properties for all events on a - given page (or the lifetime of the global tracker object). The default - Segment behavior is the latter. Any metrics / dimensions that are mapped - to a given property will be set to the page and sent as properties of all - subsequent events on that page. You can disable this functionality with - this setting. If disabled, Segment will only pass custom dimensions / - metrics as part of the payload of the event with which they are explicitly - associated. Please reference the Google Analytics - [documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/custom-dims-mets#implementation) - for more info. - settings: [] - - name: sendUserId - display_name: Send User-ID to GA - type: BOOLEAN + - name: siteSpeedSampleRate + display_name: Site Speed Sample Rate + type: NUMBER deprecated: false required: false + number_validators: + min: 1 + max: 100 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. + Defines the sample size for Site Speed data collection. If you have a + small number of visitors you might want to adjust the sampling to a larger + rate for your [site speed + stats](https://developers.google.com/analytics/devguides/collection/gajs/methods/gaJSApiBasicConfiguration?hl=en#_gat.GA_Tracker_._setSiteSpeedSampleRate). settings: [] - name: trackingId display_name: Website Tracking ID @@ -8090,39 +8076,24 @@ items: Page](https://www.google.com/analytics/web/#management/Property) of Google Analytics. Leave it blank if you don't have a website property. settings: [] - - name: typeOverride - display_name: Send Segment "Product List" Events to GA as "Event" Hits - type: BOOLEAN - deprecated: false - required: false - description: >- - By default, Segment sends "Product List Viewed" and "Product List - Filtered" ecommerce events to GA as "pageview" hit types. Enable this - setting to instead map these two specced Segment track events to GA as - "event" hit types. - settings: [] - - name: dimensions - display_name: Custom Dimensions - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 200 - map_prefix: dimension - select_options: [] + - name: domain + display_name: Cookie Domain Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^none$|^[a-zA-Z0-9_-]+\.[.a-zA-Z0-9_-]+$' 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! + _Only data sent from visitors on this domain_ will be recorded. By default + Google Analytics automatically resolves the domain name, so you should + **leave this blank unless you know you want otherwise**! This option is + useful if you need to ignore data from other domains, or explicitly set + the domain of your Google Analytics cookie. This is known as Override + Domain Name in [GA + Classic](https://developers.google.com/analytics/devguides/collection/gajs/gaTrackingSite). + If you are testing locally, you can set the domain to `none`. [Read more + about this setting in our + docs](/docs/integrations/google-analytics/#cookie-domain-name). settings: [] - name: metrics display_name: Custom Metrics @@ -8147,24 +8118,41 @@ items: hit-scoped metrics for properties. [Contact us](https://segment.com/contact) if you need help! settings: [] - - name: protocolMappings - display_name: Map Traits or Properties to Measurement Protocol Params - type: MAP + - name: mobileTrackingId + display_name: Mobile Tracking ID + type: STRING deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: - - plt - - pdt - - gclid + string_validators: + regexp: ^UA-\d+-\d+$ 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). + 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: enhancedEcommerce + display_name: Enable Enhanced Ecommerce + 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). + settings: [] + - name: nameTracker + display_name: Name Tracker + type: BOOLEAN + deprecated: false + required: false + description: >- + Name the tracker 'segmentGATracker'. Enable this if you're working with + additional Google Analytics trackers and want to ensure that your Segment + tracker has a distinct name. If this is enabled you must prepend this + tracker name to any native Google Analytics (except for create) that you + call, e.g. 'segmentGATracker.require(....)' settings: [] - name: sampleRate display_name: Sample Rate @@ -8181,6 +8169,17 @@ items: here](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#sampleRate). Currently only available in the browser - mobile coming soon. settings: [] + - name: sendUserId + display_name: Send User-ID to GA + type: BOOLEAN + 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: [] connection_modes: device: web: true @@ -8241,7 +8240,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -8317,19 +8316,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: environment - display_name: Environment - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - If you're using an 'environment' variable for gtm_preview in your tag's - query string, you can put that string here. **IMPORTANT**: make sure the - string includes `gtm_auth`. For example, your string should look like - `env-xx>m_auth=xxxxxx` - settings: [] - name: trackAllPages display_name: Track All Pages type: BOOLEAN @@ -8373,6 +8359,19 @@ items: 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 + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you're using an 'environment' variable for gtm_preview in your tag's + query string, you can put that string here. **IMPORTANT**: make sure the + string includes `gtm_auth`. For example, your string should look like + `env-xx>m_auth=xxxxxx` + settings: [] connection_modes: device: web: true @@ -8423,7 +8422,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -8454,15 +8453,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^.{8,}$' - description: You can find your API key under Settings. - settings: [] - name: environment display_name: Environment type: STRING @@ -8481,6 +8471,15 @@ items: regexp: '' description: The name of your workspace settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: You can find your API key under Settings. + settings: [] connection_modes: device: web: false @@ -8536,7 +8535,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -8633,7 +8632,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -8710,6 +8709,19 @@ 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 + + + *This has been deprecated by Hotjar* + settings: [] - name: hjid display_name: Site ID type: STRING @@ -8721,16 +8733,6 @@ 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 @@ -8770,18 +8772,6 @@ 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 @@ -8814,13 +8804,25 @@ 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 mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -8869,7 +8871,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -8931,7 +8933,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -9149,7 +9151,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -9247,7 +9249,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -9278,6 +9280,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: >- + Enter your S3 credentials or your Azure Blob Storage Shared Access + Signature (SAS). + settings: [] - name: bucketContainerUrl display_name: BUCKET CONTAINER URL type: STRING @@ -9298,17 +9311,6 @@ items: regexp: '' description: Enter 'AWS' or 'Azure' settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^.{8,}$' - description: >- - Enter your S3 credentials or your Azure Blob Storage Shared Access - Signature (SAS). - settings: [] connection_modes: device: web: false @@ -9351,23 +9353,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: collectContext - display_name: Include Context with Identify Calls - type: BOOLEAN - deprecated: false - required: false - description: >- - Pass context data with Identify calls as Custom Attributes. Includes - device.type, device.manufacturer, device.model, os.name, os.version, - app.name, app.version - settings: [] - - name: isBulkAPIEnabled - display_name: isBulkAPIEnabled - type: BOOLEAN - deprecated: false - required: false - description: '' - settings: [] - name: mobileApiKey display_name: Enter your Mobile API Key type: STRING @@ -9425,19 +9410,36 @@ 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 + - 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 + deprecated: false + required: false + description: >- + Pass context data with Identify calls as Custom Attributes. Includes + device.type, device.manufacturer, device.model, os.name, os.version, + app.name, app.version + settings: [] + - name: isBulkAPIEnabled + display_name: isBulkAPIEnabled + type: BOOLEAN 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.` + description: '' settings: [] connection_modes: device: @@ -9445,7 +9447,7 @@ items: mobile: true server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -9475,15 +9477,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: endpoint - display_name: Endpoint - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Your Iron.io API endpoint. - settings: [] - name: projectId display_name: Project ID type: STRING @@ -9504,13 +9497,22 @@ items: regexp: '^[\da-zA-Z-_]+$' description: You can find your token under the IronMQ settings for your project. settings: [] + - name: endpoint + display_name: Endpoint + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Iron.io API endpoint. + settings: [] connection_modes: device: web: false mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -9542,27 +9544,6 @@ 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 @@ -9590,13 +9571,34 @@ 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 mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -9628,17 +9630,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-z0-9]{40}$' - description: >- - You can find your API Key on the Kissmetrics [Settings - page](https://www.kissmetrics.com/settings). - settings: [] - name: prefixProperties display_name: Prefix Properties type: BOOLEAN @@ -9660,13 +9651,24 @@ items: required: false description: Send an event for every page with a name. settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-z0-9]{40}$' + description: >- + You can find your API Key on the Kissmetrics [Settings + page](https://www.kissmetrics.com/settings). + settings: [] connection_modes: device: web: true mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -9739,7 +9741,7 @@ items: mobile: true server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -9771,35 +9773,16 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true 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: urlAddon - display_name: URL Parsing Addon + - name: trackNamedPages + display_name: Track Named Pages to Keen 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. + This will track events to Keen 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: writeKey display_name: Write Key @@ -9812,28 +9795,25 @@ items: Your write key should be a minimum of 32 characters long and made up of numbers and letters only. settings: [] - - name: projectId - display_name: Project ID - type: STRING + - name: initialPageview + display_name: Track an Initial Pageview + type: BOOLEAN deprecated: false - required: true - string_validators: - regexp: '' + required: false description: >- - Your project ID. It should be 24 characters long, and look something like - this: `9181bcd23843312d87000000`. + This will send an intial 'Loaded a Page' event to Keen when the page is + loaded. We disable this by default since Keen is generally used for custom + event tracking, not pageviews. _Note: you must also have the **Send + Pageview Events** setting enabled for this to work._ settings: [] - - name: readKey - display_name: Read Key - type: STRING + - name: ipAddon + display_name: Geo IP Addon + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - If you are a Keen Pro user, enter your read key in the advanced settings - tab of your dashboard. It should be a minimum of 32 characters long and - made up of numbers and letters only. + Enable this to use Keen's data enrichment feature to add geographic + information based on IP. settings: [] - name: referrerAddon display_name: Referrer Parsing Addon @@ -9864,16 +9844,28 @@ 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 Keen - type: BOOLEAN + - name: projectId + display_name: Project ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your project ID. It should be 24 characters long, and look something like + this: `9181bcd23843312d87000000`. + settings: [] + - name: readKey + display_name: Read Key + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - This will track events to Keen 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**. + If you are a Keen Pro user, enter your read key in the advanced settings + tab of your dashboard. It should be a minimum of 32 characters long and + made up of numbers and letters only. settings: [] - name: uaAddon display_name: UserAgent Addon @@ -9882,6 +9874,16 @@ 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 @@ -9943,7 +9945,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -9975,6 +9977,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: listId + display_name: List ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + 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 @@ -10049,24 +10062,13 @@ items: only be enabled if you are experiencing an issue with duplicate profiles being created inside Klaviyo. settings: [] - - name: listId - display_name: List ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Insert the ID of the default list that you'd like to subscribe users to - when you call `.identify()`. - settings: [] connection_modes: device: web: true mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -10159,7 +10161,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -10305,7 +10307,7 @@ items: mobile: true server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -10378,15 +10380,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: email - display_name: email - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: This should be the email you signed up for your Librato account with. - settings: [] - name: token display_name: Token type: STRING @@ -10398,13 +10391,22 @@ items: You can find your API Token on the Librato [Account page](https://metrics.librato.com/tokens). settings: [] + - name: email + display_name: email + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: This should be the email you signed up for your Librato account with. + settings: [] connection_modes: device: web: false mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -10555,6 +10557,18 @@ 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 @@ -10618,18 +10632,6 @@ 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 @@ -10815,7 +10817,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -10842,17 +10844,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-z0-9]+-[a-z0-9]+$' - description: >- - You create and copy-paste your MailChimp API Key from Account Settings > - Extras > API Keys. - settings: [] - name: datacenter display_name: Datacenter ID type: STRING @@ -10886,13 +10877,24 @@ items: 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 + deprecated: false + required: true + string_validators: + regexp: '^[a-z0-9]+-[a-z0-9]+$' + description: >- + You create and copy-paste your MailChimp API Key from Account Settings > + Extras > API Keys. + settings: [] connection_modes: device: web: false mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -10947,7 +10949,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -10991,7 +10993,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -11021,41 +11023,41 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true 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: [] - - 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: [] connection_modes: device: @@ -11122,24 +11124,6 @@ items: these fields to map your Segment track event names to Marketo Custom Activities. We'll only send events that you specify. settings: - - name: event - display_name: Segment Event Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter the Segment Event Name. - settings: [] - - name: marketoActivityId - display_name: Marketo Custom Activity ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[0-9]+$' - description: Enter the Marketo Custom Activity ID. This must be an Integer. - settings: [] - name: segmentProperty display_name: Marketo Fields type: MIXED @@ -11147,13 +11131,6 @@ 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 @@ -11189,6 +11166,31 @@ 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: event + display_name: Segment Event Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter the Segment Event Name. + settings: [] + - name: marketoActivityId + display_name: Marketo Custom Activity ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[0-9]+$' + description: Enter the Marketo Custom Activity ID. This must be an Integer. + settings: [] - name: privateKey display_name: API Private Key type: STRING @@ -11344,6 +11346,19 @@ 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 @@ -11398,19 +11413,6 @@ 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 @@ -11464,7 +11466,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -11497,87 +11499,14 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: token - display_name: Token - type: STRING - deprecated: false - required: true - 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). - settings: [] - - name: trackAllPages - display_name: Track All 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. - settings: [] - - name: apiKey - display_name: API Secret - type: STRING - 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). - settings: [] - - name: crossSubdomainCookie - display_name: Cross Subdomain Cookie - type: BOOLEAN - deprecated: false - required: false - description: >- - This will allow the Mixpanel cookie to persist between different pages of - your application. - settings: [] - - name: groupIdentifierTraits - display_name: Group Identifier Traits - type: LIST - deprecated: false - required: false - description: >- - What trait Segment should use as your Mixpanel "group key" in group calls. - If, for example, you set this to be `company`, then "company" will be sent - as `group_key` and the value of `traits["company"]` will be sent as the - `group_id`. - settings: [] - - name: legacySuperProperties - display_name: Legacy Super Properties - type: BOOLEAN - deprecated: false - required: false - description: >- - We used to add $ to mixpanel traits as super properties. This fixes that: - https://github.com/segmentio/integrations/pull/124/files - settings: [] - - name: propIncrements - display_name: Properties to increment in People - type: LIST - deprecated: false - required: false - description: >- - If you want to see and segment by event counts and last event date in - Mixpanel people, enable people, and then list the events you want to see - in People here. - settings: [] - - name: trackCategorizedPages - display_name: Track Categorized Pages to Mixpanel + - name: secureCookie + display_name: Secure Cookie 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**. + This will mark the Mixpanel cookie as secure, meaning it will only be + transmitted over https settings: [] - name: sourceName display_name: Source Name @@ -11590,26 +11519,26 @@ items: This value, if it's not blank, will be sent as `segment_source_name` to Mixpanel for every `event`/`page`/`screen` call. settings: [] - - name: superProperties - display_name: Properties to send as Super Properties - type: LIST + - name: token + display_name: Token + type: STRING deprecated: false - required: false + required: true + string_validators: + regexp: '^[a-f0-9]{32}$' description: >- - If you want to see and segment by Super Properties in Mixpanel, then list - the properties you want to see as Super Properties here. + You can find your token under **Account** 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: trackAllPages + display_name: Track All 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 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. + method](https://segment.io/libraries/analytics.js#page) calls. We keep + this disabled by default. settings: [] - name: eventIncrements display_name: Events to increment in People @@ -11624,6 +11553,26 @@ items: 2. List the events you want to see in People here. settings: [] + - name: groupTraitsToSetOnce + display_name: Group Traits to Set Once + type: LIST + deprecated: false + required: false + description: Group traits to be set only once using Mixpanel's `$set_once` operator. + settings: [] + - name: persistence + display_name: Persistence Type + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - cookie + - localStorage + description: >- + This will allow the Mixpanel cookie to persist between different pages of + your application. + settings: [] - name: trackNamedPages display_name: Track Named Pages to Mixpanel type: BOOLEAN @@ -11635,12 +11584,46 @@ items: `name` associated with them. For example `page('Signup')` would translate to **Viewed Signup Page**. settings: [] - - name: groupTraitsToSetOnce - display_name: Group Traits to Set Once + - name: apiKey + display_name: API Secret + type: STRING + 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). + settings: [] + - name: groupIdentifierTraits + display_name: Group Identifier Traits type: LIST deprecated: false required: false - description: Group traits to be set only once using Mixpanel's `$set_once` operator. + description: >- + What trait Segment should use as your Mixpanel "group key" in group calls. + If, for example, you set this to be `company`, then "company" will be sent + as `group_key` and the value of `traits["company"]` will be sent as the + `group_id`. + settings: [] + - name: setAllTraitsByDefault + display_name: Automatically set all Traits as Super Properties and People Properties + type: BOOLEAN + deprecated: false + required: false + description: >- + While this is checked, our integration automatically sets all traits on + identify calls as super properties and people properties if Mixpanel + People is checked as well. + settings: [] + - name: enableEuropeanUnionEndpoint + display_name: Enable European Union Endpoint + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this setting to send your events to Mixpanel's [EU + endpoint](https://developer.mixpanel.com/docs/implement-mixpanel#section-implementing-mixpanel-in-the-european-union-eu). settings: [] - name: people display_name: Use Mixpanel People @@ -11665,37 +11648,65 @@ items: - List the traits you want to see in People here. settings: [] - - name: persistence - display_name: Persistence Type - type: SELECT + - 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: [] + - name: superProperties + display_name: Properties to send as Super Properties + type: LIST + deprecated: false + required: false + description: >- + If you want to see and segment by Super Properties in Mixpanel, then list + the properties you want to see as Super Properties here. + settings: [] + - name: consolidatedPageCalls + display_name: Track All Pages to Mixpanel with a Consolidated Event Name + 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. + settings: [] + - name: crossSubdomainCookie + display_name: Cross Subdomain Cookie + type: BOOLEAN deprecated: false required: false - select_validators: - select_options: - - cookie - - localStorage description: >- This will allow the Mixpanel cookie to persist between different pages of your application. settings: [] - - name: secureCookie - display_name: Secure Cookie + - name: legacySuperProperties + display_name: Legacy Super Properties type: BOOLEAN deprecated: false required: false description: >- - This will mark the Mixpanel cookie as secure, meaning it will only be - transmitted over https + We used to add $ to mixpanel traits as super properties. This fixes that: + https://github.com/segmentio/integrations/pull/124/files settings: [] - - name: setAllTraitsByDefault - display_name: Automatically set all Traits as Super Properties and People Properties - type: BOOLEAN + - name: propIncrements + display_name: Properties to increment in People + type: LIST deprecated: false required: false description: >- - While this is checked, our integration automatically sets all traits on - identify calls as super properties and people properties if Mixpanel - People is checked as well. + If you want to see and segment by event counts and last event date in + Mixpanel people, enable people, and then list the events you want to see + in People here. settings: [] connection_modes: device: @@ -11951,7 +11962,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -12100,7 +12111,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -12149,7 +12160,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -12179,6 +12190,39 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: fbAppId + display_name: Facebook App ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + You can find your Facebook App ID in your Nanigans pixel; it's the xxx + part of the fb_app_id=xxx parameter. + settings: [] + - name: isMobile + display_name: Send Events to Mobile Endpoint + type: BOOLEAN + deprecated: false + required: false + description: >- + Select this option to send your data to Nanigans' mobile endpoint. Most + projects (even mobile ones) don't need this option enabled; if you're + unsure, check with your Nanigans contact. Note that if you set this + option, you must also set your Facebook App ID. + settings: [] + - name: appId + display_name: App ID + type: STRING + 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 @@ -12188,17 +12232,6 @@ items: Use these fields to map your Segment event names to Nanigans event names. We'll only send Nanigans the conversion events you specify. settings: - - name: event - display_name: Segment Event Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Our Nanigans integration allows you to map the event names you track in - Segment to Nanigans events of name and type. - settings: [] - name: name display_name: Nanigans Event Name type: STRING @@ -12233,46 +12266,24 @@ items: Nanigans. Email [friends@segment.com](mailto:friends@segment.com) if you need help! settings: [] - - name: fbAppId - display_name: Facebook App ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - You can find your Facebook App ID in your Nanigans pixel; it's the xxx - part of the fb_app_id=xxx parameter. - settings: [] - - name: isMobile - display_name: Send Events to Mobile Endpoint - type: BOOLEAN - deprecated: false - required: false - description: >- - Select this option to send your data to Nanigans' mobile endpoint. Most - projects (even mobile ones) don't need this option enabled; if you're - unsure, check with your Nanigans contact. Note that if you set this - option, you must also set your Facebook App ID. - settings: [] - - name: appId - display_name: App ID - type: STRING - 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: event + display_name: Segment Event Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Our Nanigans integration allows you to map the event names you track in + Segment to Nanigans events of name and type. + settings: [] connection_modes: device: web: true mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -12301,6 +12312,18 @@ 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 @@ -12327,25 +12350,13 @@ 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 mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -12374,26 +12385,26 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: memberId - display_name: Member ID + - name: projectId + display_name: Project ID type: STRING deprecated: false required: true string_validators: regexp: '^[0-9]+$' description: >- - You can find your Member ID in your Navilytics [code settings + You can find your Project ID in your Navilytics [code settings page](https://www.navilytics.com/member/code_settings). settings: [] - - name: projectId - display_name: Project ID + - name: memberId + display_name: Member ID type: STRING deprecated: false required: true string_validators: regexp: '^[0-9]+$' description: >- - You can find your Project ID in your Navilytics [code settings + You can find your Member ID in your Navilytics [code settings page](https://www.navilytics.com/member/code_settings). settings: [] connection_modes: @@ -12432,6 +12443,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: accountId + display_name: Account ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your New Relic Insights account ID + settings: [] + - name: defaultEventType + display_name: Custom Default Event Type + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + By default the eventType for any unmapped track events will be sent as + '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 @@ -12469,34 +12501,13 @@ items: If you want to send your Segment `userId` and `anonymousId`, enabling this option will do so. settings: [] - - name: accountId - display_name: Account ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Your New Relic Insights account ID - settings: [] - - name: defaultEventType - display_name: Custom Default Event Type - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - By default the eventType for any unmapped track events will be sent as - 'Segment'. You can define another custom eventType name to be used instead - of that here. - settings: [] connection_modes: device: web: false mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -12526,6 +12537,33 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: subbrandPropertyName + display_name: Subbrand Property Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + By default, clientid and subbrand are setup in Nielsen backend + configuration to capture brand and sub-brand information. The fields get + populated from backend for a registered client appid. But if an app + contains multiple brands and sub-brands and client is willing to give + credit to another brand or sub-brand then please indicate which property + value from your payload you want to use to override `subbrand`. + settings: [] + - name: adAssetIdPropertyName + display_name: Custom Ad Asset Id 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. + settings: [] - name: appId display_name: AppID type: STRING @@ -12535,17 +12573,20 @@ items: regexp: '' description: Enter your Nielsen DCR App ID. settings: [] - - name: contentAssetIdPropertyName - display_name: Custom Content Asset Id Property Name + - name: clientIdPropertyName + display_name: Client Id 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 content 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 `clientId`. settings: [] - name: contentLengthPropertyName display_name: Content Length Property Name @@ -12570,8 +12611,8 @@ items: Note: DO NOT: activate the Debug flag in a production environment. settings: [] - - name: adAssetIdPropertyName - display_name: Custom Ad Asset Id Property Name + - name: contentAssetIdPropertyName + display_name: Custom Content Asset Id Property Name type: STRING deprecated: false required: false @@ -12579,23 +12620,8 @@ 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 ad asset ids please - indicate the name of the property here. - settings: [] - - name: clientIdPropertyName - display_name: Client Id 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`. + you would like to set up a custom property mapping for content asset ids + please indicate the name of the property here. settings: [] - name: instanceName display_name: Instance Name @@ -12617,21 +12643,6 @@ items: By default we will use production mode. Uncheck this setting if you are developing or testing this integration. settings: [] - - name: subbrandPropertyName - display_name: Subbrand Property Name - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - By default, clientid and subbrand are setup in Nielsen backend - configuration to capture brand and sub-brand information. The fields get - populated from backend for a registered client appid. But if an app - contains multiple brands and sub-brands and client is willing to give - credit to another brand or sub-brand then please indicate which property - value from your payload you want to use to override `subbrand`. - settings: [] connection_modes: device: web: true @@ -12688,7 +12699,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -12746,7 +12757,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -12776,6 +12787,32 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: page + display_name: Log pageviews to the Olark chat console + type: BOOLEAN + deprecated: false + required: false + description: Log pageviews to the Olark chat console + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: ^\d+-\d+-\d+-\d+$ + description: >- + You can find your Site ID on the [Olark Install + page](https://www.olark.com/install?r=qhl4tltg). It should look something + like this: `9385-174-10-1457`. + settings: [] + - name: track + display_name: Log custom events from analytics.track() to the Olark chat console + type: BOOLEAN + deprecated: false + required: false + description: Log custom events from analytics.track() to the Olark chat console + settings: [] - name: groupId display_name: Group ID type: STRING @@ -12812,32 +12849,6 @@ items: Automatically send Live Chat message events, conversation starts and ends to other tools you have enabled. settings: [] - - name: page - display_name: Log pageviews to the Olark chat console - type: BOOLEAN - deprecated: false - required: false - description: Log pageviews to the Olark chat console - settings: [] - - name: siteId - display_name: Site ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: ^\d+-\d+-\d+-\d+$ - description: >- - You can find your Site ID on the [Olark Install - page](https://www.olark.com/install?r=qhl4tltg). It should look something - like this: `9385-174-10-1457`. - settings: [] - - name: track - display_name: Log custom events from analytics.track() to the Olark chat console - type: BOOLEAN - deprecated: false - required: false - description: Log custom events from analytics.track() to the Olark chat console - settings: [] connection_modes: device: web: true @@ -12918,29 +12929,20 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: - - name: accountId - display_name: Account ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - In order to use Optimizely X via _server side_, you must enter your - **Account ID** from your Optimizely account. You can find this ID by - visiting https://app.optimizely.com/v2/accountsettings/account/plan - settings: [] - - name: datafileUrl - display_name: Datafile URL - type: STRING + - name: cacheExp + display_name: Cache Exp + type: NUMBER deprecated: false required: false - string_validators: - regexp: '' + number_validators: + min: 300 + max: 0 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` + 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: listen display_name: >- @@ -12974,15 +12976,6 @@ items: activateExperiment:False]; ``` settings: [] - - name: nonInteraction - display_name: >- - Specifies the Experiment Viewed as a non-interaction event for Google - Analytics - type: BOOLEAN - deprecated: false - required: false - description: Send `Experiment Viewed` as a non-interaction event - settings: [] - name: useOptimizely3 display_name: Use Optimizely 3 type: BOOLEAN @@ -13007,20 +13000,17 @@ 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: cacheExp - display_name: Cache Exp - type: NUMBER + - name: datafileUrl + display_name: Datafile URL + type: STRING deprecated: false required: false - number_validators: - min: 300 - max: 0 + string_validators: + regexp: '' 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). + In order to use Optimizely X _server side_, you must enter the entire URL + for your datafile. It should look something like + `https://cdn.optimizely.com/json/9218021209.json` settings: [] - name: fallbackToAnonymousId display_name: Fall Back To Anonymous Id @@ -13029,6 +13019,15 @@ items: required: false description: Optionally fall back to `anonymousId` when `userId` is not present. settings: [] + - name: nonInteraction + display_name: >- + Specifies the Experiment Viewed as a non-interaction event for Google + Analytics + type: BOOLEAN + deprecated: false + required: false + description: Send `Experiment Viewed` as a non-interaction event + settings: [] - name: trackKnownUsers display_name: Only Track Known Users type: BOOLEAN @@ -13049,6 +13048,18 @@ items: Enable this if you want the server side integration to use User ID instead of anonymous ID in your identify calls 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: [] connection_modes: device: web: false @@ -13091,6 +13102,35 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: nonInteraction + display_name: Send `Experiment Viewed` as a non-interaction event + type: BOOLEAN + deprecated: false + required: false + description: >- + Specifies the `Experiment Viewed` as a non-interaction event for Google + Analytics + settings: [] + - name: sendRevenueOnlyForOrderCompleted + display_name: Send `properties.revenue` only on `Order Completed` events (recommended) + type: BOOLEAN + deprecated: false + required: false + description: >- + This is Optimizely expected behavior. This will send revenue only on + `Order Completed` events. + settings: [] + - name: trackCategorizedPages + display_name: Track Categorized 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 a + `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 @@ -13112,43 +13152,48 @@ items: 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 - deprecated: false - required: false - description: >- - Sends the experiment and variation information as properties on a track - call. - settings: [] - - name: nonInteraction - display_name: Send `Experiment Viewed` as a non-interaction event - type: BOOLEAN + - name: customCampaignProperties + display_name: Custom Campaign Properties + type: MAP deprecated: false required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: [] description: >- - Specifies the `Experiment Viewed` as a non-interaction event for Google - Analytics + Map here the properties from your event that want to pass to Optimizely as + part of the Campaign. The keys for the map correspond to Segment's + properties, and the values the Campaign properties. For example, `source + -> campaign_name`. settings: [] - - name: sendRevenueOnlyForOrderCompleted - display_name: Send `properties.revenue` only on `Order Completed` events (recommended) - type: BOOLEAN + - name: customExperimentProperties + display_name: Custom Experiment Properties + type: MAP deprecated: false required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: [] description: >- - This is Optimizely expected behavior. This will send revenue only on - `Order Completed` events. + Map here the properties from your event that want to pass to Optimizely as + part of the Experiment. The keys for the map correspond to Segment's + properties, and the values the Experiment properties. For example, `color + -> experiment_color`. settings: [] - - name: trackCategorizedPages - display_name: Track Categorized Pages + - name: listen + display_name: Send experiment data to other tools (as a track call) 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 a - `category` associated with them. For example `page('Docs', 'Index')` would - translate to **Viewed Docs Page**. + Sends the experiment and variation information as properties on a track + call. settings: [] connection_modes: device: @@ -13187,6 +13232,52 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: piCId + display_name: Campaign ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: ^\d+$ + description: >- + This setting is only used in the client side `analytics.js` integration + with Pardot and will not be used if you are sending data from a server + side source. You can find your Campaign ID (or `piCId`) under **Marketing + > Campaigns** in your [Pardot account](https://pi.pardot.com/campaign). + After selecting your desired website campaign, press **View Tracking + Code**. Note: you can still use a URL query parameter of `pi_campaign_id` + to override this on specific pages. + settings: [] + - name: userKey + display_name: User Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^[a-f0-9]{32}$' + description: >- + You can find your User Key on under **User Settings** in your [Pardot + account](https://pi.pardot.com/account). + settings: [] + - name: apiVersion + display_name: API Version + type: SELECT + 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 @@ -13249,59 +13340,13 @@ items: in your [Pardot account](https://pi.pardot.com/campaign). After selecting your desired website campaign, press **View Tracking Code**. settings: [] - - name: piCId - display_name: Campaign ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: ^\d+$ - description: >- - This setting is only used in the client side `analytics.js` integration - with Pardot and will not be used if you are sending data from a server - side source. You can find your Campaign ID (or `piCId`) under **Marketing - > Campaigns** in your [Pardot account](https://pi.pardot.com/campaign). - After selecting your desired website campaign, press **View Tracking - Code**. Note: you can still use a URL query parameter of `pi_campaign_id` - to override this on specific pages. - settings: [] - - name: userKey - display_name: User Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^[a-f0-9]{32}$' - description: >- - You can find your User Key on under **User Settings** in your [Pardot - account](https://pi.pardot.com/account). - settings: [] - - name: apiVersion - display_name: API Version - type: SELECT - 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 mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -13331,26 +13376,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: Domain - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Parsely's required API Key should be your website domain. (ie. - segment.com) - settings: [] - - name: customMapping - display_name: Map Custom Page Properties - type: MAP - deprecated: false - required: false - description: >- - Map your custom `.page()` property names on the left and semantic Parsely - properties on the right. - settings: [] - name: dynamicTracking display_name: Enable Dynamic Tracking type: BOOLEAN @@ -13383,6 +13408,26 @@ items: here](https://www.parsely.com/help/integration/dynamic/) for more information. settings: [] + - name: apiKey + display_name: Domain + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Parsely's required API Key should be your website domain. (ie. + segment.com) + settings: [] + - name: customMapping + display_name: Map Custom Page Properties + type: MAP + deprecated: false + required: false + description: >- + Map your custom `.page()` property names on the left and semantic Parsely + properties on the right. + settings: [] connection_modes: device: web: true @@ -13539,7 +13584,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -13637,7 +13682,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -13812,26 +13857,6 @@ 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 @@ -13854,6 +13879,26 @@ 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 @@ -13963,7 +14008,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -14052,7 +14097,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -14098,7 +14143,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -14146,7 +14191,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -14177,6 +14222,16 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: track + display_name: Record Events to Qualaroo + type: BOOLEAN + deprecated: false + required: false + description: >- + By default Qualaroo only records a user's traits, not the events they + trigger. If you'd like target a survey at users who've triggered a certain + event, you'll want to enable this setting. + settings: [] - name: customerId display_name: Customer ID type: STRING @@ -14201,16 +14256,6 @@ items: Javascript library URL. So if your URL is: `s3.amazonaws.com/ki.js/37282/9F2.js`, your Site Token would be: `9F2`. settings: [] - - name: track - display_name: Record Events to Qualaroo - type: BOOLEAN - deprecated: false - required: false - description: >- - By default Qualaroo only records a user's traits, not the events they - trigger. If you'd like target a survey at users who've triggered a certain - event, you'll want to enable this setting. - settings: [] connection_modes: device: web: true @@ -14381,7 +14426,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -14524,23 +14569,23 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key + - name: organization_id + display_name: Organization Id type: STRING deprecated: false required: false string_validators: regexp: '' - description: Your Ramen API key for the server-side integration + description: Your Ramen organization id settings: [] - - name: organization_id - display_name: Organization Id + - name: apiKey + display_name: API Key type: STRING deprecated: false required: false string_validators: regexp: '' - description: Your Ramen organization id + description: Your Ramen API key for the server-side integration settings: [] connection_modes: device: @@ -14548,7 +14593,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -14602,7 +14647,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -14649,7 +14694,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -14691,7 +14736,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -14721,6 +14766,95 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: optin + display_name: Set Default Permission Setting to OPTIN + type: BOOLEAN + deprecated: false + required: false + description: >- + Choose whether records added to Profile Lists should be `'OPTIN'` rather + than the default `'OPTOUT'` + settings: [] + - name: petName + display_name: Profile Extension Table + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Please enter the name of your default Profile Extension Table. + settings: [] + - name: pod + display_name: Pod + type: SELECT + deprecated: false + required: true + select_validators: + select_options: + - '2' + - '5' + - '8' + - '9' + description: >- + The pod that hosts your Responsys account. Simply check your url during + your login screen. This is required to any requests to your account. The + default is `interact2`. + settings: [] + - name: folderName + display_name: Folder Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Please enter the default Folder Name that holds the provided Profile List + and Profile Extension Table. + settings: [] + - name: optOutEmailTrait + display_name: Email Permission Status Trait Mapping + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Please enter the trait you would like to be mapped to + `EMAIL_PEERMISSION_STATUS_`. This will allow you to track users who opt in + and out of marketing communications in your apps and websites. The value + of this trait MUST be a boolean. + settings: [] + - name: optOutMobileTrait + display_name: Mobile Permission Status Trait Mapping + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Please enter the trait youw would like to be mapped to + MOBILE_PERMISSION_STATUS_. This will allow you to track users who opt in + and out of marketing communications in your apps and websites. The value + of this trait MUST be a boolean. + settings: [] + - name: password + display_name: Password + type: PASSWORD + deprecated: false + required: true + string_validators: + regexp: '' + description: Please enter your account's password. + settings: [] + - name: username + display_name: Username + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Please enter your account's username. + settings: [] - name: events display_name: Events type: MIXED @@ -14730,27 +14864,6 @@ 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 - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter the Segment Event Name. - settings: [] - name: suppName display_name: Responsys Supplemental Table Name type: STRING @@ -14780,13 +14893,6 @@ items: required: false description: Map your Segment properties to Responsys Columns settings: - - name: primaryKey - display_name: Set as Primary Key - type: BOOLEAN - deprecated: false - required: false - description: Mark this property as a Primary Key in Responsys. - settings: [] - name: columns display_name: Segment Property Name type: STRING @@ -14822,6 +14928,13 @@ items: - TIMESTAMP description: Enter the Responsys column type. settings: [] + - name: primaryKey + display_name: Set as Primary Key + type: BOOLEAN + deprecated: false + required: false + description: Mark this property as a Primary Key in Responsys. + settings: [] - name: useSegmentMsgId display_name: Use Segment Message ID type: BOOLEAN @@ -14843,105 +14956,37 @@ items: want to connect records in your Profile Lists/Extension Tables with records in this Supplemental Table. settings: [] - - name: password - display_name: Password - type: PASSWORD - deprecated: false - required: true - string_validators: - regexp: '' - description: Please enter your account's password. - settings: [] - - name: pod - display_name: Pod - type: SELECT - deprecated: false - required: true - select_validators: - select_options: - - '2' - - '5' - - '8' - - '9' - description: >- - The pod that hosts your Responsys account. Simply check your url during - your login screen. This is required to any requests to your account. The - default is `interact2`. - settings: [] - - name: username - display_name: Username - type: STRING - 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 - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Please enter the default Profile List. Make sure that the Profile List is - inside the provided Folder Name. - settings: [] - - name: optOutEmailTrait - display_name: Email Permission Status Trait Mapping - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Please enter the trait you would like to be mapped to - `EMAIL_PEERMISSION_STATUS_`. This will allow you to track users who opt in - and out of marketing communications in your apps and websites. The value - of this trait MUST be a boolean. - settings: [] - - name: optOutMobileTrait - display_name: Mobile Permission Status Trait Mapping + - 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 + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter the Segment Event Name. + settings: [] + - name: listName + display_name: Profile List Name type: STRING deprecated: false - required: false + required: true string_validators: regexp: '' description: >- - Please enter the trait youw would like to be mapped to - MOBILE_PERMISSION_STATUS_. This will allow you to track users who opt in - and out of marketing communications in your apps and websites. The value - of this trait MUST be a boolean. - settings: [] - - name: optin - display_name: Set Default Permission Setting to OPTIN - type: BOOLEAN - deprecated: false - required: false - description: >- - Choose whether records added to Profile Lists should be `'OPTIN'` rather - than the default `'OPTOUT'` - settings: [] - - name: petName - display_name: Profile Extension Table - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: Please enter the name of your default Profile Extension Table. + Please enter the default Profile List. Make sure that the Profile List is + inside the provided Folder Name. settings: [] connection_modes: device: @@ -14949,7 +14994,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -15027,26 +15072,33 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: identify - display_name: Include custom user data with Rollbar's error tracking + - name: captureUnhandledRejections + display_name: Capture Unhandled Rejections type: BOOLEAN deprecated: false required: false description: >- - When this option is enabled we will store metadata about the user on - `identify` calls. + Catch and report unhandled Promise rejections, such as Promise failures + that do not have a corresponding `.then(null, function(e) {})` handler. settings: [] - - name: sourceMapEnabled - display_name: Enable Source Map - type: BOOLEAN + - name: environment + display_name: Environment + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: The environment the code is running in. + settings: [] + - name: ignoredMessages + display_name: Ignored Messages + type: LIST deprecated: false required: false description: >- - When this option is enabled, we'll let Rollbar know you have source maps - enabled. Be sure to implement either Option A or B in [these - instructions](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map) - to set up source maps with Rollbar as well as fill out Code Version in you - Rollbar Integration settings in your Segment source. + If you want to ignore a specific exception message, say for a third-party + browser plugin that is throwing errors, you can add them here and Rollbar + will ignore exceptions matching those messages. settings: [] - name: accessToken display_name: Access Token @@ -15057,6 +15109,13 @@ 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: codeVersion display_name: Code Version type: STRING @@ -15068,15 +15127,6 @@ 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 @@ -15086,31 +15136,26 @@ items: 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 - deprecated: false - required: false - description: >- - If you want to ignore a specific exception message, say for a third-party - browser plugin that is throwing errors, you can add them here and Rollbar - will ignore exceptions matching those messages. - settings: [] - - name: captureUncaught - display_name: Capture uncaught exceptions + - name: identify + display_name: Include custom user data with Rollbar's error tracking type: BOOLEAN deprecated: false required: false - description: Record uncaught exceptions from `window.onerror`. + description: >- + When this option is enabled we will store metadata about the user on + `identify` calls. settings: [] - - name: captureUnhandledRejections - display_name: Capture Unhandled Rejections + - name: sourceMapEnabled + display_name: Enable Source Map 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. + When this option is enabled, we'll let Rollbar know you have source maps + enabled. Be sure to implement either Option A or B in [these + instructions](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map) + to set up source maps with Rollbar as well as fill out Code Version in you + Rollbar Integration settings in your Segment source. settings: [] connection_modes: device: @@ -15167,7 +15212,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -15248,9 +15293,9 @@ items: components: - type: CLOUD platforms: - browser: true + browser: false server: true - mobile: true + mobile: false browserUnbundlingSupported: false browserUnbundlingPublic: true settings: @@ -15428,66 +15473,6 @@ 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 - deprecated: false - required: false - description: >- - This will map address traits in your group calls as Shipping Address for - your Account Objects. - settings: [] - - name: version - display_name: Version - type: SELECT - deprecated: false - required: false - select_validators: - select_options: - - '1' - - '2' - description: >- - V1 is deprecated: should not be used going forwards and is left for legacy - compatibility. Our V2 integration supports getting your prospective - customers into Salesforce as Leads from your website or mobile app. - settings: [] - name: leadLookupFields display_name: Custom Lead Lookup Fields type: MAP @@ -15520,15 +15505,6 @@ 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 @@ -15541,6 +15517,15 @@ items: Personal Information > [Reset My Security Token](https://na15.salesforce.com/_ui/system/security/ResetApiTokenEdit)**. settings: [] + - name: shipping + display_name: Send Address as Shipping Address + type: BOOLEAN + deprecated: false + required: false + description: >- + This will map address traits in your group calls as Shipping Address for + your Account Objects. + settings: [] - name: username display_name: Account Email type: STRING @@ -15553,13 +15538,73 @@ items: account just for Segment so that you don't need to use your actual password. settings: [] + - name: version + display_name: Version + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - '1' + - '2' + description: >- + V1 is deprecated: should not be used going forwards and is left for legacy + compatibility. Our V2 integration supports getting your prospective + customers into Salesforce as Leads from your website or mobile app. + 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: 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: [] connection_modes: device: web: false mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -15590,6 +15635,66 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: subDomain + display_name: Subdomain + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Your subdomain is represented by a 28-character string starting with the + letters "mc" in any of your base URIs. For example, in the base URI + `mc563885gzs27c5t9-63k636ttgm.rest.marketingcloudapis.com`, the subdomain + is `mc563885gzs27c5t9-63k636ttgm` + settings: [] + - name: apiEvents + display_name: API Events + type: MIXED + deprecated: false + required: false + description: >- + Trigger API Events in SFMC in response to Segment events. + + + **This setting is a Beta release.** You can read more about Beta features + in [Segment First Access and Beta Terms and + Conditions](https://segment.com/docs/legal/first-access-beta-preview/). By + using this feature, you agree to these terms. + settings: [] + - name: clientId + display_name: Client ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your Salesforce Marketing Cloud Client ID. For instructions on how to find + your Client ID, check out our + [documentation](https://segment.com/docs/destinations/salesforce-marketing-cloud/). + settings: [] + - name: clientSecret + display_name: Client Secret + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your Salesforce Marketing Cloud Client Secret. For instructions on how to + find your Client Secret, check out our + [documentation](https://segment.com/docs/integrations/salesforce-marketing-cloud). + settings: [] + - 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 @@ -15658,73 +15763,13 @@ items: Analytics > Contact Builder > Data Extensions**; the extension's name will appear in the *External Key* column. settings: [] - - name: subDomain - display_name: Subdomain - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Your subdomain is represented by a 28-character string starting with the - letters "mc" in any of your base URIs. For example, in the base URI - `mc563885gzs27c5t9-63k636ttgm.rest.marketingcloudapis.com`, the subdomain - is `mc563885gzs27c5t9-63k636ttgm` - settings: [] - - name: apiEvents - display_name: API Events - type: MIXED - deprecated: false - required: false - description: >- - Trigger API Events in SFMC in response to Segment events. - - - **This setting is a Beta release.** You can read more about Beta features - in [Segment First Access and Beta Terms and - Conditions](https://segment.com/docs/legal/first-access-beta-preview/). By - using this feature, you agree to these terms. - settings: [] - - name: clientId - display_name: Client ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Your Salesforce Marketing Cloud Client ID. For instructions on how to find - your Client ID, check out our - [documentation](https://segment.com/docs/destinations/salesforce-marketing-cloud/). - settings: [] - - name: clientSecret - display_name: Client Secret - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Your Salesforce Marketing Cloud Client Secret. For instructions on how to - find your Client Secret, check out our - [documentation](https://segment.com/docs/integrations/salesforce-marketing-cloud). - settings: [] - - 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 mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -15782,7 +15827,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -15848,7 +15893,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -15898,7 +15943,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -15948,7 +15993,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -15996,7 +16041,7 @@ items: mobile: false server: false cloud: - web: false + web: true mobile: true server: true previous_names: @@ -16025,6 +16070,21 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: customVersionProperty + display_name: Set Release by Property + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Dynamically track the version of your application in Sentry. If the + property you set here is on the global window object (example: you input + 'my_custom_version', and window.my_custom_version = '2.4.5') then we will + use that version. If not, we will default to the manually-set Release + property. We recommend that this value is unique to prevent it from being + overwritten by other integrations. + settings: [] - name: ignoreErrors display_name: Ignore Errors type: LIST @@ -16034,17 +16094,26 @@ items: A list of these messages to be filtered out before being sent to Sentry as either regular expressions or strings. settings: [] - - name: includePaths - display_name: Include Paths + - name: ignoreUrls + display_name: Ignore Urls type: LIST deprecated: false required: false description: >- - An array of regex patterns to indicate which urls are a part of your app - in the stack trace. All other frames will appear collapsed inside Sentry - to make it easier to discern between frames that happened in your code vs - other code. It’d be suggested to add the current page url, and the host - for your CDN. + 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: maxMessageLength + display_name: Maximum Message Length + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: >- + 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 @@ -16055,18 +16124,6 @@ items: regexp: '' description: Track the version of your application in Sentry. settings: [] - - name: whitelistUrls - display_name: Whitelist Urls - type: LIST - deprecated: false - required: false - description: >- - The inverse of ignoreUrls. Only report errors from whole urls matching a - regex pattern or an exact string. whitelistUrls should match the url of - your actual JavaScript files. It should match the url of your site if and - only if you are inlining code inside