diff --git a/scripts/catalog.js b/scripts/catalog.js index b6b723542d..9c1a31869b 100644 --- a/scripts/catalog.js +++ b/scripts/catalog.js @@ -18,6 +18,7 @@ const slugify = (displayName) => { .replace('.','-') if (slug === '-net') slug = 'net' + if (slug === 'talon-one') slug = 'talonone' if (slug === 'roku-alpha') slug = 'roku' if (slug === 'shopify-by-littledata') slug = 'shopify-littledata' if (slug === 'talon-one') slug = 'talonone' @@ -189,11 +190,16 @@ const updateSources = async () => { // Create source catalog yaml file const options = { noArrayIndent: true }; - let output = yaml.safeDump({ items: sourcesUpdated }, options); + var todayDate = new Date().toISOString().slice(0,10); + output = "# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT\n" + output += "# sources last updated " + todayDate + " \n"; + output += yaml.safeDump({ items: sourcesUpdated }, options); fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/sources.yml`), output); // Create source-category mapping yaml file + var todayDate = new Date().toISOString().slice(0,10); output = "# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT\n" + output += "# source cateogries last updated " + todayDate + " \n"; output += yaml.safeDump({ items: sourceCategories }, options); fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/source_categories.yml`), output); } @@ -272,10 +278,16 @@ const updateDestinations = async () => { // Create destination catalog yaml file const options = { noArrayIndent: true }; - let output = yaml.safeDump({ items: destinationsUpdated }, options); + output = "# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT\n" + var todayDate = new Date().toISOString().slice(0,10); + output += "# destination data last updated " + todayDate + " \n"; + output += yaml.safeDump({ items: destinationsUpdated }, options); fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/destinations.yml`), output); - // Create source-category mapping yaml file + + // Create destination-category mapping yaml file output = "# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT\n" + var todayDate = new Date().toISOString().slice(0,10); + output += "# destination categories last updated " + todayDate + " \n"; output += yaml.safeDump({ items: destinationCategories }, options); fs.writeFileSync(path.resolve(__dirname, `../src/_data/catalog/destination_categories.yml`), output); } diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 29c1a0cff5..cc468ae3f0 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,4 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT +# destination categories last updated 2020-01-22 items: - display_name: Email Marketing slug: email-marketing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 803eb93189..23c6e69fd6 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,3 +1,5 @@ +# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT +# destination data last updated 2020-01-22 items: - display_name: ActiveCampaign slug: activecampaign @@ -189,30 +191,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: events - display_name: Events - type: MAP - deprecated: false - required: false - description: >- - AdRoll allows you to create a Segment Name and ID for conversions events. - Use this mapping to trigger the *AdRoll Segment ID* (on the right) when - the Event Name (on the left) is passed in a Track method. - settings: [] - - name: pixId - display_name: Pixel ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[A-Z0-9]{22}$' - description: >- - You can find your Pixel ID in your AdRoll dashboard by clicking the - **green or red dot** in the lower-left corner. In the Javascript snippet, - the Pixel ID appears as `adroll_pix_id = 'XXXXXXX'` on line 3. It should - be 22 characters long, and look something like this: - `6UUA5LKILFESVE44XH6SVX`. - settings: [] - name: _version display_name: _version type: NUMBER @@ -237,6 +215,30 @@ items: should be 22 characters long and look something like this: `WYJD6WNIAJC2XG6PT7UK4B`. settings: [] + - name: events + display_name: Events + type: MAP + deprecated: false + required: false + description: >- + AdRoll allows you to create a Segment Name and ID for conversions events. + Use this mapping to trigger the *AdRoll Segment ID* (on the right) when + the Event Name (on the left) is passed in a Track method. + settings: [] + - name: pixId + display_name: Pixel ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[A-Z0-9]{22}$' + description: >- + You can find your Pixel ID in your AdRoll dashboard by clicking the + **green or red dot** in the lower-left corner. In the Javascript snippet, + the Pixel ID appears as `adroll_pix_id = 'XXXXXXX'` on line 3. It should + be 22 characters long, and look something like this: + `6UUA5LKILFESVE44XH6SVX`. + settings: [] connection_modes: device: web: true @@ -379,6 +381,23 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: setEventBufferingEnabled + display_name: Buffer and batch events sent to Adjust + type: BOOLEAN + deprecated: false + required: false + description: >- + **Device Mode Only**: This will save battery life by buffering and + batching events sent to Adjust. But during development it's nicer to see + events come through immediately. + settings: [] + - name: trackAttributionData + display_name: Track Attribution Data + type: BOOLEAN + deprecated: false + required: false + description: Send Adjust Attribution data to Segment and other tools as a `track` call. + settings: [] - name: appToken display_name: App Token type: STRING @@ -436,23 +455,6 @@ items: This will send all your data to your production environment on Adjust. If unchecked, data will flow to your sandbox environment on Adjust. settings: [] - - name: setEventBufferingEnabled - display_name: Buffer and batch events sent to Adjust - type: BOOLEAN - deprecated: false - required: false - description: >- - **Device Mode Only**: This will save battery life by buffering and - batching events sent to Adjust. But during development it's nicer to see - events come through immediately. - settings: [] - - name: trackAttributionData - display_name: Track Attribution Data - type: BOOLEAN - deprecated: false - required: false - description: Send Adjust Attribution data to Segment and other tools as a `track` call. - settings: [] connection_modes: device: web: false @@ -494,85 +496,41 @@ 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 + - name: reportSuiteId + display_name: Report Suite ID(s) type: STRING deprecated: false - required: false + required: true 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. + You can find your Report Suite ID in your Adobe Analytics Settings page. + Multiple report suite ids can be separated by commas: + `suite1,suite2,suite3`. settings: [] - - name: customDataPrefix - display_name: Context Data Property Prefix + - name: trackingServerSecureUrl + display_name: Tracking Server Secure URL 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. + description: This is the secure URL of your Adobe Analytics server. settings: [] - - name: removeFallbackVisitorId - display_name: 'No Fallbacks for Visitor ID: Server-Side Only ' - type: BOOLEAN + - name: productIdentifier + display_name: Product Identifier + type: SELECT deprecated: false required: false + select_validators: + select_options: + - name + - sku + - id 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. + 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: contextValues display_name: Context Data Variables @@ -596,88 +554,99 @@ items: **NOTE**: By default we send all your `properties` as Context Data Variables so you do not need to map them again here. settings: [] - - name: enableTrackPageName - display_name: Enable pageName for Track Events - type: BOOLEAN + - name: customDataPrefix + display_name: Context Data Property Prefix + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - If you do not want to attach `pageName` for your `.track()` calls, you can - disable this option. + If you would like to prefix your Segment properties before sending them as + contextData, enter a prefix here. settings: [] - - name: lVars - display_name: List Variables + - name: events + display_name: Events + type: MIXED + deprecated: false + required: false + description: Map your Segment events to custom Adobe events. + settings: [] + - name: props + display_name: Props type: MAP deprecated: false required: false map_validators: regexp: '' min: 0 - max: 3 - map_prefix: list + max: 150 + map_prefix: prop select_options: [] description: >- - Map your Adobe Analytics list variables names to the property names you’re - using in your Segment events. Enter a Segment property name on the left - and an Adobe Analytics list variable number on the right. You can view - your Segment events and properties in your Schema. + Map your Adobe Analytics 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: merchEvents - display_name: 'Merchandising Events ' - type: MIXED + - name: timestampOption + display_name: Timestamp Option + type: SELECT deprecated: false required: false - description: |- - Configure merchandising event, such as purchase or currency events. - - This is currently in Beta Testing and not generally available. - settings: - - name: merchEvents - display_name: merchEvents - type: MIXED - deprecated: false - required: false - description: The name of the adobe event. - settings: [] - - name: utf8Charset - display_name: Use UTF-8 Charset + select_validators: + select_options: + - enabled + - disabled + - hybrid + description: >- + Adobe Analytics can have Report Suites that will accept timestamped, + non-timestamped or hybrid data. Note that we can only play historical + data for timestamped or hybrid Report Suites. + settings: [] + - name: useSecureServerUrl + display_name: Use Secure URL for Server-side type: BOOLEAN deprecated: false required: false description: >- - 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. + 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: eVars - display_name: eVars - type: MAP + - name: addBuildToAppId + display_name: Add application build to Adobe's App ID + type: BOOLEAN 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. + If this setting is enable, we will add `context.app.build`, if present, to + Adobe's AppID, as ` ()`. settings: [] - - name: eventsV2 - display_name: Events V2 (Bundled Mobile Only) - type: MAP + - 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: ssl + display_name: SSL + type: BOOLEAN deprecated: false required: false description: >- - **Note**: If you are bundling our Adobe Analytics SDK on your mobile - device, you should map your events here. If you are sending via server - side you should use the `Events` option instead. Map your Adobe Analytics - property names on the left to Adobe event names on the right. Your events - MUST be set up in Adobe and mapped here in order to to be forwarded to the - destination. This setting only applies to Mobile integrations with Adobe. + Check this box if you would like your Adobe Heartbeat calls to be made + over HTTPS. + settings: [] + - name: utf8Charset + display_name: Use UTF-8 Charset + type: BOOLEAN + deprecated: false + required: false + description: >- + Only applicable on server-side or cloud-mode. If this setting is enabled, + we will send the payload to Adobe Analytics with UTF-8 charset. Useful + when your events contains accents or other special characters. settings: [] - name: preferVisitorId display_name: Prefer VisitorID for Hybrid Timestamp Reporting @@ -691,37 +660,74 @@ 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 + - name: sendBothTimestampVisitorId + display_name: Send Both Timestamp and VisitorID for Timestamp Optional Reporting Suites + type: BOOLEAN deprecated: false required: false - map_validators: + 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: marketingCloudOrgId + display_name: Marketing Cloud Organization Id + type: STRING + deprecated: false + required: false + string_validators: regexp: '' - min: 0 - max: 150 - map_prefix: prop - select_options: [] description: >- - Map your Adobe Analytics property names to the property names you’re using - in your Segment events. Enter a Segment property name on the left and an - Adobe Analytics property number on the right. You can view your Segment - events and properties in your Schema. + If you 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: timestampOption - display_name: Timestamp Option - type: SELECT + - name: merchEvents + display_name: 'Merchandising Events ' + type: MIXED + deprecated: false + required: false + description: |- + Configure merchandising event, such as purchase or currency events. + + This is currently in Beta Testing and not generally available. + settings: + - name: merchEvents + display_name: merchEvents + type: MIXED + deprecated: false + required: false + description: The name of the adobe event. + settings: [] + - name: removeFallbackVisitorId + display_name: 'No Fallbacks for Visitor ID: Server-Side Only ' + type: BOOLEAN deprecated: false required: false - select_validators: - select_options: - - enabled - - disabled - - hybrid description: >- - Adobe Analytics can have Report Suites that will accept timestamped, - non-timestamped or hybrid data. Note that we can only play historical - data for timestamped or hybrid Report Suites. + 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: sendFalseValues + display_name: Send False values + type: BOOLEAN + deprecated: false + required: false + description: >- + By default, we don't send properties with a `false` as value on cloud + mode. Enabling this setting will send any boolean property where value is + `false`. settings: [] - name: trackingServerUrl display_name: Tracking Server URL @@ -732,46 +738,61 @@ items: regexp: '' description: This is the URL of your Adobe Analytics server. settings: [] - - name: disableVisitorId - display_name: Drop Visitor ID + - name: useLegacyLinkName + display_name: Use Legacy LinkName type: BOOLEAN deprecated: false required: false - description: This will disable Visitor ID from being passed to Adobe. + 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: marketingCloudOrgId - display_name: Marketing Cloud Organization Id - type: STRING + - name: enableTrackPageName + display_name: Enable pageName for Track Events + type: BOOLEAN 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'. + If you do not want to attach `pageName` for your `.track()` calls, you can + disable this option. settings: [] - - name: reportSuiteId - display_name: Report Suite ID(s) - type: STRING + - name: lVars + display_name: List Variables + type: MAP deprecated: false - required: true - string_validators: + required: false + map_validators: regexp: '' + min: 0 + max: 3 + map_prefix: list + select_options: [] description: >- - You can find your Report Suite ID in your Adobe Analytics Settings page. - Multiple report suite ids can be separated by commas: - `suite1,suite2,suite3`. + Map your Adobe Analytics list variables names to the property names you’re + using in your Segment events. Enter a Segment property name on the left + and an Adobe Analytics list variable number on the right. You can view + your Segment events and properties in your Schema. settings: [] - - name: useSecureServerUrl - display_name: Use Secure URL for Server-side - 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: >- - Enable this option if you want to use the 'Tracking Server Secure URL' - endpoint instead of the normal URL for server-side and Cloud Mode calls. + Map your Adobe Analytics 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: customDelimiter display_name: 'List Variable and Prop Custom Delimiter: Server-Side Only ' @@ -797,53 +818,34 @@ items: format 'list1', 'list2', etc. and props in format 'prop1', 'prop2', etc. Must be all lowercase with no whitespace. 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: sendFalseValues - display_name: Send False values - type: BOOLEAN + - name: eventsV2 + display_name: Events V2 (Bundled Mobile Only) + type: MAP deprecated: false required: false description: >- - By default, we don't send properties with a `false` as value on cloud - mode. Enabling this setting will send any boolean property where value is - `false`. - settings: [] - - name: events - display_name: Events - type: MIXED - deprecated: false - required: false - description: Map your Segment events to custom Adobe events. + **Note**: If you are bundling our Adobe Analytics SDK on your mobile + device, you should map your events here. If you are sending via server + side you should use the `Events` option instead. Map your Adobe Analytics + property names on the left to Adobe event names on the right. Your events + MUST be set up in Adobe and mapped here in order to to be forwarded to the + destination. This setting only applies to Mobile integrations with Adobe. settings: [] - - name: hVars - display_name: Hierarchy Variables + - name: eVars + display_name: eVars type: MAP deprecated: false required: false map_validators: regexp: '' min: 0 - max: 5 - map_prefix: hier + max: 250 + map_prefix: eVar 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 + 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: heartbeatTrackingServerUrl @@ -945,15 +947,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^.{8,}$' - description: Airship generated string identifying the Bearer token. - settings: [] - name: appKey display_name: App Key type: STRING @@ -965,6 +958,15 @@ items: Airship generated string identifying the app setup. Used in the application bundle. settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: Airship generated string identifying the Bearer token. + settings: [] connection_modes: device: web: false @@ -1002,27 +1004,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true 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: [] - - 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: [] connection_modes: device: @@ -1060,23 +1062,23 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: accountId - display_name: AWS Account ID + - name: region + display_name: Region type: STRING deprecated: false required: true string_validators: regexp: '' - description: The ID of the AWS Account you'd like us to send data to. + description: The EventBridge Firehose AWS region key. settings: [] - - name: region - display_name: Region + - name: accountId + display_name: AWS Account ID type: STRING deprecated: false required: true string_validators: regexp: '' - description: The EventBridge Firehose AWS region key. + description: The ID of the AWS Account you'd like us to send data to. settings: [] connection_modes: device: @@ -1117,6 +1119,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: region + display_name: AWS Kinesis Stream Region + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The Kinesis Stream's AWS region key + settings: [] - name: roleAddress display_name: Role Address type: STRING @@ -1162,15 +1173,6 @@ items: `userId` or `anonymousId`*). This option should provide much more stable and even distribution. settings: [] - - name: region - display_name: AWS Kinesis Stream Region - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: The Kinesis Stream's AWS region key - settings: [] connection_modes: device: web: false @@ -1312,27 +1314,21 @@ items: 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 + - name: clientContext + display_name: Client Context + type: MAP deprecated: false - required: true - string_validators: + required: false + map_validators: regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: [] 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. + An optional map to pass to the Lambda function. See [AWS Lambda + documentation](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) + for more information. settings: [] - name: externalId display_name: External ID @@ -1348,30 +1344,27 @@ items: 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 - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: [] - description: >- - An optional map to pass to the Lambda function. See [AWS Lambda - documentation](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) - for more information. - settings: [] - - name: region - display_name: Region + - name: function + display_name: Lambda 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 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 @@ -1390,6 +1383,15 @@ items: Select `Tail` if you would like to see detailed logs in Cloud Watch. settings: [] + - name: region + display_name: Region + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: 'AWS Region where the lambda lives. E.G. `us-west-2`, `eu-west-3`' + settings: [] connection_modes: device: web: false @@ -1426,6 +1428,39 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: clientContext + display_name: Client Context + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: [] + description: >- + An optional map to pass to the Lambda function. See [AWS Lambda + documentation](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) + for more information. + settings: [] + - name: logType + display_name: Log Type + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - None + - Tail + description: >- + Lambda [log + type](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax). + By default `None`. + + + Select `Tail` if you would like to see detailed logs in Cloud Watch. + settings: [] - name: function display_name: Lambda type: STRING @@ -1459,21 +1494,16 @@ items: AWS Region where the lambda lives. If it is not defined, we'll use `us-west-2` by default. settings: [] - - name: clientContext - display_name: Client Context - type: MAP + - name: roleAddress + display_name: Role Address + type: STRING deprecated: false - required: false - map_validators: + required: true + string_validators: regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: [] description: >- - An optional map to pass to the Lambda function. See [AWS Lambda - documentation](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) - for more information. + The address of the AWS role that will be invoking Lambda (ex: + `arn:aws:iam::874699288871:role/example-role`). settings: [] - name: externalId display_name: External ID @@ -1489,34 +1519,6 @@ items: roles, check [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). settings: [] - - name: logType - display_name: Log Type - type: SELECT - deprecated: false - required: false - select_validators: - select_options: - - None - - Tail - description: >- - Lambda [log - type](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax). - By default `None`. - - - Select `Tail` if you would like to see detailed logs in Cloud Watch. - settings: [] - - name: roleAddress - display_name: Role Address - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - The address of the AWS role that will be invoking Lambda (ex: - `arn:aws:iam::874699288871:role/example-role`). - settings: [] connection_modes: device: web: false @@ -1607,21 +1609,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: uid - display_name: Client ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your Client ID in your Ambassador dashboard by clicking on - Editor in the navigation pane along the left-hand side of the page. On the - following page, click the 'Here you go' link next to 'Need the code - snippet or credentials?' and copy the value shown under ID. It should be - 32 characters long, and look something like this: - 012345ab-c0d1-110e-1f0g-h1234ij5kl6m. - settings: [] - name: campaigns display_name: Campaigns type: MAP @@ -1642,6 +1629,21 @@ items: Ambassador conversion, add your event name on the left and "conversion" on the right. settings: [] + - name: uid + display_name: Client ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + You can find your Client ID in your Ambassador dashboard by clicking on + Editor in the navigation pane along the left-hand side of the page. On the + following page, click the 'Here you go' link next to 'Need the code + snippet or credentials?' and copy the value shown under ID. It should be + 32 characters long, and look something like this: + 012345ab-c0d1-110e-1f0g-h1234ij5kl6m. + settings: [] connection_modes: device: web: true @@ -1681,121 +1683,110 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: batchEvents - display_name: Batch Events - type: BOOLEAN + - name: traitsToAppend + display_name: Traits to Append + type: LIST 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. + Server-Side and Mobile Only. Configure values to be appended to the user + property array via identify.traits. settings: [] - - name: groupValueTrait - display_name: Group Value Trait - type: STRING + - name: useCustomAmplitudeProperties + display_name: Send Custom Language and Country Properties + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - What trait Segment should use as your Amplitude "group value" in group - calls. If, for example, you set this to be `plan`, then `traits["plan"]` - will be sent as `groupValue` to Amplitude. + 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 - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: - - user_properties - - event_properties + - name: useLogRevenueV2 + display_name: Use Log Revenue V2 API + type: BOOLEAN + deprecated: false + required: false 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: trackGclid - display_name: Track GCLID + - name: sendToBatchEndpoint + display_name: Send To Batch Endpoint 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. + Server-Side Only. If true, events are sent to Amplitude's `batch` endpoint + rather than to their `httpapi` endpoint. Because Amplitude's `batch` + endpoint throttles traffic less restrictively than the Amplitude `httpapi` + endpoint, enabling this setting may help to reduce 429s - or throttling + errors - from Amplitude. Amplitude's `batch` endpoint throttles data only + when the rate of events sharing the same `user_id` or `device_id` exceeds + an average of 1,000/second over a 30-second period. More information about + Amplitude's throttling is available here in their docs: + https://developers.amplitude.com/#429s-in-depth. settings: [] - - name: apiKey - display_name: API Key - type: STRING + - name: trackProductsOnce + display_name: Track products once + type: BOOLEAN deprecated: false - required: true - string_validators: - regexp: '^[a-z0-9]{32}$' + required: false description: >- - You can find your API Key on your Amplitude [Settings - page](https://amplitude.com/settings). + *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: eventUploadPeriodMillis - display_name: Event Upload Period Millis (for batching events) - type: NUMBER + - name: trackUtmProperties + display_name: Track UTM Properties to Amplitude. + type: BOOLEAN deprecated: false required: false - number_validators: - min: 0 - max: 0 description: >- - Amount of time in milliseconds that the SDK waits before uploading events - if `batchEvents` is `true`. + This will track UTM properties found in the querystring to Amplitude (only + for Device mode). settings: [] - - name: preferAnonymousIdForDeviceId - display_name: Prefer Anonymous ID for Device ID + - name: trackAllPages + display_name: Track All Pages to Amplitude type: BOOLEAN deprecated: false required: false description: >- - By default, Segment will use `context.device.id` as the Amplitude - `device_id`, using `anonymousId` if `context.device.id` isn't present. - - - Enable this setting to flip this behavior; `anonymousId` will be used as - the `device_id`, falling back to `context.device.id` if it isn't present. - - - In browsers, enabling this setting means the user's anonymous ID, which - you can set using `analytics.user().anonymousId('ID_GOES_HERE')`, will be - set as the Amplitude device ID. Otherwise, Amplitude's default logic for - determining device IDs will be used. + This will track **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: traitsToIncrement - display_name: Traits To Increment - type: LIST + - name: trackRevenuePerProduct + display_name: Track Revenue Per Product + type: BOOLEAN deprecated: false required: false description: >- - Server-Side and Mobile Only. Configure `trait` to increment on identify. - If the trait is present, it will increment the trait given the numerical - value passed in when you call `identify` with the trait. + 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: deviceIdFromUrlParam - display_name: Set Device ID From URL Parameter amp_device_id - type: BOOLEAN + - name: eventUploadThreshold + display_name: Event Upload Threshold (for batching events) + type: NUMBER deprecated: false required: false + number_validators: + min: 0 + max: 0 description: >- - If true, the SDK will parse device ID values from url parameter - `amp_device_id` if available. + Minimum number of events to batch together per request if `batchEvents` is + `true`. settings: [] - name: groupTypeTrait display_name: Group Type Trait @@ -1818,26 +1809,39 @@ items: regexp: '' description: Your Amplitude Secret Key (Only needed for user deletion) settings: [] - - name: trackRevenuePerProduct - display_name: Track Revenue Per Product + - name: trackCategorizedPages + display_name: Track Categorized Pages to Amplitude 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. + 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: useAdvertisingIdForDeviceId - display_name: Use AdvertisingId for DeviceId + - 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: saveParamsReferrerOncePerSession + display_name: 'Save Referrer, URL Params, GCLID Once Per Session' type: BOOLEAN deprecated: false required: false description: >- - Mobile Only (will *not* work in cloud-mode). Allows users to use - advertisingIdentifier instead of identifierForVendor as the Device ID. + If true 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: sendAlias display_name: Enable Alias @@ -1851,77 +1855,47 @@ items: this setting is disabled, your Segment Amplitude destination will reject `alias` events as unsupported. settings: [] - - name: trackAllPages - display_name: Track All Pages to Amplitude - type: BOOLEAN - deprecated: false - required: false - description: >- - This will track **Loaded a Page** events to Amplitude for all [`page` - method](https://segment.io/libraries/analytics.js#page) calls. We keep - this disabled by default, since Amplitude isn't generally used for - pageview tracking. - settings: [] - - name: trackProductsOnce - display_name: Track products once + - name: batchEvents + display_name: Batch Events type: BOOLEAN deprecated: false required: false description: >- - *Beta feature* Amplitude recently added support to submit an array of - products on "Order Completed" events. If this setting is set to true, we - will send all the products in one single event to Amplitude. - settings: [] - - name: eventUploadThreshold - display_name: Event Upload Threshold (for batching events) - type: NUMBER - deprecated: false - required: false - number_validators: - min: 0 - max: 0 - description: >- - Minimum number of events to batch together per request if `batchEvents` is - `true`. + 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: saveParamsReferrerOncePerSession - display_name: 'Save Referrer, URL Params, GCLID Once Per Session' - type: BOOLEAN + - name: traitsToSetOnce + display_name: Traits to Set Once + type: LIST 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. + Server-Side and Mobile Only. Configure values to be set only once via + identify.traits. 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: useAdvertisingIdForDeviceId + display_name: Use AdvertisingId for DeviceId type: BOOLEAN deprecated: false required: false description: >- - Enabling this will send referrer information as a user property to - Amplitude when you call Segment's `page` method. - settings: [] - - name: traitsToAppend - display_name: Traits to Append - type: LIST - deprecated: false - required: false - description: >- - Server-Side and Mobile Only. Configure values to be appended to the user - property array via identify.traits. + Mobile Only (will *not* work in cloud-mode). Allows users to use + advertisingIdentifier instead of identifierForVendor as the Device ID. settings: [] - name: versionName display_name: Version Name @@ -1945,80 +1919,113 @@ items: `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: enableLocationListening - display_name: Enable Location Listening - type: BOOLEAN + - name: mapQueryParams + display_name: Map Query Params to Custom Property + type: MAP deprecated: false required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - user_properties + - event_properties description: >- - 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. + 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: useCustomAmplitudeProperties - display_name: Send Custom Language and Country Properties + - name: preferAnonymousIdForDeviceId + display_name: Prefer Anonymous ID for Device ID 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'});` + 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: useLogRevenueV2 - display_name: Use Log Revenue V2 API - type: BOOLEAN + - name: groupValueTrait + display_name: Group Value Trait + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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. + 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: unsetParamsReferrerOnNewSession - display_name: Unset Params Referrer On New Session + - name: trackNamedPages + display_name: Track Named Pages to Amplitude type: BOOLEAN deprecated: false required: false description: >- - If false, the existing referrer and `utm_parameter` values will be carried - through each new session. If set to true, the referrer and `utm_parameter` - user properties, which include `referrer`, `utm_source`, `utm_medium`, - `utm_campaign`, `utm_term`, and `utm_content`, will be set to null upon - instantiating a new session. **Note**: This only works if Track Referrer - or Track UTM Properties to Amplitude are set to true. + This will track 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: [] - - name: forceHttps - display_name: Force Https + - name: traitsToIncrement + display_name: Traits To Increment + type: LIST + deprecated: false + required: false + description: >- + Server-Side and Mobile Only. Configure `trait` to increment on identify. + If the trait is present, it will increment the trait given the numerical + value passed in when you call `identify` with the trait. + settings: [] + - name: 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: deviceIdFromUrlParam + display_name: Set Device ID From URL Parameter amp_device_id type: BOOLEAN deprecated: false required: false description: >- - If true, the events will always be uploaded to HTTPS endpoint. Otherwise - the SDK will use the embedding site's protocol. + If true, the SDK will parse device ID values from url parameter + `amp_device_id` if available. settings: [] - - name: sendToBatchEndpoint - display_name: Send To Batch Endpoint + - name: enableLocationListening + display_name: Enable Location Listening type: BOOLEAN deprecated: false required: false description: >- - Server-Side Only. If true, events are sent to Amplitude's `batch` endpoint - rather than to their `httpapi` endpoint. Because Amplitude's `batch` - endpoint throttles traffic less restrictively than the Amplitude `httpapi` - endpoint, enabling this setting may help to reduce 429s - or throttling - errors - from Amplitude. Amplitude's `batch` endpoint throttles data only - when the rate of events sharing the same `user_id` or `device_id` exceeds - an average of 1,000/second over a 30-second period. More information about - Amplitude's throttling is available here in their docs: - https://developers.amplitude.com/#429s-in-depth. + Mobile Only. If a user has granted your app location permissions, enable + this setting so that the SDK will also grab the location of the user. + Amplitude will never prompt the user for location permission, so this must + be done by your app. settings: [] - name: trackSessionEvents display_name: Track Session Events to Amplitude @@ -2030,15 +2037,6 @@ items: mobile products. Amplitude's libraries track sessions automatically and this option is not necessary for session tracking. settings: [] - - name: trackUtmProperties - display_name: Track UTM Properties to Amplitude. - type: BOOLEAN - deprecated: false - required: false - description: >- - This will track UTM properties found in the querystring to Amplitude (only - for Device mode). - settings: [] - name: traitsToPrepend display_name: Traits to Prepend type: LIST @@ -2048,38 +2046,42 @@ items: Server-Side and Mobile Only. Configure values to be prepended to the user property array via identify.traits. settings: [] - - name: traitsToSetOnce - display_name: Traits to Set Once - type: LIST + - name: forceHttps + display_name: Force Https + type: BOOLEAN deprecated: false required: false description: >- - Server-Side and Mobile Only. Configure values to be set only once via - identify.traits. + If true, the events will always be uploaded to HTTPS endpoint. Otherwise + the SDK will use the embedding site's protocol. settings: [] - - name: trackCategorizedPages - display_name: Track Categorized Pages to Amplitude + - name: trackGclid + display_name: Track GCLID 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**. + If true, captures the gclid url parameter as well as the user's + initial_gclid via a set once operation. settings: [] - - name: trackNamedPages - display_name: Track Named Pages to Amplitude + - name: trackReferrer + display_name: Track Referrer to Amplitude type: BOOLEAN deprecated: false required: false description: >- - This will track events to Amplitude for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `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. + Enabling this will send referrer information as a user property to + Amplitude when you call Segment's `page` method. + settings: [] + - name: trackAllPagesV2 + display_name: Track All Screens + type: BOOLEAN + deprecated: false + required: false + description: >- + Mobile only. Sends a "Loaded Screen" event and the screen name as a + property to Amplitude. Moving forward, this is the preferred method of + tracking screen events in Amplitude. settings: [] connection_modes: device: @@ -2257,42 +2259,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: androidAppID - display_name: Android App ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Your Android App's ID. Find this in your AppsFlyer's 'My App' dashboard. - It should look something like 'com.appsflyer.myapp'. This is required for - Android projects if you want to send events using the server side - integration. - settings: [] - - name: appleAppID - display_name: Apple App ID (iOS) - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^[0-9]*$' - description: >- - Your App's ID, which is accessible from iTunes or in AppsFlyer's 'My App' - dashboard. This is optional for Android projects, and only required for - iOS projects. - settings: [] - - name: appsFlyerDevKey - display_name: AppsFlyer Dev Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-zA-Z0-9]{10,30}$' - description: >- - Your unique developer ID from AppsFlyer, which is accessible from your - AppsFlyer account. - settings: [] - name: canOmitAppsFlyerId display_name: Can Omit AppsFlyerId type: BOOLEAN @@ -2336,6 +2302,42 @@ items: Send attribution data to Segment and other tools as a track call (mobile libraries only). settings: [] + - name: androidAppID + display_name: Android App ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Your Android App's ID. Find this in your AppsFlyer's 'My App' dashboard. + It should look something like 'com.appsflyer.myapp'. This is required for + Android projects if you want to send events using the server side + integration. + settings: [] + - name: appleAppID + display_name: Apple App ID (iOS) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^[0-9]*$' + description: >- + Your App's ID, which is accessible from iTunes or in AppsFlyer's 'My App' + dashboard. This is optional for Android projects, and only required for + iOS projects. + settings: [] + - name: appsFlyerDevKey + display_name: AppsFlyer Dev Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-zA-Z0-9]{10,30}$' + description: >- + Your unique developer ID from AppsFlyer, which is accessible from your + AppsFlyer account. + settings: [] connection_modes: device: web: false @@ -2480,6 +2482,26 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: allowedDomains + display_name: Allowed Domains + type: LIST + deprecated: false + required: false + description: >- + Track errors and performance metrics only from specific domains. If this + blacklist is empty, all domains will track metrics. + settings: [] + - name: apiKey + display_name: API Key + type: STRING + 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 @@ -2505,26 +2527,6 @@ items: Enable offline errors and metrics tracking when network connectivity is not available. settings: [] - - name: allowedDomains - display_name: Allowed Domains - type: LIST - deprecated: false - required: false - description: >- - Track errors and performance metrics only from specific domains. If this - blacklist is empty, all domains will track metrics. - settings: [] - - 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 @@ -2747,24 +2749,6 @@ 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 - deprecated: false - required: false - description: Toggles whether Batch is allowed to collect advertising IDs - settings: [] - name: gcmSenderID display_name: GCM Sender ID type: STRING @@ -2789,6 +2773,24 @@ 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: [] + - name: canUseAdvertisingID + display_name: Allow advertising ID collection. + type: BOOLEAN + deprecated: false + required: false + description: Toggles whether Batch is allowed to collect advertising IDs + settings: [] connection_modes: device: web: false @@ -2916,6 +2918,13 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: retarget + display_name: Retarget + type: BOOLEAN + deprecated: false + required: false + description: This will retarget page calls on the client-side + settings: [] - name: apiKey display_name: API Key type: STRING @@ -2925,13 +2934,6 @@ items: regexp: '' description: Your API key can be found in Account Profile > API Keys settings: [] - - name: retarget - display_name: Retarget - type: BOOLEAN - deprecated: false - required: false - description: This will retarget page calls on the client-side - settings: [] connection_modes: device: web: true @@ -3033,44 +3035,99 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: safariWebsitePushId - display_name: Safari Website Push ID - type: STRING + - name: doNotLoadFontAwesome + display_name: Do Not Load Font Awesome + type: BOOLEAN + deprecated: false + required: false + description: >- + **Web Only:** Braze uses [FontAwesome](https://fontawesome.com/) for + in-app message icons. By default, Braze will automatically load + FontAwesome from + https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css. + To disable this behavior (e.g. because your site uses a customized version + of FontAwesome), set this option to true. Note that if you do this, you + are responsible for ensuring that FontAwesome is loaded on your site - + otherwise in-app messages may not render correctly. **This setting is only + applicable if you are using version 2 of the Braze Web SDK.** + settings: [] + - name: enableHtmlInAppMessages + display_name: Enable HTML In-App Messages + type: BOOLEAN + deprecated: false + required: false + description: >- + **Web only**: Enabling this option will allow Braze dashboard users to + write HTML In-App messages. Check out [Braze + Documentation](https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html#.initialize) + for more information on this setting. **This setting is only applicable if + you are using version 2 of the Braze Web SDK.** + settings: [] + - name: openInAppMessagesInNewTab + display_name: Open In-App Messages In New Tab + type: BOOLEAN + deprecated: false + required: false + description: >- + By default, links from in-app message clicks load in the current tab or a + new tab as specified in the dashboard on a message-by-message basis. Set + this option to true to force all links from in-app message clicks open in + a new tab or window. **This setting is only applicable if you are using + version 2 of the Braze Web SDK.** + settings: [] + - name: trackNamedPages + display_name: Track Only Named Pages + 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. + 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: appGroupId + display_name: REST API Key + type: STRING + deprecated: false + required: true 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 can be found in your Braze dashboard under App Settings > Developer + Console. (Formerly 'App Group Identifier') settings: [] - - name: allowCrawlerActivity - display_name: Allow Crawler Activity + - name: automaticallyDisplayMessages + display_name: Automatically Send In-App Messages type: BOOLEAN deprecated: false required: false description: >- - **Web Only:** By default, the Braze Web SDK ignores activity from known - spiders or web crawlers, such as Google, based on the user agent string. - This saves datapoints, makes analytics more accurate, and may improve page - rank. However, if you want Braze to log activity from these crawlers - instead, you may set this option to true. + **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: datacenter - display_name: Appboy Datacenter - type: SELECT + - name: customEndpoint + display_name: Custom API Endpoint + type: STRING deprecated: false - required: true - select_validators: - select_options: - - us - - us02 - - us03 - - us04 - - eu - description: 'Choose your Appboy Gateway (ie. US 01, US 02, EU 01, etc.).' + required: false + string_validators: + regexp: '' + description: >- + If you've been assigned an API endpoint by the Braze team specifically for + use with their Mobile or Javascript SDKs, please input that here. It + should look something like: sdk.api.appboy.eu. Otherwise, leave this + blank. settings: [] - name: minimumIntervalBetweenTriggerActionsInSeconds display_name: Minimum Interval Between Trigger Actions In Seconds @@ -3088,36 +3145,30 @@ items: 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 - 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. - settings: [] - - name: trackAllPages - display_name: Track All Pages + - name: openNewsFeedCardsInNewTab + display_name: Open News Feed Cards In New Tab 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. + 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: updateExistingOnly - display_name: Update Existing Users Only - type: BOOLEAN + - name: sessionTimeoutInSeconds + display_name: Session Timeout In Seconds + type: NUMBER deprecated: false required: false - description: >- - **Server Side only**: A flag to determine whether to update existing users - only, defaults to false + number_validators: + min: 0 + max: 0 + description: > + **Web Only:** By default, sessions time out after 30 minutes of + inactivity. Provide a value for this configuration option to override that + default with a value of your own. **This setting is only applicable if you + are using version 2 of the Braze Web SDK.** settings: [] - name: version display_name: Braze Web SDK Version @@ -3136,31 +3187,30 @@ 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: automatic_in_app_message_registration_enabled - display_name: Enable Automatic In-App Message Registration - type: BOOLEAN - deprecated: false - required: false - description: >- - **Mobile Only:** Every activity in your app must be registered with Braze - to allow it to add in-app message views to the view hierarchy. By default, - Braze's Segment integration automatically registers every activity. - However, if you would like to manually register activities, you may do so - by disabling this setting. For more information, see the Braze - [documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/android/in-app_messaging/integration/#step-1-braze-in-app-message-manager-registration). - settings: [] - - name: customEndpoint - display_name: Custom API Endpoint + - name: apiKey + display_name: App Identifier 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 Mobile or Javascript SDKs, please input that here. It - should look something like: sdk.api.appboy.eu. Otherwise, leave this - blank. + The API key found in your Braze dashboard, used to identify your + application as the app identifier. (Formerly 'API Key') + settings: [] + - name: datacenter + display_name: Appboy Datacenter + type: SELECT + deprecated: false + required: true + select_validators: + select_options: + - us + - us02 + - us03 + - us04 + - eu + description: 'Choose your Appboy Gateway (ie. US 01, US 02, EU 01, etc.).' settings: [] - name: enableLogging display_name: Enable Logging @@ -3175,74 +3225,39 @@ items: 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: openNewsFeedCardsInNewTab - display_name: Open News Feed Cards In New Tab + - name: logPurchaseWhenRevenuePresent + display_name: Log Purchase when Revenue is present 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.** + When this option is enabled, all Track calls with a property called + `revenue` will trigger Braze's LogRevenue event. settings: [] - - name: appGroupId - display_name: REST API Key + - name: restCustomEndpoint + display_name: Custom REST API Endpoint 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') - settings: [] - - name: doNotLoadFontAwesome - display_name: Do Not Load Font Awesome - type: BOOLEAN - deprecated: false - required: false - description: >- - **Web Only:** Braze uses [FontAwesome](https://fontawesome.com/) for - in-app message icons. By default, Braze will automatically load - FontAwesome from - https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css. - To disable this behavior (e.g. because your site uses a customized version - of FontAwesome), set this option to true. Note that if you do this, you - are responsible for ensuring that FontAwesome is loaded on your site - - otherwise in-app messages may not render correctly. **This setting is only - applicable if you are using version 2 of the Braze Web SDK.** - settings: [] - - name: trackNamedPages - display_name: Track Only Named Pages - 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. - settings: [] - - name: logPurchaseWhenRevenuePresent - display_name: Log Purchase when Revenue is present - type: BOOLEAN - deprecated: false - required: false - description: >- - When this option is enabled, all Track calls with a property called - `revenue` will trigger Braze's LogRevenue event. + If you've been assigned an API endpoint by the Braze team specifically for + use with their REST API, please input that here. It should look something + like "https://foo.bar.braze.com". Otherwise, leave this blank. settings: [] - - name: openInAppMessagesInNewTab - display_name: Open In-App Messages In New Tab - type: BOOLEAN + - name: safariWebsitePushId + display_name: Safari Website Push ID + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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**: 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: serviceWorkerLocation display_name: Service Worker Location @@ -3256,53 +3271,40 @@ items: documentation: https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html 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: apiKey - display_name: App Identifier - type: STRING + - name: automatic_in_app_message_registration_enabled + display_name: Enable Automatic In-App Message Registration + type: BOOLEAN 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') + **Mobile Only:** Every activity in your app must be registered with Braze + to allow it to add in-app message views to the view hierarchy. By default, + Braze's Segment integration automatically registers every activity. + However, if you would like to manually register activities, you may do so + by disabling this setting. For more information, see the Braze + [documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/android/in-app_messaging/integration/#step-1-braze-in-app-message-manager-registration). settings: [] - - name: automaticallyDisplayMessages - display_name: Automatically Send In-App Messages + - name: trackAllPages + display_name: Track All Pages 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. + 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: enableHtmlInAppMessages - display_name: Enable HTML In-App Messages + - name: allowCrawlerActivity + display_name: Allow Crawler Activity 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.** + **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: [] connection_modes: device: @@ -4300,27 +4302,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key + - name: apiSecret + display_name: Project Id type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your API key in ClientSuccess under the top right menu, Apps - & Integrations > Usage + You can find your Project Id in ClientSuccess under the top right menu, + Apps & Integrations > Usage settings: [] - - name: apiSecret - display_name: Project Id + - name: apiKey + display_name: API Key type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your Project Id in ClientSuccess under the top right menu, - Apps & Integrations > Usage + You can find your API key in ClientSuccess under the top right menu, Apps + & Integrations > Usage settings: [] connection_modes: device: @@ -4410,36 +4412,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: hybridAttributionModel - display_name: Hybrid Attribution Model - type: BOOLEAN - deprecated: false - required: false - description: >- - This will make **Completed Order** events always send a `sale` event in - addition to a `sale.new` or `sale.repeat` event if it has a boolean - `repeat` property. - settings: [] - - name: siteId - display_name: Site ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - If you'd like to send mobile data to Convertro's server side integration, - please enter your Convertro Site ID - settings: [] - - name: account - display_name: Account - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter your Convertro Account Name - settings: [] - name: clientName display_name: Client Name type: STRING @@ -4472,6 +4444,36 @@ items: you want to send to Convertro, put the event name you send to Segment on the left, and the name you want Convertro to receive it as on the right. settings: [] + - name: hybridAttributionModel + display_name: Hybrid Attribution Model + type: BOOLEAN + deprecated: false + required: false + description: >- + This will make **Completed Order** events always send a `sale` event in + addition to a `sale.new` or `sale.repeat` event if it has a boolean + `repeat` property. + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you'd like to send mobile data to Convertro's server side integration, + please enter your Convertro Site ID + settings: [] + - name: account + display_name: Account + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your Convertro Account Name + settings: [] connection_modes: device: web: true @@ -4615,32 +4617,6 @@ 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 @@ -4685,6 +4661,32 @@ 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 @@ -4782,17 +4784,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: includeVersionCode - display_name: Include the Version Code (Android) - type: BOOLEAN - deprecated: false - required: false - description: >- - This will include the version code from the manifest file in your app's - version name (Android only). Check out the [Crittercism - docs](https://app.crittercism.com/developers/docs-optional-android#include_version_code) - for more info. - settings: [] - name: monitorWebView display_name: Monitor Web View (iOS) type: BOOLEAN @@ -4852,11 +4843,22 @@ items: docs](http://docs.crittercism.com/overview/overview.html#service-monitoring) for more info. settings: [] - connection_modes: - device: - web: false - mobile: true - server: false + - name: includeVersionCode + display_name: Include the Version Code (Android) + type: BOOLEAN + deprecated: false + required: false + description: >- + This will include the version code from the manifest file in your app's + version name (Android only). Check out the [Crittercism + docs](https://app.crittercism.com/developers/docs-optional-android#include_version_code) + for more info. + settings: [] + connection_modes: + device: + web: false + mobile: true + server: false cloud: web: false mobile: false @@ -5041,20 +5043,6 @@ 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 @@ -5073,6 +5061,20 @@ 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 @@ -5206,38 +5208,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true 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: [] - - name: segmentWriteKey - display_name: Segment Write Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Set here the write key for this source. It's required if cookie matching - is enabled. - settings: [] - - name: 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: activityTag display_name: Activity Tag type: STRING @@ -5260,43 +5230,6 @@ items: Use these fields to map your Segment event names to Floodlight tags. We'll only send Floodlight the conversion events you specify. settings: - - name: event - display_name: Segment Event Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Our Floodlight integration allows you to map the event names you track - in Segment to Floodlight tags. - settings: [] - - name: cat - display_name: Floodlight Activity Tag - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - This should be the `cat` of your tag string, which Floodlight servers - use to identify the activity group to which the activity belongs. If you - leave this option blank, we will fall back to whatever you define in the - top level Activity Tag setting. - settings: [] - - name: type - display_name: Floodlight Group Tag - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - This should be the `type` of your tag string, which identifies the - activity group with which the Floodlight activity is associated. If you - leave this option blank, we will fall back to whatever you define in the - top level Group Tag setting. - settings: [] - name: isSalesTag display_name: Fire as Sales Tag type: BOOLEAN @@ -5342,16 +5275,64 @@ items: `{{context.userAgent}}`. Please reference our [docs](/docs/destinations/doubleclick-floodlight/) for more info. settings: [] - - name: googleNetworkId - display_name: Google Network Id + - name: event + display_name: Segment Event Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Our Floodlight integration allows you to map the event names you track + in Segment to Floodlight tags. + settings: [] + - name: cat + display_name: Floodlight Activity Tag + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + This should be the `cat` of your tag string, which Floodlight servers + use to identify the activity group to which the activity belongs. If you + leave this option blank, we will fall back to whatever you define in the + top level Activity Tag setting. + settings: [] + - name: type + display_name: Floodlight Group Tag + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + This should be the `type` of your tag string, which identifies the + activity group with which the Floodlight activity is associated. If you + leave this option blank, we will fall back to whatever you define in the + top level Group Tag setting. + settings: [] + - name: source + display_name: DoubleClick Advertiser ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your advertiser ID that is the source of the Floodlight activity. This + should be the `src` of your tag string. + settings: [] + - name: token + display_name: Authorization Token for server-to-server requests type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Provide your Google Network Id here if you have enabled cookie matching - (Get DoubleClick Id setting). + Please add the Token to send your conversions using the server-to-server + endpoint from DisplayVideo 360. settings: [] - name: groupTag display_name: Group Tag @@ -5366,16 +5347,37 @@ items: same value for this parameter across all conversion events or you can define this value for each of your conversion event mappings below. settings: [] - - name: token - display_name: Authorization Token for server-to-server requests + - name: segmentWriteKey + display_name: Segment Write Key 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. + Set here the write key for this source. It's required if cookie matching + is enabled. + settings: [] + - name: getDoubleClickId + display_name: Get DoubleClick Id + type: BOOLEAN + 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: [] + - name: googleNetworkId + display_name: Google Network Id + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Provide your Google Network Id here if you have enabled cookie matching + (Get DoubleClick Id setting). settings: [] connection_modes: device: @@ -5458,8 +5460,8 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: embedId - display_name: Embed ID + - name: apiKey + display_name: API Key type: STRING deprecated: false required: true @@ -5469,8 +5471,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: apiKey - display_name: API Key + - name: embedId + display_name: Embed ID type: STRING deprecated: false required: true @@ -5517,6 +5519,23 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: campaignId + display_name: Campaign ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^[0-9]{7,9}$' + description: >- + Your campaign ID can be found in your + [Campaigns](https://www.getdrip.com/campaigns) page. Copy a campaign URL, + the campaign ID will be the last segment of that url e.g + (https://www.getdrip.com/account_id/campaigns/campaign_id). If you need to + set this value dynamically, you can pass `integrations.Drip.campaignId` as + an integration specific option and we will respect that. **IMPORTANT**: If + 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 @@ -5542,23 +5561,6 @@ items: Integrations**. It should be a 7, 8, or 9 character numerical string, like this: `83702741`. settings: [] - - name: campaignId - display_name: Campaign ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^[0-9]{7,9}$' - description: >- - Your campaign ID can be found in your - [Campaigns](https://www.getdrip.com/campaigns) page. Copy a campaign URL, - the campaign ID will be the last segment of that url e.g - (https://www.getdrip.com/account_id/campaigns/campaign_id). If you need to - set this value dynamically, you can pass `integrations.Drip.campaignId` as - an integration specific option and we will respect that. **IMPORTANT**: If - you put a value in here, we will by default try to subscribe every user to - this campaign ID. - settings: [] connection_modes: device: web: true @@ -5736,21 +5738,26 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: mappedGroupTraits - display_name: Map Custom Traits to Accounts - type: MAP + - 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 deprecated: false required: false description: >- - Please input the Segment trait names on the left and their corresponding - Eloqua Custom Account Field names on the right. The traits must be set up - in the Eloqua dashboard prior to instantiating this mapping. - - - **Note:** If you have set up Custom Account Fields in Eloqua, please - ensure the corresponding Segment payload property values are of the same - data type specified in Eloqua's dashboard. Eloqua will reject any event - containing a Custom Account Field with an incorrect data type. + *Server Side Only*: Enable this setting to create or update an Eloqua + `contact` with traits from your `track` events' `context.traits` object. + *Note that when this setting is enabled, the destination will only process + `track` events and will reject `identify` events.* This is to reduce the + number of potentially repetitive API calls sent downstream to Eloqua. settings: [] - name: sendGroup display_name: Create or Update Account on Group @@ -5761,45 +5768,6 @@ 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 - deprecated: false - required: false - description: >- - *Server Side Only*: Enable this setting to create or update an Eloqua - `contact` with traits from your `track` events' `context.traits` object. - *Note that when this setting is enabled, the destination will only process - `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 @@ -5827,6 +5795,22 @@ items: 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 + deprecated: false + required: false + description: >- + Please input the Segment trait names on the left and their corresponding + Eloqua Custom Account Field names on the right. The traits must be set up + in the Eloqua dashboard prior to instantiating this mapping. + + + **Note:** If you have set up Custom Account Fields in Eloqua, please + ensure the corresponding Segment payload property values are of the same + data type specified in Eloqua's dashboard. Eloqua will reject any event + containing a Custom Account Field with an incorrect data type. + settings: [] - name: mappedIdentifyTraits display_name: Map Custom Traits to Contacts type: MAP @@ -5843,6 +5827,24 @@ items: data type specified in Eloqua's dashboard. Eloqua will reject any event containing a Custom Contact 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: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your Site ID + settings: [] connection_modes: device: web: true @@ -5977,16 +5979,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: meta - display_name: Include custom user data with Errorception's error tracking - type: BOOLEAN - deprecated: false - required: false - description: >- - When this option is enabled we will store metadata about the user on - `identify` calls, using the [Errorception `meta` - API](http://blog.errorception.com/2012/11/capture-custom-data-with-your-errors.html). - settings: [] - name: projectId display_name: Project ID type: STRING @@ -6001,6 +5993,16 @@ items: out of your Errorception URL, `/projects/PROJECT_ID`. It should be 24 characters long and look something like this: `326b76b52f52c3f662000140`. settings: [] + - name: meta + display_name: Include custom user data with Errorception's error tracking + type: BOOLEAN + deprecated: false + required: false + description: >- + When this option is enabled we will store metadata about the user on + `identify` calls, using the [Errorception `meta` + API](http://blog.errorception.com/2012/11/capture-custom-data-with-your-errors.html). + settings: [] connection_modes: device: web: true @@ -6342,20 +6344,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: - - name: legacyEvents - display_name: Legacy Conversion Pixel IDs - type: MAP - deprecated: false - required: false - description: >- - These are your - **[deprecated](https://developers.facebook.com/docs/ads-for-websites)** - Conversion Pixel IDs from Facebook Conversion Tracking. Facebook will - still accept data in this format, though it's no longer possible to create - conversion Pixel IDs. Now you create conversions based on standard and - custom events inside their interface. Enter your event name in the left - column and your pixel ID in the right column. - settings: [] - name: pixelId display_name: Pixel ID type: STRING @@ -6367,16 +6355,39 @@ items: 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 - type: MAP + - name: standardEventsCustomProperties + display_name: Standard Events custom properties + type: LIST deprecated: false required: false description: >- - Enter your category value on the left, and the Facebook content type to - map to on the right. Facebook recognizes certain event types that can help - deliver relevant ads. If no category values are mapped we'll default to - `product` and `product_group`, depending on the event. + Add here all the custom properties you want to send as part of your + Standard Events (Order Completed, Checkout Started, etc) as `property + name`. + settings: [] + - name: blacklistPiiProperties + display_name: Blacklist PII Properties + type: MIXED + 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: keyForExternalId display_name: 'Client-Side Only: Advanced Match Trait Key for External ID' @@ -6391,6 +6402,58 @@ items: will use the value of this trait to map it to Facebook Pixel's `external_id`. settings: [] + - name: valueIdentifier + display_name: Value Field Identifier + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - price + - value + description: >- + For pre-purchase events such as `Product Viewed` and `Product Added`, + choose which Segment property you would like to map to Facebook's value + property. + settings: [] + - name: whitelistPiiProperties + display_name: Whitelist PII Properties + type: LIST + deprecated: false + required: false + description: >- + By default, Segment will strip any PII from the properties of `track` + events that get sent to Facebook. If you would like to override this + functionality, you can input each property you would like to whitelist as + a line item in this setting. **Please reference our + [documentation](https://segment.com/docs/destinations/facebook-pixel/#pii-blacklisting) + for the exact property names we filter out.** + settings: [] + - name: contentTypes + display_name: Map Categories to FB Content Types + type: MAP + deprecated: false + required: false + description: >- + Enter your category value on the left, and the Facebook content type to + map to on the right. Facebook recognizes certain event types that can help + deliver relevant ads. If no category values are mapped we'll default to + `product` and `product_group`, depending on the event. + settings: [] + - name: legacyEvents + display_name: Legacy Conversion Pixel IDs + type: MAP + deprecated: false + required: false + description: >- + These are your + **[deprecated](https://developers.facebook.com/docs/ads-for-websites)** + Conversion Pixel IDs from Facebook Conversion Tracking. Facebook will + still accept data in this format, though it's no longer possible to create + conversion Pixel IDs. Now you create conversions based on standard and + custom events inside their interface. Enter your event name in the left + column and your pixel ID in the right column. + settings: [] - name: standardEvents display_name: Map Your Events to Standard FB Events type: MAP @@ -6428,16 +6491,6 @@ 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 @@ -6447,57 +6500,6 @@ items: Enable this setting if you want to send, `userId` (or `anonymousId` if not present) as external Id to Facebook. settings: [] - - name: valueIdentifier - display_name: Value Field Identifier - type: SELECT - deprecated: false - required: false - select_validators: - select_options: - - price - - value - description: >- - For pre-purchase events such as `Product Viewed` and `Product Added`, - choose which Segment property you would like to map to Facebook's value - property. - settings: [] - - name: 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 @@ -6533,15 +6535,6 @@ 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 @@ -6553,6 +6546,15 @@ 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 @@ -6642,15 +6644,6 @@ 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 @@ -6699,6 +6692,15 @@ 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 @@ -7020,25 +7022,6 @@ 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 - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your _fs_org on the FullStory settings page by logging into - your account, clicking the settings icon on the bottom left, and looking - in the recording snippet for window['_fs_org'] - settings: [] - name: trackAllPages display_name: Track All Pages type: BOOLEAN @@ -7060,6 +7043,25 @@ 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: [] + - name: org + display_name: FS Org + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + You can find your _fs_org on the FullStory settings page by logging into + your account, clicking the settings icon on the bottom left, and looking + in the recording snippet for window['_fs_org'] + settings: [] connection_modes: device: web: true @@ -7196,17 +7198,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: accessKey - display_name: Access Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-z0-9-]{36}$' - description: >- - It should be 36 characters long, and look something like this: - `35a84f9e-7084-47a1-b8a5-593444e9e862`. - settings: [] - name: events display_name: Whitelist Track Events type: MIXED @@ -7233,6 +7224,17 @@ items: those events through. Put the name of your `.track()` events here, ie. 'Order Completed' settings: [] + - name: accessKey + display_name: Access Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-z0-9-]{36}$' + description: >- + It should be 36 characters long, and look something like this: + `35a84f9e-7084-47a1-b8a5-593444e9e862`. + settings: [] connection_modes: device: web: false @@ -7369,6 +7371,16 @@ 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 @@ -7395,36 +7407,6 @@ items: Enable if you need to anonymize the IP address of visitors to your website. settings: [] - - name: apiKey - display_name: API Key (Server-side) - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Generate your server-side API key here: - https://www.gosquared.com/settings/api - settings: [] - - name: 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: 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: apiSecret display_name: Site Token type: STRING @@ -7450,6 +7432,26 @@ items: example’s subdomains. By default, cookies are set on the current domain (including subdomain) only. 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: apiKey + display_name: API Key (Server-side) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Generate your server-side API key here: + https://www.gosquared.com/settings/api + settings: [] connection_modes: device: web: true @@ -7486,30 +7488,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: linkId - display_name: Link Id - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - The AdWords Link Id associated with Segment. The process for obtaining - this can be found - [here](https://support.google.com/adwords/answer/7365001). To create this - Link Id, you must input Segment's Provider Id: **7552494388** - - - **Important:** this setting is required only if you are using the new - AdWords for mobile implementations. - settings: [] - - name: pageRemarketing - display_name: Page Remarketing - type: BOOLEAN - deprecated: false - required: false - description: Enable this to send a remarketing tag with your page calls - settings: [] - name: trackAttributionData display_name: Track Attribution Data type: BOOLEAN @@ -7608,6 +7586,30 @@ items: 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: [] + - name: linkId + display_name: Link Id + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + The AdWords Link Id associated with Segment. The process for obtaining + this can be found + [here](https://support.google.com/adwords/answer/7365001). To create this + Link Id, you must input Segment's Provider Id: **7552494388** + + + **Important:** this setting is required only if you are using the new + AdWords for mobile implementations. + settings: [] + - name: pageRemarketing + display_name: Page Remarketing + type: BOOLEAN + deprecated: false + required: false + description: Enable this to send a remarketing tag with your page calls + settings: [] connection_modes: device: web: true @@ -7644,26 +7646,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: accountId - display_name: Google Conversion ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: ^AW-.+ - description: >- - Enter your GOOGLE-CONVERSION-ID. You can get this value from your global - site tag snippet. It should look something like `AW-901243031` - settings: [] - - name: clickConversions - display_name: Click Conversions - type: MIXED - deprecated: false - required: false - description: >- - You can map your `.track()` events to specific AdWords Click Conversions - by providing your event `name` and the Conversion ID. - settings: [] - name: conversionLinker display_name: Conversion Linker type: BOOLEAN @@ -7707,24 +7689,44 @@ items: conversions will be sent as remarketing hits which will allow you to create audiences based on those properties. settings: [] - connection_modes: - device: - web: true - mobile: false - server: false - cloud: - web: false - mobile: false - server: false - previous_names: - - Google AdWords New - - Google Ads (Google Tag Manager) - - Google Ads (Gtag) -- display_name: Google Analytics - slug: google-analytics - name: catalog/destinations/google-analytics - description: >- - Google Analytics is the most popular analytics tool for the web. It’s free + - name: accountId + display_name: Google Conversion ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: ^AW-.+ + description: >- + Enter your GOOGLE-CONVERSION-ID. You can get this value from your global + site tag snippet. It should look something like `AW-901243031` + settings: [] + - name: clickConversions + display_name: Click Conversions + type: MIXED + deprecated: false + required: false + description: >- + You can map your `.track()` events to specific AdWords Click Conversions + by providing your event `name` and the Conversion ID. + settings: [] + connection_modes: + device: + web: true + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + previous_names: + - Google AdWords New + - Google Ads (Google Tag Manager) + - Google Ads (Gtag) +- display_name: Google Analytics + slug: google-analytics + name: catalog/destinations/google-analytics + description: >- + Google Analytics is the most popular analytics tool for the web. It’s free and provides a wide range of features. It’s especially good at measuring traffic sources and ad campaigns. hidden: false @@ -7748,32 +7750,41 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: includeSearch - display_name: Include the Querystring in Page Views + - name: doubleClick + display_name: 'Remarketing, Display Ads and Demographic Reports.' type: BOOLEAN deprecated: false required: false + description: Works with both Universal and Classic tracking methods. + settings: [] + - name: trackingId + display_name: Website Tracking ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: ^UA-\d+-\d+$ description: >- - The querystring doesn't usually affect the content of the page in a - significant way (like sorting), so we disable this by default. + Your website's Tracking ID is in the **Tracking Info** tab on the [Admin + Page](https://www.google.com/analytics/web/#management/Property) of Google + Analytics. Leave it blank if you don't have a website property. settings: [] - - name: setAllMappedProps - display_name: Set Custom Dimensions & Metrics to the Page + - name: useGoogleAmpClientId + display_name: Use Google AMP Client ID 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. + Google’s AMP Client ID API lets you uniquely identify users who engage + with your content on AMP and non-AMP pages. If you opt-in, Google + Analytics will use the user's AMP Client ID to determine that multiple + site events belong to the same user when those users visit AMP pages via a + [Google viewer](https://support.google.com/websearch/answer/7220196). + Associating events and users provides features like user counts and + session-based metrics. *Enabling this feature will affect your reporting.* + Please carefully reference Google's + [documentation](https://support.google.com/analytics/answer/7486764?hl=en&ref_topic=7378717) + for more info before you enable it. settings: [] - name: contentGroupings display_name: Content Groupings @@ -7794,30 +7805,42 @@ items: value of the property you designate as the value of the specified content grouping. settings: [] - - name: enhancedLinkAttribution - display_name: Enable Enhanced Link Attribution + - name: enhancedEcommerce + display_name: Enable Enhanced Ecommerce type: BOOLEAN deprecated: false required: false description: >- - Provides more detailed reports on the links clicked on your site. Read - more about it in the [Google support - documentation](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-link-attribution). + 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: identifyCategory - display_name: Server Side Identify Event Category + - name: identifyEventName + display_name: Server Side Identify Event Action type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - If you have **Enabled Server Side Identify**, you can specify 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. + If you have **Enabled Server Side Identify**, you can specify what the + event action will be since all custom metrics/dimensions for server side + `.identify()` calls will be sent via an event hit to GA. The default value + will be `'User Enriched'` + settings: [] + - name: siteSpeedSampleRate + display_name: Site Speed Sample Rate + type: NUMBER + deprecated: false + required: false + number_validators: + min: 1 + max: 100 + 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). settings: [] - name: trackNamedPages display_name: Track Named Pages @@ -7830,56 +7853,55 @@ 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 + - name: anonymizeIp + display_name: Anonymize IP Addresses 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. + For client side libraries. Read more about anonymizing IP addresses from + the [Google support + documentation](https://support.google.com/analytics/answer/2763052?hl=en). settings: [] - - name: useGoogleAmpClientId - display_name: Use Google AMP Client ID - type: BOOLEAN + - name: ignoredReferrers + display_name: Ignored Referrers + type: MULTI_LINE_STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - Google’s AMP Client ID API lets you uniquely identify users who engage - with your content on AMP and non-AMP pages. If you opt-in, Google - Analytics will use the user's AMP Client ID to determine that multiple - site events belong to the same user when those users visit AMP pages via a - [Google viewer](https://support.google.com/websearch/answer/7220196). - Associating events and users provides features like user counts and - session-based metrics. *Enabling this feature will affect your reporting.* - Please carefully reference Google's - [documentation](https://support.google.com/analytics/answer/7486764?hl=en&ref_topic=7378717) - for more info before you enable it. + 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: dimensions - display_name: Custom Dimensions - type: MAP + - name: resetCustomDimensionsOnPage + display_name: Reset dimensions on Page calls + type: LIST deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 200 - map_prefix: dimension - select_options: [] description: >- - Because Google Analytics cannot accept arbitrary data about users or - events, when you use `analytics.identify(userId, traits)` with custom - traits or `analytics.track('event', properties)` with custom properties, - you need to map those traits and properties to Google Analytics custom - dimensions if you want them to be sent to GA. Enter a trait or property - name on the left. Choose the Google Analytics dimension you want on the - right. Google Analytics only accepts numbered dimensions (e.g. - dimension3). We suggest using user-scoped dimensions for trait mappings - and hit-scoped dimensions for properties [Contact - us](https://segment.com/contact) if you need help! + 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: mobileTrackingId + display_name: Mobile Tracking ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: ^UA-\d+-\d+$ + description: >- + Google Analytics tracks mobile apps separately, so you'll want to create a + separate Google Analytics mobile app property. Remember to only add a + mobile tracking ID if you're tracking from a mobile library. If you're + tracking from a hybrid app, fill in your website tracking ID instead. + Leave it blank if you don't have a mobile app property. settings: [] - name: optimize display_name: Optimize Container ID @@ -7892,16 +7914,6 @@ items: Integrate with Google Analytics Optimize plugin. Please enter your Optimize Container ID settings: [] - - name: resetCustomDimensionsOnPage - display_name: Reset dimensions on Page calls - type: LIST - deprecated: false - required: false - description: >- - If you have an SPA website, and need to reset custom dimensions between - page calls, add to this setting all the properties (already mapped as - custom dimensions) that need to be reset for each page call. - settings: [] - name: reportUncaughtExceptions display_name: Send Uncaught Exceptions to GA (Mobile) type: BOOLEAN @@ -7911,115 +7923,152 @@ items: This lets you study errors and exceptions in your iOS and Android apps in Google Analytics. settings: [] - - name: serversideTrackingId - display_name: Serverside Tracking ID - type: STRING + - name: setAllMappedProps + display_name: Set Custom Dimensions & Metrics to the Page + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: ^UA-\d+-\d+$ description: >- - Your Serverside Tracking ID is the UA code for the Google Analytics - property you want to send server-side calls to. Leave it blank if you - don't have a server-side client library that you want to send data from. - Remember that data tracked from mobile integrations that are not bundled - in your app send data to Google Analytics server side, since Segment sends - data to them via our own servers. + 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: trackCategorizedPages - display_name: Track Categorized Pages - type: BOOLEAN + - name: sampleRate + display_name: Sample Rate + type: NUMBER deprecated: false required: false + number_validators: + min: 1 + max: 100 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**. + Specifies what percentage of users should be tracked. This defaults to 100 + (no users are sampled out) but large sites may need to use a lower sample + rate to stay within Google Analytics processing limits as [seen + here](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#sampleRate). + Currently only available in the browser - mobile coming soon. settings: [] - - name: enableServerIdentify - display_name: Enable Server Side Identify + - name: classic + display_name: Use Classic Analytics on Your Site 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. + **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 + - name: domain + display_name: Cookie Domain Name type: STRING deprecated: false required: false string_validators: - regexp: '' + regexp: '^none$|^[a-zA-Z0-9_-]+\.[.a-zA-Z0-9_-]+$' 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'` + _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: ignoredReferrers - display_name: Ignored Referrers - type: MULTI_LINE_STRING + - name: enhancedLinkAttribution + display_name: Enable Enhanced Link Attribution + type: BOOLEAN deprecated: false required: false - string_validators: + 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). + settings: [] + - name: metrics + display_name: Custom Metrics + type: MAP + deprecated: false + required: false + map_validators: regexp: '' + min: 0 + max: 200 + map_prefix: metric + select_options: [] description: >- - 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._ + Because Google Analytics cannot accept arbitrary data about users or + events, when you use `analytics.identify(userId, traits)` with custom + numerical traits or `analytics.track('event', properties)` with custom + numerical properties, you need to map those traits and properties to + Google Analytics custom metrics if you want them to be sent to GA. Enter a + trait or property name on the left. Choose the Google Analytics metric you + want on the right. Google Analytics only accepts numbered metrics (e.g. + metric3). We suggest using user-scoped metrics for trait mappings and + hit-scoped metrics for properties. [Contact + us](https://segment.com/contact) if you need help! settings: [] - - name: doubleClick - display_name: 'Remarketing, Display Ads and Demographic Reports.' + - name: nonInteraction + display_name: Add the non-interaction flag to all events type: BOOLEAN deprecated: false required: false - description: Works with both Universal and Classic tracking methods. + description: >- + Adds a _noninteraction: true flag_ to every event tracked to Google + Analytics. If you're seeing unusually low bounce rates this will solve + that issue. settings: [] - - name: serversideClassic - display_name: Use Classic Analytics for Your Serverside Tracking + - 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 profiles 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: anonymizeIp - display_name: Anonymize IP Addresses + - name: enableServerIdentify + display_name: Enable Server Side Identify type: BOOLEAN deprecated: false required: false description: >- - For client side libraries. Read more about anonymizing IP addresses from - the [Google support - documentation](https://support.google.com/analytics/answer/2763052?hl=en). + If you are sending `.identify()` calls from your server side libraries or + have Segment Cloud Apps that send back `.identify()` calls with enriched + user traits, you can send that data to your GA account via custom + dimensions and metrics. Unlike the client side integration which has the + luxury of browsers and the global window `ga` tracker, for server side we + will check your `traits` and your settings for custom dimension/metric + mappings and send it with an explicit event. settings: [] - - name: classic - display_name: Use Classic Analytics on Your Site - type: BOOLEAN + - name: identifyCategory + display_name: Server Side Identify Event Category + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - **Important:** When creating your Google Analytics profile, you can choose - between **Classic** and **Universal** Analytics. After March 2013, new - profiles default to Universal, while earlier ones are Classic. An easy - test: if you see `_gaq.push` in your code you're using Classic, so enable - this. + If you have **Enabled Server Side Identify**, you can specify 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: protocolMappings display_name: Map Traits or Properties to Measurement Protocol Params @@ -8040,63 +8089,57 @@ items: 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 + - name: sendUserId + display_name: Send User-ID to GA type: BOOLEAN deprecated: false required: false description: >- - Adds a _noninteraction: true flag_ to every event tracked to Google - Analytics. If you're seeing unusually low bounce rates this will solve - that issue. + User-ID enables the analysis of groups of sessions across devices, using a + unique and persistent ID. This only works with Google Analytics Universal. + IMPORTANT: Sending email or other personally identifiable information + (PII) violates Google Analytics Terms of Service. settings: [] - - name: siteSpeedSampleRate - display_name: Site Speed Sample Rate - type: NUMBER + - name: serversideClassic + display_name: Use Classic Analytics for Your Serverside Tracking + type: BOOLEAN deprecated: false required: false - number_validators: - min: 1 - max: 100 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). + **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: trackingId - display_name: Website Tracking ID + - name: serversideTrackingId + display_name: Serverside Tracking ID type: STRING deprecated: false required: false string_validators: regexp: ^UA-\d+-\d+$ description: >- - Your website's Tracking ID is in the **Tracking Info** tab on the [Admin - Page](https://www.google.com/analytics/web/#management/Property) of Google - Analytics. Leave it blank if you don't have a website property. + Your Serverside Tracking ID is the UA code for the Google Analytics + property you want to send server-side calls to. Leave it blank if you + don't have a server-side client library that you want to send data from. + Remember that data tracked from mobile integrations that are not bundled + in your app send data to Google Analytics server side, since Segment sends + data to them via our own servers. settings: [] - - name: domain - display_name: Cookie Domain Name - type: STRING + - name: typeOverride + display_name: Send Segment "Product List" Events to GA as "Event" Hits + 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). + 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: metrics - display_name: Custom Metrics + - name: dimensions + display_name: Custom Dimensions type: MAP deprecated: false required: false @@ -8104,43 +8147,28 @@ items: regexp: '' min: 0 max: 200 - map_prefix: metric + map_prefix: dimension select_options: [] description: >- Because Google Analytics cannot accept arbitrary data about users or - events, when you use `analytics.identify(userId, traits)` with custom - numerical traits or `analytics.track('event', properties)` with custom - numerical properties, you need to map those traits and properties to - Google Analytics custom metrics if you want them to be sent to GA. Enter a - trait or property name on the left. Choose the Google Analytics metric you - want on the right. Google Analytics only accepts numbered metrics (e.g. - metric3). We suggest using user-scoped metrics for trait mappings and - hit-scoped metrics for properties. [Contact - us](https://segment.com/contact) if you need help! - settings: [] - - name: mobileTrackingId - display_name: Mobile Tracking ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: ^UA-\d+-\d+$ - description: >- - Google Analytics tracks mobile apps separately, so you'll want to create a - separate Google Analytics mobile app property. Remember to only add a - mobile tracking ID if you're tracking from a mobile library. If you're - tracking from a hybrid app, fill in your website tracking ID instead. - Leave it blank if you don't have a mobile app property. + 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: enhancedEcommerce - display_name: Enable Enhanced Ecommerce + - name: includeSearch + display_name: Include the Querystring in Page Views 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). + 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: nameTracker display_name: Name Tracker @@ -8154,32 +8182,6 @@ items: tracker name to any native Google Analytics (except for create) that you call, e.g. 'segmentGATracker.require(....)' settings: [] - - name: sampleRate - display_name: Sample Rate - type: NUMBER - deprecated: false - required: false - number_validators: - min: 1 - max: 100 - description: >- - Specifies what percentage of users should be tracked. This defaults to 100 - (no users are sampled out) but large sites may need to use a lower sample - rate to stay within Google Analytics processing limits as [seen - here](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#sampleRate). - Currently only available in the browser - mobile coming soon. - settings: [] - - name: sendUserId - display_name: Send User-ID to GA - type: BOOLEAN - 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 @@ -8316,6 +8318,19 @@ 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 @@ -8359,19 +8374,6 @@ 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 @@ -8453,6 +8455,15 @@ 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 @@ -8471,15 +8482,6 @@ 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 @@ -9073,27 +9075,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: domain - display_name: Domain + - name: projectId + display_name: Project ID type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your Improvely domain in your Improvely analytics code - snippet as `im_domain`. + You can find your Improvely project id in your Improvely analytics code + snippet as `im_project_id`. settings: [] - - name: projectId - display_name: Project ID + - name: domain + display_name: Domain type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your Improvely project id in your Improvely analytics code - snippet as `im_project_id`. + You can find your Improvely domain in your Improvely analytics code + snippet as `im_domain`. settings: [] connection_modes: device: @@ -9280,17 +9282,6 @@ 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 @@ -9311,6 +9302,17 @@ items: regexp: '' description: Enter 'AWS' or 'Azure' settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: >- + Enter your S3 credentials or your Azure Blob Storage Shared Access + Signature (SAS). + settings: [] connection_modes: device: web: false @@ -9353,15 +9355,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: mobileApiKey - display_name: Enter your Mobile API Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: 'Note: this is **required** to send data to Intercom from your mobile apps.' - settings: [] - name: oauth display_name: OAuth type: BOOLEAN @@ -9441,6 +9434,15 @@ items: required: false description: '' settings: [] + - name: mobileApiKey + display_name: Enter your Mobile API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: 'Note: this is **required** to send data to Intercom from your mobile apps.' + settings: [] connection_modes: device: web: true @@ -9477,6 +9479,15 @@ 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 @@ -9497,15 +9508,6 @@ 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 @@ -9544,18 +9546,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your iterable API key under your "API Configuration - Settings". It should look something like this: - 42f187310705012194bd0bd694905664ae. - settings: [] - name: mapAllPagesToSingleEventName display_name: Map All Pages to Single Event Name type: BOOLEAN @@ -9592,6 +9582,18 @@ items: required: false description: Send an event for every page or screen with a name. settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + You can find your iterable API key under your "API Configuration + Settings". It should look something like this: + 42f187310705012194bd0bd694905664ae. + settings: [] connection_modes: device: web: false @@ -9630,6 +9632,17 @@ 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 @@ -9651,17 +9664,6 @@ 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 @@ -9773,6 +9775,44 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: + - name: uaAddon + display_name: UserAgent Addon + type: BOOLEAN + deprecated: false + required: false + description: Enable this to use the Keen's data enrichment to parse UserAgent strings. + settings: [] + - name: ipAddon + display_name: Geo IP Addon + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this to use Keen's data enrichment feature to add geographic + information based on IP. + settings: [] + - name: projectId + display_name: Project ID + type: STRING + 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: trackCategorizedPages + display_name: Track Categorized Pages to Keen + type: BOOLEAN + deprecated: false + required: false + description: >- + This will track events to Keen 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 to Keen type: BOOLEAN @@ -9784,6 +9824,16 @@ items: `name` associated with them. For example `page('Signup')` would translate to **Viewed Signup Page**. settings: [] + - name: urlAddon + display_name: URL Parsing Addon + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this to use the Keen's data enrichment feature for parsing URLs + into its components for easier filtering. Note that `userAgent` is only + collected on Android, not on iOS. + settings: [] - name: writeKey display_name: Write Key type: STRING @@ -9806,14 +9856,17 @@ items: 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 + - name: readKey + display_name: Read Key + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - Enable this to use Keen's data enrichment feature to add geographic - information based on IP. + If you are a Keen Pro user, enter your read key in the advanced settings + tab of your dashboard. It should be a minimum of 32 characters long and + made up of numbers and letters only. settings: [] - name: referrerAddon display_name: Referrer Parsing Addon @@ -9833,57 +9886,6 @@ items: This will track **Loaded a Page** events to Keen for all [`page` method](https://segment.io/libraries/analytics.js#page) calls. settings: [] - - name: trackCategorizedPages - display_name: Track Categorized Pages to Keen - type: BOOLEAN - deprecated: false - required: false - description: >- - This will track events to Keen 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: 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: >- - 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 - type: BOOLEAN - deprecated: false - required: false - description: Enable this to use the Keen's data enrichment to parse UserAgent strings. - settings: [] - - name: urlAddon - display_name: URL Parsing Addon - type: BOOLEAN - 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 @@ -9977,29 +9979,6 @@ 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 - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Note: this is **required** to use the List API. You can find this by going - to Klaviyo's UI and clicking Account > Settings > API Keys > Create API - Key - settings: [] - name: sendAnonymous display_name: Fallback on Anonymous ID type: BOOLEAN @@ -10062,6 +10041,29 @@ 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: [] + - name: privateKey + display_name: Enter your Private Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Note: this is **required** to use the List API. You can find this by going + to Klaviyo's UI and clicking Account > Settings > API Keys > Create API + Key + settings: [] connection_modes: device: web: true @@ -10238,37 +10240,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: appId - display_name: Leanplum Application Id - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - The application ID. To find yours, select your app in the navigation - column, and click Edit Apps. Under Keys, click Show. - settings: [] - - name: clientKey - display_name: Leanplum Client Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Either the Production or Development keys, depending on which API call you - want to make. - settings: [] - - name: devMode - display_name: Use Leanplum in Development Mode - type: BOOLEAN - deprecated: false - required: false - description: >- - To use development mode, you must also input your Development key as the - client key. - settings: [] - name: gcmSenderId display_name: GCM Sender ID type: STRING @@ -10301,6 +10272,37 @@ items: use Leanplum's built in sender ID instead. If you have set your own GCM Sender ID and enable this setting, both IDs will be used. settings: [] + - name: appId + display_name: Leanplum Application Id + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + The application ID. To find yours, select your app in the navigation + column, and click Edit Apps. Under Keys, click Show. + settings: [] + - name: clientKey + display_name: Leanplum Client Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Either the Production or Development keys, depending on which API call you + want to make. + settings: [] + - name: devMode + display_name: Use Leanplum in Development Mode + type: BOOLEAN + deprecated: false + required: false + description: >- + To use development mode, you must also input your Development key as the + client key. + settings: [] connection_modes: device: web: false @@ -10380,6 +10382,15 @@ 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 @@ -10391,15 +10402,6 @@ 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 @@ -10557,6 +10559,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: setOrganizationScope + display_name: Use Organization Scope for Attributes + type: BOOLEAN + deprecated: false + required: false + description: >- + This allows a user to set the `profileScope` of attributes within + Localytics to Organization. If this is enabled, the attributes that you + set for a user will be available across all of your apps in Localytics. If + it's unchecked, we'll use the default SDK behavior of Application scoping. + settings: [] - name: appKey display_name: App Key type: STRING @@ -10621,17 +10634,6 @@ items: If an App stays in the background for more than this many seconds, start a new session when it returns to foreground. settings: [] - - name: setOrganizationScope - display_name: Use Organization Scope for Attributes - type: BOOLEAN - deprecated: false - required: false - description: >- - This allows a user to set the `profileScope` of attributes within - Localytics to Organization. If this is enabled, the attributes that you - set for a user will be available across all of your apps in Localytics. If - it's unchecked, we'll use the default SDK behavior of Application scoping. - settings: [] connection_modes: device: web: true @@ -10717,27 +10719,6 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^\w{10,30}$' - description: >- - Your API key should be a series of numbers and letters, like - `3daDLlqb4ANg7l0rf4cfl6xF`. This is only required if you are using the - Lytics server side integration. - settings: [] - - name: blockload - display_name: Ensure Entity - type: BOOLEAN - deprecated: false - required: false - description: >- - If `true`, ensures entity returned from Lytics personalization api - reflects all events from current page view. - settings: [] - name: cid display_name: CID type: STRING @@ -10761,11 +10742,32 @@ items: type: STRING deprecated: false required: false - string_validators: - regexp: '^[-_\w]{3,50}$' + string_validators: + regexp: '^[-_\w]{3,50}$' + description: >- + A brief, but informative name for organizating your data in Lytics. Only + necessary when you are tracking multiple websites. + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^\w{10,30}$' + description: >- + Your API key should be a series of numbers and letters, like + `3daDLlqb4ANg7l0rf4cfl6xF`. This is only required if you are using the + Lytics server side integration. + settings: [] + - name: blockload + display_name: Ensure Entity + type: BOOLEAN + deprecated: false + required: false description: >- - A brief, but informative name for organizating your data in Lytics. Only - necessary when you are tracking multiple websites. + If `true`, ensures entity returned from Lytics personalization api + reflects all events from current page view. settings: [] connection_modes: device: @@ -10844,6 +10846,17 @@ 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 @@ -10877,17 +10890,6 @@ 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 @@ -10923,25 +10925,25 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: Authentication key + - name: listId + display_name: List ID type: STRING deprecated: false required: true string_validators: regexp: '' - description: Your Mailjet Authentication key + description: >- + Please provide the default list id for which contacts will be associated + with settings: [] - - name: listId - display_name: List ID + - name: apiKey + display_name: Authentication key type: STRING deprecated: false required: true string_validators: regexp: '' - description: >- - Please provide the default list id for which contacts will be associated - with + description: Your Mailjet Authentication key settings: [] connection_modes: device: @@ -11124,6 +11126,24 @@ 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 @@ -11173,24 +11193,6 @@ items: 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 @@ -11346,6 +11348,38 @@ items: required: false description: Configure a conversion pixel settings: + - name: vParameters + display_name: V-Parameters + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 10 + map_prefix: v + select_options: [] + description: >- + Map event properties to vParameters and we'll insert the value of that + property in the corresponding query parameter of the MediaMath Pixel. + Email [friends@segment.io](mailto:friends@segment.io) if you need help! + settings: [] + - name: sParameters + display_name: S-Parameters + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 10 + map_prefix: s + select_options: [] + description: >- + Map event properties to sParameters and we'll insert the value of that + property in the corresponding query parameter of the MediaMath Pixel. + Email [friends@segment.io](mailto:friends@segment.io) if you need help! + settings: [] - name: event display_name: Event Name type: STRING @@ -11381,38 +11415,6 @@ items: Enter the `mt_adid` that you want us to send when this conversion event is triggered. settings: [] - - name: vParameters - display_name: V-Parameters - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 10 - map_prefix: v - select_options: [] - description: >- - Map event properties to vParameters and we'll insert the value of that - property in the corresponding query parameter of the MediaMath Pixel. - Email [friends@segment.io](mailto:friends@segment.io) if you need help! - settings: [] - - name: sParameters - display_name: S-Parameters - type: MAP - deprecated: false - required: false - map_validators: - regexp: '' - min: 0 - max: 10 - map_prefix: s - select_options: [] - description: >- - Map event properties to sParameters and we'll insert the value of that - property in the corresponding query parameter of the MediaMath Pixel. - Email [friends@segment.io](mailto:friends@segment.io) if you need help! - settings: [] connection_modes: device: web: true @@ -11508,6 +11510,89 @@ items: This will mark the Mixpanel cookie as secure, meaning it will only be transmitted over https settings: [] + - name: setAllTraitsByDefault + display_name: Automatically set all Traits as Super Properties and People Properties + type: BOOLEAN + deprecated: false + required: false + description: >- + While this is checked, our integration automatically sets all traits on + identify calls as super properties and people properties if Mixpanel + People is checked as well. + settings: [] + - name: superProperties + display_name: Properties to send as Super Properties + type: LIST + 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: 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: eventIncrements + display_name: Events 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, you will need to: + + 1. Enable the "Use Mixpanel People" setting. + + 2. List the events you want to see in People here. + 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: people + display_name: Use Mixpanel People + type: BOOLEAN + deprecated: false + required: false + description: >- + This will send all of your + [identify](https://segment.io/docs/methods/identify) calls to Mixpanel's + People feature. + settings: [] - name: sourceName display_name: Source Name type: STRING @@ -11516,8 +11601,37 @@ items: string_validators: regexp: '' description: >- - This value, if it's not blank, will be sent as `segment_source_name` to - Mixpanel for every `event`/`page`/`screen` call. + This value, if it's not blank, will be sent as `segment_source_name` to + Mixpanel for every `event`/`page`/`screen` call. + 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: 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: token display_name: Token @@ -11540,38 +11654,15 @@ items: 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 + - 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, you will need to: - - 1. Enable the "Use Mixpanel People" setting. - - 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. + Mixpanel people, enable people, and then list the events you want to see + in People here. settings: [] - name: trackNamedPages display_name: Track Named Pages to Mixpanel @@ -11584,17 +11675,6 @@ items: `name` associated with them. For example `page('Signup')` would translate to **Viewed Signup Page**. 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: groupIdentifierTraits display_name: Group Identifier Traits type: LIST @@ -11606,35 +11686,6 @@ items: 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 - type: BOOLEAN - deprecated: false - required: false - description: >- - This will send all of your - [identify](https://segment.io/docs/methods/identify) calls to Mixpanel's - People feature. - settings: [] - name: peopleProperties display_name: Traits to set as People Properties type: LIST @@ -11659,55 +11710,6 @@ items: `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 - description: >- - This will allow the Mixpanel cookie to persist between different pages of - your application. - 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: [] connection_modes: device: web: true @@ -12038,15 +12040,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: Site ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Your Mouseflow site ID. - settings: [] - name: mouseflowHtmlDelay display_name: Mouseflow HTML Delay type: NUMBER @@ -12057,6 +12050,15 @@ items: max: 0 description: HTML Delay settings: [] + - name: apiKey + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Mouseflow site ID. + settings: [] connection_modes: device: web: true @@ -12385,26 +12387,26 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true 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: [] - - 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: [] connection_modes: @@ -12443,6 +12445,34 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: insertKey + display_name: Insert Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Put your New Relic Insert Key + settings: [] + - name: sendContext + display_name: Send Device Context + type: BOOLEAN + deprecated: false + required: false + description: >- + If you enable this setting, we will flatten all your `context` fields + delimited by a period and send it to New Relic. This is recommended as + getting rich device context is useful inside New Relic. + settings: [] + - name: sendIds + display_name: Send UserId and AnonymousId + type: BOOLEAN + deprecated: false + required: false + description: >- + If you want to send your Segment `userId` and `anonymousId`, enabling this + option will do so. + settings: [] - name: accountId display_name: Account ID type: STRING @@ -12473,34 +12503,6 @@ items: Enter your Segment `.track()` event names on the left and their respective eventType (table name) in New Relic. settings: [] - - name: insertKey - display_name: Insert Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: Put your New Relic Insert Key - settings: [] - - name: sendContext - display_name: Send Device Context - type: BOOLEAN - deprecated: false - required: false - description: >- - If you enable this setting, we will flatten all your `context` fields - delimited by a period and send it to New Relic. This is recommended as - getting rich device context is useful inside New Relic. - settings: [] - - name: sendIds - display_name: Send UserId and AnonymousId - type: BOOLEAN - deprecated: false - required: false - description: >- - If you want to send your Segment `userId` and `anonymousId`, enabling this - option will do so. - settings: [] connection_modes: device: web: false @@ -12537,20 +12539,16 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: subbrandPropertyName - display_name: Subbrand Property Name - type: STRING + - name: nolDevDebug + display_name: Enable Debug Mode + type: BOOLEAN 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`. + Check this setting if you would like to activate the Debug flag. Once the + flag is active, it logs each API call made and the data passed. + + Note: DO NOT: activate the Debug flag in a production environment. settings: [] - name: adAssetIdPropertyName display_name: Custom Ad Asset Id Property Name @@ -12573,43 +12571,46 @@ items: regexp: '' description: Enter your Nielsen DCR App ID. settings: [] - - name: clientIdPropertyName - display_name: Client Id Property Name + - name: instanceName + display_name: Instance 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 can optionally define the explicit name of the Nielsen instance we + initialize its SDK with. settings: [] - - name: contentLengthPropertyName - display_name: Content Length Property Name + - name: subbrandPropertyName + display_name: Subbrand Property Name type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - Segment will map our `total_length` property to Nielsen's `length` field - by default. If you would like to set up a custom property mapping please - indicate the name of the property here. - settings: [] - - name: nolDevDebug - display_name: Enable Debug Mode - type: BOOLEAN + By default, clientid and subbrand are setup in Nielsen backend + configuration to capture brand and sub-brand information. The fields get + populated from backend for a registered client appid. But if an app + contains multiple brands and sub-brands and client is willing to give + credit to another brand or sub-brand then please indicate which property + value from your payload you want to use to override `subbrand`. + settings: [] + - name: clientIdPropertyName + display_name: Client Id Property Name + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - Check this setting if you would like to activate the Debug flag. Once the - flag is active, it logs each API call made and the data passed. - - Note: DO NOT: activate the Debug flag in a production environment. + 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: contentAssetIdPropertyName display_name: Custom Content Asset Id Property Name @@ -12623,16 +12624,17 @@ items: 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 + - name: contentLengthPropertyName + display_name: Content Length Property Name type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - You can optionally define the explicit name of the Nielsen instance we - initialize its SDK with. + Segment will map our `total_length` property to Nielsen's `length` field + by default. If you would like to set up a custom property mapping please + indicate the name of the property here. settings: [] - name: sfCode display_name: Enable Production Mode @@ -12929,21 +12931,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: - - name: cacheExp - display_name: Cache Exp - type: NUMBER - deprecated: false - required: false - number_validators: - min: 300 - max: 0 - description: >- - To optimize the server side integration, we will cache the fetched - *Datafile* that you have provided for this amount of time (in seconds) in - Redis. Since the datafile should not change unless you modified the - conditions or variation rules of your experiments, it is advised to have a - minimum floor of 300 seconds (5 minutes). - settings: [] - name: listen display_name: >- Sends the experiment and variation information as properties on a track @@ -13000,17 +12987,20 @@ 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: 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: fallbackToAnonymousId display_name: Fall Back To Anonymous Id @@ -13060,6 +13050,18 @@ items: **Account ID** from your Optimizely account. You can find this ID by visiting https://app.optimizely.com/v2/accountsettings/account/plan settings: [] + - name: datafileUrl + display_name: Datafile URL + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + In order to use Optimizely X _server side_, you must enter the entire URL + for your datafile. It should look something like + `https://cdn.optimizely.com/json/9218021209.json` + settings: [] connection_modes: device: web: false @@ -13102,35 +13104,6 @@ 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 @@ -13195,6 +13168,35 @@ items: 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 + 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: [] connection_modes: device: web: true @@ -13376,19 +13378,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: dynamicTracking - display_name: Enable Dynamic Tracking - type: BOOLEAN - deprecated: false - required: false - description: >- - If you enable Dynamic Tracking, Segment will disable Parsely autotracking - and instead explicitly proxy your `page()` calls to Parsely. This feature - is recommended if you want Segment to pass additional pageview metadata - collected with your `.page()` properties through to Parsely. [See - here](https://www.parsely.com/help/integration/dynamic/) for more - information. - settings: [] - name: inPixelMetadata display_name: Enable In-Pixel Metadata type: BOOLEAN @@ -13428,6 +13417,19 @@ items: 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 + deprecated: false + required: false + description: >- + If you enable Dynamic Tracking, Segment will disable Parsely autotracking + and instead explicitly proxy your `page()` calls to Parsely. This feature + is recommended if you want Segment to pass additional pageview metadata + collected with your `.page()` properties through to Parsely. [See + here](https://www.parsely.com/help/integration/dynamic/) for more + information. + settings: [] connection_modes: device: web: true @@ -13857,18 +13859,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: customVariableLimit - display_name: Custom Variable Limit - type: NUMBER - deprecated: false - required: false - number_validators: - min: 0 - max: 0 - description: >- - If you have manually changed your Piwik custom variable limit, please - enter your new value here. The Piwik default is 5. - settings: [] - name: goals display_name: Goals type: MAP @@ -13899,6 +13889,18 @@ items: You can find your Server URL in your snippet, we will append `/piwik.php` to the URL automatically. settings: [] + - name: customVariableLimit + display_name: Custom Variable Limit + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: >- + If you have manually changed your Piwik custom variable limit, please + enter your new value here. The Piwik default is 5. + settings: [] connection_modes: device: web: true @@ -14222,16 +14224,6 @@ 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 @@ -14256,6 +14248,16 @@ 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 @@ -14295,15 +14297,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: advertise - display_name: Advertise - type: BOOLEAN - deprecated: false - required: false - description: >- - By default data will be sent to Quantcast Measure, enable this option to - send to Quantcast Advertise - settings: [] - name: advertiseProducts display_name: Advertise Products type: BOOLEAN @@ -14336,6 +14329,15 @@ items: You can find your P-Code in the right-hand column under **Your P-Code** after you login to [Quantcast](https://www.quantcast.com/). settings: [] + - name: advertise + display_name: Advertise + type: BOOLEAN + deprecated: false + required: false + description: >- + By default data will be sent to Quantcast Measure, enable this option to + send to Quantcast Advertise + settings: [] connection_modes: device: web: true @@ -14373,24 +14375,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: clientId - display_name: ClientID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Your QuanticMind account manager will provide your ClientID. - settings: [] - - name: domain - display_name: Domain - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: 'Your QuanticMind account manager will provide your Domain, if needed.' - settings: [] - name: events display_name: Events type: MAP @@ -14409,16 +14393,34 @@ items: the QuanticMind event number you want on the right. Email [friends@segment.io](mailto:friends@segment.io) if you need help! settings: [] - - name: noclick - display_name: Use Order Id For Server Side Attribution - type: BOOLEAN + - name: noclick + display_name: Use Order Id For Server Side Attribution + type: BOOLEAN + deprecated: false + required: false + description: >- + Conversions where the pixel-user-id is set to `noclick` will indicate to + QuanticMind that the conversion should not be matched to a click directly, + but instead to a conversion through the conversion's `orderId`. Only use + if instructed specifically by your InsideVault account manager. + settings: [] + - name: clientId + display_name: ClientID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your QuanticMind account manager will provide your ClientID. + settings: [] + - name: domain + display_name: Domain + type: STRING deprecated: false required: false - description: >- - Conversions where the pixel-user-id is set to `noclick` will indicate to - QuanticMind that the conversion should not be matched to a click directly, - but instead to a conversion through the conversion's `orderId`. Only use - if instructed specifically by your InsideVault account manager. + string_validators: + regexp: '' + description: 'Your QuanticMind account manager will provide your Domain, if needed.' settings: [] connection_modes: device: @@ -14766,24 +14768,6 @@ 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 @@ -14846,14 +14830,14 @@ items: regexp: '' description: Please enter your account's password. settings: [] - - name: username - display_name: Username + - name: petName + display_name: Profile Extension Table type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' - description: Please enter your account's username. + description: Please enter the name of your default Profile Extension Table. settings: [] - name: events display_name: Events @@ -14864,28 +14848,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: suppName - display_name: Responsys Supplemental Table Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter a Responsys Supplemental Table Name. - settings: [] - - name: folderName - display_name: Responsys Folder Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Optional. Enter a Responsys Folder Name where this Supplemental exists - or where you'd like one to be created. If this input is left blank, we - will fallback on the default Folder Name you've provided at the top - level settings. - settings: [] - name: columns display_name: Columns type: MIXED @@ -14977,6 +14939,28 @@ items: regexp: '' description: Enter the Segment Event Name. settings: [] + - name: suppName + display_name: Responsys Supplemental Table Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter a Responsys Supplemental Table Name. + settings: [] + - name: folderName + display_name: Responsys Folder Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Optional. Enter a Responsys Folder Name where this Supplemental exists + or where you'd like one to be created. If this input is left blank, we + will fallback on the default Folder Name you've provided at the top + level settings. + settings: [] - name: listName display_name: Profile List Name type: STRING @@ -14988,6 +14972,24 @@ items: Please enter the default Profile List. Make sure that the Profile List is inside the provided Folder Name. 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: username + display_name: Username + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Please enter your account's username. + settings: [] connection_modes: device: web: false @@ -15072,14 +15074,30 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: captureUnhandledRejections - display_name: Capture Unhandled Rejections + - name: guessUncaughtFrames + display_name: Guess Uncaught Frames 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, Rollbar will guess which frames the error was + thrown from when the browser does not provide line and column numbers. + settings: [] + - name: accessToken + display_name: Access Token + type: STRING + deprecated: false + required: true + string_validators: + 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: environment display_name: Environment @@ -15100,21 +15118,26 @@ items: 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 - type: STRING + - name: sourceMapEnabled + display_name: Enable Source Map + type: BOOLEAN deprecated: false - required: true - string_validators: - regexp: '' - description: Your Rollbar access token + required: false + description: >- + When this option is enabled, we'll let Rollbar know you have source maps + enabled. Be sure to implement either Option A or B in [these + instructions](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map) + to set up source maps with Rollbar as well as fill out Code Version in you + Rollbar Integration settings in your Segment source. settings: [] - - name: captureUncaught - display_name: Capture uncaught exceptions + - name: captureUnhandledRejections + display_name: Capture Unhandled Rejections type: BOOLEAN deprecated: false required: false - description: Record uncaught exceptions from `window.onerror`. + description: >- + Catch and report unhandled Promise rejections, such as Promise failures + that do not have a corresponding `.then(null, function(e) {})` handler. settings: [] - name: codeVersion display_name: Code Version @@ -15127,15 +15150,6 @@ items: If you have enabled Source Maps, this is a version string, such as a version number or git sha settings: [] - - name: guessUncaughtFrames - display_name: Guess Uncaught Frames - type: BOOLEAN - deprecated: false - required: false - description: >- - When this option is enabled, Rollbar will guess which frames the error was - thrown from when the browser does not provide line and column numbers. - settings: [] - name: identify display_name: Include custom user data with Rollbar's error tracking type: BOOLEAN @@ -15145,18 +15159,6 @@ items: When this option is enabled we will store metadata about the user on `identify` calls. settings: [] - - name: sourceMapEnabled - display_name: Enable Source Map - type: BOOLEAN - deprecated: false - required: false - description: >- - When this option is enabled, we'll let Rollbar know you have source maps - enabled. Be sure to implement either Option A or B in [these - instructions](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map) - to set up source maps with Rollbar as well as fill out Code Version in you - Rollbar Integration settings in your Segment source. - settings: [] connection_modes: device: web: true @@ -15299,24 +15301,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: sharedSecret - display_name: Shared Secret - type: PASSWORD - deprecated: false - required: true - string_validators: - regexp: '' - description: The Shared Secret found in your Sailthru dashboard. - settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: The API key found in your Sailthru dashboard. - settings: [] - name: customerId display_name: Customer Id type: STRING @@ -15378,6 +15362,24 @@ items: Select whether to opt out users from email campaigns. The default status is `none`. settings: [] + - name: sharedSecret + display_name: Shared Secret + type: PASSWORD + deprecated: false + required: true + string_validators: + regexp: '' + description: The Shared Secret found in your Sailthru dashboard. + settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: The API key found in your Sailthru dashboard. + settings: [] connection_modes: device: web: false @@ -15418,15 +15420,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^.{8,}$' - description: Login to www.salescamp.app and go to setting - > integration -> segment - settings: [] - name: events display_name: 'Events ' type: LIST @@ -15437,6 +15430,15 @@ items: recommend you to add event in below list that important for your sales process (ex. "Demo Request Placed", "Order Placed" etc.) settings: [] + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: Login to www.salescamp.app and go to setting - > integration -> segment + settings: [] connection_modes: device: web: false @@ -15473,6 +15475,46 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: username + display_name: Account Email + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Enter your Salesforce account email. We recommend creating a separate + account just for Segment so that you don't need to use your actual + password. + settings: [] + - name: actions + display_name: Actions + type: MIXED + 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: 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: leadLookupFields display_name: Custom Lead Lookup Fields type: MAP @@ -15491,6 +15533,33 @@ items: with another field **you need to explicitly define that as a row in this setting**. settings: [] + - name: sandbox + display_name: Sandbox + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this setting if the Salesforce instance you are integrating with is + a Sandbox environment. + settings: [] + - name: shipping + display_name: Send Address as Shipping Address + type: BOOLEAN + deprecated: false + required: false + description: >- + This will map address traits in your group calls as Shipping Address for + your Account Objects. + settings: [] + - name: alwaysEnabled + display_name: Always Enabled + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this to send *every* event to Salesforce, bypassing the need to set + `'Salesforce': true` in your track calls. + settings: [] - name: password display_name: Account Password type: PASSWORD @@ -15517,27 +15586,6 @@ items: Personal Information > [Reset My Security Token](https://na15.salesforce.com/_ui/system/security/ResetApiTokenEdit)**. settings: [] - - name: shipping - display_name: Send Address as Shipping Address - type: BOOLEAN - deprecated: false - required: false - description: >- - This will map address traits in your group calls as Shipping Address for - your Account Objects. - settings: [] - - name: username - display_name: Account Email - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Enter your Salesforce account email. We recommend creating a separate - account just for Segment so that you don't need to use your actual - password. - settings: [] - name: version display_name: Version type: SELECT @@ -15552,52 +15600,6 @@ items: 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 @@ -15635,57 +15637,6 @@ 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 @@ -15763,6 +15714,57 @@ 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: [] connection_modes: device: web: false @@ -15858,33 +15860,33 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: token - display_name: Token + - name: apiKey + display_name: API Key type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - This is a legacy setting, and now known as the apiKey. To connect - SatisMeter with Segment first create a project in your Satismeter - dashboard and then navigate to Settings / Install and click the green - button 'Enable with Segment'. You can also manually copy Settings / - Integrations / API keys / Write key and use it as the token. The tokeny + To connect SatisMeter with Segment first create a project in your + Satismeter dashboard and then navigate to Settings / Install and click the + green button 'Enable with Segment'. You can also manually copy Settings / + Integrations / API keys / Write key and use it as the api key. The api key should look like urC2RuBlt7utBCzu. settings: [] - - name: apiKey - display_name: API Key + - name: token + display_name: Token type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - To connect SatisMeter with Segment first create a project in your - Satismeter dashboard and then navigate to Settings / Install and click the - green button 'Enable with Segment'. You can also manually copy Settings / - Integrations / API keys / Write key and use it as the api key. The api key + This is a legacy setting, and now known as the apiKey. To connect + SatisMeter with Segment first create a project in your Satismeter + dashboard and then navigate to Settings / Install and click the green + button 'Enable with Segment'. You can also manually copy Settings / + Integrations / API keys / Write key and use it as the token. The tokeny should look like urC2RuBlt7utBCzu. settings: [] connection_modes: @@ -16070,30 +16072,6 @@ 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 - deprecated: false - required: false - description: >- - A list of these messages to be filtered out before being sent to Sentry as - either regular expressions or strings. - settings: [] - name: ignoreUrls display_name: Ignore Urls type: LIST @@ -16124,6 +16102,54 @@ items: regexp: '' description: Track the version of your application in Sentry. settings: [] + - name: serverName + display_name: Server Name + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Typically this would be the server name, but that doesn’t exist on all + platforms. Instead you may use something like the device ID, as it + indicates the host which the client is running on. + settings: [] + - name: customVersionProperty + display_name: Set Release by Property + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Dynamically track the version of your application in Sentry. If the + property you set here is on the global window object (example: you input + 'my_custom_version', and window.my_custom_version = '2.4.5') then we will + use that version. If not, we will default to the manually-set Release + property. We recommend that this value is unique to prevent it from being + overwritten by other integrations. + settings: [] + - name: ignoreErrors + display_name: Ignore Errors + type: LIST + deprecated: false + required: false + description: >- + A list of these messages to be filtered out before being sent to Sentry as + either regular expressions or strings. + settings: [] + - name: whitelistUrls + display_name: Whitelist Urls + type: LIST + 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