diff --git a/README.md b/README.md index 3c8d7e8ae3..9a44bb6c3b 100644 --- a/README.md +++ b/README.md @@ -195,7 +195,7 @@ You can see how to write them in the `styleguide.md`, and see how they render at - `dev`: runs `jekyll serve` locally with incremental builds. Useful when updating CSS, JS, or content and you don't want to rebuild everytime. - `build`: Builds the site docs. Used by CI to publish the docs to staging and production -- `catalog`: Pulls in the latest catalog data from the Platform API and saves it in the respective data files. Requires an API key to be passed in env via PLATFORM_API_TOKEN +- `catalog`: Pulls in the latest catalog data from the Platform API and saves it in the respective data files. Requires an API key to be passed in env via PLATFORM_API_TOKEN. [Instructions here](#bring-your-own-token). - `sidenav`: Builds the side navs for 'main', 'legal', 'api', 'partners' and stores the output in `/src/_data/sidenav-auto/`. This output isn't used for the actual build. - `typewriter`: pulls in the current state of the Docs tracking plan for implementing Segment tracking - `seed`: copies all example data files out of the `_templates` directory and puts them in the `_data` directory. Useful if you don't have a way to set up an API key. @@ -299,11 +299,19 @@ $ make catalog ##### Bring your own token -You create your own token via the Access Management Page. Feel free to use [`segment-engineering`](https://app.segment.com/segment-engineering/settings/access-management) or [`segment_prod`](https://app.segment.com/segment_prod/settings/access-management). Once you have the token, set the value in the `.env` file. +You create your own token in the Segment App. You can use your own personal workspace, or if you have access to them, use [`segment-engineering`](https://app.segment.com/segment-engineering/settings/access-management) or [`segment_prod`](https://app.segment.com/segment_prod/settings/access-management). Go to **Settings > Access Management > Tokens**. +Any type of token will work, but you might want to limit it to a read-only token. Make sure you label it so folks know what it's for! + +Once you make a new token, paste the token value in the `.env` file like so: + +```text +PLATFORM_API_TOKEN=(token value here) +``` +You can now run `make catalog`! #### Catalog Data + Doc Links -By default, the links on the catalog page and respective sidenavs will attempt to automagically set hyperlinks, for actual doc file, at the path `connections/:type/:slug`. However, given the transitory state of Docs V2, these links might 404 since the respective doc might be in a different directory. +By default, the links on the catalog page and respective sidenavs attempt to automagically set hyperlinks, for actual doc file, at the path `connections/:type/:slug`. However, given the transitory state of Docs V2, these links might 404 since the respective doc might be in a different directory. #### Object Sources and Warehouses These two catalogs are hardcoded in the `_data` directory since the Config API does not expose these resources. diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 82e606223b..e7926eb18f 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -189,30 +189,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: _version - display_name: _version - type: NUMBER - deprecated: false - required: false - number_validators: - min: 0 - max: 0 - description: '' - settings: [] - - name: advId - display_name: Advertiser ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[A-Z0-9]{22}$' - description: >- - You can find your Advertiser ID in your AdRoll dashboard by clicking the - **green or red dot** in the lower-left corner. In the Javascript snippet, - the Advertiser ID appears as `adroll_avd_id = 'XXXXXXX'` on line 2. It - should be 22 characters long and look something like this: - `WYJD6WNIAJC2XG6PT7UK4B`. - settings: [] - name: events display_name: Events type: MAP @@ -237,6 +213,30 @@ items: be 22 characters long, and look something like this: `6UUA5LKILFESVE44XH6SVX`. settings: [] + - name: _version + display_name: _version + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: '' + settings: [] + - name: advId + display_name: Advertiser ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[A-Z0-9]{22}$' + description: >- + You can find your Advertiser ID in your AdRoll dashboard by clicking the + **green or red dot** in the lower-left corner. In the Javascript snippet, + the Advertiser ID appears as `adroll_avd_id = 'XXXXXXX'` on line 2. It + should be 22 characters long and look something like this: + `WYJD6WNIAJC2XG6PT7UK4B`. + settings: [] connection_modes: device: web: true @@ -494,6 +494,92 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true 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: useLegacyLinkName + display_name: Use Legacy LinkName + type: BOOLEAN + deprecated: false + required: false + description: >- + Before sending LinkName to Adobe Analytics, prepend the URL with `Link + Name - `. + + + This setting enables a legacy behavior for backwards compatibility. You + probably want to keep this setting turned off. + settings: [] + - name: 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: contextValues + display_name: Context Data Variables + type: MAP + deprecated: false + required: false + description: >- + Map values you pass into the context object to [Context Data + Variables](https://marketing.adobe.com/resources/help/en_US/sc/implement/context_data_variables.html) + in Adobe Analytics. Then you can use processing rules to map you Context + Data Variables in Adobe to other variables with Adobe Analytics Processing + Rules. In the box on the left, put your Segment context key. The box on + the right is what Context Data Variable you'd like it to be mapper to in + Adobe. + + + If you have a nested object, separate the name with a `.` For example if + you wanted to map the page referrer, you would put: page.referrer. + + + **NOTE**: By default we send all your `properties` as Context Data + Variables so you do not need to map them again here. + settings: [] + - name: customDataPrefix + display_name: Context Data Property Prefix + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you would like to prefix your Segment properties before sending them as + contextData, enter a prefix here. + settings: [] + - name: hVars + display_name: Hierarchy Variables + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 5 + map_prefix: hier + select_options: [] + description: >- + Map your Adobe Analytics hVars to the property names you’re using in your + Segment page calls. Enter a Segment property name on the left and an Adobe + Analytics hVar number on the right. You can view your Segment page calls + and properties in your Schema. + settings: [] - name: removeFallbackVisitorId display_name: 'No Fallbacks for Visitor ID: Server-Side Only ' type: BOOLEAN @@ -519,49 +605,42 @@ items: Check this box if you would like your Adobe Heartbeat calls to be made over HTTPS. settings: [] - - name: useLegacyLinkName - display_name: Use Legacy LinkName + - name: enableTrackPageName + display_name: Enable pageName for Track Events 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. + If you do not want to attach `pageName` for your `.track()` calls, you can + disable this option. settings: [] - - name: customDelimiter - display_name: 'List Variable and Prop Custom Delimiter: Server-Side Only ' - type: MAP + - name: heartbeatTrackingServerUrl + display_name: Heartbeat Tracking Server URL + type: STRING deprecated: false required: false - map_validators: + string_validators: regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: - - '|' - - ',' - - ':' - - ; - - / description: >- - Add a custom delimiter to concatenate Adobe Analytics lVars or props sent - as an array. Note, if you do not specify a custom delimiter, arrays will - be concatenated with a comma. Please add the Adobe Analytics lVar or prop - on the left and select a custom delimiter on the right. lVars must be in - format 'list1', 'list2', etc. and props in format 'prop1', 'prop2', etc. - Must be all lowercase with no whitespace. + This is the URL of your Adobe Heartbeat server. Please contact Adobe to + obtain this URL. settings: [] - - name: disableVisitorId - display_name: Drop Visitor ID - type: BOOLEAN + - name: lVars + display_name: List Variables + type: MAP deprecated: false required: false - description: This will disable Visitor ID from being passed to Adobe. + map_validators: + regexp: '' + min: 0 + max: 3 + map_prefix: list + select_options: [] + description: >- + Map your Adobe Analytics list variables names to the property names you’re + using in your Segment events. Enter a Segment property name on the left + and an Adobe Analytics list variable number on the right. You can view + your Segment events and properties in your Schema. settings: [] - name: preferVisitorId display_name: Prefer VisitorID for Hybrid Timestamp Reporting @@ -575,6 +654,20 @@ items: about your user attribution, you should enable this if you're using a hybrid timestamp reporting suite. settings: [] + - name: events + display_name: Events + type: MIXED + deprecated: false + required: false + description: Map your Segment events to custom Adobe events. + settings: [] + - name: disableVisitorId + display_name: Drop Visitor ID + type: BOOLEAN + deprecated: false + required: false + description: This will disable Visitor ID from being passed to Adobe. + settings: [] - name: sendFalseValues display_name: Send False values type: BOOLEAN @@ -585,31 +678,35 @@ items: mode. Enabling this setting will send any boolean property where value is `false`. settings: [] - - name: enableTrackPageName - display_name: Enable pageName for Track Events - type: BOOLEAN + - name: timestampOption + display_name: Timestamp Option + type: SELECT deprecated: false required: false + select_validators: + select_options: + - enabled + - disabled + - hybrid description: >- - If you do not want to attach `pageName` for your `.track()` calls, you can - disable this option. + 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: lVars - display_name: List Variables - type: MAP + - name: productIdentifier + display_name: Product Identifier + type: SELECT deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 3 - map_prefix: list - select_options: [] + select_validators: + select_options: + - name + - sku + - id 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. + Adobe Analytics only accepts a single [product + identifier](https://marketing.adobe.com/resources/help/en_US/sc/implement/products.html). + Use this option to choose whether we send product `name`, `id`, or `sku`. settings: [] - name: props display_name: Props @@ -628,20 +725,38 @@ items: Adobe Analytics property number on the right. You can view your Segment events and properties in your Schema. settings: [] - - name: productIdentifier - display_name: Product Identifier - type: SELECT + - name: trackingServerSecureUrl + display_name: Tracking Server Secure URL + type: STRING 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`. + string_validators: + regexp: '' + description: This is the secure URL of your Adobe Analytics server. + settings: [] + - name: customDelimiter + display_name: 'List Variable and Prop Custom Delimiter: Server-Side Only ' + type: MAP + deprecated: false + required: false + map_validators: + regexp: '' + min: 0 + max: 0 + map_prefix: '' + select_options: + - '|' + - ',' + - ':' + - ; + - / + description: >- + Add a custom delimiter to concatenate Adobe Analytics lVars or props sent + as an array. Note, if you do not specify a custom delimiter, arrays will + be concatenated with a comma. Please add the Adobe Analytics lVar or prop + on the left and select a custom delimiter on the right. lVars must be in + format 'list1', 'list2', etc. and props in format 'prop1', 'prop2', etc. + Must be all lowercase with no whitespace. settings: [] - name: reportSuiteId display_name: Report Suite ID(s) @@ -673,26 +788,6 @@ items: If this setting is enable, we will add `context.app.build`, if present, to Adobe's AppID, as ` ()`. settings: [] - - name: trackingServerSecureUrl - display_name: Tracking Server Secure URL - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: This is the secure URL of your Adobe Analytics server. - settings: [] - - name: customDataPrefix - display_name: Context Data Property Prefix - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - If you would like to prefix your Segment properties before sending them as - contextData, enter a prefix here. - settings: [] - name: marketingCloudOrgId display_name: Marketing Cloud Organization Id type: STRING @@ -706,100 +801,6 @@ items: 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 - deprecated: false - required: false - select_validators: - select_options: - - enabled - - disabled - - hybrid - description: >- - Adobe Analytics can have Report Suites that will accept timestamped, - non-timestamped or hybrid data. Note that we can only play historical - data for timestamped or hybrid Report Suites. - settings: [] - - name: trackingServerUrl - display_name: Tracking Server URL - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: This is the URL of your Adobe Analytics server. - settings: [] - - name: contextValues - display_name: Context Data Variables - type: MAP - deprecated: false - required: false - description: >- - Map values you pass into the context object to [Context Data - Variables](https://marketing.adobe.com/resources/help/en_US/sc/implement/context_data_variables.html) - in Adobe Analytics. Then you can use processing rules to map you Context - Data Variables in Adobe to other variables with Adobe Analytics Processing - Rules. In the box on the left, put your Segment context key. The box on - the right is what Context Data Variable you'd like it to be mapper to in - Adobe. - - - If you have a nested object, separate the name with a `.` For example if - you wanted to map the page referrer, you would put: page.referrer. - - - **NOTE**: By default we send all your `properties` as Context Data - Variables so you do not need to map them again here. - settings: [] - - name: events - display_name: Events - type: MIXED - deprecated: false - required: false - description: Map your Segment events to custom Adobe events. - settings: [] - - name: heartbeatTrackingServerUrl - display_name: Heartbeat Tracking Server URL - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This is the URL of your Adobe Heartbeat server. Please contact Adobe to - obtain this URL. - settings: [] - - name: 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: 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: eVars display_name: eVars type: MAP @@ -830,32 +831,31 @@ items: MUST be set up in Adobe and mapped here in order to to be forwarded to the destination. This setting only applies to Mobile integrations with Adobe. settings: [] - - name: hVars - display_name: Hierarchy Variables - type: MAP + - name: merchEvents + display_name: 'Merchandising Events ' + type: MIXED deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 5 - map_prefix: hier - select_options: [] - description: >- - Map your Adobe Analytics hVars to the property names you’re using in your - Segment page calls. Enter a Segment property name on the left and an Adobe - Analytics hVar number on the right. You can view your Segment page calls - and properties in your Schema. - settings: [] - - name: utf8Charset - display_name: Use UTF-8 Charset - type: BOOLEAN + 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: trackingServerUrl + display_name: Tracking Server URL + type: STRING 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. + string_validators: + regexp: '' + description: This is the URL of your Adobe Analytics server. settings: [] connection_modes: device: @@ -1002,27 +1002,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 +1060,23 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: region - display_name: Region + - name: accountId + display_name: AWS Account ID type: STRING deprecated: false required: true string_validators: regexp: '' - description: The EventBridge Firehose AWS region key. + description: The ID of the AWS Account you'd like us to send data to. settings: [] - - name: accountId - display_name: AWS Account ID + - name: region + display_name: Region type: STRING deprecated: false required: true string_validators: regexp: '' - description: The ID of the AWS Account you'd like us to send data to. + description: The EventBridge Firehose AWS region key. settings: [] connection_modes: device: @@ -1117,6 +1117,26 @@ 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 + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + The address of the AWS role that will be writing to Kinesis (ex: + arn:aws:iam::874699288871:role/example-role) + settings: [] - name: secretId display_name: Secret ID type: STRING @@ -1151,26 +1171,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: [] - - name: roleAddress - display_name: Role Address - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - The address of the AWS role that will be writing to Kinesis (ex: - arn:aws:iam::874699288871:role/example-role) - settings: [] connection_modes: device: web: false @@ -1214,8 +1214,19 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: mappedStreams - display_name: Map Segment Events to Firehose Delivery Streams + - name: secretId + display_name: Secret ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + The External ID to your IAM role. This value is a secret and should be + treated as a password. + settings: [] + - name: mappedStreams + display_name: Map Segment Events to Firehose Delivery Streams type: MIXED deprecated: false required: false @@ -1254,17 +1265,6 @@ items: The address of the AWS role that will be writing to Kinesis Firehose (ex: arn:aws:iam::874699288871:role/example-role) settings: [] - - name: secretId - display_name: Secret ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - The External ID to your IAM role. This value is a secret and should be - treated as a password. - settings: [] connection_modes: device: web: false @@ -1301,26 +1301,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true 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: [] - - name: roleAddress - display_name: Role Address - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - The address of the AWS role that will be invoking Lambda (ex: - `arn:aws:iam::874699288871:role/example-role`). - settings: [] - name: clientContext display_name: Client Context type: MAP @@ -1373,6 +1353,17 @@ items: You can append a version number or alias to any of the formats. settings: [] + - name: roleAddress + display_name: Role Address + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + The address of the AWS role that will be invoking Lambda (ex: + `arn:aws:iam::874699288871:role/example-role`). + settings: [] - name: logType display_name: Log Type type: SELECT @@ -1390,6 +1381,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,20 +1426,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: externalId - display_name: External ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This is an optional string Segment will use to assume the role provided to - invoke the Lambda function. If this setting is not defined, we'll use the - Source ID. For more information about external IDs while assuming AWS - roles, check - [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). - settings: [] - name: logType display_name: Log Type type: SELECT @@ -1457,32 +1443,30 @@ items: Select `Tail` if you would like to see detailed logs in Cloud Watch. settings: [] - - name: clientContext - display_name: Client Context - type: MAP + - name: region + display_name: Region + type: STRING deprecated: false required: false - map_validators: + 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. + AWS Region where the lambda lives. If it is not defined, we'll use + `us-west-2` by default. settings: [] - - name: region - display_name: Region + - name: externalId + display_name: External ID type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - AWS Region where the lambda lives. If it is not defined, we'll use - `us-west-2` by default. + This is an optional string Segment will use to assume the role provided to + invoke the Lambda function. If this setting is not defined, we'll use the + Source ID. For more information about external IDs while assuming AWS + roles, check + [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html). settings: [] - name: function display_name: Lambda @@ -1517,6 +1501,22 @@ items: The address of the AWS role that will be invoking Lambda (ex: `arn:aws:iam::874699288871:role/example-role`). settings: [] + - name: clientContext + display_name: Client Context + type: MAP + 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: [] connection_modes: device: web: false @@ -1607,6 +1607,21 @@ 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 @@ -1627,21 +1642,6 @@ 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,27 +1681,30 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key - type: STRING + - name: useCustomAmplitudeProperties + display_name: Send Custom Language and Country Properties + 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). + 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: trackCategorizedPages - display_name: Track Categorized Pages to Amplitude - 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: >- - 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**. + Minimum number of events to batch together per request if `batchEvents` is + `true`. settings: [] - name: trackGclid display_name: Track GCLID @@ -1712,14 +1715,35 @@ items: If true, captures the gclid url parameter as well as the user's initial_gclid via a set once operation. 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: groupValueTrait + display_name: Group Value Trait + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + What trait Segment should use as your Amplitude "group value" in group + calls. If, for example, you set this to be `plan`, then `traits["plan"]` + will be sent as `groupValue` to Amplitude. + settings: [] + - name: trackReferrer + display_name: Track Referrer to Amplitude + type: BOOLEAN + deprecated: false + required: false + description: >- + Enabling this will send referrer information as a user property to + Amplitude when you call Segment's `page` method. settings: [] - name: versionName display_name: Version Name @@ -1732,6 +1756,24 @@ items: Optional. You can assign a version name for your page, and we'll send it to Amplitude for more detailed events. 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: traitsToSetOnce + display_name: Traits to Set Once + type: LIST + deprecated: false + required: false + description: >- + Server-Side and Mobile Only. Configure values to be set only once via + identify.traits. + settings: [] - name: groupTypeTrait display_name: Group Type Trait type: STRING @@ -1744,125 +1786,115 @@ items: calls. If, for example, you set this to be `industry`, then `traits["industry"]` will be sent as `groupType` to Amplitude. settings: [] - - name: secretKey - display_name: Secret Key - type: STRING + - name: mapQueryParams + display_name: Map Query Params to Custom Property + type: MAP deprecated: false required: false - string_validators: + map_validators: regexp: '' - description: Your Amplitude Secret Key (Only needed for user deletion) - settings: [] - - name: trackNamedPages - display_name: Track Named Pages to Amplitude - type: BOOLEAN - deprecated: false - required: false + min: 0 + max: 0 + map_prefix: '' + select_options: + - user_properties + - event_properties description: >- - This will track events to Amplitude for [`page` + When sending data via server side or Cloud Mode, you can send the custom + query params that are automatically collected by `analytics.js` (or + whatever you manually send under `context.page.search`), by entering a + custom property name you would like to map that under on the left hand + side. On the right hand side, please choose whether you want the query + params to be set on the user profile or event metadata level. Whatever you + put on the left hand side we will map the entire query parameters string + from the `context.page.url`. + settings: [] + - name: trackNamedPages + display_name: Track Named Pages to Amplitude + type: BOOLEAN + deprecated: false + required: false + description: >- + This will track events to Amplitude for [`page` method](https://segment.io/libraries/analytics.js#page) calls that have a `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: useCustomAmplitudeProperties - display_name: Send Custom Language and Country Properties - type: BOOLEAN + - name: traitsToIncrement + display_name: Traits To Increment + type: LIST deprecated: false required: false description: >- - Enable this option if you want to send additional 'language' and 'country' - parameters inside of event_properties. This is separate from the language - and country collected from your user's context. (For example, you want to - send the language that a video is played in). You can send these in your - properties, for example: `analytics.track('Video Played', {language: - 'Japanese'});` + Server-Side and Mobile Only. Configure `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: trackAllPagesV2 - display_name: Track All Screens - type: BOOLEAN + - name: traitsToPrepend + display_name: Traits to Prepend + type: LIST 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. + Server-Side and Mobile Only. Configure values to be prepended to the user + property array via identify.traits. 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. + Mobile Only (will *not* work in cloud-mode). Allows users to use + advertisingIdentifier instead of identifierForVendor as the Device ID. settings: [] - - name: trackSessionEvents - display_name: Track Session Events to Amplitude + - name: useLogRevenueV2 + display_name: Use Log Revenue V2 API type: BOOLEAN deprecated: false required: false description: >- - (Optional) This enables the sending of start and end session events for - mobile products. Amplitude's libraries track sessions automatically and - this option is not necessary for session tracking. - settings: [] - - name: 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`. + 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: eventUploadThreshold - display_name: Event Upload Threshold (for batching events) - type: NUMBER + - name: apiKey + display_name: API Key + type: STRING deprecated: false - required: false - number_validators: - min: 0 - max: 0 + required: true + string_validators: + regexp: '^[a-z0-9]{32}$' description: >- - Minimum number of events to batch together per request if `batchEvents` is - `true`. + You can find your API Key on your Amplitude [Settings + page](https://amplitude.com/settings). settings: [] - - name: forceHttps - display_name: Force Https + - name: batchEvents + display_name: Batch Events 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, 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: mapQueryParams - display_name: Map Query Params to Custom Property - type: MAP + - name: enableLocationListening + display_name: Enable Location Listening + type: BOOLEAN deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 0 - map_prefix: '' - select_options: - - user_properties - - event_properties description: >- - When sending data via server side or Cloud Mode, you can send the custom - query params that are automatically collected by `analytics.js` (or - whatever you manually send under `context.page.search`), by entering a - custom property name you would like to map that under on the left hand - side. On the right hand side, please choose whether you want the query - params to be set on the user profile or event metadata level. Whatever you - put on the left hand side we will map the entire query parameters string - from the `context.page.url`. + 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: saveParamsReferrerOncePerSession display_name: 'Save Referrer, URL Params, GCLID Once Per Session' @@ -1875,37 +1907,14 @@ items: during the middle of the user's session will be ignored. Set to false to always capture new values. settings: [] - - name: traitsToAppend - display_name: Traits to Append - type: LIST - deprecated: false - required: false - description: >- - Server-Side and Mobile Only. Configure values to be appended to the user - property array via identify.traits. - settings: [] - - name: trackRevenuePerProduct - display_name: Track Revenue Per Product - type: BOOLEAN - deprecated: false - required: false - description: >- - Client and server only. This setting allows you to specify whether you - would like to track an Amplitude Revenue event per individual product in a - user transaction or a single Revenue event for the combined revenue of all - products. This setting is only relevant if you are using our eCommerce - spec and passing us an Order Completed event with a list of products. - settings: [] - - name: appendFieldsToEventProps - display_name: Append Fields To Event Properties - type: MAP + - name: secretKey + display_name: Secret Key + type: STRING deprecated: false required: false - description: >- - Web and server-side only. Configure event fields to be appended to - `event_props` for all track calls. For example, entering - `context.page.title` on the left and `pageTitle` on the right will set the - value of `context.page.title` at `event_properties.pageTitle`. + string_validators: + regexp: '' + description: Your Amplitude Secret Key (Only needed for user deletion) settings: [] - name: sendAlias display_name: Enable Alias @@ -1919,89 +1928,41 @@ items: this setting is disabled, your Segment Amplitude destination will reject `alias` events as unsupported. settings: [] - - name: traitsToIncrement - display_name: Traits To Increment - type: LIST - deprecated: false - required: false - description: >- - Server-Side and Mobile Only. Configure `trait` to increment on identify. - If the trait is present, it will increment the trait given the numerical - value passed in when you call `identify` with the trait. - settings: [] - - name: useAdvertisingIdForDeviceId - display_name: Use AdvertisingId for DeviceId - type: BOOLEAN - deprecated: false - required: false - description: >- - Mobile Only (will *not* work in cloud-mode). Allows users to use - advertisingIdentifier instead of identifierForVendor as the Device ID. - settings: [] - - name: batchEvents - display_name: Batch Events - type: BOOLEAN - deprecated: false - required: false - description: >- - If true, events are batched together and uploaded only when the number of - unsent events is greater than or equal to `eventUploadThreshold` or after - `eventUploadPeriodMillis` milliseconds have passed since the first unsent - event was logged. - settings: [] - - name: deviceIdFromUrlParam - display_name: Set Device ID From URL Parameter amp_device_id + - name: trackCategorizedPages + display_name: Track Categorized Pages to Amplitude type: BOOLEAN deprecated: false required: false description: >- - If true, the SDK will parse device ID values from url parameter - `amp_device_id` if available. - settings: [] - - name: traitsToPrepend - display_name: Traits to Prepend - type: LIST - deprecated: false - required: false - description: >- - Server-Side and Mobile Only. Configure values to be prepended to the user - property array via identify.traits. + 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: useLogRevenueV2 - display_name: Use Log Revenue V2 API + - name: trackRevenuePerProduct + display_name: Track Revenue Per Product type: BOOLEAN deprecated: false required: false description: >- - Use Amplitude's logRevenueV2 API, which allows for the tracking of event - properties with the revenue event. Track an event with "price" and - "quantity" properties, and it will log total revenue = price * quantity. - You may also set a revenueType property to designate the type of revenue - (ex: purchase, refund, etc). Negative prices can be used to indicate - revenue lost. + 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: enableLocationListening - display_name: Enable Location Listening + - name: unsetParamsReferrerOnNewSession + display_name: Unset Params Referrer On New Session type: BOOLEAN deprecated: false required: false description: >- - Mobile Only. If a user has granted your app location permissions, enable - this setting so that the SDK will also grab the location of the user. - Amplitude will never prompt the user for location permission, so this must - be done by your app. - settings: [] - - name: groupValueTrait - display_name: Group Value Trait - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - What trait Segment should use as your Amplitude "group value" in group - calls. If, for example, you set this to be `plan`, then `traits["plan"]` - will be sent as `groupValue` to Amplitude. + 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: sendToBatchEndpoint display_name: Send To Batch Endpoint @@ -2029,18 +1990,47 @@ items: 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: unsetParamsReferrerOnNewSession - display_name: Unset Params Referrer On New Session - type: BOOLEAN + - name: trackSessionEvents + display_name: Track Session Events 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. + (Optional) This enables the sending of start and end session events for + mobile products. Amplitude's libraries track sessions automatically and + this option is not necessary for session tracking. + settings: [] + - name: appendFieldsToEventProps + display_name: Append Fields To Event Properties + type: MAP + deprecated: false + required: false + description: >- + Web and server-side only. Configure event fields to be appended to + `event_props` for all track calls. For example, entering + `context.page.title` on the left and `pageTitle` on the right will set the + value of `context.page.title` at `event_properties.pageTitle`. + settings: [] + - name: deviceIdFromUrlParam + display_name: Set Device ID From URL Parameter amp_device_id + type: BOOLEAN + deprecated: false + required: false + description: >- + If true, the SDK will parse device ID values from url parameter + `amp_device_id` if available. + settings: [] + - name: eventUploadPeriodMillis + display_name: Event Upload Period Millis (for batching events) + type: NUMBER + deprecated: false + required: false + number_validators: + min: 0 + max: 0 + description: >- + Amount of time in milliseconds that the SDK waits before uploading events + if `batchEvents` is `true`. settings: [] - name: preferAnonymousIdForDeviceId display_name: Prefer Anonymous ID for Device ID @@ -2072,14 +2062,24 @@ items: this disabled by default, since Amplitude isn't generally used for pageview tracking. settings: [] - - name: trackUtmProperties - display_name: Track UTM Properties to Amplitude. + - name: trackAllPagesV2 + display_name: Track All Screens type: BOOLEAN deprecated: false required: false description: >- - This will track UTM properties found in the querystring to Amplitude (only - for Device mode). + Mobile only. Sends a "Loaded Screen" event and the screen name as a + property to Amplitude. Moving forward, this is the preferred method of + tracking screen events in Amplitude. + settings: [] + - name: traitsToAppend + display_name: Traits to Append + type: LIST + deprecated: false + required: false + description: >- + Server-Side and Mobile Only. Configure values to be appended to the user + property array via identify.traits. settings: [] connection_modes: device: @@ -2479,6 +2479,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: disableAjaxMonitoring + display_name: Disable AJAX Monitoring + type: BOOLEAN + deprecated: false + required: false + description: >- + If you don't want to track the AJAX(XHR) requests in your app, then select + this option. + settings: [] - name: disableSpa display_name: Disable SPA type: BOOLEAN @@ -2515,15 +2524,6 @@ items: 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 - deprecated: false - required: false - description: >- - If you don't want to track the AJAX(XHR) requests in your app, then select - this option. - settings: [] connection_modes: device: web: true @@ -2969,27 +2969,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: branch_key - display_name: Branch Key + - name: apiSecret + display_name: Branch Secret type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' description: >- - Your Branch app key can be retrieved on the settings page of the [Branch + Required for server-side calls. Your Branch secret can be retrieved on the + settings page of the [Branch dashboard](https://dashboard.branch.io/#/settings). settings: [] - - name: apiSecret - display_name: Branch Secret + - name: branch_key + display_name: Branch Key type: STRING deprecated: false - required: false + required: true string_validators: regexp: '' description: >- - Required for server-side calls. Your Branch secret can be retrieved on the - settings page of the [Branch + Your Branch app key can be retrieved on the settings page of the [Branch dashboard](https://dashboard.branch.io/#/settings). settings: [] connection_modes: @@ -3032,54 +3032,41 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: doNotLoadFontAwesome - display_name: Do Not Load Font Awesome - type: BOOLEAN - deprecated: false - required: false - description: >- - **Web Only:** Braze uses [FontAwesome](https://fontawesome.com/) for - in-app message icons. By default, Braze will automatically load - FontAwesome from - https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css. - To disable this behavior (e.g. because your site uses a customized version - of FontAwesome), set this option to true. Note that if you do this, you - are responsible for ensuring that FontAwesome is loaded on your site - - otherwise in-app messages may not render correctly. **This setting is only - applicable if you are using version 2 of the Braze Web SDK.** - settings: [] - - name: enableLogging - display_name: Enable Logging + - name: allowCrawlerActivity + display_name: Allow Crawler Activity type: BOOLEAN deprecated: false required: false description: >- - **Web Only:** Set to true to enable logging by default. Note that this - will cause Braze to log to the javascript console, which is visible to all - users! You should probably remove this or provide an alternate logger with - [appboy.setLogger()](https://js.appboycdn.com/web-sdk/2.0/doc/module-appboy.html#.setLogger) - before you release your page to production. **This setting is only - applicable if you are using version 2 of the Braze Web SDK.** + **Web Only:** By default, the Braze Web SDK ignores activity from known + spiders or web crawlers, such as Google, based on the user agent string. + This saves datapoints, makes analytics more accurate, and may improve page + rank. However, if you want Braze to log activity from these crawlers + instead, you may set this option to true. settings: [] - - name: logPurchaseWhenRevenuePresent - display_name: Log Purchase when Revenue is present + - name: enableHtmlInAppMessages + display_name: Enable HTML In-App Messages 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. + **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: openNewsFeedCardsInNewTab - display_name: Open News Feed Cards In New Tab + - name: openInAppMessagesInNewTab + display_name: Open In-App Messages In New Tab type: BOOLEAN deprecated: false required: false description: >- - By default, links from news feed cards load in the current tab or window. - Set this option to true to make links from news feed cards open in a new - tab or window. **This setting is only applicable if you are using version - 2 of the Braze Web SDK.** + 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: trackAllPages display_name: Track All Pages @@ -3091,84 +3078,54 @@ items: Braze as a Loaded/Viewed a Page event. This option is disabled by default since Braze isn't generally used for page view tracking. settings: [] - - name: apiKey - display_name: App Identifier + - name: safariWebsitePushId + display_name: Safari Website Push ID type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - The API key found in your Braze dashboard, used to identify your - application as the app identifier. (Formerly 'API Key') + **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: automatic_in_app_message_registration_enabled - display_name: Enable Automatic In-App Message Registration - type: BOOLEAN + - name: serviceWorkerLocation + display_name: Service Worker Location + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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). + Specify your `serviceWorkerLocation` as defined in the Braze Web SDK + documentation: + https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html settings: [] - - name: datacenter - display_name: Appboy Datacenter - type: SELECT + - name: appGroupId + display_name: REST API Key + type: STRING deprecated: false required: true - select_validators: - select_options: - - us - - us02 - - us03 - - us04 - - eu - description: 'Choose your Appboy Gateway (ie. US 01, US 02, EU 01, etc.).' - settings: [] - - name: enableHtmlInAppMessages - display_name: Enable HTML In-App Messages - type: BOOLEAN - deprecated: false - required: false + string_validators: + regexp: '' 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.** + This can be found in your Braze dashboard under App Settings > Developer + Console. (Formerly 'App Group Identifier') settings: [] - - name: openInAppMessagesInNewTab - display_name: Open In-App Messages In New Tab + - name: automatic_in_app_message_registration_enabled + display_name: Enable Automatic In-App Message Registration 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: version - display_name: Braze Web SDK Version - type: SELECT - deprecated: false - required: false - select_validators: - select_options: - - '1' - - '2' - description: >- - **Web Only:** The [major](https://semver.org/) version of the Braze web - SDK you would like to use. Please reference their - [changelog](https://github.com/Appboy/appboy-web-sdk/blob/master/CHANGELOG.md) - for more info. **Please ensure you read - [this](https://segment.com/docs/destinations/braze/#migrating-to-v2-of-the-braze-web-sdk) - section of our documentation carefully before changing this setting.** + **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 @@ -3181,48 +3138,50 @@ items: register your own display subscribers or send soft push notifications to your users, make sure to disable this option. settings: [] - - name: minimumIntervalBetweenTriggerActionsInSeconds - display_name: Minimum Interval Between Trigger Actions In Seconds - type: NUMBER + - name: customEndpoint + display_name: Custom API Endpoint + type: STRING deprecated: false required: false - number_validators: - min: 0 - max: 0 + string_validators: + regexp: '' description: >- - **Web Only:** By default, a trigger action will only fire if at least 30 - seconds have elapsed since the last trigger action. Provide a value for - this configuration option to override that default with a value of your - own. We do not recommend making this value any smaller than 10 to avoid - spamming the user with notifications. **This setting is only applicable if - you are using version 2 of the Braze Web SDK.** + If you've been assigned an API endpoint by the Braze team specifically for + use with their Mobile or Javascript SDKs, please input that here. It + should look something like: sdk.api.appboy.eu. Otherwise, leave this + blank. settings: [] - - name: safariWebsitePushId - display_name: Safari Website Push ID - type: STRING + - name: doNotLoadFontAwesome + display_name: Do Not Load Font Awesome + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - **Web Only**: To send push notifications on Safari, Braze needs your - Website Push Id. To get your Webite Push ID, check out the first two - bullet points - [here](https://www.braze.com/documentation/Web/#step-5-configure-safari-push). + **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: sessionTimeoutInSeconds - display_name: Session Timeout In Seconds + - name: minimumIntervalBetweenTriggerActionsInSeconds + display_name: Minimum Interval Between Trigger Actions In Seconds type: NUMBER deprecated: false required: false number_validators: min: 0 max: 0 - description: > - **Web Only:** By default, 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.** + description: >- + **Web Only:** By default, a trigger action will only fire if at least 30 + seconds have elapsed since the last trigger action. Provide a value for + this configuration option to override that default with a value of your + own. We do not recommend making this value any smaller than 10 to avoid + spamming the user with notifications. **This setting is only applicable if + you are using version 2 of the Braze Web SDK.** settings: [] - name: trackNamedPages display_name: Track Only Named Pages @@ -3234,41 +3193,50 @@ items: Braze that have a `name` associated with them. For example, `page('Signup')` would translate to **Viewed Signup Page** in Braze. settings: [] - - name: allowCrawlerActivity - display_name: Allow Crawler Activity + - name: updateExistingOnly + display_name: Update Existing Users Only 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. + **Server Side only**: A flag to determine whether to update existing users + only, defaults to false settings: [] - - name: appGroupId - display_name: REST API Key + - name: apiKey + display_name: App Identifier 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') + The API key found in your Braze dashboard, used to identify your + application as the app identifier. (Formerly 'API Key') settings: [] - - name: customEndpoint - display_name: Custom API Endpoint - type: STRING + - 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: openNewsFeedCardsInNewTab + display_name: Open News Feed Cards In New Tab + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - If you've been assigned an API endpoint by the Braze team specifically for - use with their Mobile or Javascript SDKs, please input that here. It - should look something like: sdk.api.appboy.eu. Otherwise, leave this - blank. + By default, links from news feed cards load in the current tab or window. + Set this option to true to make links from news feed cards open in a new + tab or window. **This setting is only applicable if you are using version + 2 of the Braze Web SDK.** settings: [] - name: restCustomEndpoint display_name: Custom REST API Endpoint @@ -3282,26 +3250,58 @@ items: 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: serviceWorkerLocation - display_name: Service Worker Location - type: STRING + - 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: enableLogging + display_name: Enable Logging + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - Specify your `serviceWorkerLocation` as defined in the Braze Web SDK - documentation: - https://js.appboycdn.com/web-sdk/latest/doc/module-appboy.html + **Web Only:** Set to true to enable logging by default. Note that this + will cause Braze to log to the javascript console, which is visible to all + users! You should probably remove this or provide an alternate logger with + [appboy.setLogger()](https://js.appboycdn.com/web-sdk/2.0/doc/module-appboy.html#.setLogger) + before you release your page to production. **This setting is only + applicable if you are using version 2 of the Braze Web SDK.** settings: [] - - name: updateExistingOnly - display_name: Update Existing Users Only + - name: logPurchaseWhenRevenuePresent + display_name: Log Purchase when Revenue is present type: BOOLEAN deprecated: false required: false description: >- - **Server Side only**: A flag to determine whether to update existing users - only, defaults to false + When this option is enabled, all Track calls with a property called + `revenue` will trigger Braze's LogRevenue event. + settings: [] + - name: version + display_name: Braze Web SDK Version + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - '1' + - '2' + description: >- + **Web Only:** The [major](https://semver.org/) version of the Braze web + SDK you would like to use. Please reference their + [changelog](https://github.com/Appboy/appboy-web-sdk/blob/master/CHANGELOG.md) + for more info. **Please ensure you read + [this](https://segment.com/docs/destinations/braze/#migrating-to-v2-of-the-braze-web-sdk) + section of our documentation carefully before changing this setting.** settings: [] connection_modes: device: @@ -3337,15 +3337,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: host - display_name: Domain - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: You can use your own domain with Bronto - settings: [] - name: siteId display_name: Site ID type: STRING @@ -3357,6 +3348,15 @@ items: You can find your Site ID in your Bronto [Account Page](https://app.bronto.com/login/index/login/) settings: [] + - name: host + display_name: Domain + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: You can use your own domain with Bronto + settings: [] connection_modes: device: web: true @@ -3393,6 +3393,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: showFeedbackTab + display_name: Show the Default Feedback Tab + type: BOOLEAN + deprecated: false + required: false + description: >- + You should only disable this setting if you want to [build your own + feedback + tab](http://support.bugherd.com/entries/21497629-Create-your-own-Send-Feedback-tab) + with the BugHerd API. + settings: [] - name: apiKey display_name: API Key type: STRING @@ -3405,17 +3416,6 @@ items: BugHerd [Project page](http://bugherd.com/). It will appear in your tracking code as `?apikey=...` settings: [] - - name: showFeedbackTab - display_name: Show the Default Feedback Tab - type: BOOLEAN - deprecated: false - required: false - description: >- - You should only disable this setting if you want to [build your own - feedback - tab](http://support.bugherd.com/entries/21497629-Create-your-own-Send-Feedback-tab) - with the BugHerd API. - settings: [] connection_modes: device: web: true @@ -3690,6 +3690,58 @@ items: server: true previous_names: - Candu +- display_name: Canny + slug: canny + name: catalog/destinations/canny + description: Integration to sync your Segment users into Canny + hidden: false + url: connections/destinations/catalog/canny + status: PUBLIC_BETA + logo: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/9338aebf-369e-4350-ad24-d2acf23e576e.svg + mark: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/3d01bc5d-4382-49d5-aed2-95dbc43f9cad.svg + categories: + - Surveys + components: [] + platforms: + browser: true + server: true + mobile: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: >- + You can find your API Key in the Segment Integration page in your admin + settings. + settings: [] + - name: customFields + display_name: Custom Fields + type: LIST + deprecated: false + required: false + description: 'Segment traits to be imported as custom fields (e.g. "age,phone,username")' + settings: [] + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: false + server: false + previous_names: + - Canny - display_name: Castle slug: castle name: catalog/destinations/castle @@ -3840,6 +3892,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: sendNameAndCategoryAsTitle + display_name: sendNameAndCategoryAsTitle + type: BOOLEAN + deprecated: false + required: false + description: >+ + [Chartbeat expects](http://support.chartbeat.com/docs/#titles) the + `document.title` ( Segment `page`'s `props.title`) to populate as + *title*. + +
+ +
+ + + This setting respects Segment's legacy behavior of setting the page name + and category as *title* for existing users, but defaults new users to the + correct behavior of sending `document.title` as *title* to Chartbeat, and + allows current users to opt-in to the correct behavior if they chose. + + settings: [] - name: uid display_name: UID type: STRING @@ -3873,27 +3946,6 @@ items: Chartbeat. Don't include the `www.` because Chartbeat handles that for you automatically. settings: [] - - name: sendNameAndCategoryAsTitle - display_name: sendNameAndCategoryAsTitle - type: BOOLEAN - deprecated: false - required: false - description: >+ - [Chartbeat expects](http://support.chartbeat.com/docs/#titles) the - `document.title` ( Segment `page`'s `props.title`) to populate as - *title*. - -
- -
- - - This setting respects Segment's legacy behavior of setting the page name - and category as *title* for existing users, but defaults new users to the - correct behavior of sending `document.title` as *title* to Chartbeat, and - allows current users to opt-in to the correct behavior if they chose. - - settings: [] connection_modes: device: web: true @@ -4131,17 +4183,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: clevertap_account_token - display_name: Account Token - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - **Mobile Only:**Add your CleverTap Account Token which you can find in the - CleverTap Dashboard under Settings. - settings: [] - name: region display_name: Region type: SELECT @@ -4165,6 +4206,17 @@ items: Add your CleverTap Account ID which you can find in the CleverTap Dashboard under Settings. settings: [] + - name: clevertap_account_token + display_name: Account Token + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + **Mobile Only:**Add your CleverTap Account Token which you can find in the + CleverTap Dashboard under Settings. + settings: [] connection_modes: device: web: true @@ -4248,27 +4300,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiSecret - display_name: Project Id + - name: apiKey + display_name: API Key type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your Project Id in ClientSuccess under the top right menu, - Apps & Integrations > Usage + You can find your API key in ClientSuccess under the top right menu, Apps + & Integrations > Usage settings: [] - - name: apiKey - display_name: API Key + - name: apiSecret + display_name: Project Id type: STRING deprecated: false required: true string_validators: regexp: '' description: >- - You can find your API key in ClientSuccess under the top right menu, Apps - & Integrations > Usage + You can find your Project Id in ClientSuccess under the top right menu, + Apps & Integrations > Usage settings: [] connection_modes: device: @@ -4358,27 +4410,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 @@ -4420,6 +4451,27 @@ items: you want to send to Convertro, put the event name you send to Segment on the left, and the name you want Convertro to receive it as on the right. settings: [] + - name: hybridAttributionModel + display_name: Hybrid Attribution Model + type: BOOLEAN + deprecated: false + required: false + description: >- + This will make **Completed Order** events always send a `sale` event in + addition to a `sale.new` or `sale.repeat` event if it has a boolean + `repeat` property. + settings: [] + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you'd like to send mobile data to Convertro's server side integration, + please enter your Convertro Site ID + settings: [] connection_modes: device: web: true @@ -4730,31 +4782,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: appId - display_name: App ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^([a-z0-9]{40}|[a-z0-9]{24})$' - description: >- - You can find your App ID on the Crittercism [Settings - page](https://app.crittercism.com/developers). It should be 24 characters - long, and look something like this: `93ac1026a7928a581c000002`. - settings: [] - - name: customVersionName - display_name: Custom Version Name (Android) - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Override the default version name of your app that is reported to - Crittercism (Android only). Check out the [Crittercism - docs](http://docs.crittercism.com/android/android.html#customizing-the-version-reported-to-crittercism) - for more info. - settings: [] - name: enableServiceMonitoring display_name: Enable Service Monitoring (Android) type: BOOLEAN @@ -4800,6 +4827,31 @@ items: docs](https://app.crittercism.com/developers/docs-optional-android#including_logcat) for more info. settings: [] + - name: appId + display_name: App ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^([a-z0-9]{40}|[a-z0-9]{24})$' + description: >- + You can find your App ID on the Crittercism [Settings + page](https://app.crittercism.com/developers). It should be 24 characters + long, and look something like this: `93ac1026a7928a581c000002`. + settings: [] + - name: customVersionName + display_name: Custom Version Name (Android) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Override the default version name of your app that is reported to + Crittercism (Android only). Check out the [Crittercism + docs](http://docs.crittercism.com/android/android.html#customizing-the-version-reported-to-crittercism) + for more info. + settings: [] connection_modes: device: web: false @@ -4989,6 +5041,17 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^([a-z0-9]{20})?([a-z0-9]{64})?$' + description: >- + 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 @@ -5010,17 +5073,6 @@ items: required: false description: 'If true, timestamps are converted to Unix Time.' settings: [] - - name: siteId - display_name: Site ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^([a-z0-9]{20})?([a-z0-9]{64})?$' - description: >- - You can find your Site ID on the Customer.io [Integration - page](https://fly.customer.io/account/customerio_integration). - settings: [] connection_modes: device: web: true @@ -5154,6 +5206,52 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: groupTag + display_name: Group Tag + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + This setting maps to the Doubleclick Floodlight container group tag (the + `type` parameter) string. You can choose to use this setting to define the + same value for this parameter across all conversion events or you can + define this value for each of your conversion event mappings below. + settings: [] + - name: 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: 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: [] + - name: segmentWriteKey + display_name: Segment Write Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Set here the write key for this source. It's required if cookie matching + is enabled. + settings: [] - name: token display_name: Authorization Token for server-to-server requests type: STRING @@ -5165,6 +5263,19 @@ items: Please add the Token to send your conversions using the server-to-server endpoint from DisplayVideo 360. settings: [] + - name: activityTag + display_name: Activity Tag + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + This setting maps to the Doubleclick Floodlight container activity tag (or + `cat`) string. You can choose to use this setting to define the same value + for this parameter across all conversion events or you can define this + value for each of your conversion event mappings below. + settings: [] - name: events display_name: Conversion events type: MIXED @@ -5256,42 +5367,15 @@ items: leave this option blank, we will fall back to whatever you define in the top level Group Tag setting. settings: [] - - name: groupTag - display_name: Group Tag - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This setting maps to the Doubleclick Floodlight container group tag (the - `type` parameter) string. You can choose to use this setting to define the - same value for this parameter across all conversion events or you can - define this value for each of your conversion event mappings below. - settings: [] - - name: 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 + - name: getDoubleClickId + display_name: Get DoubleClick Id + type: BOOLEAN deprecated: false required: false - string_validators: - regexp: '' description: >- - This setting maps to the Doubleclick Floodlight container activity tag (or - `cat`) string. You can choose to use this setting to define the same value - for this parameter across all conversion events or you can define this - value for each of your conversion event mappings below. + 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: [] connection_modes: device: @@ -5652,15 +5736,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: sendGroup - display_name: Create or Update Account on Group - type: BOOLEAN - deprecated: false - required: false - description: >- - *Server Side Only*: Enable this setting to create or update an Eloqua - account on a `group` event. - settings: [] - name: siteId display_name: Site ID type: STRING @@ -5670,6 +5745,24 @@ items: regexp: '' description: Enter your Site ID settings: [] + - name: username + display_name: Username + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your login username + settings: [] + - name: companyName + display_name: Company Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter your login company name + settings: [] - name: mappedIdentifyTraits display_name: Map Custom Traits to Contacts type: MAP @@ -5695,6 +5788,27 @@ items: regexp: '' description: Enter your login passord settings: [] + - name: sendGroup + display_name: Create or Update Account on Group + type: BOOLEAN + deprecated: false + required: false + description: >- + *Server Side Only*: Enable this setting to create or update an Eloqua + account on a `group` event. + settings: [] + - name: 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: mappedEvents display_name: Map Track Events to Custom Objects type: MAP @@ -5729,36 +5843,6 @@ items: data type specified in Eloqua's dashboard. Eloqua will reject any event containing a Custom Account Field with an incorrect data type. settings: [] - - name: username - display_name: Username - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter your login username - settings: [] - - name: companyName - display_name: Company Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter your login company name - settings: [] - - name: 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: [] connection_modes: device: web: true @@ -6171,27 +6255,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: oauth - display_name: oauth - type: BOOLEAN - deprecated: false - required: false - description: 'Authorize Segment to oauth ' - 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`, `Product Added`, and - `Product List Viewed`, choose which Segment property you would like to map - to Facebook's `value` property. - settings: [] - name: completeRegistrations display_name: Map Track Events as CompleteRegistration Conversions to Event Set IDs type: MAP @@ -6223,6 +6286,27 @@ items: send as `Lead` conversions. On the right hand side, put the ID of the Facebook Offline Event Set where you want to send these conversions. settings: [] + - name: oauth + display_name: oauth + type: BOOLEAN + deprecated: false + required: false + description: 'Authorize Segment to oauth ' + 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`, `Product Added`, and + `Product List Viewed`, choose which Segment property you would like to map + to Facebook's `value` property. + settings: [] connection_modes: device: web: false @@ -6258,6 +6342,33 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false 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: blacklistPiiProperties display_name: Blacklist PII Properties type: MIXED @@ -6273,41 +6384,6 @@ items: setting to append to this default list. You can also use this setting to optionally hash any PII values instead of dropping them. settings: [] - - name: keyForExternalId - display_name: 'Client-Side Only: Advanced Match Trait Key for External ID' - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Please indicated a user trait key which you would like Segment to use to - send an `external_id` to Facebook Pixel using advanced matching. Segment - will use the value of this trait to map it to Facebook Pixel's - `external_id`. - settings: [] - - name: pixelId - display_name: Pixel ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Your Pixel ID, from the snippet created on the [Facebook Pixel creation - page](https://www.facebook.com/ads/manager/pixel/facebook_pixel/). - settings: [] - - name: contentTypes - display_name: Map Categories to FB Content Types - type: MAP - deprecated: false - required: false - description: >- - Enter your category value on the left, and the Facebook content type to - map to on the right. Facebook recognizes certain event types that can help - deliver relevant ads. If no category values are mapped we'll default to - `product` and `product_group`, depending on the event. - settings: [] - name: initWithExistingTraits display_name: Enable Advanced Matching type: BOOLEAN @@ -6317,19 +6393,18 @@ items: 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: legacyEvents - display_name: Legacy Conversion Pixel IDs - type: MAP + - name: keyForExternalId + display_name: 'Client-Side Only: Advanced Match Trait Key for External ID' + type: STRING deprecated: false required: false + string_validators: + regexp: '' 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. + Please indicated a user trait key which you would like Segment to use to + send an `external_id` to Facebook Pixel using advanced matching. Segment + will use the value of this trait to map it to Facebook Pixel's + `external_id`. settings: [] - name: standardEvents display_name: Map Your Events to Standard FB Events @@ -6378,32 +6453,50 @@ items: Standard Events (Order Completed, Checkout Started, etc) as `property name`. settings: [] - - name: valueIdentifier - display_name: Value Field Identifier - type: SELECT + - name: contentTypes + display_name: Map Categories to FB Content Types + type: MAP 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. + 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: whitelistPiiProperties - display_name: Whitelist PII Properties - type: LIST + - name: legacyEvents + display_name: Legacy Conversion Pixel IDs + type: MAP 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.** + 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 + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Your Pixel ID, from the snippet created on the [Facebook Pixel creation + page](https://www.facebook.com/ads/manager/pixel/facebook_pixel/). + settings: [] + - name: userIdAsExternalId + display_name: Use UserId or Anonymous Id as External Id + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this setting if you want to send, `userId` (or `anonymousId` if not + present) as external Id to Facebook. settings: [] connection_modes: device: @@ -6440,25 +6533,25 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key + - name: publishableApiKey + display_name: Publishable API Key type: STRING deprecated: false - required: true + required: false string_validators: - regexp: '^.{8,}$' - description: >- - Go to https://app.factors.ai/#/settings/segment. Choose your Project on - the top dropdown. Enable Segment and Copy the API Key. + regexp: '' + description: Enter a description. settings: [] - - name: publishableApiKey - display_name: Publishable API Key + - name: apiKey + display_name: API Key type: STRING deprecated: false - required: false + required: true string_validators: - regexp: '' - description: Enter a description. + regexp: '^.{8,}$' + description: >- + Go to https://app.factors.ai/#/settings/segment. Choose your Project on + the top dropdown. Enable Segment and Copy the API Key. settings: [] connection_modes: device: @@ -6831,30 +6924,6 @@ items: required: false description: Map your page calls to specific FriendBuy Widgets. settings: - - name: id - display_name: Widget ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - If you created a FriendBuy widget, you can enter your **Widget ID** here - to load it onto your webpages. - settings: [] - - name: autoDelay - display_name: Widget Auto Delay - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This optional `auto_delay` property determines the auto-popup behavior - of a widget. It is specified as an integer with the number of - milliseconds to wait before the widget appears automatically. A value of - 0 indicates manual widget invocation. - settings: [] - name: selector display_name: Widget Selector type: STRING @@ -6891,6 +6960,30 @@ items: Enter the `name` of your `.page()` calls. ie. `'Home'` if you are calling `.page('Home')`. settings: [] + - name: id + display_name: Widget ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + If you created a FriendBuy widget, you can enter your **Widget ID** here + to load it onto your webpages. + settings: [] + - name: autoDelay + display_name: Widget Auto Delay + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + This optional `auto_delay` property determines the auto-popup behavior + of a widget. It is specified as an integer with the number of + milliseconds to wait before the widget appears automatically. A value of + 0 indicates manual widget invocation. + settings: [] connection_modes: device: web: true @@ -7276,27 +7369,14 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiSecret - display_name: Site Token - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^GSN-\d{6}-[A-Z]$' - description: >- - You can find your Site Token by viewing the GoSquared [Integration - guide](https://www.gosquared.com/integration/). It should look something - like `GSN-123456-A`. - settings: [] - - name: trackLocal - display_name: Track Local + - name: trackHash + display_name: Track Hash type: BOOLEAN deprecated: false required: false description: >- - Enable to track data on local pages/sites (using the `file://` protocol, - or on `localhost`). This helps prevent local development from polluting - your stats. + Enable if you'd like page hashes to be tracked alongside the page URL. By + default, `example.com/about#us` will be tracked as `example.com/about`. settings: [] - name: trackParams display_name: Track Parameters @@ -7308,13 +7388,6 @@ items: example `/home?my=query&string=true` will be tracked as `/home` if this is set to disabled. settings: [] - - name: useCookies - display_name: Use Cookies - type: BOOLEAN - deprecated: false - required: false - description: Disable this if you don't want to use cookies - settings: [] - name: anonymizeIP display_name: Anonymize IP type: BOOLEAN @@ -7324,17 +7397,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: cookieDomain display_name: Cookie Domain type: STRING @@ -7348,14 +7410,45 @@ items: example’s subdomains. By default, cookies are set on the current domain (including subdomain) only. settings: [] - - name: trackHash - display_name: Track Hash + - name: trackLocal + display_name: Track Local type: BOOLEAN deprecated: false required: false description: >- - Enable if you'd like page hashes to be tracked alongside the page URL. By - default, `example.com/about#us` will be tracked as `example.com/about`. + Enable 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: useCookies + display_name: Use Cookies + type: BOOLEAN + deprecated: false + required: false + description: Disable this if you don't want to use cookies + settings: [] + - name: apiKey + display_name: API Key (Server-side) + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Generate your server-side API key here: + https://www.gosquared.com/settings/api + settings: [] + - name: apiSecret + display_name: Site Token + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^GSN-\d{6}-[A-Z]$' + description: >- + You can find your Site Token by viewing the GoSquared [Integration + guide](https://www.gosquared.com/integration/). It should look something + like `GSN-123456-A`. settings: [] connection_modes: device: @@ -7393,15 +7486,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: correctLat - display_name: Correct LAT Behavior - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this to set Limit Ad Tracking to `true` when - context.device.adTrackingEnabled is `false`. - settings: [] - name: eventMappings display_name: Event Mappings type: MIXED @@ -7515,6 +7599,15 @@ items: to override this on a per-event basis but at the very least this conversion ID will serve as the ID used in page calls. settings: [] + - name: correctLat + display_name: Correct LAT Behavior + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this to set Limit Ad Tracking to `true` when + context.device.adTrackingEnabled is `false`. + settings: [] connection_modes: device: web: true @@ -7551,17 +7644,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: defaultPageConversion - display_name: Default Page Conversion - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - If you want to map all your default `.page()` calls that do not explicitly - pass in a `name` to a conversion event, you can enter it here. - settings: [] - name: pageLoadConversions display_name: Page Load Conversions type: MIXED @@ -7614,6 +7696,17 @@ items: recommended by Google as it can lead to less accurate conversion measurements. settings: [] + - name: defaultPageConversion + display_name: Default Page Conversion + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you want to map all your default `.page()` calls that do not explicitly + pass in a `name` to a conversion event, you can enter it here. + settings: [] connection_modes: device: web: true @@ -7655,14 +7748,26 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: reportUncaughtExceptions - display_name: Send Uncaught Exceptions to GA (Mobile) + - 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: mobileTrackingId + display_name: Mobile Tracking ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: ^UA-\d+-\d+$ description: >- - This lets you study errors and exceptions in your iOS and Android apps in - Google Analytics. + 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: protocolMappings display_name: Map Traits or Properties to Measurement Protocol Params @@ -7683,108 +7788,107 @@ items: traits or properties to known [measurement protocol params](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters). settings: [] - - name: ignoredReferrers - display_name: Ignored Referrers - type: MULTI_LINE_STRING + - name: resetCustomDimensionsOnPage + display_name: Reset dimensions on Page calls + type: LIST deprecated: false required: false - string_validators: - regexp: '' description: >- - Add any domains you want to ignore, separated by line breaks. You might - use this if you want Google Analytics to ignore certain referral domains - (e.g. to prevent your subdomains from showing up as referrers in your - analytics). _Note: this only works for Classic profiles. Universal - profiles can_ [edit their ignored - referrers](https://support.google.com/analytics/answer/2795830?hl=en&ref_topic=2790009) - _directly inside Google Analytics._ + If you 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: includeSearch - display_name: Include the Querystring in Page Views + - name: sendUserId + display_name: Send User-ID to GA type: BOOLEAN deprecated: false required: false description: >- - The querystring doesn't usually affect the content of the page in a - significant way (like sorting), so we disable this by default. + 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: trackNamedPages - display_name: Track Named Pages - type: BOOLEAN + - name: serversideTrackingId + display_name: Serverside Tracking ID + type: STRING deprecated: false required: false + string_validators: + regexp: ^UA-\d+-\d+$ description: >- - Tracks events to Google Analytics for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `name` associated with them. E.g. `page('Signup')` translates to **Viewed - Signup Page**. + 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: useGoogleAmpClientId - display_name: Use Google AMP Client ID + - name: classic + display_name: Use Classic Analytics on Your Site type: BOOLEAN deprecated: false required: false description: >- - Google’s AMP Client ID API lets you uniquely identify users who engage - with your content on AMP and non-AMP pages. If you opt-in, Google - Analytics will use the user's AMP Client ID to determine that multiple - site events belong to the same user when those users visit AMP pages via a - [Google viewer](https://support.google.com/websearch/answer/7220196). - Associating events and users provides features like user counts and - session-based metrics. *Enabling this feature will affect your reporting.* - Please carefully reference Google's - [documentation](https://support.google.com/analytics/answer/7486764?hl=en&ref_topic=7378717) - for more info before you enable it. + **Important:** When creating your Google Analytics profile, you can choose + between **Classic** and **Universal** Analytics. After March 2013, new + profiles default to Universal, while earlier ones are Classic. An easy + test: if you see `_gaq.push` in your code you're using Classic, so enable + this. settings: [] - - name: enhancedLinkAttribution - display_name: Enable Enhanced Link Attribution + - name: enableServerIdentify + display_name: Enable Server Side Identify 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 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: sampleRate - display_name: Sample Rate - type: NUMBER + - name: identifyEventName + display_name: Server Side Identify Event Action + type: STRING deprecated: false required: false - number_validators: - min: 1 - max: 100 + string_validators: + regexp: '' 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. + 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: sendUserId - display_name: Send User-ID to GA + - name: reportUncaughtExceptions + display_name: Send Uncaught Exceptions to GA (Mobile) 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. + This lets you study errors and exceptions in your iOS and Android apps in + Google Analytics. settings: [] - - name: siteSpeedSampleRate - display_name: Site Speed Sample Rate - type: NUMBER + - name: setAllMappedProps + display_name: Set Custom Dimensions & Metrics to the Page + 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). + 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 @@ -7797,60 +7901,17 @@ items: `category` associated with them. E.g. `page('Docs', 'Index')` translates to **Viewed Docs Page**. settings: [] - - name: enhancedEcommerce - display_name: Enable Enhanced Ecommerce - type: BOOLEAN - deprecated: false - required: false - description: >- - If you want more detailed reports on ecommerce, you might want to enable - this feature. Read more about it - [here](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce). - settings: [] - - name: domain - display_name: Cookie Domain Name - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^none$|^[a-zA-Z0-9_-]+\.[.a-zA-Z0-9_-]+$' - description: >- - _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: mobileTrackingId - display_name: Mobile Tracking ID + - name: trackingId + display_name: Website 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: serversideClassic - display_name: Use Classic Analytics for Your Serverside Tracking - type: BOOLEAN - deprecated: false - required: false - description: >- - **Important:** When creating your Google Analytics profile, you can choose - between **Classic** and **Universal** Analytics. After March 2013, new - profiles default to Universal, while earlier profiles are Classic. An easy - test: if you see `_gaq.push` in your code you're using Classic, so enable - this. + 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: contentGroupings display_name: Content Groupings @@ -7871,128 +7932,123 @@ items: value of the property you designate as the value of the specified content grouping. settings: [] - - name: setAllMappedProps - display_name: Set Custom Dimensions & Metrics to the Page + - name: includeSearch + display_name: Include the Querystring in Page Views 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. + The querystring doesn't usually affect the content of the page in a + significant way (like sorting), so we disable this by default. settings: [] - - name: metrics - display_name: Custom Metrics - type: MAP + - name: nonInteraction + display_name: Add the non-interaction flag to all events + type: BOOLEAN deprecated: false required: false - map_validators: - regexp: '' - min: 0 - max: 200 - map_prefix: metric - select_options: [] description: >- - Because Google Analytics cannot accept arbitrary data about users or - events, when you use `analytics.identify(userId, traits)` with custom - numerical traits or `analytics.track('event', properties)` with custom - numerical properties, you need to map those traits and properties to - Google Analytics custom metrics if you want them to be sent to GA. Enter a - trait or property name on the left. Choose the Google Analytics metric you - want on the right. Google Analytics only accepts numbered metrics (e.g. - metric3). We suggest using user-scoped metrics for trait mappings and - hit-scoped metrics for properties. [Contact - us](https://segment.com/contact) if you need help! + 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: identifyEventName - display_name: Server Side Identify Event Action + - name: optimize + display_name: Optimize Container ID type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - If you have **Enabled Server Side Identify**, you can specify 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'` + Integrate with Google Analytics Optimize plugin. Please enter your + Optimize Container ID settings: [] - - name: dimensions - display_name: Custom Dimensions - type: MAP + - name: identifyCategory + display_name: Server Side Identify Event Category + type: STRING deprecated: false required: false - map_validators: + string_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 **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: doubleClick - display_name: 'Remarketing, Display Ads and Demographic Reports.' + - name: trackNamedPages + display_name: Track Named Pages type: BOOLEAN deprecated: false required: false - description: Works with both Universal and Classic tracking methods. + description: >- + Tracks events to Google Analytics for [`page` + method](https://segment.io/libraries/analytics.js#page) calls that have a + `name` associated with them. E.g. `page('Signup')` translates to **Viewed + Signup Page**. settings: [] - - name: enableServerIdentify - display_name: Enable Server Side Identify + - name: enhancedLinkAttribution + display_name: Enable Enhanced Link Attribution type: BOOLEAN deprecated: false required: false description: >- - If you are sending `.identify()` calls from your server side libraries or - have Segment Cloud Apps that send back `.identify()` calls with enriched - user traits, you can send that data to your GA account via custom - dimensions and metrics. Unlike the client side integration which has the - luxury of browsers and the global window `ga` tracker, for server side we - will check your `traits` and your settings for custom dimension/metric - mappings and send it with an explicit event. + 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: nonInteraction - display_name: Add the non-interaction flag to all events + - name: ignoredReferrers + display_name: Ignored Referrers + type: MULTI_LINE_STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + Add any domains you want to ignore, separated by line breaks. You might + use this if you want Google Analytics to ignore certain referral domains + (e.g. to prevent your subdomains from showing up as referrers in your + analytics). _Note: this only works for Classic profiles. Universal + profiles can_ [edit their ignored + referrers](https://support.google.com/analytics/answer/2795830?hl=en&ref_topic=2790009) + _directly inside Google Analytics._ + settings: [] + - name: nameTracker + display_name: Name Tracker 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. + Name the tracker 'segmentGATracker'. Enable this if you're working with + additional Google Analytics trackers and want to ensure that your Segment + tracker has a distinct name. If this is enabled you must prepend this + tracker name to any native Google Analytics (except for create) that you + call, e.g. 'segmentGATracker.require(....)' settings: [] - - name: serversideTrackingId - display_name: Serverside Tracking ID - type: STRING + - name: siteSpeedSampleRate + display_name: Site Speed Sample Rate + type: NUMBER deprecated: false required: false - string_validators: - regexp: ^UA-\d+-\d+$ + number_validators: + min: 1 + max: 100 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. + 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: enhancedEcommerce + display_name: Enable Enhanced Ecommerce + type: BOOLEAN + deprecated: false + required: false + description: >- + If you want more detailed reports on ecommerce, you might want to enable + this feature. Read more about it + [here](https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce). settings: [] - name: typeOverride display_name: Send Segment "Product List" Events to GA as "Event" Hits @@ -8005,78 +8061,125 @@ items: setting to instead map these two specced Segment track events to GA as "event" hit types. settings: [] - - name: anonymizeIp - display_name: Anonymize IP Addresses + - name: useGoogleAmpClientId + display_name: Use Google AMP Client ID 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). + 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: identifyCategory - display_name: Server Side Identify Event Category - type: STRING + - name: dimensions + display_name: Custom Dimensions + type: MAP deprecated: false required: false - string_validators: + map_validators: regexp: '' - description: >- - If you have **Enabled Server Side Identify**, you can specify the trait - you want to look up for setting the event category will be since all - custom metrics/dimensions for server side `.identify()` calls will be sent - via an event hit to GA. The default value will be `'All'`. For example, if - you are sending `traits.category`, you can put 'category' in the setting - above and we will send the value of this trait as the event category. - settings: [] - - name: nameTracker - display_name: Name Tracker - type: BOOLEAN - deprecated: false - required: false - description: >- - Name the tracker 'segmentGATracker'. Enable this if you're working with - additional Google Analytics trackers and want to ensure that your Segment - tracker has a distinct name. If this is enabled you must prepend this - tracker name to any native Google Analytics (except for create) that you - call, e.g. 'segmentGATracker.require(....)' + 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! settings: [] - - name: optimize - display_name: Optimize Container ID + - 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: >- - Integrate with Google Analytics Optimize plugin. Please enter your - Optimize Container ID + _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: trackingId - display_name: Website Tracking ID - type: STRING + - name: metrics + display_name: Custom Metrics + type: MAP deprecated: false required: false - string_validators: - regexp: ^UA-\d+-\d+$ + map_validators: + regexp: '' + min: 0 + max: 200 + map_prefix: metric + select_options: [] 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. + 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: classic - display_name: Use Classic Analytics on Your Site + - name: serversideClassic + display_name: Use Classic Analytics for Your Serverside Tracking type: BOOLEAN deprecated: false required: false description: >- **Important:** When creating your Google Analytics profile, you can choose between **Classic** and **Universal** Analytics. After March 2013, new - profiles default to Universal, while earlier ones are Classic. An easy + 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: anonymizeIp + display_name: Anonymize IP Addresses + 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). + settings: [] + - name: sampleRate + display_name: Sample Rate + type: NUMBER + deprecated: false + required: false + number_validators: + min: 1 + max: 100 + description: >- + Specifies what percentage of users should be tracked. This defaults to 100 + (no users are sampled out) but large sites may need to use a lower sample + rate to stay within Google Analytics processing limits as [seen + here](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#sampleRate). + Currently only available in the browser - mobile coming soon. + settings: [] connection_modes: device: web: true @@ -8606,16 +8709,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: hjPlaceholderPolyfill - display_name: IE9 Placeholder Polyfill - type: BOOLEAN - deprecated: false - required: false - description: >- - HotJar loads a polyfill for placeholder tags on input fields for IE9. - Disable this if you already use a placeholder plugin. - https://docs.hotjar.com/v1.0/docs/disabling-placeholder-polyfill - settings: [] - name: hjid display_name: Site ID type: STRING @@ -8627,6 +8720,16 @@ items: This is your site ID for HotJar. It should be a whole number, such as `123456`. settings: [] + - name: hjPlaceholderPolyfill + display_name: IE9 Placeholder Polyfill + type: BOOLEAN + deprecated: false + required: false + description: >- + HotJar loads a polyfill for placeholder tags on input fields for IE9. + Disable this if you already use a placeholder plugin. + https://docs.hotjar.com/v1.0/docs/disabling-placeholder-polyfill + settings: [] connection_modes: device: web: true @@ -8797,28 +8900,29 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: authToken - display_name: Authentication Key + - name: apiURL + display_name: API URL type: STRING deprecated: false required: true string_validators: - regexp: '' + regexp: '^https:\/\/.[a-zA-Z0-9.-]\+\.ubx\.ibmmarketing\.cloud\/.*\/$' description: >- - You can find your endpoint's Authorization Key by looking at your endpoint - details in UBX. It should look something like - `eff08b68-0000-0000-9a19-8e43dbeeb201:US`. + Enter your UBX account's base URL endpoint here. This can be found in the + email you received from UBX after setting up your UBX account. It shoul + have the format `https://.ubx.ibmmarketing.cloud/`. settings: [] - - name: apiURL - display_name: API URL + - name: authToken + display_name: Authentication Key type: STRING deprecated: false required: true string_validators: - regexp: '^https:\/\/.*\/$' + regexp: '' description: >- - Enter your UBX account's base URL endpoint here. This can be found in the - email you received from UBX after setting up your UBX account. + You can find your endpoint's Authorization Key by looking at your endpoint + details in UBX. It should look something like + `eff08b68-0000-0000-9a19-8e43dbeeb201:US`. settings: [] connection_modes: device: @@ -8856,27 +8960,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: @@ -9063,6 +9167,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: + - name: platform + display_name: PLATFORM + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter 'AWS' or 'Azure' + settings: [] - name: apiKey display_name: API Key type: STRING @@ -9085,15 +9198,6 @@ items: Enter URL for the AWS S3 bucket name or Azure Blob Storage container. (e.g. 'https://my-storage.blob.core.windows.net/my-container' ). settings: [] - - name: platform - display_name: PLATFORM - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter 'AWS' or 'Azure' - settings: [] connection_modes: device: web: false @@ -9136,6 +9240,45 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: isBulkAPIEnabled + display_name: isBulkAPIEnabled + type: BOOLEAN + deprecated: false + required: false + description: '' + settings: [] + - name: mobileApiKey + display_name: Enter your Mobile API Key + type: STRING + 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 + deprecated: false + required: false + description: >- + Intercom uses an OAuth-like interface for reading/writing to their system. + This option stores the various values that are needed by Intercom to + validate requests (replaces API keys), and the user-specific values for UI + display (e.g. user's email, avatar, list of accounts, etc.). These fields + are unique to Intercom, and are cleared out en masse when disconnecting + (revoking authorization). + settings: [] + - name: richLinkProperties + display_name: Rich Link Properties + type: LIST + deprecated: false + required: false + description: >- + To use Intercom's Rich Link object, list the name of the exact Segment + property name and make sure the value of those properties only include + `url` and `value` keys. + settings: [] - name: activator display_name: Custom Inbox Button Selector type: STRING @@ -9185,45 +9328,6 @@ items: device.type, device.manufacturer, device.model, os.name, os.version, app.name, app.version settings: [] - - name: isBulkAPIEnabled - display_name: isBulkAPIEnabled - type: BOOLEAN - deprecated: false - required: false - description: '' - settings: [] - - name: mobileApiKey - display_name: Enter your Mobile API Key - type: STRING - 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 - deprecated: false - required: false - description: >- - Intercom uses an OAuth-like interface for reading/writing to their system. - This option stores the various values that are needed by Intercom to - validate requests (replaces API keys), and the user-specific values for UI - display (e.g. user's email, avatar, list of accounts, etc.). These fields - are unique to Intercom, and are cleared out en masse when disconnecting - (revoking authorization). - settings: [] - - name: richLinkProperties - display_name: Rich Link Properties - type: LIST - deprecated: false - required: false - description: >- - To use Intercom's Rich Link object, list the name of the exact Segment - property name and make sure the value of those properties only include - `url` and `value` keys. - settings: [] connection_modes: device: web: true @@ -9325,22 +9429,8 @@ items: server: true mobile: true browserUnbundlingSupported: false - browserUnbundlingPublic: true - settings: - - name: trackCategorizedPages - display_name: Track Categorized Pages - type: BOOLEAN - deprecated: false - required: false - description: Send an event for every page or screen with a category. - settings: [] - - name: trackNamedPages - display_name: Track Named Pages - type: BOOLEAN - deprecated: false - required: false - description: Send an event for every page or screen with a name. - settings: [] + browserUnbundlingPublic: true + settings: - name: apiKey display_name: API Key type: STRING @@ -9375,6 +9465,20 @@ items: required: false description: Send an event for every page or screen event. settings: [] + - name: trackCategorizedPages + display_name: Track Categorized Pages + type: BOOLEAN + deprecated: false + required: false + description: Send an event for every page or screen with a category. + settings: [] + - name: trackNamedPages + display_name: Track Named Pages + type: BOOLEAN + deprecated: false + required: false + description: Send an event for every page or screen with a name. + settings: [] connection_modes: device: web: false @@ -9483,21 +9587,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: pushSenderId - display_name: Sender ID / Google API Project Number - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - If you are using our older mobile library (before v2 iOS or v3 Android) - and have packaged Kahuna’s SDK, you can give us the sender ID. The sender - ID is also called the project number in your Google API project. Make sure - you have created a project by following instructions - [here](http://app.usekahuna.com/tap/getstarted/android/), under 'Enable - Personalized Push' - settings: [] - name: apiKey display_name: Secret Key type: STRING @@ -9518,6 +9607,21 @@ items: Check to send data to production account (default sandbox) once you are ready to pass data to Kahuna's production namespace settings: [] + - name: pushSenderId + display_name: Sender ID / Google API Project Number + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you are using our older mobile library (before v2 iOS or v3 Android) + and have packaged Kahuna’s SDK, you can give us the sender ID. The sender + ID is also called the project number in your Google API project. Make sure + you have created a project by following instructions + [here](http://app.usekahuna.com/tap/getstarted/android/), under 'Enable + Personalized Push' + settings: [] connection_modes: device: web: false @@ -9556,16 +9660,36 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: - - name: trackCategorizedPages - display_name: Track Categorized Pages to Keen + - 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: trackNamedPages + display_name: Track Named 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**. + `name` associated with them. For example `page('Signup')` would translate + to **Viewed Signup Page**. settings: [] - name: uaAddon display_name: UserAgent Addon @@ -9584,35 +9708,6 @@ items: into its components for easier filtering. Note that `userAgent` is only collected on Android, not on iOS. settings: [] - - name: referrerAddon - display_name: Referrer Parsing Addon - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this to use the Keen IO's data enrichment feature for parsing - referrer URLs into their source. - settings: [] - - name: trackAllPages - display_name: Track All Pages to Keen - type: BOOLEAN - deprecated: false - required: false - description: >- - This will track **Loaded a Page** events to Keen for all [`page` - method](https://segment.io/libraries/analytics.js#page) calls. - settings: [] - - name: trackNamedPages - display_name: Track Named 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 - `name` associated with them. For example `page('Signup')` would translate - to **Viewed Signup Page**. - settings: [] - name: writeKey display_name: Write Key type: STRING @@ -9635,25 +9730,34 @@ 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 + - name: referrerAddon + display_name: Referrer Parsing Addon type: BOOLEAN deprecated: false required: false description: >- - Enable this to use Keen's data enrichment feature to add geographic - information based on IP. + Enable this to use the Keen IO's data enrichment feature for parsing + referrer URLs into their source. settings: [] - - name: projectId - display_name: Project ID - type: STRING + - name: trackAllPages + display_name: Track All Pages to Keen + type: BOOLEAN deprecated: false - required: true - string_validators: - regexp: '' + required: false description: >- - Your project ID. It should be 24 characters long, and look something like - this: `9181bcd23843312d87000000`. + This will 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: readKey display_name: Read Key @@ -9760,6 +9864,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-zA-Z0-9]{6}$' + description: Your API key + settings: [] - name: confirmOptin display_name: Confirm Optin type: BOOLEAN @@ -9836,15 +9949,6 @@ items: and server side integration regarding how this event name is sent without forcibly breaking the current behavior. settings: [] - - name: apiKey - display_name: API Key - type: STRING - deprecated: false - required: true - string_validators: - regexp: '^[a-zA-Z0-9]{6}$' - description: Your API key - settings: [] connection_modes: device: web: true @@ -10021,6 +10125,24 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true 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 + deprecated: false + required: false + string_validators: + regexp: '' + description: The GCM sender ID that should be used for Push Notifications. + settings: [] - name: trackAsSupplementalData display_name: Track as Supplemental Events type: BOOLEAN @@ -10066,24 +10188,6 @@ items: 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 - deprecated: false - required: false - string_validators: - regexp: '' - description: The GCM sender ID that should be used for Push Notifications. - settings: [] connection_modes: device: web: false @@ -10268,17 +10372,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: group - display_name: Group - type: STRING - deprecated: false - required: false - string_validators: - regexp: ^\d+$ - description: >- - You can divide LiveChat agents into different groups such as "Billing" or - "Support" - settings: [] - name: license display_name: License type: STRING @@ -10300,6 +10393,17 @@ items: Automatically send Live Chat message events, conversation starts and ends to other tools you have enabled. settings: [] + - name: group + display_name: Group + type: STRING + deprecated: false + required: false + string_validators: + regexp: ^\d+$ + description: >- + You can divide LiveChat agents into different groups such as "Billing" or + "Support" + settings: [] connection_modes: device: web: true @@ -10340,17 +10444,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: setOrganizationScope - display_name: Use Organization Scope for Attributes - type: BOOLEAN - deprecated: false - required: false - description: >- - This allows a user to set the `profileScope` of attributes within - Localytics to Organization. If this is enabled, the attributes that you - set for a user will be available across all of your apps in Localytics. If - it's unchecked, we'll use the default SDK behavior of Application scoping. - settings: [] - name: appKey display_name: App Key type: STRING @@ -10415,6 +10508,17 @@ items: If an App stays in the background for more than this many seconds, start a new session when it returns to foreground. settings: [] + - name: setOrganizationScope + display_name: Use Organization Scope for Attributes + type: BOOLEAN + deprecated: false + required: false + description: >- + This allows a user to set the `profileScope` of attributes within + Localytics to Organization. If this is enabled, the attributes that you + set for a user will be available across all of your apps in Localytics. If + it's unchecked, we'll use the default SDK behavior of Application scoping. + settings: [] connection_modes: device: web: true @@ -10500,6 +10604,17 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: + - name: stream + display_name: Stream + type: STRING + deprecated: false + required: false + 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 @@ -10536,19 +10651,8 @@ items: deprecated: false required: false description: >- - If `true`, allows for the Lytics `_uid` to load the same across multiple - domains. - settings: [] - - name: stream - display_name: Stream - type: STRING - deprecated: false - required: false - 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. + If `true`, allows for the Lytics `_uid` to load the same across multiple + domains. settings: [] connection_modes: device: @@ -10627,6 +10731,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 @@ -10660,17 +10775,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 @@ -10806,6 +10910,15 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: clientId + display_name: Client ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Your Marketo REST API Client ID. + settings: [] - name: clientSecret display_name: Client Secret type: STRING @@ -10833,15 +10946,6 @@ items: regexp: '' description: Name of the folder in which to create static lists. settings: [] - - name: clientId - display_name: Client ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Your Marketo REST API Client ID. - settings: [] connection_modes: device: web: false @@ -10878,6 +10982,17 @@ items: browserUnbundlingSupported: true browserUnbundlingPublic: true settings: + - name: beta + display_name: Send Track Events Server Side + type: BOOLEAN + deprecated: false + required: false + description: >- + **Applicable only if you are using Marketo in Device Mode**. This setting + will route all of your Track events through our server-side integration + with Marketo's REST API. Page and Identify events will still be sent using + our client side integration with the Marketo JavaScript SDK. + settings: [] - name: clientId display_name: Client ID type: STRING @@ -10932,17 +11047,6 @@ items: required: false description: Map your Segment properties to the Marketo Activity Fields settings: - - name: segmentProperty - display_name: Segment Property Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Enter the Segment Property Name. This is case sensitive so make sure - the name matches exactly how you are passing it in your .track() call. - settings: [] - name: marketoAttributeName display_name: Marketo Field Name type: STRING @@ -10974,6 +11078,17 @@ items: required: false description: Mark this property as the Primary field in Marketo. settings: [] + - name: segmentProperty + display_name: Segment Property Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Enter the Segment Property Name. This is case sensitive so make sure + the name matches exactly how you are passing it in your .track() call. + settings: [] - name: privateKey display_name: API Private Key type: STRING @@ -10995,19 +11110,6 @@ items: Use these fields for Marketo Lead fields that you'd like mapped to your Segment Identify Traits. settings: - - name: marketoFieldType - display_name: Marketo Field Type - type: SELECT - deprecated: false - required: true - select_validators: - select_options: - - boolean - - number - - date - - string - description: The Marketo Field type for this trait. - settings: [] - name: segmentTrait display_name: Segment Trait Name type: STRING @@ -11031,6 +11133,19 @@ items: Enter a Marketo Field name. Make sure to copy and paste the REST API name exactly. settings: [] + - name: marketoFieldType + display_name: Marketo Field Type + type: SELECT + deprecated: false + required: true + select_validators: + select_options: + - boolean + - number + - date + - string + description: The Marketo Field type for this trait. + settings: [] - name: accountId display_name: Munchkin Account ID type: STRING @@ -11052,17 +11167,6 @@ items: you'd like to track anonymous Leads in Marketo. If you don't want to track anonymous Leads in Marketo, you must pass a User ID in your event. settings: [] - - name: beta - display_name: Send Track Events Server Side - type: BOOLEAN - deprecated: false - required: false - description: >- - **Applicable only if you are using Marketo in Device Mode**. This setting - will route all of your Track events through our server-side integration - with Marketo's REST API. Page and Identify events will still be sent using - our client side integration with the Marketo JavaScript SDK. - settings: [] connection_modes: device: web: true @@ -11129,6 +11233,35 @@ items: required: false description: Configure a conversion pixel 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 + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Mediamath allows you to track conversions. When you `analytics.track('my + event')` we will map that event to the `mt_id` and `mt_adid` that you + provide. We'll map other data like properties to s and v parameters + below. + settings: [] - name: mtId display_name: mt_id type: STRING @@ -11167,35 +11300,6 @@ items: property in the corresponding query parameter of the MediaMath Pixel. Email [friends@segment.io](mailto:friends@segment.io) if you need help! settings: [] - - name: 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 - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Mediamath allows you to track conversions. When you `analytics.track('my - event')` we will map that event to the `mt_id` and `mt_adid` that you - provide. We'll map other data like properties to s and v parameters - below. - settings: [] connection_modes: device: web: true @@ -11270,122 +11374,47 @@ items: url: 'https://cdn.filepicker.io/api/file/7fjgkCRQwaiKEzPg2yl9' categories: - Analytics - components: - - type: WEB - - type: IOS - - type: ANDROID - - type: CLOUD - platforms: - browser: true - server: true - mobile: true - browserUnbundlingSupported: true - browserUnbundlingPublic: true - settings: - - name: trackAllPages - display_name: Track All Pages to Mixpanel - type: BOOLEAN - deprecated: false - required: false - description: >- - This will track **Loaded a Page** events to Mixpanel for all [`page` - method](https://segment.io/libraries/analytics.js#page) calls. We keep - this disabled by default. - settings: [] - - name: 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: groupTraitsToSetOnce - display_name: Group Traits to Set Once - type: LIST - deprecated: false - required: false - description: Group traits to be set only once using Mixpanel's `$set_once` operator. - settings: [] - - name: legacySuperProperties - display_name: Legacy Super Properties - type: BOOLEAN - 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: peopleProperties - display_name: Traits to set as People Properties - type: LIST - deprecated: false - required: false - description: >- - If you only want to set specific traits as People Properties in Mixpanel - People, you will need to: - - - Enable the "Use Mixpanel People" setting. - - - List the traits you want to see in People here. - settings: [] - - name: 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: sourceName - display_name: Source Name - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - This value, if it's not blank, will be sent as `segment_source_name` to - Mixpanel for every `event`/`page`/`screen` call. - settings: [] - - name: apiKey - display_name: API Secret - type: STRING + components: + - type: WEB + - type: IOS + - type: ANDROID + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + browserUnbundlingSupported: true + browserUnbundlingPublic: true + settings: + - name: superProperties + display_name: Properties to send as Super Properties + type: LIST 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). + 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 + - name: trackCategorizedPages + display_name: Track Categorized Pages to Mixpanel type: BOOLEAN deprecated: false required: false description: >- - This will track **Loaded a Page** events to Mixpanel for all [`page` - method](https://segment.io/libraries/analytics.js#page) calls and **Loaded - a Screen** events for all [`screen` - method](https://segment.io/libraries/ios#screen) calls. We enable this by - default as it's how Mixpanel suggests sending these calls. + This will track events to Mixpanel for [`page` + method](https://segment.io/libraries/analytics.js#page) calls that have a + `category` associated with them. For example `page('Docs', 'Index')` would + translate to **Viewed Docs Index Page**. settings: [] - - name: 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. + Mixpanel people, enable people, and then list the events you want to see + in People here. settings: [] - name: secureCookie display_name: Secure Cookie @@ -11396,14 +11425,16 @@ items: This will mark the Mixpanel cookie as secure, meaning it will only be transmitted over https settings: [] - - name: superProperties - display_name: Properties to send as Super Properties - type: LIST + - name: sourceName + display_name: Source Name + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - If you want to see and segment by Super Properties in Mixpanel, then list - the properties you want to see as Super Properties here. + This value, if it's not blank, will be sent as `segment_source_name` to + Mixpanel for every `event`/`page`/`screen` call. settings: [] - name: trackNamedPages display_name: Track Named Pages to Mixpanel @@ -11416,6 +11447,19 @@ items: `name` associated with them. For example `page('Signup')` would translate to **Viewed Signup Page**. 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: groupIdentifierTraits display_name: Group Identifier Traits type: LIST @@ -11427,36 +11471,36 @@ items: as `group_key` and the value of `traits["company"]` will be sent as the `group_id`. settings: [] - - name: propIncrements - display_name: Properties to increment in People - type: LIST + - name: legacySuperProperties + display_name: Legacy Super Properties + type: BOOLEAN deprecated: false required: false description: >- - If you want to see and segment by event counts and last event date in - Mixpanel people, enable people, and then list the events you want to see - in People here. + We used to add $ to mixpanel traits as super properties. This fixes that: + https://github.com/segmentio/integrations/pull/124/files settings: [] - - name: trackCategorizedPages - display_name: Track Categorized Pages to Mixpanel + - name: trackAllPages + display_name: Track All Pages to Mixpanel type: BOOLEAN deprecated: false required: false description: >- - This will track events to Mixpanel for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have a - `category` associated with them. For example `page('Docs', 'Index')` would - translate to **Viewed Docs Index Page**. + This will track **Loaded a Page** events to Mixpanel for all [`page` + method](https://segment.io/libraries/analytics.js#page) calls. We keep + this disabled by default. settings: [] - - name: people - display_name: Use Mixpanel People + - name: consolidatedPageCalls + display_name: Track All Pages to Mixpanel with a Consolidated Event Name type: BOOLEAN deprecated: false required: false description: >- - This will send all of your - [identify](https://segment.io/docs/methods/identify) calls to Mixpanel's - People feature. + This will 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: persistence display_name: Persistence Type @@ -11482,6 +11526,66 @@ items: You can find your token under **Account** in the upper-right of the [Mixpanel interface](https://mixpanel.com). 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 + deprecated: false + required: false + description: >- + If you only want to set specific traits as People Properties in Mixpanel + People, you will need to: + + - Enable the "Use Mixpanel People" setting. + + - List the traits you want to see in People here. + settings: [] + - name: 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: 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: 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: [] connection_modes: device: web: true @@ -11899,13 +12003,11 @@ items: more customers. hidden: false url: connections/destinations/catalog/mutiny - status: PUBLIC_BETA + status: PUBLIC logo: - url: >- - https://public-segment-devcenter-production.s3.amazonaws.com/1f1f06ee-b2eb-4ada-a70c-270114869379.svg + url: 'https://cdn.filepicker.io/api/file/yHxpcoXQBblmuSlGPk3A' mark: - url: >- - https://public-segment-devcenter-production.s3.amazonaws.com/648853ad-84a1-4a48-a0a7-af8c1ea0676b.svg + url: 'https://cdn.filepicker.io/api/file/Vyy0RA1uQqauquutPMcw' categories: - Personalization - A/B Testing @@ -12313,32 +12415,14 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: adAssetIdPropertyName - display_name: Custom Ad Asset Id Property Name - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Segment will map our `asset_id` property to Nielsen's `assetId` field. If - you would like to set up a custom property mapping for ad asset ids please - indicate the name of the property here. - settings: [] - - name: clientIdPropertyName - display_name: Client Id Property Name + - name: appId + display_name: AppID type: STRING deprecated: false required: false string_validators: regexp: '' - description: >- - By default, clientid and subbrand are setup in Nielsen backend - configuration to capture brand and sub-brand information. The fields get - populated from backend for a registered client appid. But if an app - contains multiple brands and sub-brands and client is willing to give - credit to another brand or sub-brand then please indicate which property - value from your payload you want to use to override `clientId`. + description: Enter your Nielsen DCR App ID. settings: [] - name: contentAssetIdPropertyName display_name: Custom Content Asset Id Property Name @@ -12352,17 +12436,25 @@ 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: contentLengthPropertyName - display_name: Content Length Property Name - type: STRING + - name: nolDevDebug + display_name: Enable Debug Mode + type: BOOLEAN 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. + Check this setting if you would like to activate the Debug flag. Once the + flag is active, it logs each API call made and the data passed. + + Note: DO NOT: activate the Debug flag in a production environment. + settings: [] + - name: sfCode + display_name: Enable Production Mode + type: BOOLEAN + deprecated: false + required: false + description: >- + By default we will use production mode. Uncheck this setting if you are + developing or testing this integration. settings: [] - name: subbrandPropertyName display_name: Subbrand Property Name @@ -12379,45 +12471,55 @@ items: 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: appId - display_name: AppID + - name: adAssetIdPropertyName + display_name: Custom Ad Asset Id Property Name type: STRING deprecated: false required: false string_validators: regexp: '' - description: Enter your Nielsen DCR App ID. + description: >- + Segment will map our `asset_id` property to Nielsen's `assetId` field. If + you would like to set up a custom property mapping for ad asset ids please + indicate the name of the property here. settings: [] - - name: instanceName - display_name: Instance Name + - name: clientIdPropertyName + display_name: Client Id 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. + 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: nolDevDebug - display_name: Enable Debug Mode - type: BOOLEAN + - name: contentLengthPropertyName + display_name: Content Length 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. - settings: [] - - name: sfCode - display_name: Enable Production Mode - type: BOOLEAN + 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: instanceName + display_name: Instance Name + type: STRING deprecated: false required: false + string_validators: + regexp: '' description: >- - By default we will use production mode. Uncheck this setting if you are - developing or testing this integration. + You can optionally define the explicit name of the Nielsen instance we + initialize its SDK with. settings: [] connection_modes: device: @@ -12563,6 +12665,33 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: groupId + display_name: Group ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you want to use Olark across multiple different websites under the same + account, create an Olark Group and add the ID here. + settings: [] + - name: identify + display_name: Show the user's name or email chat console + type: BOOLEAN + deprecated: false + required: false + description: >- + Show the user's name or email from analytics.identify() in the Olark chat + console + settings: [] + - name: inline + display_name: Use inline chat box + type: BOOLEAN + deprecated: false + required: false + description: Configures whether the chat box should be inlined or not + settings: [] - name: listen display_name: Record live chat events. type: BOOLEAN @@ -12598,33 +12727,6 @@ items: required: false description: Log custom events from analytics.track() to the Olark chat console settings: [] - - name: groupId - display_name: Group ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - If you want to use Olark across multiple different websites under the same - account, create an Olark Group and add the ID here. - settings: [] - - name: identify - display_name: Show the user's name or email chat console - type: BOOLEAN - deprecated: false - required: false - description: >- - Show the user's name or email from analytics.identify() in the Olark chat - console - settings: [] - - name: inline - display_name: Use inline chat box - type: BOOLEAN - deprecated: false - required: false - description: Configures whether the chat box should be inlined or not - settings: [] connection_modes: device: web: true @@ -12705,6 +12807,27 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: false settings: + - name: useOptimizelyUserId + display_name: Use Optimizely User ID + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this if you want the server side integration to use Optimizely User + ID instead of User ID or anonymous ID in your calls + settings: [] + - name: accountId + display_name: Account ID + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + In order to use Optimizely X via _server side_, you must enter your + **Account ID** from your Optimizely account. You can find this ID by + visiting https://app.optimizely.com/v2/accountsettings/account/plan + settings: [] - name: cacheExp display_name: Cache Exp type: NUMBER @@ -12720,6 +12843,18 @@ items: conditions or variation rules of your experiments, it is advised to have a minimum floor of 300 seconds (5 minutes). settings: [] + - name: datafileUrl + display_name: Datafile URL + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + In order to use Optimizely X _server side_, you must enter the entire URL + for your datafile. It should look something like + `https://cdn.optimizely.com/json/9218021209.json` + settings: [] - name: fallbackToAnonymousId display_name: Fall Back To Anonymous Id type: BOOLEAN @@ -12768,39 +12903,6 @@ items: required: false description: Send `Experiment Viewed` as a non-interaction event settings: [] - - name: useUserId - display_name: Use User ID - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this if you want the server side integration to use User ID instead - of anonymous ID in your identify calls - settings: [] - - name: accountId - display_name: Account ID - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - In order to use Optimizely X via _server side_, you must enter your - **Account ID** from your Optimizely account. You can find this ID by - visiting https://app.optimizely.com/v2/accountsettings/account/plan - settings: [] - - name: datafileUrl - display_name: Datafile URL - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - In order to use Optimizely X _server side_, you must enter the entire URL - for your datafile. It should look something like - `https://cdn.optimizely.com/json/9218021209.json` - settings: [] - name: trackKnownUsers display_name: Only Track Known Users type: BOOLEAN @@ -12827,6 +12929,15 @@ items: documentation: https://docs.developers.optimizely.com/full-stack/docs/changelog#section-may-2019 settings: [] + - name: useUserId + display_name: Use User ID + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this if you want the server side integration to use User ID instead + of anonymous ID in your identify calls + settings: [] connection_modes: device: web: false @@ -12869,27 +12980,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: trackNamedPages - display_name: Track Named Pages - type: BOOLEAN - deprecated: false - required: false - description: >- - This will track events to Optimizely for [`page` - method](https://segment.io/libraries/analytics.js#page) calls that have - either a `name` or `category` associated with them. For example - `page('Signup', 'Home')` would translate to **Viewed Home Signup Page**. - settings: [] - - name: variations - display_name: Send experiment data to other tools as an identify call (not recommended) - type: BOOLEAN - deprecated: false - required: false - description: >- - The reason this is not recommended is because if you're running lots of - experiments, this could lead to loads of unwanted properties in end tools - as well as unwanted columns in Segment connected databases. - settings: [] - name: listen display_name: Send experiment data to other tools (as a track call) type: BOOLEAN @@ -12928,6 +13018,27 @@ items: `category` associated with them. For example `page('Docs', 'Index')` would translate to **Viewed Docs Page**. settings: [] + - name: trackNamedPages + display_name: Track Named Pages + type: BOOLEAN + deprecated: false + required: false + description: >- + This will track events to Optimizely for [`page` + method](https://segment.io/libraries/analytics.js#page) calls that have + either a `name` or `category` associated with them. For example + `page('Signup', 'Home')` would translate to **Viewed Home Signup Page**. + settings: [] + - name: variations + display_name: Send experiment data to other tools as an identify call (not recommended) + type: BOOLEAN + deprecated: false + required: false + description: >- + The reason this is not recommended is because if you're running lots of + experiments, this could lead to loads of unwanted properties in end tools + as well as unwanted columns in Segment connected databases. + settings: [] connection_modes: device: web: true @@ -12965,17 +13076,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: userKey - display_name: User Key - type: STRING - deprecated: false - required: false - string_validators: - regexp: '^[a-f0-9]{32}$' - description: >- - You can find your User Key on under **User Settings** in your [Pardot - account](https://pi.pardot.com/account). - settings: [] - name: apiVersion display_name: API Version type: SELECT @@ -13073,6 +13173,17 @@ items: Code**. Note: you can still use a URL query parameter of `pi_campaign_id` to override this on specific pages. settings: [] + - name: userKey + display_name: User Key + type: STRING + deprecated: false + required: false + string_validators: + regexp: '^[a-f0-9]{32}$' + description: >- + You can find your User Key on under **User Settings** in your [Pardot + account](https://pi.pardot.com/account). + settings: [] connection_modes: device: web: true @@ -13590,6 +13701,26 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: siteId + display_name: Site ID + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: You can find your Site ID in your piwik snippet. + settings: [] + - name: url + display_name: Server URL + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + You can find your Server URL in your snippet, we will append `/piwik.php` + to the URL automatically. + settings: [] - name: customVariableLimit display_name: Custom Variable Limit type: NUMBER @@ -13612,26 +13743,6 @@ items: `event` to a goal ID, enter event names on the left and goal ID's on the right. settings: [] - - name: siteId - display_name: Site ID - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: You can find your Site ID in your piwik snippet. - settings: [] - - name: url - display_name: Server URL - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - You can find your Server URL in your snippet, we will append `/piwik.php` - to the URL automatically. - settings: [] connection_modes: device: web: true @@ -14020,23 +14131,14 @@ items: components: - type: WEB - type: IOS - - type: ANDROID - platforms: - browser: true - server: false - mobile: true - 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: [] + - type: ANDROID + platforms: + browser: true + server: false + mobile: true + browserUnbundlingSupported: false + browserUnbundlingPublic: true + settings: - name: advertiseProducts display_name: Advertise Products type: BOOLEAN @@ -14069,6 +14171,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 @@ -14106,6 +14217,17 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - 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 @@ -14142,17 +14264,6 @@ 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 - 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: [] connection_modes: device: web: true @@ -14191,16 +14302,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: trackEvents - display_name: Generic Track Events - type: LIST - deprecated: false - required: false - description: >- - Quora Conversion Pixel currently supports a single `Generic` Track event. - This is expected to change in the near future. For now, you can map any - number of event names to this `Generic` event to fire it. - settings: [] - name: writeKey display_name: Quora Conversion Pixel Key type: STRING @@ -14215,6 +14316,16 @@ items: letters and numbers that is the second argument to `qp('init', )` settings: [] + - name: trackEvents + display_name: Generic Track Events + type: LIST + deprecated: false + required: false + description: >- + Quora Conversion Pixel currently supports a single `Generic` Track event. + This is expected to change in the near future. For now, you can map any + number of event names to this `Generic` event to fire it. + settings: [] connection_modes: device: web: true @@ -14499,64 +14610,6 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: listName - display_name: Profile List Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: >- - Please enter the default Profile List. Make sure that the Profile List is - inside the provided Folder Name. - settings: [] - - name: optOutEmailTrait - display_name: Email Permission Status Trait Mapping - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - Please enter the trait you would like to be mapped to - `EMAIL_PEERMISSION_STATUS_`. This will allow you to track users who opt in - and out of marketing communications in your apps and websites. The value - of this trait MUST be a boolean. - settings: [] - - name: password - display_name: Password - type: PASSWORD - deprecated: false - required: true - string_validators: - regexp: '' - description: Please enter your account's password. - settings: [] - - name: petName - display_name: Profile Extension Table - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: Please enter the name of your default Profile Extension Table. - settings: [] - - name: pod - display_name: Pod - type: SELECT - deprecated: false - required: true - select_validators: - select_options: - - '2' - - '5' - - '8' - - '9' - description: >- - The pod that hosts your Responsys account. Simply check your url during - your login screen. This is required to any requests to your account. The - default is `interact2`. - settings: [] - name: events display_name: Events type: MIXED @@ -14566,17 +14619,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: mapUserId - display_name: Map Segment UserId - type: BOOLEAN - deprecated: false - required: false - description: >- - Check this box if you want to automatically create and or map Segment's - `userId` field as a column in Responsys. Highly **recommended** if you - want to connect records in your Profile Lists/Extension Tables with - records in this Supplemental Table. - settings: [] - name: mapEmail display_name: Map Email type: BOOLEAN @@ -14627,6 +14669,24 @@ items: required: false description: Map your Segment properties to Responsys Columns settings: + - name: columns + display_name: Segment Property Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter the Segment Property Name. + settings: [] + - name: fieldName + display_name: Responsys Column Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter the Responsys column name. + settings: [] - name: fieldType display_name: Responsys Column Type type: SELECT @@ -14651,24 +14711,6 @@ items: required: false description: Mark this property as a Primary Key in Responsys. settings: [] - - name: columns - display_name: Segment Property Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter the Segment Property Name. - settings: [] - - name: fieldName - display_name: Responsys Column Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter the Responsys column name. - settings: [] - name: useSegmentMsgId display_name: Use Segment Message ID type: BOOLEAN @@ -14679,16 +14721,29 @@ items: ensure that you do not overwrite historical records in your Supplemental Tables. settings: [] - - name: folderName - display_name: Folder Name + - name: mapUserId + display_name: Map Segment UserId + type: BOOLEAN + deprecated: false + required: false + description: >- + Check this box if you want to automatically create and or map Segment's + `userId` field as a column in Responsys. Highly **recommended** if you + want to connect records in your Profile Lists/Extension Tables with + records in this Supplemental Table. + settings: [] + - name: optOutEmailTrait + display_name: Email Permission Status Trait Mapping type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' description: >- - Please enter the default Folder Name that holds the provided Profile List - and Profile Extension Table. + Please enter the trait you would like to be mapped to + `EMAIL_PEERMISSION_STATUS_`. This will allow you to track users who opt in + and out of marketing communications in your apps and websites. The value + of this trait MUST be a boolean. settings: [] - name: optOutMobileTrait display_name: Mobile Permission Status Trait Mapping @@ -14712,6 +14767,31 @@ items: Choose whether records added to Profile Lists should be `'OPTIN'` rather than the default `'OPTOUT'` settings: [] + - name: petName + display_name: Profile Extension Table + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: Please enter the name of your default Profile Extension Table. + settings: [] + - name: pod + display_name: Pod + type: SELECT + deprecated: false + required: true + select_validators: + select_options: + - '2' + - '5' + - '8' + - '9' + description: >- + The pod that hosts your Responsys account. Simply check your url during + your login screen. This is required to any requests to your account. The + default is `interact2`. + settings: [] - name: username display_name: Username type: STRING @@ -14721,6 +14801,37 @@ items: regexp: '' description: Please enter your account's username. settings: [] + - name: folderName + display_name: Folder Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Please enter the default Folder Name that holds the provided Profile List + and Profile Extension Table. + settings: [] + - name: listName + display_name: Profile List Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: >- + Please enter the default Profile List. Make sure that the Profile List is + inside the provided Folder Name. + settings: [] + - name: password + display_name: Password + type: PASSWORD + deprecated: false + required: true + string_validators: + regexp: '' + description: Please enter your account's password. + settings: [] connection_modes: device: web: false @@ -14805,6 +14916,38 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: codeVersion + display_name: Code Version + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + If you have enabled Source Maps, this is a version string, such as a + version number or git sha + settings: [] + - name: sourceMapEnabled + display_name: Enable Source Map + type: BOOLEAN + deprecated: false + required: false + description: >- + When this option is enabled, we'll let Rollbar know you have source maps + enabled. Be sure to implement either Option A or B in [these + instructions](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map) + to set up source maps with Rollbar as well as fill out Code Version in you + Rollbar Integration settings in your Segment source. + settings: [] + - name: captureUnhandledRejections + display_name: Capture Unhandled Rejections + type: BOOLEAN + deprecated: false + required: false + description: >- + Catch and report unhandled Promise rejections, such as Promise failures + that do not have a corresponding `.then(null, function(e) {})` handler. + settings: [] - name: captureUncaught display_name: Capture uncaught exceptions type: BOOLEAN @@ -14821,26 +14964,6 @@ items: regexp: '' description: The environment the code is running in. settings: [] - - name: accessToken - display_name: Access Token - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Your Rollbar access token - settings: [] - - name: codeVersion - display_name: Code Version - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - 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 @@ -14869,26 +14992,14 @@ items: browser plugin that is throwing errors, you can add them here and Rollbar will ignore exceptions matching those messages. settings: [] - - name: sourceMapEnabled - display_name: Enable Source Map - type: BOOLEAN - deprecated: false - required: false - description: >- - When this option is enabled, we'll let Rollbar know you have source maps - enabled. Be sure to implement either Option A or B in [these - instructions](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map) - to set up source maps with Rollbar as well as fill out Code Version in you - Rollbar Integration settings in your Segment source. - settings: [] - - name: captureUnhandledRejections - display_name: Capture Unhandled Rejections - type: BOOLEAN + - name: accessToken + display_name: Access Token + type: STRING 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. + required: true + string_validators: + regexp: '' + description: Your Rollbar access token settings: [] connection_modes: device: @@ -15032,35 +15143,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 - deprecated: false - required: false - string_validators: - regexp: '' - description: >- - **Required for page calls**. This value can be found in your Sailthru - Dashboard under **App Settings** - settings: [] - name: defaultListName display_name: Default List Name type: STRING @@ -15111,6 +15193,35 @@ 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: [] + - name: customerId + display_name: Customer Id + type: STRING + deprecated: false + required: false + string_validators: + regexp: '' + description: >- + **Required for page calls**. This value can be found in your Sailthru + Dashboard under **App Settings** + settings: [] connection_modes: device: web: false @@ -15206,6 +15317,50 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: + - name: sandbox + display_name: Sandbox + type: BOOLEAN + deprecated: false + required: false + description: >- + Enable this setting if the Salesforce instance you are integrating with is + a Sandbox environment. + settings: [] + - name: securityToken + display_name: Security Token + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^[a-zA-Z0-9]{24,25}$' + description: >- + You can find your Security Token under **Setup > Personal Setup > My + 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: version + display_name: Version + type: SELECT + deprecated: false + required: false + select_validators: + select_options: + - '1' + - '2' + description: >- + V1 is deprecated: should not be used going forwards and is left for legacy + compatibility. Our V2 integration supports getting your prospective + customers into Salesforce as Leads from your website or mobile app. + settings: [] - name: actions display_name: Actions type: MIXED @@ -15225,14 +15380,14 @@ items: 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 + - name: alwaysEnabled + display_name: Always Enabled type: BOOLEAN deprecated: false required: false description: >- - This will map address traits in your group calls as Billing Address for - your Account Objects. + 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 @@ -15248,49 +15403,14 @@ items: password. You can do that under **Setup > Administration Setup > Users > New User**. settings: [] - - name: sandbox - display_name: Sandbox - type: BOOLEAN - deprecated: false - required: false - description: >- - Enable this setting if the Salesforce instance you are integrating with is - a Sandbox environment. - settings: [] - - name: 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 - deprecated: false - required: false - select_validators: - select_options: - - '1' - - '2' - description: >- - V1 is deprecated: should not be used going forwards and is left for legacy - compatibility. Our V2 integration supports getting your prospective - customers into Salesforce as Leads from your website or mobile app. - settings: [] - - name: alwaysEnabled - display_name: Always Enabled + - name: billing + display_name: Send Address as Billing Address 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. + 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 @@ -15310,26 +15430,17 @@ items: with another field **you need to explicitly define that as a row in this setting**. settings: [] - - name: securityToken - display_name: Security Token + - name: username + display_name: Account Email type: STRING deprecated: false required: true string_validators: - regexp: '^[a-zA-Z0-9]{24,25}$' - description: >- - You can find your Security Token under **Setup > Personal Setup > My - 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 + regexp: '' description: >- - This will map address traits in your group calls as Shipping Address for - your Account Objects. + 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: [] connection_modes: device: @@ -15368,6 +15479,45 @@ 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 @@ -15457,45 +15607,6 @@ 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: [] connection_modes: device: web: false @@ -15591,33 +15702,33 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: apiKey - display_name: API Key + - name: token + display_name: Token type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - To connect SatisMeter with Segment first create a project in your - Satismeter dashboard and then navigate to Settings / Install and click the - green button 'Enable with Segment'. You can also manually copy Settings / - Integrations / API keys / Write key and use it as the api key. The api key + This is a legacy setting, and now known as the apiKey. To connect + SatisMeter with Segment first create a project in your Satismeter + dashboard and then navigate to Settings / Install and click the green + button 'Enable with Segment'. You can also manually copy Settings / + Integrations / API keys / Write key and use it as the token. The tokeny should look like urC2RuBlt7utBCzu. settings: [] - - name: token - display_name: Token + - name: apiKey + display_name: API Key type: STRING deprecated: false required: false string_validators: regexp: '' description: >- - This is a legacy setting, and now known as the apiKey. To connect - SatisMeter with Segment first create a project in your Satismeter - dashboard and then navigate to Settings / Install and click the green - button 'Enable with Segment'. You can also manually copy Settings / - Integrations / API keys / Write key and use it as the token. The tokeny + To connect SatisMeter with Segment first create a project in your + Satismeter dashboard and then navigate to Settings / Install and click the + green button 'Enable with Segment'. You can also manually copy Settings / + Integrations / API keys / Write key and use it as the api key. The api key should look like urC2RuBlt7utBCzu. settings: [] connection_modes: @@ -15803,29 +15914,32 @@ items: browserUnbundlingSupported: false browserUnbundlingPublic: true settings: - - name: serverName - display_name: Server Name + - name: ignoreUrls + display_name: Ignore Urls + type: LIST + deprecated: false + required: false + description: >- + The inverse of whitelistUrls and similar to ignoreErrors, but will ignore + errors from whole urls matching a regex pattern or an exact string. + settings: [] + - name: logger + display_name: Logger type: STRING deprecated: false required: false string_validators: regexp: '' - description: >- - Typically this would be the server name, but that doesn’t exist on all - platforms. Instead you may use something like the device ID, as it - indicates the host which the client is running on. + description: The name of the logger used by Sentry. settings: [] - - name: config - display_name: Public DSN + - name: release + display_name: Release type: STRING deprecated: false - required: true + required: false string_validators: regexp: '' - description: >- - You can find your Public DSN by going to Sentry and clicking Projects & - Teams > Any Project > Settings > Client Keys (DSN). This should be the - PUBLIC DSN since it does not contain a secret. + description: Track the version of your application in Sentry. settings: [] - name: customVersionProperty display_name: Set Release by Property @@ -15851,36 +15965,6 @@ items: A list of these messages to be filtered out before being sent to Sentry as either regular expressions or strings. settings: [] - - name: ignoreUrls - display_name: Ignore Urls - type: LIST - deprecated: false - required: false - description: >- - The inverse of whitelistUrls and similar to ignoreErrors, but will ignore - errors from whole urls matching a regex pattern or an exact string. - settings: [] - - name: includePaths - display_name: Include Paths - type: LIST - deprecated: false - required: false - description: >- - An array of regex patterns to indicate which urls are a part of your app - in the stack trace. All other frames will appear collapsed inside Sentry - to make it easier to discern between frames that happened in your code vs - other code. It’d be suggested to add the current page url, and the host - for your CDN. - settings: [] - - name: logger - display_name: Logger - type: STRING - deprecated: false - required: false - string_validators: - regexp: '' - description: The name of the logger used by Sentry. - settings: [] - name: maxMessageLength display_name: Maximum Message Length type: NUMBER @@ -15893,14 +15977,17 @@ items: By default, Raven does not truncate messages. If you need to truncate characters for whatever reason, you may set this to limit the length. settings: [] - - name: release - display_name: Release + - name: serverName + display_name: Server Name type: STRING deprecated: false required: false string_validators: regexp: '' - description: Track the version of your application in Sentry. + description: >- + Typically this would be the server name, but that doesn’t exist on all + platforms. Instead you may use something like the device ID, as it + indicates the host which the client is running on. settings: [] - name: whitelistUrls display_name: Whitelist Urls @@ -15914,6 +16001,30 @@ items: only if you are inlining code inside