# analytics.js Vimeo Plugin

With the analytics.js Vimeo Plugin you can collect Vimeo player events into the Segment ecosystem.

## Getting Started

To use the Vimeo plugin:

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).

   * **Note:** Make sure to select the access scopes you need as the plugin only needs to read information about your video(s).
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:

   ![the plugins setting screen.](https://docs-resources.prod.twilio.com/78cc56df70076dfca6e3a17502260eb5d33435b8bda717e8bce6a59c01c56358.png)
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:

```js
<iframe src="https://player.vimeo.com/video/76979871" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
<script src="https://player.vimeo.com/api/player.js"></script>
<script>
    var iframe = document.querySelector('iframe');
    var player = new Vimeo.Player(iframe);
    analytics.ready(function () {
      var VimeoAnalytics = window.analytics.plugins.VimeoAnalytics
      var vimeoAnalytics = new VimeoAnalytics(player, 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX0365')
      vimeoAnalytics.initialize()
    })
</script>
```

That's it! The plugin listens to the Vimeo player for events, and responds by firing the corresponding [Segment Video Spec](/docs/segment/connections/spec/video/) events on Analytics.js.

## Supported Events

The plugin tracks the following [Segment Video Spec](/docs/segment/connections/spec/video/) events:

* Video Playback Started
* Video Playback Completed
* Video Playback Paused/Resumed
* Video Content Started/Completed

## Supported Properties

The plugin automatically attaches the following [Segment Video Spec](/docs/segment/connections/spec/video/) properties to the above events:

**'Playback' Events**

* Total Length
* Position
* Video Player
* Sound

**'Content' Events**

* Title
* Description
* Publisher