Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
10 KiB
10 KiB
YouTube Data API
This page contains the setup guide and reference information for the YouTube Data API source connector.
The YouTube Data API v3 provides access to YouTube data, such as videos, playlists, channels, comments, and simple stats. This connector is a simpler version of the YouTube connector. If you need more detailed reports from your channel, use the YouTube Analytics Connector.
Prerequisites
- One or more YouTube Channel IDs you want to sync data from
- (For Airbyte Open Source) One of the following authentication methods:
- A Google API Key with the YouTube Data API v3 enabled
- OAuth 2.0 credentials (Client ID, Client Secret, and Refresh Token)
Setup guide
Find your YouTube Channel IDs
- Go to YouTube and navigate to the channel you want to sync.
- The Channel ID is in the URL:
https://www.youtube.com/channel/CHANNEL_ID. - Alternatively, you can find it in YouTube Studio under Settings > Channel > Advanced settings.
For Airbyte Cloud
- Log into your Airbyte Cloud account.
- Click Sources and then click + New source.
- Select YouTube Data API from the list.
- Enter a name for your source.
- Choose your authentication method:
- For OAuth 2.0: Click Sign in with Google to authenticate your Google account.
- For API Key: Enter your Google API key.
- Enter one or more Channel IDs to sync data from.
- Click Set up source.
For Airbyte Open Source
Create credentials
You can authenticate using either an API Key or OAuth 2.0.
Option A: API Key (simpler setup, public data only)
- Go to the Google Cloud Console.
- Create a new project or select an existing one.
- Navigate to APIs & Services > Library and enable the YouTube Data API v3.
- Go to APIs & Services > Credentials.
- Click Create Credentials > API key.
- Copy the generated API key.
- (Recommended) Click Restrict key to limit the key's usage to the YouTube Data API v3.
Option B: OAuth 2.0 (required for accessing private data)
- Go to the Google Cloud Console.
- Create a new project or select an existing one.
- Navigate to APIs & Services > Library and enable the YouTube Data API v3.
- Go to APIs & Services > Credentials.
- Click Create Credentials > OAuth client ID.
- Configure the OAuth consent screen if prompted.
- Copy the Client ID and Client Secret.
- Use these credentials to obtain a refresh token. Refer to Google's OAuth 2.0 documentation for detailed instructions.
Set up the connector
- In Airbyte, go to Sources and click + New source.
- Select YouTube Data API from the list.
- Enter a name for your source.
- Choose your authentication method and enter the required credentials.
- Enter one or more Channel IDs to sync data from.
- Click Set up source.
Supported sync modes
The YouTube Data API source connector supports the following sync modes:
Supported streams
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
|---|---|---|---|---|
| video | videoId | DefaultPaginator | Yes | No |
| videos | DefaultPaginator | Yes | No | |
| channels | id | DefaultPaginator | Yes | No |
| comments | DefaultPaginator | Yes | No | |
| channel_comments | DefaultPaginator | Yes | No |
Stream descriptions
- video: Detailed information about videos from the specified channels, including title, description, thumbnails, and publish date.
- videos: A list of video IDs from the specified channels.
- channels: Information about the specified YouTube channels, including statistics and content details.
- comments: Comments on videos from the specified channels.
- channel_comments: All comment threads related to the specified channels.
Limitations and considerations
- The YouTube Data API has quota limits. Each API request costs a certain number of quota units, and the default quota is 10,000 units per day.
- API keys can only access public data. To access private data, you must use OAuth 2.0 authentication.
- The connector does not support service account authentication because the YouTube Data API does not support this method.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.0.43 | 2025-12-17 | 70971 | Add acceptance tests |
| 0.0.42 | 2025-11-23 | 69315 | Add OAuth 2.0 support |
| 0.0.41 | 2025-11-25 | 70079 | Update dependencies |
| 0.0.40 | 2025-11-18 | 69532 | Update dependencies |
| 0.0.39 | 2025-10-29 | 68942 | Update dependencies |
| 0.0.38 | 2025-10-21 | 68456 | Update dependencies |
| 0.0.37 | 2025-10-14 | 67987 | Update dependencies |
| 0.0.36 | 2025-10-07 | 67241 | Update dependencies |
| 0.0.35 | 2025-09-30 | 66846 | Update dependencies |
| 0.0.34 | 2025-09-24 | 66475 | Update dependencies |
| 0.0.33 | 2025-09-09 | 65731 | Update dependencies |
| 0.0.32 | 2025-08-24 | 65468 | Update dependencies |
| 0.0.31 | 2025-08-09 | 64863 | Update dependencies |
| 0.0.30 | 2025-08-02 | 64386 | Update dependencies |
| 0.0.29 | 2025-07-26 | 64056 | Update dependencies |
| 0.0.28 | 2025-07-19 | 63640 | Update dependencies |
| 0.0.27 | 2025-07-12 | 63216 | Update dependencies |
| 0.0.26 | 2025-07-05 | 62701 | Update dependencies |
| 0.0.25 | 2025-06-28 | 62233 | Update dependencies |
| 0.0.24 | 2025-06-21 | 61759 | Update dependencies |
| 0.0.23 | 2025-06-15 | 61171 | Update dependencies |
| 0.0.22 | 2025-05-24 | 60786 | Update dependencies |
| 0.0.21 | 2025-05-10 | 59968 | Update dependencies |
| 0.0.20 | 2025-05-04 | 59566 | Update dependencies |
| 0.0.19 | 2025-04-26 | 58930 | Update dependencies |
| 0.0.18 | 2025-04-19 | 58550 | Update dependencies |
| 0.0.17 | 2025-04-13 | 58052 | Update dependencies |
| 0.0.16 | 2025-04-05 | 57379 | Update dependencies |
| 0.0.15 | 2025-03-29 | 56821 | Update dependencies |
| 0.0.14 | 2025-03-22 | 56338 | Update dependencies |
| 0.0.13 | 2025-03-09 | 55664 | Update dependencies |
| 0.0.12 | 2025-03-01 | 55162 | Update dependencies |
| 0.0.11 | 2025-02-23 | 54632 | Update dependencies |
| 0.0.10 | 2025-02-15 | 53087 | Update dependencies |
| 0.0.9 | 2025-01-25 | 52387 | Update dependencies |
| 0.0.8 | 2025-01-18 | 52006 | Update dependencies |
| 0.0.7 | 2025-01-11 | 51380 | Update dependencies |
| 0.0.6 | 2025-01-04 | 50753 | Update dependencies |
| 0.0.5 | 2024-12-21 | 50326 | Update dependencies |
| 0.0.4 | 2024-12-14 | 49756 | Update dependencies |
| 0.0.3 | 2024-12-12 | 49403 | Update dependencies |
| 0.0.2 | 2024-12-11 | 49125 | Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64 |
| 0.0.1 | 2024-11-08 | Initial release by @bala-ceg via Connector Builder |