Skip to content

Commit 3a571da

Browse files
author
markzegarelli
committed
Merge branch 'develop' of github.com:segmentio/segment-docs into develop
2 parents 0671d7b + 9264e68 commit 3a571da

File tree

12 files changed

+69
-117
lines changed

12 files changed

+69
-117
lines changed

src/connections/destinations/catalog/actions-commandbar/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: CommandBar Destination
33
hide-boilerplate: true
44
hide-dossier: true
5-
private: true
6-
hidden: true
75
id: 638f843c4520d424f63c9e51
86
---
97

src/connections/destinations/catalog/actions-google-analytics-4/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,10 @@ For a complete map of Universal Analytics functionality to corresponding Google
128128

129129
## FAQ & Troubleshooting
130130

131+
### Data not sending to Google
132+
133+
Ensure that at least one mapping has been configured and enabled in the destination mappings for an event that you would like to reach Google. Without any mappings enabled to trigger on an event that has been ingested by the connected source, the destination will not send events downstream.
134+
131135
### Attribution Reporting
132136

133137
Google doesn't currently support passing certain reserved fields to the Google Analytics 4 Measurement Protocol API. This includes attribution data, like UTM parameters. If you rely on attribution reporting, you can either send this data as [custom dimensions](/docs/connections/destinations/catalog/actions-google-analytics-4/#custom-dimensions-and-metrics) or implement a parallel client-side integration to collect this data with gtag.js.

src/connections/destinations/catalog/actions-intercom-cloud/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Intercom Cloud Mode (Actions) provides the following benefits over the classic I
3131
2. Search for **Intercom Cloud Mode (Actions)** in the Destinations Catalog, and select the destination.
3232
3. Click **Configure Intercom Cloud Mode (Actions)**.
3333
4. Select the source that will send data to Intercom Cloud Mode (Actions) and follow the steps to name your destination.
34-
5. On the **Settings** tab, authenticate with Intercom using OAuth.
34+
5. On the **Settings** tab, authenticate with Intercom using OAuth. If you have multiple Intercom workspaces, choose one workspace that you'll connect to Segment.
3535
6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings).
3636
7. Enable the destination and configured mappings.
3737

src/connections/destinations/catalog/matomo/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ rewrite: true
44
redirect_from: '/connections/destinations/catalog/piwik/'
55
id: 54521fda25e721e32a72eee7
66
---
7-
[Matomo](https://matomo.org/), formerly Piwik, is the leading open source web analytics platform that gives you valuable insights into your website's visitors, your marketing campaigns and much more, so you can optimize your strategy and online experience of your visitors.
7+
[Matomo](https://matomo.org/), formerly Piwik, is the leading open source web analytics platform that gives you valuable insights into your website's visitors, your marketing campaigns and much more, so you can optimize your strategy and online experience of your visitors.
8+
9+
Segment’s Matomo destination code is open-source and can be viewed on GitHub:
10+
- [Javascript](https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/piwik/lib/index.js){:target="_blank"}
811

912
## Getting Started
1013

src/connections/destinations/catalog/youbora/index.md

Lines changed: 39 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -11,89 +11,39 @@ Youbora automatically starts recording data.
1111
## Tracking Video Events
1212

1313
Segment can keep track of events occurring on any number of video players on your
14-
page. **You must include the `session_id` propert with every video event you want to send to the Youbora so Segment can keep track of which player to attribute the events to.**
14+
page. **You must include the `session_id` property with every video event you want to send to Youbora so Segment can keep track of which player to attribute the events to.**
1515

1616

1717
### Video Playback Started
1818

19-
When a user starts playback of a video, use the [Video Playback Started](/docs/connections/spec/video/#playback-events) event. Segment maps the properties
20-
from the Video Playback Started event to the following Youbora video metadata
21-
fields:
22-
23-
<table>
24-
<tr>
25-
<td>**Youbora Parameter**</td>
26-
<td>**Segment Property**</td>
27-
<td>**Data Type**</td>
28-
</tr>
29-
<tr>
30-
<td>'content.isLive'</td>
31-
<td>`properties.livestream`</td>
32-
<td>Boolean</td>
33-
</tr>
34-
<tr>
35-
<td>Resource</td>
36-
<td>`context.page.url`</td>
37-
<td>String</td>
38-
</tr>
39-
</table>
19+
When a user starts playback of a video, use the [Video Playback Started](/docs/connections/spec/video/#playback-events) event. Segment maps the properties from the Video Playback Started event to the following Youbora video metadata fields:
20+
21+
| Youbora Parameter | Segment Property | Data Type |
22+
| ----------------- | ----------------------- | --------- |
23+
| `content.isLive` | `properties.livestream` | Boolean |
24+
| Resource | `context.page.url` | String |
25+
4026

4127
### Video Content Started
4228

43-
When the video content actually begins playing, use the [Video Content
44-
Started](/docs/connections/spec/video/#content-events) event. Segment maps the properties
45-
from the Video Playback Started event to the following Youbora video metadata
46-
fields:
47-
48-
<table>
49-
<tr>
50-
<td>**Youbora Parameter**</td>
51-
<td>**Segment Property**</td>
52-
<td>**Data Type**</td>
53-
</tr>
54-
<tr>
55-
<td>'content.title'</td>
56-
<td>`properties.title`</td>
57-
<td>String</td>
58-
</tr>
59-
<tr>
60-
<td>'content.title2'</td>
61-
<td>`properties.program`</td>
62-
<td>String</td>
63-
</tr>
64-
<tr>
65-
<td>'content.duration'</td>
66-
<td>`properties.total_length`</td>
67-
<td>Integer</td>
68-
</tr>
69-
<tr>
70-
<td>'content.metadata.content_id'</td>
71-
<td>`properties.asset_id`</td>
72-
<td>String</td>
73-
</tr>
74-
<tr>
75-
<td>'content.metadata.genre'</td>
76-
<td>`properties.genre`</td>
77-
<td>String</td>
78-
</tr>
79-
<tr>
80-
<td>'content.metadata.owner'</td>
81-
<td>`properties.publisher`</td>
82-
<td>String</td>
83-
</tr>
84-
</table>
85-
86-
Using the difference in time between when `Video Playback Started` and `Video
87-
Content Started`, Youbora will calculate the join time for you.
29+
When the video content actually begins playing, use the [Video Content Started](/docs/connections/spec/video/#content-events) event. Segment maps the properties from the Video Playback Started event to the following Youbora video metadata fields:
30+
31+
| Youbora Parameter | Segment Property | Data Type |
32+
|:----------------------------- |:------------------------- |:--------- |
33+
| `content.title` | `properties.title` | String |
34+
| `content.title2` | `properties.program` | String |
35+
| `content.duration` | `properties.total_length` | Integer |
36+
| `content.metadata.content_id` | `properties.asset_id` | String |
37+
| `content.metadata.genre` | `properties.genre` | String |
38+
| `content.metadata.owner` | `properties.publisher` | String |
39+
40+
Youbora calculates the join time using the time difference between `Video Playback Started` and `Video Content Started`,
8841

8942
### Video Playback Paused/Resumed
9043

91-
When a user pauses/resumes playback of a video, use the [Video
92-
Playback Paused](/docs/connections/spec/video/#playback-events) and [Video Playback
93-
Resumed](/docs/connections/spec/video/#playback-events) events.
44+
When a user pauses or resumes playback of a video, use the [Video Playback Paused](/docs/connections/spec/video/#playback-events) and [Video Playback Resumed](/docs/connections/spec/video/#playback-events) events.
9445

95-
If the user pauses during an ad, be sure to fill the
96-
`properties.ad_asset_id` field from our spec for **both** calls, as we use its
46+
If the user pauses during an ad, fill the `properties.ad_asset_id` field from the spec for **both** calls, as Segment uses its
9747
presence to determine whether the pause is occurring during an ad or not.
9848

9949
**Example**
@@ -112,11 +62,7 @@ analytics.track('Video Playback Resumed', {
11262

11363
### Video Playback Seek Started/Completed
11464

115-
When the video content actually begins playing, use the [Video
116-
Playback Seek Started](/docs/connections/spec/video/#playback-events) and [Video Playback
117-
Seek Completed](/docs/connections/spec/video/#playback-events) events. Youbora internally
118-
calculates the duration of the seek but if you would prefer to provide this
119-
value yourself you can pass it as the integration-specific option `duration`.
65+
When the video content actually begins playing, use the [Video Playback Seek Started](/docs/connections/spec/video/#playback-events) and [Video Playback Seek Completed](/docs/connections/spec/video/#playback-events) events. Youbora internally calculates the duration of the seek but if you would prefer to provide this value yourself you can pass it as the integration-specific option `duration`.
12066

12167
**Example**
12268

@@ -133,10 +79,6 @@ Playback Buffer Started](/docs/connections/spec/video/#playback-events) and [Vid
13379
Buffer Completed](/docs/connections/spec/video/#playback-events) events. Segment maps the
13480
properties from these events to the following Youbora video metadata fields:
13581

136-
If the buffer occurs during an ad, be sure to fill the
137-
`properties.ad_asset_id` field from our spec for **both** calls, as we use its
138-
presence to determine whether the buffer is occurring during an ad or not.
139-
14082
**Example**
14183

14284
```js
@@ -145,14 +87,16 @@ analytics.track('Video Playback Buffer Started', { session_id: 1 });
14587
analytics.track('Video Playback Buffer Completed', { session_id: 1 });
14688
```
14789

90+
If the user pauses during an ad, fill the `properties.ad_asset_id` field from the spec for **both** calls, as Segment uses its
91+
presence to determine whether the pause is occurring during an ad or not.
92+
14893
### Video Playback Interrupted
14994

15095
When playback of a video is interrupted, use the [Video Playback Interrupted](/docs/connections/spec/video/#playback-events) event.
15196

15297
### Video Playback Completed
15398

154-
To track the completion of the video playback session, use our [Video
155-
Playback Completed](/docs/connections/spec/video/#playback-events) event.
99+
To track the completion of the video playback session, use the [Video Playback Completed](/docs/connections/spec/video/#playback-events) event.
156100

157101
**Example**
158102

@@ -165,18 +109,10 @@ analytics.track('Video Playback Completed', { session_id: 1 });
165109
When an ad begins to load, use the [Video Ad Started](/docs/connections/spec/video/#ad-events) event. Segment maps the properties from
166110
these events to the following Youbora video metadata fields:
167111

168-
<table>
169-
<tr>
170-
<td>**Youbora Parameter**</td>
171-
<td>**Segment Property**</td>
172-
<td>**Data Type**</td>
173-
</tr>
174-
<tr>
175-
<td>'ad.title'</td>
176-
<td>`properties.title`</td>
177-
<td>String</td>
178-
</tr>
179-
</table>
112+
| Youbora Parameter | Segment Property | Data Type |
113+
| ----------------- | ------------------ | --------- |
114+
| `ad.title` | `properties.title` | String |
115+
180116

181117
**Example**
182118

@@ -186,8 +122,7 @@ analytics.track('Video Ad Started', { session_id: 1, title: 'Test Ad Title', ad_
186122

187123
### Video Ad Completed
188124

189-
To track the completion of an ad, use our [Video Ad
190-
Completed](/docs/connections/spec/video/#ad-events) event.
125+
To track the completion of an ad, use the [Video Ad Completed](/docs/connections/spec/video/#ad-events) event.
191126

192127
**Example**
193128

@@ -214,13 +149,9 @@ Youbora supports automatic video tracking for the following video players:
214149
- ThePlatform
215150
- VideoJS
216151

217-
However, note that relying solely on Youbora auto tracking will not send your
218-
video events to Segment downstream destinations, including a raw data warehouse.
219-
To track data to downstream tools, we recommend either manually implementing all
220-
video player events or manually implementing all events alongside Youbora. If
221-
you employ the latter method, you should indicate explicitly that your Segment
222-
events should not flow to Youbora (because they've already been auto-tracked by
223-
the Youbora library).
152+
However, relying solely on Youbora auto tracking will not send your video events to Segment downstream destinations, including a raw data warehouse. To track data to downstream tools, Segment recommends either manually implementing all video player events or manually implementing all events alongside Youbora.
153+
154+
If you employ the latter method, you should indicate explicitly that your Segment events should not flow to Youbora (because they've already been auto-tracked by the Youbora library).
224155

225156
```javascript
226157
analytics.track('Video Playback Started', { // empty properties object
@@ -231,10 +162,9 @@ analytics.track('Video Playback Started', { // empty properties object
231162
});
232163
```
233164

234-
In order to track a player that falls in one of the above categories, follow the
235-
below steps:
165+
Use the following steps to track a player that falls in one of the previous categories:
236166

237-
1. Ensure you have the latest snippet on your page (Updated 2/6/18).
167+
1. Ensure you have the latest snippet on your page.
238168
2. If your snippet is in the `head` of your page, move it to the very bottom of
239169
your `body`, right before the `</body>` tag.
240170
3. Replace the `load` method in your snippet with the following (you can delete
@@ -268,11 +198,9 @@ below steps:
268198
In the `player` field, pass the video player object, or the ID of the
269199
video player element in the case of HTML5.
270200

271-
In the `options` field, you can pass options the same way you would pass them
272-
natively to Youbora as documented
273-
[here](http://developer.nicepeopleatwork.com/plugins/general/setting-youbora-options/).
201+
In the `options` field, you can pass options the same way you would [pass them natively to Youbora](http://developer.nicepeopleatwork.com/plugins/general/setting-youbora-options/){:target="_blank"}.
274202

275-
See the below example for what a working implementation looks like:
203+
The following example shows a working implementation:
276204

277205
```js
278206
<script>

src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,8 @@ Log into your downstream tools and check that your events are populating, and co
139139

140140
### No Data After Updating Credentials
141141

142-
When a connected account changes or updates their credentials, the customer will have to create a new Facebook Lead Ads source. Reauthorization implies that a new token gets generated, but the token is not the sole link between Segment and Facebook. A Segment app is installed onto an FB Account and that will be the sprouting point from where tokens are generated. The reason we can't disconnect and reconnect the CRM on Facebook with reauthorization is because the creation of a new token will mean to invalidate the rest of the tokens attached to the same Facebook account.
142+
When you update or change credentials on a connected account, you need to create a new Facebook Lead Ads source to reauthorize Facebook. Reauthorization implies that a new token is generated, but the token is not the only link between Segment and Facebook.
143143

144-
For example, let's imagine you have a Facebook Account with three accounts: Account A, Account B, and Account C. You connect Segment to all of them and then generate tokens respectively. Later on, you decide for whatever reason to reauthorize the "Account A" page, the other tokens will be invalidated, and the pages will stop working.
144+
When you connect the Facebook Leads Ads source, a Segment application is installed on the connected Facebook account. If you were to generate a new token on the same source, it would invalidate all other tokens attached to that Facebook account.
145+
146+
For example, if you have a Facebook Account with three accounts: Account A, Account B, and Account C, you can connect Segment to all of them and then generate a token for each account. Later on, if you need to reauthorize the "Account A" page, the tokens for Account B and Account C are invalidated, and the pages stop working.

src/connections/sources/catalog/libraries/mobile/react-native/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ To get started with the Analytics for React Native 2.0 library:
7272
`trackAppLifecycleEvents` | The default is set to `false`. <br> This enables you to automatically track app lifecycle events, such as application installed, opened, updated, backgrounded. Set to true to `true` to track.
7373
`trackDeepLinks` | The default is set to `false`. <br> This automatically tracks when the user opens the app via a deep link. Set to Enable automatic tracking for when the user opens the app via a deep link.
7474
`proxy` | The default is set to `undefined`. <br> This is a batch url to post to instead of the default batch endpoint.
75+
`collectDeviceId` | The default is set to `fasle`. <br> This automatically adds a `device.Id` property to the context object from the DRM API on Android devices.
7576

7677
## Set up iOS Deep Link Tracking
7778
> warning ""

src/connections/sources/catalog/libraries/website/javascript/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -758,6 +758,7 @@ Segment offers video player 'plugins' so you can quickly collect video events us
758758

759759
Analytics.js tracks across subdomains out of the box; all Segment destinations fully support this feature.
760760

761+
To track activity on your subdomains, include the Segment Analytics.js snippet on each subdomain. Segment sets users' `anonymousId` on the top-level domain, so users are tracked across any subdomains.
761762

762763
## Analytics.js performance
763764

src/connections/sources/catalog/libraries/website/javascript/supported-browsers.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,13 @@ The library is regularly tested and is functional with the following browsers:
1515
- Microsoft Edge
1616
- Brave
1717

18+
1819
### Internet Explorer Support
1920

2021
Segment guarantees support for Internet Explorer 11 and later for Analytics.js. Remember that different bundled (device-mode) destinations might have different compatibility guarantees for their own products. Refer to the vendor's documentation to confirm browser compatibility.
2122

23+
> info ""
24+
> Classic destinations and Analytics.js support Internet Explorer 11, but some Actions destinations are not yet supported.
2225
2326
## Tracking Protection (ITP, ETP)
2427

src/connections/sources/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,12 @@ To create a source:
7171
4. Enter a name for your source as well as any information on the setup page.
7272
5. Click **Add Source**.
7373

74+
> info "One source or multiple sources?"
75+
> Segment suggests that you create one source for each type of data you want to collect. For example, you might have one source for all of your website tracking and a different source for any mobile tracking. Creating one source per data type provides the following benefits:
76+
> - Debugger ease of use - mixing libraries/sources on a single API key means you’re heavily reliant on filtering to actually test events
77+
> - Flexibility sending data to different projects - if you want to have different warehouse schemas, analytics projects, etc, having multiple sources would create this separation
78+
> - More control - as your account grows with the number of destinations you enable, having separate sources allows you to have more control
79+
7480
## Website libraries
7581

7682
[Analytics.js](/docs/connections/sources/catalog/libraries/website/javascript/), the JavaScript library, is the most powerful way to track customer data from your website. If you're just starting out, Segment recommends it over server-side libraries as the simplest installation for any website.

0 commit comments

Comments
 (0)