Skip to content

Commit 43b30a4

Browse files
committed
addressed comments and vale suggestions
1 parent f90eeec commit 43b30a4

File tree

2 files changed

+18
-18
lines changed
  • src/connections/sources/catalog/libraries/website/plugins

2 files changed

+18
-18
lines changed

src/connections/sources/catalog/libraries/website/plugins/vimeo/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@ title: analytics.js Vimeo Plugin
33
hidden: true
44
---
55

6-
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.
77

88
## Getting Started
99
To use the Vimeo plugin:
1010

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

1414
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:
1515

1616
![the plugins setting screen](./images/youtube-vimeo-plugins-beta-2021-06-04.png)
1717

1818
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:
1919

20-
```
20+
```js
2121
<iframe src="https://player.vimeo.com/video/76979871" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
2222
<script src="https://player.vimeo.com/api/player.js"></script>
2323
<script>
@@ -30,17 +30,17 @@ To use the Vimeo plugin:
3030
})
3131
</script>
3232
```
33-
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.
3434

3535
## 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:
3737
- Video Playback Started
3838
- Video Playback Completed
3939
- Video Playback Paused/Resumed
4040
- Video Content Started/Completed
4141

4242
## 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:
4444

4545
**'Playback' Events**
4646
- Total Length

src/connections/sources/catalog/libraries/website/plugins/youtube/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,28 @@ title: analytics.js YouTube Plugin
33
hidden: true
44
---
55

6-
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.
77

88
## Prerequisites
99
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).
1010

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

1313
## Getting Started
1414

1515
After you've generated the API key:
1616

1717
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:
1919

2020
![the plugins setting screen](./images/youtube-vimeo-plugins-beta-2021-06-04.png)
2121

22-
**Note:** At this time, only Javascript sources support plugins.
22+
**Note:** Only Javascript sources support plugins.
2323

2424
2. Initialize the plugin by giving it access to the YouTube video player instance(s) running on your page.
2525
- Use the initialize method in the YouTube `onYouTubeIframeAPIReady()` function to register and initialize the plugin with the player instance and your API key:
2626

27-
```
27+
```js
2828
var player;
2929
function onYouTubeIframeAPIReady() {
3030
player = new YT.Player('player', {
@@ -38,22 +38,22 @@ var player;
3838
})}
3939
```
4040

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

4343
## 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:
4545

4646
Event | Details
4747
----- | -------
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.
5151
Video Playback Buffer Started/Completed | When playback starts and finishes buffering content or an ad.
5252
Video Playback Seek Started/Completed | When a user manually seeks a certain position of the content or ad in the playback.
5353
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.
5454

5555
## 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:
5757

5858
**'Playback' Events**
5959
- Total Length

0 commit comments

Comments
 (0)