Skip to content

Commit bdcde2a

Browse files
pwsegpwseg
authored
Merge pull request #4081 from segmentio/youbora-destination-typo-fixes
Fix Youbora Destination Typos
2 parents 55935d1 + 8ddef4e commit bdcde2a

File tree

1 file changed

+39
-111
lines changed
  • src/connections/destinations/catalog/youbora

1 file changed

+39
-111
lines changed

‎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>

0 commit comments

Comments
 (0)