You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/promoter-io/index.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,8 +11,6 @@ hide-dossier: true
11
11
12
12
Once the Segment library is integrated with your service, add your Promoter API Key and enable Promoter in your Segment destinations page. You can find your API key in Promoter.io under **Accounts Settings > Segment Destination**.
13
13
14
-
- - -
15
-
16
14
Promoter supports the `identify` and `track` methods from Segment and will allow you to:
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/quora-conversion-pixel/index.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,13 +13,13 @@ id: 5952698570a3e552b9575519
13
13
2. Search for "Quora" in the Catalog, select it, and choose which of your sources to connect the destination to.
14
14
3. Add your Quora Conversion Pixel Key to your Destination settings. To get this you will need to do the following:
15
15
16
-
i. Log into your [Quora Ads Manager Account](https://www.quora.com/ads/account){:target="_blank"}.
16
+
1. Log into your [Quora Ads Manager Account](https://www.quora.com/ads/account){:target="_blank"}.
17
17
18
-
ii. Navigate to the "Quora Pixel" tab in your Quora Dashboard.
18
+
2. Navigate to the "Quora Pixel" tab in your Quora Dashboard.
19
19
20
-
iii. Click the "Setup Pixel" button to open the installation popup modal.
20
+
3. Click the "Setup Pixel" button to open the installation popup modal.
21
21
22
-
iv. Under "Option A: Install a JavaScript Pixel," find your Quora Conversion Pixel Key in the Quora JavaScript Pixel - the key is embedded in a tag that looks like `qp('init', '7cc5a029c2604daa8365d15ff337146e')`. In the example below, the key is `7cc5a029c2604daa8365d15ff337146e`.
22
+
4. Under "Option A: Install a JavaScript Pixel," find your Quora Conversion Pixel Key in the Quora JavaScript Pixel - the key is embedded in a tag that looks like `qp('init', '7cc5a029c2604daa8365d15ff337146e')`. In the example below, the key is `7cc5a029c2604daa8365d15ff337146e`.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/ramen/index.md
+50-62Lines changed: 50 additions & 62 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,20 @@
2
2
title: Ramen Destination
3
3
id: 558c9d1a0a20f4e22f0fb3bb
4
4
---
5
+
5
6
## Getting Started
6
7
7
8
When you enable Ramen in the Segment web app, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Ramen's JavaScript library onto your page. This means you should remove Ramen's snippet from your page if you already have it there.
8
-
9
-
+ As of March 2016, Ramen supports asking questions of anonymous website visitors in addition to logged-in users. Calling [`page`](#page), [`track`](#track), and [`group`](#group) will work without calling [`identify`](#identify). However, when you call [`identify`](#identify) you _must_ pass in an `id` or else the Ramen destination will ignore the call.
10
-
11
-
9
+
10
+
- As of March 2016, Ramen supports asking questions of anonymous website visitors in addition to logged-in users. Calling [`page`](#page), [`track`](#track), and [`group`](#group) will work without calling [`identify`](#identify). However, when you call [`identify`](#identify) you _must_ pass in an `id` or else the Ramen destination will ignore the call.
11
+
12
12
## Identify
13
-
13
+
14
14
When you make an [Identify call](/docs/connections/spec/identify) on Analytics.js, it identifies the logged-in user to Ramen.
15
-
15
+
16
16
Here is a full example, which we will annotate below:
*`email` becomes the `email` of the user in Ramen.
33
34
*`name` becomes the `name` of the user in Ramen.
34
35
*`created_at` becomes the `customer_created_at` timestamp for the user in Ramen. It can be passed in as a `Date` or seconds since the epoch.
35
36
* If `company` is an `Object` with an `id` attribute, we'll treat that information as if it was passed to [`group`](#group) and create a company in Ramen.
36
37
* Attributes with names ending in `_at` will be parsed as times.
37
38
* Attributes with names beginning with `is_` will be parsed as Booleans.
38
-
39
-
39
+
40
40
**Note:** Ramen will ignore any calls to `identify` that do not contain `userId`.
41
-
42
-
43
-
41
+
44
42
## Group
45
-
43
+
46
44
Segment supports Ramen Companies in Analytics.js through the [`group`](/docs/connections/spec/group) method. Users can be put into multiple groups, which will associate them to multiple companies in Ramen.
47
-
45
+
48
46
Here is a full example, which we will annotate below:
49
47
50
48
```javascript
@@ -57,49 +55,44 @@ analytics.group('314159', {
57
55
mrr:149.99
58
56
});
59
57
```
60
-
58
+
61
59
Here is a list of the attributes we process:
62
-
60
+
63
61
*`id` becomes the `id` of the company in Ramen.
64
62
*`url` becomes the `url` of the company in Ramen.
65
63
*`name` becomes the `name` of the company in Ramen.
66
64
*`created_at` becomes the `company_created_at` timestamp for the company in Ramen. It can be passed in as a `Date` or seconds since the epoch.
67
65
* Other attributes can be passed in as well, and will parsed according to the same rules as denoted in the [`identify`](#identify) section.
68
-
69
-
66
+
70
67
## Page
71
-
68
+
72
69
When you call [`page`](/docs/connections/spec/page) on Analytics.js, it registers a new pageview in Ramen and checks to see if any questions should be asked.
73
-
70
+
74
71
Ramen does not support passing in any attributes to `page`. You can call `page({ title: "Our page" })` but the attributes (ie. `title` in this example) will be ignored.
75
-
76
-
72
+
77
73
## Track
78
-
74
+
79
75
When you call [`track`](/docs/connections/spec/track) on Analytics.js, it registers a new event in Ramen and checks to see if any questions should be asked.
80
-
76
+
81
77
Ramen does not support passing in any attributes to `track` beyond the event name. You can call `track('Subscribed', { plan: "Startup" })` but the attributes (ie. `plan` in this example) will be ignored.
82
-
83
-
84
-
- - -
85
-
78
+
79
+
86
80
## Features
87
-
88
-
81
+
89
82
### Secure Mode
90
-
83
+
91
84
If you want to enable Ramen [secure mode](http://docs.ramen.is/#secure-mode){:target="_blank"} for analytics.js, you can pass in the `timestamp` and `auth_hash` variables by rendering it in your server-side templates.
92
-
85
+
93
86
The `timestamp` should be a Unix timestamp (epoch seconds). The `auth_hash` is a SHA256 has of several attributes. The hash is not based on the email, it is based on:
94
-
95
-
+ user.email - If you do not store emails for your customers, use an empty string
96
-
+ user.id
97
-
+ user.name - If you do not have a name for your customers, use their email address or an empty string
98
-
+ timestamp
99
-
+ Ramen API Secret
100
-
87
+
88
+
- user.email - If you do not store emails for your customers, use an empty string
89
+
- user.id
90
+
- user.name - If you do not have a name for your customers, use their email address or an empty string
91
+
- timestamp
92
+
- Ramen API Secret
93
+
101
94
Here's an example of a Ruby web server rendering an identify call with secure mode:
`RAMEN_ORGANIZATION_SECRET_KEY` is found in Ramen's RamenJS documentation.
118
-
119
-
120
-
- - -
121
-
122
-
111
+
123
112
## Troubleshooting
124
-
125
-
113
+
126
114
### I'm seeing a `404` error
127
-
115
+
128
116
Check to make sure your Ramen `ORGANIZATION_ID` is correct.
129
-
117
+
130
118
### I'm seeing a `401` error
131
-
119
+
132
120
The request you are sending is not valid. Several things can cause this:
133
-
134
-
+ An invalid `user.email`. It can be blank, but it cannot be an invalid email address.
135
-
+ A missing `user.id`.
136
-
+ Not including `timestamp` and `auth_hash` once Secure Mode has been enabled. You can see if Secure Mode is enabled by visiting your RamenJS settings page in Ramen.
137
-
121
+
122
+
- An invalid `user.email`. It can be blank, but it cannot be an invalid email address.
123
+
- A missing `user.id`.
124
+
- Not including `timestamp` and `auth_hash` once Secure Mode has been enabled. You can see if Secure Mode is enabled by visiting your RamenJS settings page in Ramen.
125
+
138
126
If the above all look correct, and you are sending `timestamp` and `auth_hash`, check the following:
139
-
140
-
+`timestamp` is being dynamically generated (ie. it is not accidentally hard-coded).
141
-
+`auth_hash` is being calculated correctly
142
-
127
+
128
+
-`timestamp` is being dynamically generated (ie. it is not accidentally hard-coded).
129
+
-`auth_hash` is being calculated correctly
130
+
143
131
If you are still having trouble, you can email [Ramen support](mailto:support@ramen.is).
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/recombee-ai/index.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,6 @@ This destination is maintained by Recombee. For any issues with the destination,
18
18
19
19
> info ""
20
20
> The Recombee Destination is currently in beta, which means that the Recombee team is still actively developing the destination. If you have any feedback to help improve the Recombee Destination and its documentation, [contact the Recombee support team](mailto:support@recombee.com).
21
-
>>>>>>> Stashed changes
22
21
23
22
Use this Segment destination to send your interaction data, like views, purchases, or plays, to Recombee.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/retina/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ id: 5f287bfa332cce0b1ed18331
8
8
9
9
Retina AI maintains this destination. For any issues with the destination, contact the [Retina AI Support Team](mailto:info@retina.ai).
10
10
11
-
> info ""
11
+
> info ""
12
12
> The Retina AI Destination is in beta, which means that they are still actively developing the destination. To join the beta program, or if you have any feedback to help improve the Retina AI Destination and its documentation, contact the [Retina AI Support Team](mailto:info@retina.ai).
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/rollbar/index.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,12 @@ This feature makes use of JavaScript Source Maps to translate the minified code
20
20
21
21
2. Provide your source map. There are two ways you can do this:
22
22
23
-
a. Automatic download: place a comment like the following at the bottom of your minified JavaScript files:
23
+
1. Automatic download: place a comment like the following at the bottom of your minified JavaScript files:
24
24
25
-
```
26
-
//# sourceMappingURL=URL_TO_SOURCE_MAP
27
-
```
25
+
```
26
+
//# sourceMappingURL=URL_TO_SOURCE_MAP
27
+
```
28
28
29
-
b. Upload pre-deploy: at the beginning of your deploy script, upload a source map package using Rollbar's API.
29
+
2. Upload pre-deploy: at the beginning of your deploy script, upload a source map package using Rollbar's API.
30
30
31
31
For more detail on providing your source map, checkout [Rollbar's documentation here](https://rollbar.com/docs/source-maps/#step-2-provide-your-source-map){:target="_blank"}.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/route/index.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,6 @@ Once the Segment library is integrated with your server, toggle Route `on` in yo
10
10
11
11
Route supports the `identify` and `track` methods.
12
12
13
-
---
14
-
15
13
## Identify
16
14
17
15
When you `identify` a contact, we'll pass that contact's information to Route with `email` as Route's Contact ID. The traits recognized as Route's contact profile fields are:
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/salesforce-dmp/index.md
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,17 +28,17 @@ Next, configure the Destination in the Segment web app:
28
28
29
29
### Setting up a Client-Side Web Implementation
30
30
31
-
3. Get your **Config ID** from your SFDMP console. Log into the
31
+
4. Get your **Config ID** from your SFDMP console. Log into the
32
32
console and go to **Manage** > **Capture** > **Sites**.
33
33
If you don't see this option, contact your SFDMP representative.
34
34
35
-
4. In the **Sites** tab, locate the site you want to use as the SFDMP destination.
35
+
5. In the **Sites** tab, locate the site you want to use as the SFDMP destination.
36
36
If you haven't created any sites yet, click **Create Site** and go through the options to create a new site.
37
37
38
38

39
39
40
-
5. In the dropdown, find the site tag for the site you want to use. The string you need is under "Config" and will look something like `r0u08k4tz`.
41
-
6. Go back to the Segment App, and navigate to the Salesforce DMP destination you're setting up. Locate the ConfigID setting, and paste the value you found in that field.
40
+
6. In the dropdown, find the site tag for the site you want to use. The string you need is under "Config" and will look something like `r0u08k4tz`.
41
+
7. Go back to the Segment App, and navigate to the Salesforce DMP destination you're setting up. Locate the ConfigID setting, and paste the value you found in that field.
42
42
43
43
To send client-side events to SFDMP, you must include a SFDMP Config ID and
44
44
SFDMP Namespace in your Segment settings. Segment's UI enforces inclusion of a
@@ -49,14 +49,14 @@ If you don't provide a `namespace` Segment can't pass events downstream to SFDMP
49
49
50
50
### Setting up for a Server-Side Implementation
51
51
52
-
6. To set up SFDMP for a server-side connection, enter your SFDMP `Server-side
52
+
8. To set up SFDMP for a server-side connection, enter your SFDMP `Server-side
53
53
Publisher UUID`. To locate this, Segment recommends that you contact your SFDMP representative. Helpful documentation can be found
54
54
[in the Salesforce Audience Studio Help Center](https://konsole.zendesk.com/hc/en-us/articles/219493027-Mobile-HTTP-API){:target="_blank"}.
55
-
7. Once you've retrieved your `Server-side Publisher UUID`, follow the
55
+
9. Once you've retrieved your `Server-side Publisher UUID`, follow the
56
56
instructions in the Segment SFDMP settings to enter your `Pixel.gif Domain`,
57
57
`Pixel.gif Site` and, optionally, your `Pixel.gif Section` in the correct
58
58
fields.
59
-
8. If you instead want to send your `track` events to SFDMP's
59
+
10. If you instead want to send your `track` events to SFDMP's
60
60
Event.gif endpoint instead of their Pixel.gif endpoint, first disable the
61
61
`Send Server-Side Track Calls to the Pixel.gif Endpoint` (it defaults to on)
62
62
setting in the Segment UI.
@@ -217,7 +217,8 @@ If you see page attributes automatically appended to outbound Pixel.gif calls
217
217
and you're not sure where the attributes came from, then you or someone on
218
218
your team has likely set up page scraping in SFDMP.
219
219
220
-
Warning: If you decide to rely on SFDMP's page scraping to transmit attributes
220
+
> warning ""
221
+
> If you decide to rely on SFDMP's page scraping to transmit attributes
221
222
to SFDMP rather than adding them as properties to Segment events, you won't
222
223
see these properties in other Segment connections, including in a raw data
223
224
warehouse.
@@ -401,4 +402,4 @@ The value of field `msg.event`.
401
402
402
403
| Value Passed to Segment | Value Sent to SFDMP |
403
404
|-|-|
404
-
| Any String value (for example, 'Account Created') | event_id: <`id mapped in Event ID Map UI setting`>|
405
+
| Any String value (for example, 'Account Created') | event_id: `<id mapped in Event ID Map UI setting>`|
0 commit comments