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
With the analytics.js Vimeo Plugin you can easily collect Vimeo player events into the Segment ecosystem.
6
+
With the analytics.js Vimeo Plugin you can collect Vimeo player events into the Segment ecosystem.
7
7
8
8
## Getting Started
9
9
To use the Vimeo plugin:
10
10
11
-
1. Generate an access token in Vimeo. The plugin uses this token to access metadata about the video content being played. Vimeo provides documentation to generate the access token[here](https://developer.vimeo.com/api/guides/start#generate-access-token).
12
-
-**Note:** Make sure to carefully select your access scopes. The plugin only needs to read information about your video(s).
11
+
1. Generate an access token in Vimeo. The plugin uses this token to access metadata about the playing video content. Vimeo provides documentation to [generate the access token](https://developer.vimeo.com/api/guides/start#generate-access-token).
12
+
-**Note:** Make sure to select the access scopes you need as the plugin only needs to read information about your video(s).
13
13
14
14
2. Enable a new plugin by navigating to the settings for your Source and clicking **Plugins**. You can enable the Vimeo plugin from this menu:
3. Initialize the plugin by entering your Vimeo access token and granting it access to the Vimeo video player instance(s) running on the page. Use this initialize method:
That's it! The plugin listens to the Vimeo player for events, and responds by firing the corresponding [Segment Video Spec](https://segment.com/docs/connections/spec/video/) events on Analytics.js.
33
+
That's it! The plugin listens to the Vimeo player for events, and responds by firing the corresponding [Segment Video Spec](/docs/connections/spec/video/) events on Analytics.js.
34
34
35
35
## Supported Events
36
-
The following [Segment Video Spec](https://segment.com/docs/connections/spec/video/) events are tracked by this plugin:
36
+
The plugin tracks the following [Segment Video Spec](/docs/connections/spec/video/) events:
37
37
- Video Playback Started
38
38
- Video Playback Completed
39
39
- Video Playback Paused/Resumed
40
40
- Video Content Started/Completed
41
41
42
42
## Supported Properties
43
-
The following [Segment Video Spec](https://segment.com/docs/connections/spec/video/) properties are automatically attached to the above events:
43
+
The plugin automatically attaches the following [Segment Video Spec](/docs/connections/spec/video/) properties to the above events:
With the analytics.js YouTube Plugin you can easily collect YouTube player events into the Segment ecosystem.
6
+
With the analytics.js YouTube Plugin you can collect YouTube player events into the Segment ecosystem.
7
7
8
8
## Prerequisites
9
9
The Segment YouTube Plugin requires the YouTube player JavaScript object as an input, so your YouTube player embed must use the [YouTube IFrame player API](https://developers.google.com/youtube/iframe_api_reference#Getting_Started).
10
10
11
-
To begin, generate an API Key for the Segment YouTube plugin, which it uses to access metadata about the video content being played. To do this, create a new project in the Google Developer Console, then create a new API Key in that project for the Segment YouTube plugin. You can read more about this process in the YouTube documentation on [registering an application](https://developers.google.com/youtube/registering_an_application).
11
+
To begin, generate an API Key for the Segment YouTube plugin, which it uses to access metadata about the playing video content. To do this, create a new project in the Google Developer Console, then create a new API Key in that project for the Segment YouTube plugin. You can read more about this process in the YouTube documentation on [registering an application](https://developers.google.com/youtube/registering_an_application).
12
12
13
13
## Getting Started
14
14
15
15
After you've generated the API key:
16
16
17
17
1. Enable a new plugin.
18
-
- Navigate to **Connections > Sources** and choose the right source you want to connect your Youtube plugin to. Go to the **Settings** tab of your source and select **Plugins**. You can enable the YouTube plugin from this menu:
18
+
- Navigate to **Connections > Sources** and choose the source you want to connect the YouTube plugin to. Go to the **Settings** tab of your source and select **Plugins**. You can enable the YouTube plugin from this menu:
**Note:**At this time, only Javascript sources support plugins.
22
+
**Note:**Only Javascript sources support plugins.
23
23
24
24
2. Initialize the plugin by giving it access to the YouTube video player instance(s) running on your page.
25
25
- Use the initialize method in the YouTube `onYouTubeIframeAPIReady()` function to register and initialize the plugin with the player instance and your API key:
26
26
27
-
```
27
+
```js
28
28
var player;
29
29
functiononYouTubeIframeAPIReady() {
30
30
player =newYT.Player('player', {
@@ -38,22 +38,22 @@ var player;
38
38
})}
39
39
```
40
40
41
-
That's it! The plugin listens to the YouTube player for events, and fires the corresponding [Segment Video Spec](https://segment.com/docs/connections/spec/video/) events on analytics.js.
41
+
That's it! The plugin listens to the YouTube player for events, and fires the corresponding [Segment Video Spec](/docs/connections/spec/video/) events on analytics.js.
42
42
43
43
## Supported Events
44
-
The following [Segment Video Spec](https://segment.com/docs/connections/spec/video/) events are tracked by this plugin:
44
+
The plugin tracks the following [Segment Video Spec](/docs/connections/spec/video/) events:
45
45
46
46
Event | Details
47
47
----- | -------
48
-
Video Playback Started | When a user presses Play; after the last user action required for playback to begin (eg, after user login/authentication). <br><br> - If playing a single video, this fires when the video starts. <br> - If playing a playlist, this fires when the first video in the playlist starts.
49
-
Video Playback Completed | When playback is complete and only when the session is finished. <br><br>- If playing a single video, this fires when the video finishes. <br>- If playing a playlist, this event fires when the final video in the playlist finishes.
50
-
Video Playback Paused/Resumed | When playback is resumed, by the user, after being paused.
48
+
Video Playback Started | When a user presses Play; after the last user action required for playback to begin. For example, after user login/authentication. <br><br> - If playing a single video, this fires when the video starts. <br> - If playing a playlist, this fires when the first video in the playlist starts.
49
+
Video Playback Completed | When playback is complete and when the session finishes. <br><br>- If playing a single video, this fires when the video finishes. <br>- If playing a playlist, this event fires when the final video in the playlist finishes.
50
+
Video Playback Paused/Resumed | When the user resumes playback after pausing.
51
51
Video Playback Buffer Started/Completed | When playback starts and finishes buffering content or an ad.
52
52
Video Playback Seek Started/Completed | When a user manually seeks a certain position of the content or ad in the playback.
53
53
Video Content Started/Completed | When a video content segment starts and completes playing within a playback. <br><br>- If playing a playlist, these events get fired for each individual video.
54
54
55
55
## Supported Properties
56
-
The following [Segment Video Spec](https://segment.com/docs/connections/spec/video/) properties are automatically attached to the above events:
56
+
The plugin automatically attaches the following [Segment Video Spec](/docs/connections/spec/video/) to the above events:
0 commit comments