Google Youtube Data Catalogue — Snapshot Change
ChangedPrevious snapshot
24 Nov 2025, 12:14 (Berlin)
73b30e0a87e7ba1a539a5bbd93a0fadb…
This snapshot
22 Apr 2026, 11:26 (Berlin)
c690f27d75a4c99c7206683e58791135…
Run Assessment
insignificant hand_verifiedThe initial scrape is the YouTube part of the main Google page, not this sub-catalogue. The baseline page has the other products' text too, so its extra text can't be called new.
+ 570 lines added
− 125 lines removed
52 links added
https://developers.google.com/youtube/v3/getting-started/?target=_blank
This compares the first manual scrape (PDF printouts, 24 Nov 2025) with an automated scrape, so many lines differ only in formatting. In Split view those are dimmed and hidden by default; edited lines show just the changed words highlighted.
Links Changed
Added
Line-by-line changes
695 lines
| − | Google Transparency Center |
| − | |
| − | ### Researcher Engagement |
| − | |
| − | At Google, strong relationships with universities and research institutions are in our DNA. To cultivate these collaborations, we administer a variety of programs that provide resources and support to the academic and external research communities. We provide **data, tools, and publications** to researchers, have **researcher programs** that selected researchers may apply to as well as deliver a number of **outreach** initiatives. |
| − | |
| − | ### Data, tools, and publications |
| − | |
| − | Google makes available a wide variety of data, tools, and publications to researchers studying digital safety and risks online. |
| − | |
| − | #### Google Transparency Report |
| − | |
| − | On the Google Transparency Report website, we share reports and data that shed light on how the policies and actions of governments and corporations affect privacy, security, and access to information. These include government requests to remove content, requests to delist content under European privacy law, content delistings due to copyright and the VLOSE/VLOP Transparency Report under the European Union Digital Services Act (EU DSA). |
| − | |
| − | #### Statement of Reason Data |
| − | |
| − | The EU Digital Services Act obliges providers of hosting services to send clear and specific statements of reasons to any affected recipient when they take certain actions on information that is reported to be illegal or violates the service’s terms and conditions. Google submits such Statements of Reasons to the European Commission as part of the Digital Services Act. These statements include explanations of the impacted accounts, the specific facts and circumstances leading to the provider’s decision, the type of content at issue, the law or policy that was violated, and other relevant information. You can find the submissions provided by Google to the European Commission here. |
| − | |
| − | ### Data Resources |
| − | |
| − | #### YouTube |
| − | |
| − | Available data includes a variety of information about videos, channels, comments, and playlists on the platform. For YouTube videos, data includes details such as a video’s upload date, channel ID, title, description, likes, and view count. For YouTube channels, data includes subscriber counts and total channel views, as well as details about what videos a channel has chosen to feature, such as a channel’s latest uploads, most popular uploads, or videos from one or more playlists. YouTube also provides information about comments on public videos, as well as replies to top-level comments. For playlists, YouTube provides information about resources, such as a video, that are part of a playlist, and details explaining how the resource is used in the playlist. Learn more about our data: YouTube Data API Overview. |
| − | |
| − | ### Other Data, Tools, and Publications for Researchers |
| − | |
| − | #### Google Research Resources |
| − | |
| − | We make tools and datasets available to the broader research community with the goal of building a more collaborative ecosystem. |
| − | |
| − | - Google Trends |
| − | - Dataset Search |
| − | - Data Commons |
| − | - Google Scholar |
| − | |
| − | ### Learn About the Researcher Program |
| − | |
| − | The Researcher Program equips qualified researchers with resources to advance the public’s understanding of certain Google services and their impact. |
| − | |
| − | #### Discover How to Qualify |
| − | |
| − | Qualifying researchers from diverse disciplines can apply to obtain access to data from Google Maps, Google Play, Google Search, Google Shopping and YouTube to study those platforms from a wide range of perspectives and research frameworks. This programme is currently only available for researchers affiliated with an EU-based institution and may be expanded upon in the future. Researchers interested in other data sets and research tools provided by Google should visit Google Research. |
| − | |
| − | #### How the Program Works |
| − | |
| − | 1. Confirm your eligibility with relevant platforms (requires a Google account) |
| − | 2. Submit your application |
| − | 3. If approved, access the tool(s) relevant to your research |
| − | |
| − | ### Review the Eligibility Requirements |
| − | |
| − | Qualifying researchers: |
| − | |
| − | - are affiliated with not for profit bodies, organizations and associations; |
| − | - are independent from commercial interests; |
| − | - disclose in their application the funding of their research; |
| − | - are able to meet specific data security and confidentiality requirements corresponding to each request and to protect personal data; |
| − | - describe in their application the appropriate technical and organizational measures that they have put in place to meet data security and confidentiality requirements; |
| − | - demonstrate in their application that their access to data and the time frames requested are necessary for, and proportionate to, the purposes of their research; |
| − | - demonstrate in their application that the expected results of their research will contribute to the detection, identification and understanding of the impacts of the services in the European Union, and to the assessment of the adequacy, efficiency and impacts of related risk mitigation measures in the European Union. |
| − | |
| − | Note: Individual platform teams may have additional eligibility requirements beyond those listed here. |
| − | |
| − | ### View the Program Policies |
| − | |
| − | We’ve summarized the eligibility requirements and conditions on this page. Be sure to review the Acceptable Use Policy before you apply. To participate in the program, applicants must review and agree to the policies outlined. Selected researchers must agree to the Acceptable Use Policy, along with any general Terms of Service for the platform(s) the researcher is accessing. You are fully responsible for your research and publications. In addition, Google won’t own any IP related to your research, publications or any research outcomes, or recommendations. |
| − | |
| − | ### Other Researcher Programs |
| − | |
| − | #### YouTube Researcher Program |
| − | |
| − | YouTube is equipping eligible academic researchers from around the world with data, tools, and support to advance the public’s understanding of YouTube’s platform and its impact. |
| − | |
| − | #### Google Search Researcher Program |
| − | |
| − | Google Search is providing eligible academic researchers programmatic access to the search results page to help the public better understand how Google responds to search queries. |
| − | |
| − | ### Outreach |
| − | |
| − | We administer a variety of outreach programs that provide support to the academic and external research communities. |
| − | |
| − | #### Trust and Safety Research Awards |
| − | |
| − | Google is committed to supporting innovative research and professors working to create positive societal impact with technology, particularly in areas relevant to Trust and Safety. Google is looking to fund and actively collaborate with the academic research community, exploring opportunities to expand our knowledge of Trust and Safety concerns. In addition, we have other awards that aren’t solely focused on Trust and Safety, where we often fund researchers in these programs working in trust and safety, privacy, and security. |
| − | |
| − | #### Events |
| − | |
| − | We have Google teams working across privacy, security, content responsibility, and family safety around the world. Our Google Safety Engineering Centers in Munich, Dublin, and Malaga help guide this Internet safety work, led by experienced teams of engineers, policy specialists and subject matter experts. Through our network of centers, we collaborate and share this work with researchers, policymakers and regulators. Part of this work includes holding regular events for these audiences on topics such as Security and Child Safety. Specifically for researchers, we also organize events focused on having our researchers collaborate with the academic community, like our workshop on At-Risk Users and our AI Research Day in France, which focused entirely on AI Privacy, Safety and Security research. |
| − | |
| − | --- |
| − | |
| − | #### DSA Article 40(4) Data Resources -- Platform navigation |
| − | - YouTube |
| − | - Google Search |
| − | - Google Maps |
| − | - Google Play |
| − | - Google Shopping |
| − | - DSA Access Modality & Terms |
| − | - DSA Researcher Point of Contact |
| − | - DSA 40(4) Data Access Portal |
| − | |
| − | #### Google Research Resources navigation |
| − | - Google Research Resources |
| − | - Google Trends |
| − | - Dataset Search |
| − | - Data Commons |
| − | |
| − | --- |
| − | |
| − | #### Transparency Resources |
| − | - Ads Transparency Center |
| − | - Transparency Report |
| − | |
| − | #### About our products |
| − | - How Search Works |
| − | - How YouTube Works |
| − | - Help Center |
| − | |
| − | #### Responsibility |
| − | - Public Policy |
| − | - Protecting Children |
| − | - Safety Center |
| − | - Responsible AI |
| − | |
| − | Follow us | About Google | Google products | Privacy | Terms | Help |
| + | [Skip to main content](https://developers.google.com/youtube/v3/getting-started/?target=_blank#main-content) |
| + | |
| + | - [YouTube](https://developers.google.com/youtube) |
| + | - [Data API](https://developers.google.com/youtube/v3) |
| + | |
| + | `/` |
| + | |
| + | - English |
| + | - Deutsch |
| + | - Español |
| + | - Español – América Latina |
| + | - Français |
| + | - Indonesia |
| + | - Italiano |
| + | - Polski |
| + | - Português – Brasil |
| + | - Tiếng Việt |
| + | - Türkçe |
| + | - Русский |
| + | - עברית |
| + | - العربيّة |
| + | - فارسی |
| + | - हिंदी |
| + | - বাংলা |
| + | - ภาษาไทย |
| + | - 中文 – 简体 |
| + | - 中文 – 繁體 |
| + | - 日本語 |
| + | - 한국어 |
| + | Sign in |
| + | |
| + | [Home](https://developers.google.com/youtube/v3) |
| + | [Guides](https://developers.google.com/youtube/v3/getting-started) |
| + | [Reference](https://developers.google.com/youtube/v3/docs) |
| + | [Samples](https://developers.google.com/youtube/v3/code_samples) |
| + | [Support](https://developers.google.com/youtube/v3/support) |
| + | |
| + | - [YouTube](https://developers.google.com/youtube) |
| + | - [Data API](https://developers.google.com/youtube/v3) |
| + | |
| + | - [Home](https://developers.google.com/youtube/v3) |
| + | - [Guides](https://developers.google.com/youtube/v3/getting-started) |
| + | - [Reference](https://developers.google.com/youtube/v3/docs) |
| + | - [Samples](https://developers.google.com/youtube/v3/code_samples) |
| + | - [Support](https://developers.google.com/youtube/v3/support) |
| + | |
| + | - [Overview](https://developers.google.com/youtube/v3/getting-started) |
| + | - [Client Libraries](https://developers.google.com/youtube/v3/libraries) |
| + | - Authorize Requests |
| + | |
| + | - [Overview](https://developers.google.com/youtube/v3/guides/authentication) |
| + | - [Get Auth Credentials](https://developers.google.com/youtube/registering_an_application) |
| + | - [Server-side Web Apps](https://developers.google.com/youtube/v3/guides/auth/server-side-web-apps) |
| + | - [Client-side Web Apps](https://developers.google.com/youtube/v3/guides/auth/client-side-web-apps) |
| + | - [Installed Apps](https://developers.google.com/youtube/v3/guides/auth/installed-apps) |
| + | - [Devices](https://developers.google.com/youtube/v3/guides/auth/devices) |
| + | - Quickstarts |
| + | |
| + | - [Android](https://developers.google.com/youtube/v3/quickstart/android) |
| + | - [Apps Script](https://developers.google.com/youtube/v3/quickstart/apps-script) |
| + | - [Go](https://developers.google.com/youtube/v3/quickstart/go) |
| + | - [iOS](https://developers.google.com/youtube/v3/quickstart/ios) |
| + | - [Java](https://developers.google.com/youtube/v3/quickstart/java) |
| + | - [JavaScript](https://developers.google.com/youtube/v3/quickstart/js) |
| + | - [Node.js](https://developers.google.com/youtube/v3/quickstart/nodejs) |
| + | - [PHP](https://developers.google.com/youtube/v3/quickstart/php) |
| + | - [Python](https://developers.google.com/youtube/v3/quickstart/python) |
| + | - [Ruby](https://developers.google.com/youtube/v3/quickstart/ruby) |
| + | - Guides and Tutorials |
| + | |
| + | - [Quota costs for API requests](https://developers.google.com/youtube/v3/determine_quota_cost) |
| + | - [Quota and Compliance Audits](https://developers.google.com/youtube/v3/guides/quota_and_compliance_audits) |
| + | - [Upload a Video](https://developers.google.com/youtube/v3/guides/uploading_a_video) |
| + | - [Send Resumable Uploads](https://developers.google.com/youtube/v3/guides/using_resumable_upload_protocol) |
| + | - [Find MadeForKids video status](https://developers.google.com/youtube/v3/guides/made_for_kids_status) |
| + | - [Subscribe to Push Notifications](https://developers.google.com/youtube/v3/guides/push_notifications) |
| + | - [Work with Channel IDs](https://developers.google.com/youtube/v3/guides/working_with_channel_ids) |
| + | - [Move from ClientLogin to OAuth](https://developers.google.com/youtube/v3/guides/moving_to_oauth) |
| + | - [Sample Requests](https://developers.google.com/youtube/v3/sample_requests) |
| + | - Implementation Guide |
| + | |
| + | - [Overview](https://developers.google.com/youtube/v3/guides/implementation) |
| + | - [Activities](https://developers.google.com/youtube/v3/guides/implementation/activities) |
| + | - [Captions](https://developers.google.com/youtube/v3/guides/implementation/captions) |
| + | - [Channels](https://developers.google.com/youtube/v3/guides/implementation/channels) |
| + | - [Comments](https://developers.google.com/youtube/v3/guides/implementation/comments) |
| + | - [Pagination](https://developers.google.com/youtube/v3/guides/implementation/pagination) |
| + | - [Partial responses](https://developers.google.com/youtube/v3/guides/implementation/partial) |
| + | - [Playlists](https://developers.google.com/youtube/v3/guides/implementation/playlists) |
| + | - [Ratings](https://developers.google.com/youtube/v3/guides/implementation/ratings) |
| + | - [Search requests](https://developers.google.com/youtube/v3/guides/implementation/search) |
| + | - [Subscriptions](https://developers.google.com/youtube/v3/guides/implementation/subscriptions) |
| + | - [Videos](https://developers.google.com/youtube/v3/guides/implementation/videos) |
| + | - Tools |
| + | |
| + | - [APIs Explorer](https://developers.google.com/apis-explorer/#p/youtube/v3/) |
| + | |
| + | - [Home](https://developers.google.com/) |
| + | - [Products](https://developers.google.com/products) |
| + | - [YouTube](https://developers.google.com/youtube) |
| + | - [Data API](https://developers.google.com/youtube/v3) |
| + | - [Guides](https://developers.google.com/youtube/v3/getting-started) |
| + | |
| + | # YouTube Data API Overview Stay organized with collections Save and categorize content based on your preferences. |
| + | |
| + | ## Page Summary |
| + | |
| + | outlined\_flag |
| + | |
| + | - The YouTube Data API v3 requires a Google Account, a project in the Google Developers Console, and enablement of the API, with OAuth 2.0 for user authorization, and the option to use a client library. |
| + | - The API provides access to various resource types such as activities, channels, playlists, videos, and others, with supported operations including listing, inserting, updating, and deleting, depending on the resource. |
| + | - The API employs a quota system with default limits, different costs for different operations, and a monitoring system, allowing for extensions by requesting them. |
| + | - The `part` parameter is mandatory for retrieving resources and specifies which properties to include, while the `fields` parameter further filters the response, reducing data transfer by omitting unnecessary nested properties. |
| + | - Performance optimizations include the use of ETags for caching and overwrite protection, and gzip compression to reduce bandwidth usage. |
| + | |
| + | ## Introduction |
| + | |
| + | This document is intended for developers who want to write applications that interact with YouTube. It explains basic concepts of YouTube and of the API itself. It also provides an overview of the different functions that the API supports. |
| + | |
| + | ### Before you start |
| + | |
| + | 1. You need a [Google Account](https://www.google.com/accounts/NewAccount) to access the Google API Console, request an API key, and register your application. |
| + | 2. Create a project in the [Google Developers Console](https://console.developers.google.com) and [obtain authorization credentials](https://developers.google.com/youtube/registering_an_application) so your application can submit API requests. |
| + | 3. After creating your project, make sure the YouTube Data API is one of the services that your application is registered to use: |
| + | |
| + | 1. Go to the [API Console](https://console.cloud.google.com/) and select the project that you just registered. |
| + | 2. Visit the [Enabled APIs page](https://console.cloud.google.com/apis/enabled). |
| + | In the list of APIs, make sure the status is **ON** for the **YouTube Data API v3**. |
| + | 4. If your application will use any API methods that require user authorization, read the [authentication](https://developers.google.com/youtube/v3/guides/authentication) guide to learn how to implement OAuth 2.0 authorization. |
| + | 5. Select a [client library](https://developers.google.com/youtube/v3/libraries) to simplify your API implementation. |
| + | 6. Familiarize yourself with the core concepts of the JSON (JavaScript Object Notation) data format. JSON is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see [json.org](http://json.org). |
| + | |
| + | ## Resources and resource types |
| + | |
| + | A resource is an individual data entity with a unique identifier. The table below describes the different types of resources that you can interact with using the API. |
| + | |
| + | | Resources | | |
| + | | --- | --- | |
| + | | `activity` | Contains information about an action that a particular user has taken on the YouTube site. User actions that are reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, and posting a channel bulletin, among others. | |
| + | | `channel` | Contains information about a single YouTube channel. | |
| + | | `channelBanner` | Identifies the URL to use to set a newly uploaded image as the banner image for a channel. | |
| + | | `channelSection` | Contains information about a set of videos that a channel has chosen to feature. For example, a section could feature a channel's latest uploads, most popular uploads, or videos from one or more playlists. | |
| + | | `guideCategory` | Identifies a category that YouTube associates with channels based on their content or other indicators, such as popularity. Guide categories seek to organize channels in a way that makes it easier for YouTube users to find the content they're looking for. While channels could be associated with one or more guide categories, they are not guaranteed to be in any guide categories. | |
| + | | `i18nLanguage` | Identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language. | |
| + | | `i18nRegion` | Identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale. | |
| + | | `playlist` | Represents a single YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. | |
| + | | `playlistItem` | Identifies a resource, such as a video, that is part of a playlist. The playlistItem resource also contains details that explain how the included resource is used in the playlist. | |
| + | | `search result` | Contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data. | |
| + | | `subscription` | Contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video. | |
| + | | `thumbnail` | Identifies thumbnail images associated with a resource. | |
| + | | `video` | Represents a single YouTube video. | |
| + | | `videoCategory` | Identifies a category that has been or could be associated with uploaded videos. | |
| + | | `watermark` | Identifies an image that displays during playbacks of a specified channel's videos. The channel owner can also specify a target channel to which the image links as well as timing details that determine when the watermark appears during video playbacks and the length of time it is visible. | |
| + | |
| + | Note that, in many cases, a resource contains references to other resources. For example, a `playlistItem` resource's `snippet.resourceId.videoId` property identifies a video resource that, in turn, contains complete information about the video. As another example, a search result contains either a `videoId`, `playlistId`, or `channelId` property that identifies a particular video, playlist, or channel resource. |
| + | |
| + | ### Supported operations |
| + | |
| + | The following table shows the most common methods that the API supports. Some resources also support other methods that perform functions more specific to those resources. For example, the `videos.rate` method associates a user rating with a video, and the `thumbnails.set` method uploads a video thumbnail image to YouTube and associates it with a video. |
| + | |
| + | | Operations | | |
| + | | --- | --- | |
| + | | `list` | Retrieves (`GET`) a list of zero or more resources. | |
| + | | `insert` | Creates (`POST`) a new resource. | |
| + | | `update` | Modifies (`PUT`) an existing resource to reflect data in your request. | |
| + | | `delete` | Removes (`DELETE`) a specific resource. | |
| + | |
| + | The API currently supports methods to list each of the supported resource types, and it supports write operations for many resources as well. |
| + | |
| + | The table below identifies the operations that are supported for different types of resources. Operations that insert, update, or delete resources always require [user authorization](https://developers.google.com/youtube/v3/guides/authentication). In some cases, `list` methods support both authorized and unauthorized requests, where unauthorized requests only retrieve public data while authorized requests can also retrieve information about or private to the currently authenticated user. |
| + | |
| + | | Supported Operations | | | | | |
| + | | --- | --- | --- | --- | --- | |
| + | | | **list** | **insert** | **update** | **delete** | |
| + | | `activity` | | | | | |
| + | | `caption` | | | | | |
| + | | `channel` | | | | | |
| + | | `channelBanner` | | | | | |
| + | | `channelSection` | | | | | |
| + | | `comment` | | | | | |
| + | | `commentThread` | | | | | |
| + | | `guideCategory` | | | | | |
| + | | `i18nLanguage` | | | | | |
| + | | `i18nRegion` | | | | | |
| + | | `playlist` | | | | | |
| + | | `playlistItem` | | | | | |
| + | | `search result` | | | | | |
| + | | `subscription` | | | | | |
| + | | `thumbnail` | | | | | |
| + | | `video` | | | | | |
| + | | `videoCategory` | | | | | |
| + | | `watermark` | | | | | |
| + | |
| + | ## Quota usage |
| + | |
| + | The YouTube Data API uses a quota to ensure that developers use the service as intended and do not create applications that unfairly reduce service quality or limit access for others. All API requests, including invalid requests, incur at least a one-point quota cost. You can find the quota available to your application in the [API Console](https://console.cloud.google.com/). |
| + | |
| + | Projects that enable the YouTube Data API have a default quota allocation of 10,000 units per day, an amount sufficient for the overwhelming majority of our API users. Default quota, which is subject to change, helps us optimize quota allocations and scale our infrastructure in a way that is more meaningful to our API users. You can see your quota usage on the [Quotas](https://console.developers.google.com/iam-admin/quotas) page in the API Console. |
| + | |
| + | **Note:** If you reach the quota limit, you can request additional quota by |
| + | completing the [Quota extension |
| + | request form](https://support.google.com/youtube/contact/yt_api_form) for YouTube API Services. |
| + | |
| + | ### Calculating quota usage |
| + | |
| + | Google calculates your quota usage by assigning a cost to each request. Different types of |
| + | operations have different quota costs. For example: |
| + | |
| + | - A read operation that retrieves a list of resources -- channels, videos, playlists -- usually |
| + | costs 1 unit. |
| + | - A write operation that creates, updates, or deletes a resource usually costs |
| + | `50` units. |
| + | - A search request costs `100` units. |
| + | - A video upload costs `100` units. |
| + | |
| + | The [Quota costs for API requests](https://developers.google.com/youtube/v3/determine_quota_cost) table shows the |
| + | quota cost of each API method. With these rules in mind, you can estimate the number of requests |
| + | that your application could send per day without exceeding your quota. |
| + | |
| + | ## Partial resources |
| + | |
| + | The API allows, and actually requires, the retrieval of partial resources so that applications avoid transferring, parsing, and storing unneeded data. This approach also ensures that the API uses network, CPU, and memory resources more efficiently. |
| + | |
| + | The API supports two request parameters, which are explained in the following sections, that enable you to identify the resource properties that should be included in API responses. |
| + | |
| + | - The `part` parameter identifies groups of properties that should be returned for a resource. |
| + | - The `fields` parameter filters the API response to only return specific properties within the requested resource parts. |
| + | |
| + | ### How to use the `part` parameter |
| + | |
| + | The `part` parameter is a required parameter for any API request that retrieves or returns a resource. The parameter identifies one or more top-level (non-nested) resource properties that should be included in an API response. For example, a `video` resource has the following parts: |
| + | |
| + | - `snippet` |
| + | - `contentDetails` |
| + | - `fileDetails` |
| + | - `player` |
| + | - `processingDetails` |
| + | - `recordingDetails` |
| + | - `statistics` |
| + | - `status` |
| + | - `suggestions` |
| + | - `topicDetails` |
| + | |
| + | All of these parts are objects that contain nested properties, and you can think of these objects as groups of metadata fields that the API server might (or might not) retrieve. As such, the `part` parameter requires you to select the resource components that your application actually uses. This requirement serves two key purposes: |
| + | |
| + | - It reduces latency by preventing the API server from spending time retrieving metadata fields that your application doesn't use. |
| + | - It reduces bandwidth usage by reducing (or eliminating) the amount of unnecessary data that your application might retrieve. |
| + | |
| + | Over time, as resources add more parts, these benefits will only increase since your application will not be requesting newly introduced properties that it doesn't support. |
| + | |
| + | ### How to use the `fields` parameter |
| + | |
| + | The `fields` parameter filters the API response, which only contains the resource parts identified in the `part` parameter value, so that the response only includes a specific set of fields. The `fields` parameter lets you remove nested properties from an API response and thereby further reduce your bandwidth usage. (The `part` parameter cannot be used to filter nested properties from a response.) |
| + | |
| + | The following rules explain the supported syntax for the `fields` parameter value, which is loosely based on XPath syntax: |
| + | |
| + | - Use a comma-separated list (`fields=a,b`) to select multiple fields. |
| + | - Use an asterisk (`fields=*`) as a wildcard to identify all fields. |
| + | - Use parentheses (`fields=a(b,c)`) to specify a group of nested properties that will be included in the API response. |
| + | - Use a forward slash (`fields=a/b`) to identify a nested property. |
| + | |
| + | In practice, these rules often allow several different `fields` parameter values to retrieve the same API response. For example, if you want to retrieve the playlist item ID, title, and position for every item in a playlist, you could use any of the following values: |
| + | |
| + | - `fields=items/id,playlistItems/snippet/title,playlistItems/snippet/position` |
| + | - `fields=items(id,snippet/title,snippet/position)` |
| + | - `fields=items(id,snippet(title,position))` |
| + | |
| + | **Note:** As with all query parameter values, the `fields` parameter value must be URL encoded. For better readability, the examples in this document omit the encoding. |
| + | |
| + | ### Sample partial requests |
| + | |
| + | The examples below demonstrate how you can use the `part` and `fields` parameters to ensure that API responses only include the data that your application uses: |
| + | |
| + | 1. Example 1 returns a video resource that includes four parts as well as `kind` and `etag` properties. |
| + | 2. Example 2 returns a video resource that includes two parts as well as `kind` and `etag` properties. |
| + | 3. Example 3 returns a video resource that includes two parts but excludes `kind` and `etag` properties. |
| + | 4. Example 4 returns a video resource that includes two parts but excludes `kind` and `etag` as well as some nested properties in the resource's `snippet` object. |
| + | |
| + | Example 1 |
| + | |
| + | ``` |
| + | URL: https://www.googleapis.com/youtube/v3/videos?id=7lCDEYXw3mM&key=YOUR_API_KEY |
| + | &part=snippet,contentDetails,statistics,status |
| + | |
| + | Description: This example retrieves a video resource and identifies several |
| + | resource parts that should be included in the API response. |
| + | |
| + | API response: |
| + | |
| + | { |
| + | "kind": "youtube#videoListResponse", |
| + | "etag": "\"UCBpFjp2h75_b92t44sqraUcyu0/sDAlsG9NGKfr6v5AlPZKSEZdtqA\"", |
| + | "videos": [ |
| + | { |
| + | "id": "7lCDEYXw3mM", |
| + | "kind": "youtube#video", |
| + | "etag": "\"UCBpFjp2h75_b92t44sqraUcyu0/iYynQR8AtacsFUwWmrVaw4Smb_Q\"", |
| + | "snippet": { |
| + | "publishedAt": "2012-06-20T22:45:24.000Z", |
| + | "channelId": "UC_x5XG1OV2P6uZZ5FSM9Ttw", |
| + | "title": "Google I/O 101: Q&A On Using Google APIs", |
| + | "description": "Antonio Fuentes speaks to us and takes questions on working with Google APIs and OAuth 2.0.", |
| + | "thumbnails": { |
| + | "default": { |
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/default.jpg" |
| + | }, |
| + | "medium": { |
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/mqdefault.jpg" |
| + | }, |
| + | "high": { |
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/hqdefault.jpg" |
| + | } |
| + | }, |
| + | "categoryId": "28" |
| + | }, |
| + | "contentDetails": { |
| + | "duration": "PT15M51S", |
| + | "aspectRatio": "RATIO_16_9" |
| + | }, |
| + | "statistics": { |
| + | "viewCount": "3057", |
| + | "likeCount": "25", |
| + | "dislikeCount": "0", |
| + | "favoriteCount": "17", |
| + | "commentCount": "12" |
| + | }, |
| + | "status": { |
| + | "uploadStatus": "STATUS_PROCESSED", |
| + | "privacyStatus": "PRIVACY_PUBLIC" |
| + | } |
| + | } |
| + | ] |
| + | } |
| + | ``` |
| + | |
| + | Example 2 |
| + | |
| + | ``` |
| + | URL: https://www.googleapis.com/youtube/v3/videos?id=7lCDEYXw3mM&key=YOUR_API_KEY |
| + | &part=snippet,statistics |
| + | |
| + | Description: This example modifies the part parameter value so that the |
| + | contentDetails and status properties are not included |
| + | in the response. |
| + | |
| + | API response: |
| + | |
| + | { |
| + | "kind": "youtube#videoListResponse", |
| + | "etag": "\"UCBpFjp2h75_b92t44sqraUcyu0/sDAlsG9NGKfr6v5AlPZKSEZdtqA\"", |
| + | "videos": [ |
| + | { |
| + | "id": "7lCDEYXw3mM", |
| + | "kind": "youtube#video", |
| + | "etag": "\"UCBpFjp2h75_b92t44sqraUcyu0/iYynQR8AtacsFUwWmrVaw4Smb_Q\"", |
| + | "snippet": { |
| + | "publishedAt": "2012-06-20T22:45:24.000Z", |
| + | "channelId": "UC_x5XG1OV2P6uZZ5FSM9Ttw", |
| + | "title": "Google I/O 101: Q&A On Using Google APIs", |
| + | "description": "Antonio Fuentes speaks to us and takes questions on working with Google APIs and OAuth 2.0.", |
| + | "thumbnails": { |
| + | "default": { |
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/default.jpg" |
| + | }, |
| + | "medium": { |
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/mqdefault.jpg" |
| + | }, |
| + | "high": { |
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/hqdefault.jpg" |
| + | } |
| + | }, |
| + | "categoryId": "28" |
| + | }, |
| + | "statistics": { |
| + | "viewCount": "3057", |
| + | "likeCount": "25", |
| + | "dislikeCount": "0", |
| + | "favoriteCount": "17", |
| + | "commentCount": "12" |
| + | } |
| + | } |
| + | ] |
| + | } |
| + | ``` |
| + | |
| + | Example 3 |
| + | |
| + | ``` |
| + | URL: https://www.googleapis.com/youtube/v3/videos?id=7lCDEYXw3mM&key=YOUR_API_KEY |
| + | &part=snippet,statistics&fields=items(id,snippet,statistics) |
| + | |
| + | Description: This example adds the fields parameter to remove all |
| + | kind and etag properties from the API response. |
| + | |
| + | API response: |
| + | |
| + | { |
| + | "videos": [ |
| + | { |
| + | "id": "7lCDEYXw3mM", |
| + | "snippet": { |
| + | "publishedAt": "2012-06-20T22:45:24.000Z", |
| + | "channelId": "UC_x5XG1OV2P6uZZ5FSM9Ttw", |
| + | "title": "Google I/O 101: Q&A On Using Google APIs", |
| + | "description": "Antonio Fuentes speaks to us and takes questions on working with Google APIs and OAuth 2.0.", |
| + | "thumbnails": { |
| + | "default": { |
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/default.jpg" |
| + | }, |
| + | "medium": { |
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/mqdefault.jpg" |
| + | }, |
| + | "high": { |
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/hqdefault.jpg" |
| + | } |
| + | }, |
| + | "categoryId": "28" |
| + | }, |
| + | "statistics": { |
| + | "viewCount": "3057", |
| + | "likeCount": "25", |
| + | "dislikeCount": "0", |
| + | "favoriteCount": "17", |
| + | "commentCount": "12" |
| + | } |
| + | } |
| + | ] |
| + | } |
| + | ``` |
| + | |
| + | Example 4 |
| + | |
| + | ``` |
| + | URL: https://www.googleapis.com/youtube/v3/videos?id=7lCDEYXw3mM&key=YOUR_API_KEY |
| + | &fields=items(id,snippet(channelId,title,categoryId),statistics)&part=snippet,statistics |
| + | |
| + | Description: This example modifies the fields parameter from example 3 |
| + | so that in the API response, each video resource's snippet |
| + | object only includes the channelId, title, |
| + | and categoryId properties. |
| + | |
| + | API response: |
| + | |
| + | { |
| + | "videos": [ |
| + | { |
| + | "id": "7lCDEYXw3mM", |
| + | "snippet": { |
| + | "channelId": "UC_x5XG1OV2P6uZZ5FSM9Ttw", |
| + | "title": "Google I/O 101: Q&A On Using Google APIs", |
| + | "categoryId": "28" |
| + | }, |
| + | "statistics": { |
| + | "viewCount": "3057", |
| + | "likeCount": "25", |
| + | "dislikeCount": "0", |
| + | "favoriteCount": "17", |
| + | "commentCount": "12" |
| + | } |
| + | } |
| + | ] |
| + | } |
| + | ``` |
| + | |
| + | ## Optimizing performance |
| + | |
| + | ### Using ETags |
| + | |
| + | ETags, a standard part of the [HTTP protocol](https://www.rfc-editor.org/rfc/rfc9110.html#name-etag), allow applications to refer to a specific version of a particular API resource. The resource could be an entire feed or an item in that feed. This functionality supports the following use cases: |
| + | |
| + | - **Caching and conditional retrieval** – Your application can cache API resources and their ETags. Then, when your application requests a stored resource again, it specifies the ETag associated with that resource. If the resource has changed, the API returns the modified resource and the ETag associated with that version of the resource. If the resource has not changed, the API returns an HTTP 304 response (`Not Modified`), which indicates that the resource has not changed. Your application can reduce latency and bandwidth usage by serving cached resources in this manner. |
| + | |
| + | The client libraries for Google APIs differ in their support of ETags. For example, the JavaScript client library supports ETags via a whitelist for allowed request headers that includes `If-Match` and `If-None-Match`. The whitelist allows normal browser caching to occur so that if a resource's ETag has not changed, the resource can be served from the browser cache. The Obj-C client, on the other hand, does not support ETags. |
| + | - **Protecting against inadvertent overwrites of changes** – ETags help to ensure that multiple API clients don't inadvertently overwrite each other's changes. When updating or deleting a resource, your application can specify the resource's ETag. If the ETag doesn't match the most recent version of that resource, then the API request fails. |
| + | |
| + | Using ETags in your application provides several benefits: |
| + | |
| + | - The API responds more quickly to requests for cached but unchanged resources, yielding lower latency and lower bandwidth usage. |
| + | - Your application will not inadvertently overwrite changes to a resource that were made from another API client. |
| + | |
| + | The [Google APIs Client Library for JavaScript](https://developers.google.com/api-client-library/javascript/start/start-js) supports `If-Match` and `If-None-Match` HTTP request headers, thereby enabling ETags to work within the context of normal browser caching. |
| + | |
| + | ### Using gzip |
| + | |
| + | You can also reduce the bandwidth needed for each API response by enabling gzip compression. While your application will need additional CPU time to uncompress API responses, the benefit of consuming fewer network resources usually outweighs that cost. |
| + | |
| + | To receive a gzip-encoded response you must do two things: |
| + | |
| + | - Set the `Accept-Encoding` HTTP request header to `gzip`. |
| + | - Modify your user agent to contain the string `gzip`. |
| + | |
| + | The sample HTTP headers below demonstrate these requirements for enabling gzip compression: |
| + | |
| + | ``` |
| + | Accept-Encoding: gzip |
| + | User-Agent: my program (gzip) |
| + | ``` |
| + | |
| + | Except as otherwise noted, the content of this page is licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/), and code samples are licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). For details, see the [Google Developers Site Policies](https://developers.google.com/site-policies). Java is a registered trademark of Oracle and/or its affiliates. |
| + | |
| + | Last updated 2026-03-13 UTC. |
| + | |
| + | [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-13 UTC."],[],["To utilize the YouTube Data API, you need a Google account, a project in the Google Developers Console with the API enabled, and potentially OAuth 2.0 authorization. Key actions include using `list`, `insert`, `update`, and `delete` operations on resources like `videos`, `channels`, and `playlists`. API usage is governed by quotas, with each operation incurring a cost; reading operations usually costs 1 unit, while writing or searching costs much more. Use the `part` and `fields` parameters to optimize requests, and utilize ETags and gzip compression to improve efficiency.\n"]] |
| + | |
| + | - [Blog](https://blog.youtube) |
| + | |
| + | The latest news on the YouTube blog |
| + | - [GitHub](https://github.com/youtube/api-samples) |
| + | |
| + | Find API code samples and other YouTube open-source projects. |
| + | - [Issue Tracker](https://issuetracker.google.com/issues/new?component=186600&template=874803) |
| + | |
| + | Something wrong? Send us a bug report! |
| + | - [Stack Overflow](http://stackoverflow.com/questions/ask?tags=youtube-api) |
| + | |
| + | Ask a question under the youtube-api tag |
| + | - [Videos](https://www.youtube.com/user/YouTubeDev) |
| + | |
| + | Check out the YouTube Developer Relations team's YouTube channel |
| + | |
| + | - ### Tools |
| + | |
| + | - [Google APIs Explorer](https://developers.google.com/apis-explorer/#p/) |
| + | - [YouTube Player Demo](https://developers.google.com/youtube/youtube_player_demo) |
| + | - [Configure a Subscribe Button](https://developers.google.com/youtube/youtube_subscribe_button) |
| + | - ### Issue Tracker |
| + | |
| + | - [File a bug](https://issuetracker.google.com/issues/new?component=186600&template=874803) |
| + | - [Request a feature](https://issuetracker.google.com/issues/new?component=186600&template=874803) |
| + | - [See open issues](https://issuetracker.google.com/issues?q=componentid:186600) |
| + | - ### Product Info |
| + | |
| + | - [Terms of Service](https://developers.google.com/youtube/terms) |
| + | - [Branding Guidelines](https://developers.google.com/youtube/branding_guidelines) |
| + | - [Monetization Guidelines](https://developers.google.com/youtube/creating_monetizable_applications) |
| + | - [APIs subject to Deprecation Policy](https://developers.google.com/youtube/youtube-api-list) |
| + | |
| + | - [Android](https://developer.android.com) |
| + | - [Chrome](https://developer.chrome.com/home) |
| + | - [Firebase](https://firebase.google.com) |
| + | - [Google Cloud Platform](https://cloud.google.com) |
| + | - [Google AI](https://ai.google.dev/) |
| + | - [All products](https://developers.google.com/products) |
| + | |
| + | - [Terms](https://developers.google.com/terms/site-terms) |
| + | - [Privacy](https://policies.google.com/privacy) |
| + | - [Manage cookies](https://developers.google.com/youtube/v3/getting-started/?target=_blank#) |
| + | |
| + | - English |
| + | - Deutsch |
| + | - Español |
| + | - Español – América Latina |
| + | - Français |
| + | - Indonesia |
| + | - Italiano |
| + | - Polski |
| + | - Português – Brasil |
| + | - Tiếng Việt |
| + | - Türkçe |
| + | - Русский |
| + | - עברית |
| + | - العربيّة |
| + | - فارسی |
| + | - हिंदी |
| + | - বাংলা |
| + | - ภาษาไทย |
| + | - 中文 – 简体 |
| + | - 中文 – 繁體 |
| + | - 日本語 |
| + | - 한국어 |
| Previous · 24 Nov 2025, 12:14 (Berlin) | Current · 22 Apr 2026, 11:26 (Berlin) | |||
|---|---|---|---|---|
| − | Google Transparency Center | + | [Skip to main content](https://developers.google.com/youtube/v3/getting-started/?target=_blank#main-content) | |
| − | ### Researcher Engagement | + | - [YouTube](https://developers.google.com/youtube) | |
| + | - [Data API](https://developers.google.com/youtube/v3) | |||
| − | At Google, strong relationships with universities and research institutions are in our DNA. To cultivate these collaborations, we administer a variety of programs that provide resources and support to the academic and external research communities. We provide **data, tools, and publications** to researchers, have **researcher programs** that selected researchers may apply to as well as deliver a number of **outreach** initiatives. | + | `/` | |
| − | ### Data, tools, and publications | + | - English | |
| + | - Deutsch | |||
| + | - Español | |||
| + | - Español – América Latina | |||
| + | - Français | |||
| + | - Indonesia | |||
| + | - Italiano | |||
| + | - Polski | |||
| + | - Português – Brasil | |||
| + | - Tiếng Việt | |||
| + | - Türkçe | |||
| + | - Русский | |||
| + | - עברית | |||
| + | - العربيّة | |||
| + | - فارسی | |||
| + | - हिंदी | |||
| + | - বাংলা | |||
| + | - ภาษาไทย | |||
| + | - 中文 – 简体 | |||
| + | - 中文 – 繁體 | |||
| + | - 日本語 | |||
| + | - 한국어 | |||
| + | Sign in | |||
| − | Google makes available a wide variety of data, tools, and publications to researchers studying digital safety and risks online. | + | [Home](https://developers.google.com/youtube/v3) | |
| + | [Guides](https://developers.google.com/youtube/v3/getting-started) | |||
| + | [Reference](https://developers.google.com/youtube/v3/docs) | |||
| + | [Samples](https://developers.google.com/youtube/v3/code_samples) | |||
| + | [Support](https://developers.google.com/youtube/v3/support) | |||
| − | #### Google Transparency Report | + | - [YouTube](https://developers.google.com/youtube) | |
| + | - [Data API](https://developers.google.com/youtube/v3) | |||
| − | On the Google Transparency Report website, we share reports and data that shed light on how the policies and actions of governments and corporations affect privacy, security, and access to information. These include government requests to remove content, requests to delist content under European privacy law, content delistings due to copyright and the VLOSE/VLOP Transparency Report under the European Union Digital Services Act (EU DSA). | + | - [Home](https://developers.google.com/youtube/v3) | |
| + | - [Guides](https://developers.google.com/youtube/v3/getting-started) | |||
| + | - [Reference](https://developers.google.com/youtube/v3/docs) | |||
| + | - [Samples](https://developers.google.com/youtube/v3/code_samples) | |||
| + | - [Support](https://developers.google.com/youtube/v3/support) | |||
| − | #### Statement of Reason Data | + | - [Overview](https://developers.google.com/youtube/v3/getting-started) | |
| + | - [Client Libraries](https://developers.google.com/youtube/v3/libraries) | |||
| + | - Authorize Requests | |||
| − | The EU Digital Services Act obliges providers of hosting services to send clear and specific statements of reasons to any affected recipient when they take certain actions on information that is reported to be illegal or violates the service’s terms and conditions. Google submits such Statements of Reasons to the European Commission as part of the Digital Services Act. These statements include explanations of the impacted accounts, the specific facts and circumstances leading to the provider’s decision, the type of content at issue, the law or policy that was violated, and other relevant information. You can find the submissions provided by Google to the European Commission here. | + | - [Overview](https://developers.google.com/youtube/v3/guides/authentication) | |
| + | - [Get Auth Credentials](https://developers.google.com/youtube/registering_an_application) | |||
| + | - [Server-side Web Apps](https://developers.google.com/youtube/v3/guides/auth/server-side-web-apps) | |||
| + | - [Client-side Web Apps](https://developers.google.com/youtube/v3/guides/auth/client-side-web-apps) | |||
| + | - [Installed Apps](https://developers.google.com/youtube/v3/guides/auth/installed-apps) | |||
| + | - [Devices](https://developers.google.com/youtube/v3/guides/auth/devices) | |||
| + | - Quickstarts | |||
| − | ### Data Resources | + | - [Android](https://developers.google.com/youtube/v3/quickstart/android) | |
| + | - [Apps Script](https://developers.google.com/youtube/v3/quickstart/apps-script) | |||
| + | - [Go](https://developers.google.com/youtube/v3/quickstart/go) | |||
| + | - [iOS](https://developers.google.com/youtube/v3/quickstart/ios) | |||
| + | - [Java](https://developers.google.com/youtube/v3/quickstart/java) | |||
| + | - [JavaScript](https://developers.google.com/youtube/v3/quickstart/js) | |||
| + | - [Node.js](https://developers.google.com/youtube/v3/quickstart/nodejs) | |||
| + | - [PHP](https://developers.google.com/youtube/v3/quickstart/php) | |||
| + | - [Python](https://developers.google.com/youtube/v3/quickstart/python) | |||
| + | - [Ruby](https://developers.google.com/youtube/v3/quickstart/ruby) | |||
| + | - Guides and Tutorials | |||
| − | #### YouTube | + | - [Quota costs for API requests](https://developers.google.com/youtube/v3/determine_quota_cost) | |
| + | - [Quota and Compliance Audits](https://developers.google.com/youtube/v3/guides/quota_and_compliance_audits) | |||
| + | - [Upload a Video](https://developers.google.com/youtube/v3/guides/uploading_a_video) | |||
| + | - [Send Resumable Uploads](https://developers.google.com/youtube/v3/guides/using_resumable_upload_protocol) | |||
| + | - [Find MadeForKids video status](https://developers.google.com/youtube/v3/guides/made_for_kids_status) | |||
| + | - [Subscribe to Push Notifications](https://developers.google.com/youtube/v3/guides/push_notifications) | |||
| + | - [Work with Channel IDs](https://developers.google.com/youtube/v3/guides/working_with_channel_ids) | |||
| + | - [Move from ClientLogin to OAuth](https://developers.google.com/youtube/v3/guides/moving_to_oauth) | |||
| + | - [Sample Requests](https://developers.google.com/youtube/v3/sample_requests) | |||
| + | - Implementation Guide | |||
| − | Available data includes a variety of information about videos, channels, comments, and playlists on the platform. For YouTube videos, data includes details such as a video’s upload date, channel ID, title, description, likes, and view count. For YouTube channels, data includes subscriber counts and total channel views, as well as details about what videos a channel has chosen to feature, such as a channel’s latest uploads, most popular uploads, or videos from one or more playlists. YouTube also provides information about comments on public videos, as well as replies to top-level comments. For playlists, YouTube provides information about resources, such as a video, that are part of a playlist, and details explaining how the resource is used in the playlist. Learn more about our data: YouTube Data API Overview. | + | - [Overview](https://developers.google.com/youtube/v3/guides/implementation) | |
| + | - [Activities](https://developers.google.com/youtube/v3/guides/implementation/activities) | |||
| + | - [Captions](https://developers.google.com/youtube/v3/guides/implementation/captions) | |||
| + | - [Channels](https://developers.google.com/youtube/v3/guides/implementation/channels) | |||
| + | - [Comments](https://developers.google.com/youtube/v3/guides/implementation/comments) | |||
| + | - [Pagination](https://developers.google.com/youtube/v3/guides/implementation/pagination) | |||
| + | - [Partial responses](https://developers.google.com/youtube/v3/guides/implementation/partial) | |||
| + | - [Playlists](https://developers.google.com/youtube/v3/guides/implementation/playlists) | |||
| + | - [Ratings](https://developers.google.com/youtube/v3/guides/implementation/ratings) | |||
| + | - [Search requests](https://developers.google.com/youtube/v3/guides/implementation/search) | |||
| + | - [Subscriptions](https://developers.google.com/youtube/v3/guides/implementation/subscriptions) | |||
| + | - [Videos](https://developers.google.com/youtube/v3/guides/implementation/videos) | |||
| + | - Tools | |||
| − | ### Other Data, Tools, and Publications for Researchers | + | - [APIs Explorer](https://developers.google.com/apis-explorer/#p/youtube/v3/) | |
| − | #### Google Research Resources | + | - [Home](https://developers.google.com/) | |
| + | - [Products](https://developers.google.com/products) | |||
| + | - [YouTube](https://developers.google.com/youtube) | |||
| + | - [Data API](https://developers.google.com/youtube/v3) | |||
| + | - [Guides](https://developers.google.com/youtube/v3/getting-started) | |||
| − | We make tools and datasets available to the broader research community with the goal of building a more collaborative ecosystem. | + | # YouTube Data API Overview Stay organized with collections Save and categorize content based on your preferences. | |
| − | - Google Trends | + | ## Page Summary | |
| − | - Dataset Search | |||
| − | - Data Commons | |||
| − | - Google Scholar | |||
| − | ### Learn About the Researcher Program | + | outlined\_flag | |
| − | The Researcher Program equips qualified researchers with resources to advance the public’s understanding of certain Google services and their impact. | + | - The YouTube Data API v3 requires a Google Account, a project in the Google Developers Console, and enablement of the API, with OAuth 2.0 for user authorization, and the option to use a client library. | |
| + | - The API provides access to various resource types such as activities, channels, playlists, videos, and others, with supported operations including listing, inserting, updating, and deleting, depending on the resource. | |||
| + | - The API employs a quota system with default limits, different costs for different operations, and a monitoring system, allowing for extensions by requesting them. | |||
| + | - The `part` parameter is mandatory for retrieving resources and specifies which properties to include, while the `fields` parameter further filters the response, reducing data transfer by omitting unnecessary nested properties. | |||
| + | - Performance optimizations include the use of ETags for caching and overwrite protection, and gzip compression to reduce bandwidth usage. | |||
| − | #### Discover How to Qualify | + | ## Introduction | |
| − | Qualifying researchers from diverse disciplines can apply to obtain access to data from Google Maps, Google Play, Google Search, Google Shopping and YouTube to study those platforms from a wide range of perspectives and research frameworks. This programme is currently only available for researchers affiliated with an EU-based institution and may be expanded upon in the future. Researchers interested in other data sets and research tools provided by Google should visit Google Research. | + | This document is intended for developers who want to write applications that interact with YouTube. It explains basic concepts of YouTube and of the API itself. It also provides an overview of the different functions that the API supports. | |
| − | #### How the Program Works | + | ### Before you start | |
| − | 1. Confirm your eligibility with relevant platforms (requires a Google account) | + | 1. You need a [Google Account](https://www.google.com/accounts/NewAccount) to access the Google API Console, request an API key, and register your application. | |
| − | 2. Submit your application | + | 2. Create a project in the [Google Developers Console](https://console.developers.google.com) and [obtain authorization credentials](https://developers.google.com/youtube/registering_an_application) so your application can submit API requests. | |
| − | 3. If approved, access the tool(s) relevant to your research | + | 3. After creating your project, make sure the YouTube Data API is one of the services that your application is registered to use: | |
| − | ### Review the Eligibility Requirements | + | 1. Go to the [API Console](https://console.cloud.google.com/) and select the project that you just registered. | |
| + | 2. Visit the [Enabled APIs page](https://console.cloud.google.com/apis/enabled). | |||
| + | In the list of APIs, make sure the status is **ON** for the **YouTube Data API v3**. | |||
| + | 4. If your application will use any API methods that require user authorization, read the [authentication](https://developers.google.com/youtube/v3/guides/authentication) guide to learn how to implement OAuth 2.0 authorization. | |||
| + | 5. Select a [client library](https://developers.google.com/youtube/v3/libraries) to simplify your API implementation. | |||
| + | 6. Familiarize yourself with the core concepts of the JSON (JavaScript Object Notation) data format. JSON is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see [json.org](http://json.org). | |||
| − | Qualifying researchers: | + | ## Resources and resource types | |
| − | - are affiliated with not for profit bodies, organizations and associations; | + | A resource is an individual data entity with a unique identifier. The table below describes the different types of resources that you can interact with using the API. | |
| − | - are independent from commercial interests; | |||
| − | - disclose in their application the funding of their research; | |||
| − | - are able to meet specific data security and confidentiality requirements corresponding to each request and to protect personal data; | |||
| − | - describe in their application the appropriate technical and organizational measures that they have put in place to meet data security and confidentiality requirements; | |||
| − | - demonstrate in their application that their access to data and the time frames requested are necessary for, and proportionate to, the purposes of their research; | |||
| − | - demonstrate in their application that the expected results of their research will contribute to the detection, identification and understanding of the impacts of the services in the European Union, and to the assessment of the adequacy, efficiency and impacts of related risk mitigation measures in the European Union. | |||
| − | Note: Individual platform teams may have additional eligibility requirements beyond those listed here. | + | | Resources | | | |
| + | | --- | --- | | |||
| + | | `activity` | Contains information about an action that a particular user has taken on the YouTube site. User actions that are reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, and posting a channel bulletin, among others. | | |||
| + | | `channel` | Contains information about a single YouTube channel. | | |||
| + | | `channelBanner` | Identifies the URL to use to set a newly uploaded image as the banner image for a channel. | | |||
| + | | `channelSection` | Contains information about a set of videos that a channel has chosen to feature. For example, a section could feature a channel's latest uploads, most popular uploads, or videos from one or more playlists. | | |||
| + | | `guideCategory` | Identifies a category that YouTube associates with channels based on their content or other indicators, such as popularity. Guide categories seek to organize channels in a way that makes it easier for YouTube users to find the content they're looking for. While channels could be associated with one or more guide categories, they are not guaranteed to be in any guide categories. | | |||
| + | | `i18nLanguage` | Identifies an application language that the YouTube website supports. The application language can also be referred to as a UI language. | | |||
| + | | `i18nRegion` | Identifies a geographic area that a YouTube user can select as the preferred content region. The content region can also be referred to as a content locale. | | |||
| + | | `playlist` | Represents a single YouTube playlist. A playlist is a collection of videos that can be viewed sequentially and shared with other users. | | |||
| + | | `playlistItem` | Identifies a resource, such as a video, that is part of a playlist. The playlistItem resource also contains details that explain how the included resource is used in the playlist. | | |||
| + | | `search result` | Contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data. | | |||
| + | | `subscription` | Contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video. | | |||
| + | | `thumbnail` | Identifies thumbnail images associated with a resource. | | |||
| + | | `video` | Represents a single YouTube video. | | |||
| + | | `videoCategory` | Identifies a category that has been or could be associated with uploaded videos. | | |||
| + | | `watermark` | Identifies an image that displays during playbacks of a specified channel's videos. The channel owner can also specify a target channel to which the image links as well as timing details that determine when the watermark appears during video playbacks and the length of time it is visible. | | |||
| − | ### View the Program Policies | + | Note that, in many cases, a resource contains references to other resources. For example, a `playlistItem` resource's `snippet.resourceId.videoId` property identifies a video resource that, in turn, contains complete information about the video. As another example, a search result contains either a `videoId`, `playlistId`, or `channelId` property that identifies a particular video, playlist, or channel resource. | |
| − | We’ve summarized the eligibility requirements and conditions on this page. Be sure to review the Acceptable Use Policy before you apply. To participate in the program, applicants must review and agree to the policies outlined. Selected researchers must agree to the Acceptable Use Policy, along with any general Terms of Service for the platform(s) the researcher is accessing. You are fully responsible for your research and publications. In addition, Google won’t own any IP related to your research, publications or any research outcomes, or recommendations. | + | ### Supported operations | |
| − | ### Other Researcher Programs | + | The following table shows the most common methods that the API supports. Some resources also support other methods that perform functions more specific to those resources. For example, the `videos.rate` method associates a user rating with a video, and the `thumbnails.set` method uploads a video thumbnail image to YouTube and associates it with a video. | |
| − | #### YouTube Researcher Program | + | | Operations | | | |
| + | | --- | --- | | |||
| + | | `list` | Retrieves (`GET`) a list of zero or more resources. | | |||
| + | | `insert` | Creates (`POST`) a new resource. | | |||
| + | | `update` | Modifies (`PUT`) an existing resource to reflect data in your request. | | |||
| + | | `delete` | Removes (`DELETE`) a specific resource. | | |||
| − | YouTube is equipping eligible academic researchers from around the world with data, tools, and support to advance the public’s understanding of YouTube’s platform and its impact. | + | The API currently supports methods to list each of the supported resource types, and it supports write operations for many resources as well. | |
| − | #### Google Search Researcher Program | + | The table below identifies the operations that are supported for different types of resources. Operations that insert, update, or delete resources always require [user authorization](https://developers.google.com/youtube/v3/guides/authentication). In some cases, `list` methods support both authorized and unauthorized requests, where unauthorized requests only retrieve public data while authorized requests can also retrieve information about or private to the currently authenticated user. | |
| − | Google Search is providing eligible academic researchers programmatic access to the search results page to help the public better understand how Google responds to search queries. | + | | Supported Operations | | | | | | |
| + | | --- | --- | --- | --- | --- | | |||
| + | | | **list** | **insert** | **update** | **delete** | | |||
| + | | `activity` | | | | | | |||
| + | | `caption` | | | | | | |||
| + | | `channel` | | | | | | |||
| + | | `channelBanner` | | | | | | |||
| + | | `channelSection` | | | | | | |||
| + | | `comment` | | | | | | |||
| + | | `commentThread` | | | | | | |||
| + | | `guideCategory` | | | | | | |||
| + | | `i18nLanguage` | | | | | | |||
| + | | `i18nRegion` | | | | | | |||
| + | | `playlist` | | | | | | |||
| + | | `playlistItem` | | | | | | |||
| + | | `search result` | | | | | | |||
| + | | `subscription` | | | | | | |||
| + | | `thumbnail` | | | | | | |||
| + | | `video` | | | | | | |||
| + | | `videoCategory` | | | | | | |||
| + | | `watermark` | | | | | | |||
| − | ### Outreach | + | ## Quota usage | |
| − | We administer a variety of outreach programs that provide support to the academic and external research communities. | + | The YouTube Data API uses a quota to ensure that developers use the service as intended and do not create applications that unfairly reduce service quality or limit access for others. All API requests, including invalid requests, incur at least a one-point quota cost. You can find the quota available to your application in the [API Console](https://console.cloud.google.com/). | |
| − | #### Trust and Safety Research Awards | + | Projects that enable the YouTube Data API have a default quota allocation of 10,000 units per day, an amount sufficient for the overwhelming majority of our API users. Default quota, which is subject to change, helps us optimize quota allocations and scale our infrastructure in a way that is more meaningful to our API users. You can see your quota usage on the [Quotas](https://console.developers.google.com/iam-admin/quotas) page in the API Console. | |
| − | Google is committed to supporting innovative research and professors working to create positive societal impact with technology, particularly in areas relevant to Trust and Safety. Google is looking to fund and actively collaborate with the academic research community, exploring opportunities to expand our knowledge of Trust and Safety concerns. In addition, we have other awards that aren’t solely focused on Trust and Safety, where we often fund researchers in these programs working in trust and safety, privacy, and security. | + | **Note:** If you reach the quota limit, you can request additional quota by | |
| + | completing the [Quota extension | |||
| + | request form](https://support.google.com/youtube/contact/yt_api_form) for YouTube API Services. | |||
| − | #### Events | + | ### Calculating quota usage | |
| − | We have Google teams working across privacy, security, content responsibility, and family safety around the world. Our Google Safety Engineering Centers in Munich, Dublin, and Malaga help guide this Internet safety work, led by experienced teams of engineers, policy specialists and subject matter experts. Through our network of centers, we collaborate and share this work with researchers, policymakers and regulators. Part of this work includes holding regular events for these audiences on topics such as Security and Child Safety. Specifically for researchers, we also organize events focused on having our researchers collaborate with the academic community, like our workshop on At-Risk Users and our AI Research Day in France, which focused entirely on AI Privacy, Safety and Security research. | + | Google calculates your quota usage by assigning a cost to each request. Different types of | |
| + | operations have different quota costs. For example: | |||
| − | --- | + | - A read operation that retrieves a list of resources -- channels, videos, playlists -- usually | |
| + | costs 1 unit. | |||
| + | - A write operation that creates, updates, or deletes a resource usually costs | |||
| + | `50` units. | |||
| + | - A search request costs `100` units. | |||
| + | - A video upload costs `100` units. | |||
| − | #### DSA Article 40(4) Data Resources -- Platform navigation | + | The [Quota costs for API requests](https://developers.google.com/youtube/v3/determine_quota_cost) table shows the | |
| − | - YouTube | + | quota cost of each API method. With these rules in mind, you can estimate the number of requests | |
| − | - Google Search | + | that your application could send per day without exceeding your quota. | |
| − | - Google Maps | |||
| − | - Google Play | |||
| − | - Google Shopping | |||
| − | - DSA Access Modality & Terms | |||
| − | - DSA Researcher Point of Contact | |||
| − | - DSA 40(4) Data Access Portal | |||
| − | #### Google Research Resources navigation | + | ## Partial resources | |
| − | - Google Research Resources | |||
| − | - Google Trends | |||
| − | - Dataset Search | |||
| − | - Data Commons | |||
| − | --- | + | The API allows, and actually requires, the retrieval of partial resources so that applications avoid transferring, parsing, and storing unneeded data. This approach also ensures that the API uses network, CPU, and memory resources more efficiently. | |
| − | #### Transparency Resources | + | The API supports two request parameters, which are explained in the following sections, that enable you to identify the resource properties that should be included in API responses. | |
| − | - Ads Transparency Center | |||
| − | - Transparency Report | |||
| − | #### About our products | + | - The `part` parameter identifies groups of properties that should be returned for a resource. | |
| − | - How Search Works | + | - The `fields` parameter filters the API response to only return specific properties within the requested resource parts. | |
| − | - How YouTube Works | |||
| − | - Help Center | |||
| − | #### Responsibility | + | ### How to use the `part` parameter | |
| − | - Public Policy | |||
| − | - Protecting Children | |||
| − | - Safety Center | |||
| − | - Responsible AI | |||
| − | Follow us | About Google | Google products | Privacy | Terms | Help | + | The `part` parameter is a required parameter for any API request that retrieves or returns a resource. The parameter identifies one or more top-level (non-nested) resource properties that should be included in an API response. For example, a `video` resource has the following parts: | |
| + | ||||
| + | - `snippet` | |||
| + | - `contentDetails` | |||
| + | - `fileDetails` | |||
| + | - `player` | |||
| + | - `processingDetails` | |||
| + | - `recordingDetails` | |||
| + | - `statistics` | |||
| + | - `status` | |||
| + | - `suggestions` | |||
| + | - `topicDetails` | |||
| + | ||||
| + | All of these parts are objects that contain nested properties, and you can think of these objects as groups of metadata fields that the API server might (or might not) retrieve. As such, the `part` parameter requires you to select the resource components that your application actually uses. This requirement serves two key purposes: | |||
| + | ||||
| + | - It reduces latency by preventing the API server from spending time retrieving metadata fields that your application doesn't use. | |||
| + | - It reduces bandwidth usage by reducing (or eliminating) the amount of unnecessary data that your application might retrieve. | |||
| + | ||||
| + | Over time, as resources add more parts, these benefits will only increase since your application will not be requesting newly introduced properties that it doesn't support. | |||
| + | ||||
| + | ### How to use the `fields` parameter | |||
| + | ||||
| + | The `fields` parameter filters the API response, which only contains the resource parts identified in the `part` parameter value, so that the response only includes a specific set of fields. The `fields` parameter lets you remove nested properties from an API response and thereby further reduce your bandwidth usage. (The `part` parameter cannot be used to filter nested properties from a response.) | |||
| + | ||||
| + | The following rules explain the supported syntax for the `fields` parameter value, which is loosely based on XPath syntax: | |||
| + | ||||
| + | - Use a comma-separated list (`fields=a,b`) to select multiple fields. | |||
| + | - Use an asterisk (`fields=*`) as a wildcard to identify all fields. | |||
| + | - Use parentheses (`fields=a(b,c)`) to specify a group of nested properties that will be included in the API response. | |||
| + | - Use a forward slash (`fields=a/b`) to identify a nested property. | |||
| + | ||||
| + | In practice, these rules often allow several different `fields` parameter values to retrieve the same API response. For example, if you want to retrieve the playlist item ID, title, and position for every item in a playlist, you could use any of the following values: | |||
| + | ||||
| + | - `fields=items/id,playlistItems/snippet/title,playlistItems/snippet/position` | |||
| + | - `fields=items(id,snippet/title,snippet/position)` | |||
| + | - `fields=items(id,snippet(title,position))` | |||
| + | ||||
| + | **Note:** As with all query parameter values, the `fields` parameter value must be URL encoded. For better readability, the examples in this document omit the encoding. | |||
| + | ||||
| + | ### Sample partial requests | |||
| + | ||||
| + | The examples below demonstrate how you can use the `part` and `fields` parameters to ensure that API responses only include the data that your application uses: | |||
| + | ||||
| + | 1. Example 1 returns a video resource that includes four parts as well as `kind` and `etag` properties. | |||
| + | 2. Example 2 returns a video resource that includes two parts as well as `kind` and `etag` properties. | |||
| + | 3. Example 3 returns a video resource that includes two parts but excludes `kind` and `etag` properties. | |||
| + | 4. Example 4 returns a video resource that includes two parts but excludes `kind` and `etag` as well as some nested properties in the resource's `snippet` object. | |||
| + | ||||
| + | Example 1 | |||
| + | ||||
| + | ``` | |||
| + | URL: https://www.googleapis.com/youtube/v3/videos?id=7lCDEYXw3mM&key=YOUR_API_KEY | |||
| + | &part=snippet,contentDetails,statistics,status | |||
| + | ||||
| + | Description: This example retrieves a video resource and identifies several | |||
| + | resource parts that should be included in the API response. | |||
| + | ||||
| + | API response: | |||
| + | ||||
| + | { | |||
| + | "kind": "youtube#videoListResponse", | |||
| + | "etag": "\"UCBpFjp2h75_b92t44sqraUcyu0/sDAlsG9NGKfr6v5AlPZKSEZdtqA\"", | |||
| + | "videos": [ | |||
| + | { | |||
| + | "id": "7lCDEYXw3mM", | |||
| + | "kind": "youtube#video", | |||
| + | "etag": "\"UCBpFjp2h75_b92t44sqraUcyu0/iYynQR8AtacsFUwWmrVaw4Smb_Q\"", | |||
| + | "snippet": { | |||
| + | "publishedAt": "2012-06-20T22:45:24.000Z", | |||
| + | "channelId": "UC_x5XG1OV2P6uZZ5FSM9Ttw", | |||
| + | "title": "Google I/O 101: Q&A On Using Google APIs", | |||
| + | "description": "Antonio Fuentes speaks to us and takes questions on working with Google APIs and OAuth 2.0.", | |||
| + | "thumbnails": { | |||
| + | "default": { | |||
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/default.jpg" | |||
| + | }, | |||
| + | "medium": { | |||
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/mqdefault.jpg" | |||
| + | }, | |||
| + | "high": { | |||
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/hqdefault.jpg" | |||
| + | } | |||
| + | }, | |||
| + | "categoryId": "28" | |||
| + | }, | |||
| + | "contentDetails": { | |||
| + | "duration": "PT15M51S", | |||
| + | "aspectRatio": "RATIO_16_9" | |||
| + | }, | |||
| + | "statistics": { | |||
| + | "viewCount": "3057", | |||
| + | "likeCount": "25", | |||
| + | "dislikeCount": "0", | |||
| + | "favoriteCount": "17", | |||
| + | "commentCount": "12" | |||
| + | }, | |||
| + | "status": { | |||
| + | "uploadStatus": "STATUS_PROCESSED", | |||
| + | "privacyStatus": "PRIVACY_PUBLIC" | |||
| + | } | |||
| + | } | |||
| + | ] | |||
| + | } | |||
| + | ``` | |||
| + | ||||
| + | Example 2 | |||
| + | ||||
| + | ``` | |||
| + | URL: https://www.googleapis.com/youtube/v3/videos?id=7lCDEYXw3mM&key=YOUR_API_KEY | |||
| + | &part=snippet,statistics | |||
| + | ||||
| + | Description: This example modifies the part parameter value so that the | |||
| + | contentDetails and status properties are not included | |||
| + | in the response. | |||
| + | ||||
| + | API response: | |||
| + | ||||
| + | { | |||
| + | "kind": "youtube#videoListResponse", | |||
| + | "etag": "\"UCBpFjp2h75_b92t44sqraUcyu0/sDAlsG9NGKfr6v5AlPZKSEZdtqA\"", | |||
| + | "videos": [ | |||
| + | { | |||
| + | "id": "7lCDEYXw3mM", | |||
| + | "kind": "youtube#video", | |||
| + | "etag": "\"UCBpFjp2h75_b92t44sqraUcyu0/iYynQR8AtacsFUwWmrVaw4Smb_Q\"", | |||
| + | "snippet": { | |||
| + | "publishedAt": "2012-06-20T22:45:24.000Z", | |||
| + | "channelId": "UC_x5XG1OV2P6uZZ5FSM9Ttw", | |||
| + | "title": "Google I/O 101: Q&A On Using Google APIs", | |||
| + | "description": "Antonio Fuentes speaks to us and takes questions on working with Google APIs and OAuth 2.0.", | |||
| + | "thumbnails": { | |||
| + | "default": { | |||
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/default.jpg" | |||
| + | }, | |||
| + | "medium": { | |||
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/mqdefault.jpg" | |||
| + | }, | |||
| + | "high": { | |||
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/hqdefault.jpg" | |||
| + | } | |||
| + | }, | |||
| + | "categoryId": "28" | |||
| + | }, | |||
| + | "statistics": { | |||
| + | "viewCount": "3057", | |||
| + | "likeCount": "25", | |||
| + | "dislikeCount": "0", | |||
| + | "favoriteCount": "17", | |||
| + | "commentCount": "12" | |||
| + | } | |||
| + | } | |||
| + | ] | |||
| + | } | |||
| + | ``` | |||
| + | ||||
| + | Example 3 | |||
| + | ||||
| + | ``` | |||
| + | URL: https://www.googleapis.com/youtube/v3/videos?id=7lCDEYXw3mM&key=YOUR_API_KEY | |||
| + | &part=snippet,statistics&fields=items(id,snippet,statistics) | |||
| + | ||||
| + | Description: This example adds the fields parameter to remove all | |||
| + | kind and etag properties from the API response. | |||
| + | ||||
| + | API response: | |||
| + | ||||
| + | { | |||
| + | "videos": [ | |||
| + | { | |||
| + | "id": "7lCDEYXw3mM", | |||
| + | "snippet": { | |||
| + | "publishedAt": "2012-06-20T22:45:24.000Z", | |||
| + | "channelId": "UC_x5XG1OV2P6uZZ5FSM9Ttw", | |||
| + | "title": "Google I/O 101: Q&A On Using Google APIs", | |||
| + | "description": "Antonio Fuentes speaks to us and takes questions on working with Google APIs and OAuth 2.0.", | |||
| + | "thumbnails": { | |||
| + | "default": { | |||
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/default.jpg" | |||
| + | }, | |||
| + | "medium": { | |||
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/mqdefault.jpg" | |||
| + | }, | |||
| + | "high": { | |||
| + | "url": "https://i.ytimg.com/vi/7lCDEYXw3mM/hqdefault.jpg" | |||
| + | } | |||
| + | }, | |||
| + | "categoryId": "28" | |||
| + | }, | |||
| + | "statistics": { | |||
| + | "viewCount": "3057", | |||
| + | "likeCount": "25", | |||
| + | "dislikeCount": "0", | |||
| + | "favoriteCount": "17", | |||
| + | "commentCount": "12" | |||
| + | } | |||
| + | } | |||
| + | ] | |||
| + | } | |||
| + | ``` | |||
| + | ||||
| + | Example 4 | |||
| + | ||||
| + | ``` | |||
| + | URL: https://www.googleapis.com/youtube/v3/videos?id=7lCDEYXw3mM&key=YOUR_API_KEY | |||
| + | &fields=items(id,snippet(channelId,title,categoryId),statistics)&part=snippet,statistics | |||
| + | ||||
| + | Description: This example modifies the fields parameter from example 3 | |||
| + | so that in the API response, each video resource's snippet | |||
| + | object only includes the channelId, title, | |||
| + | and categoryId properties. | |||
| + | ||||
| + | API response: | |||
| + | ||||
| + | { | |||
| + | "videos": [ | |||
| + | { | |||
| + | "id": "7lCDEYXw3mM", | |||
| + | "snippet": { | |||
| + | "channelId": "UC_x5XG1OV2P6uZZ5FSM9Ttw", | |||
| + | "title": "Google I/O 101: Q&A On Using Google APIs", | |||
| + | "categoryId": "28" | |||
| + | }, | |||
| + | "statistics": { | |||
| + | "viewCount": "3057", | |||
| + | "likeCount": "25", | |||
| + | "dislikeCount": "0", | |||
| + | "favoriteCount": "17", | |||
| + | "commentCount": "12" | |||
| + | } | |||
| + | } | |||
| + | ] | |||
| + | } | |||
| + | ``` | |||
| + | ||||
| + | ## Optimizing performance | |||
| + | ||||
| + | ### Using ETags | |||
| + | ||||
| + | ETags, a standard part of the [HTTP protocol](https://www.rfc-editor.org/rfc/rfc9110.html#name-etag), allow applications to refer to a specific version of a particular API resource. The resource could be an entire feed or an item in that feed. This functionality supports the following use cases: | |||
| + | ||||
| + | - **Caching and conditional retrieval** – Your application can cache API resources and their ETags. Then, when your application requests a stored resource again, it specifies the ETag associated with that resource. If the resource has changed, the API returns the modified resource and the ETag associated with that version of the resource. If the resource has not changed, the API returns an HTTP 304 response (`Not Modified`), which indicates that the resource has not changed. Your application can reduce latency and bandwidth usage by serving cached resources in this manner. | |||
| + | ||||
| + | The client libraries for Google APIs differ in their support of ETags. For example, the JavaScript client library supports ETags via a whitelist for allowed request headers that includes `If-Match` and `If-None-Match`. The whitelist allows normal browser caching to occur so that if a resource's ETag has not changed, the resource can be served from the browser cache. The Obj-C client, on the other hand, does not support ETags. | |||
| + | - **Protecting against inadvertent overwrites of changes** – ETags help to ensure that multiple API clients don't inadvertently overwrite each other's changes. When updating or deleting a resource, your application can specify the resource's ETag. If the ETag doesn't match the most recent version of that resource, then the API request fails. | |||
| + | ||||
| + | Using ETags in your application provides several benefits: | |||
| + | ||||
| + | - The API responds more quickly to requests for cached but unchanged resources, yielding lower latency and lower bandwidth usage. | |||
| + | - Your application will not inadvertently overwrite changes to a resource that were made from another API client. | |||
| + | ||||
| + | The [Google APIs Client Library for JavaScript](https://developers.google.com/api-client-library/javascript/start/start-js) supports `If-Match` and `If-None-Match` HTTP request headers, thereby enabling ETags to work within the context of normal browser caching. | |||
| + | ||||
| + | ### Using gzip | |||
| + | ||||
| + | You can also reduce the bandwidth needed for each API response by enabling gzip compression. While your application will need additional CPU time to uncompress API responses, the benefit of consuming fewer network resources usually outweighs that cost. | |||
| + | ||||
| + | To receive a gzip-encoded response you must do two things: | |||
| + | ||||
| + | - Set the `Accept-Encoding` HTTP request header to `gzip`. | |||
| + | - Modify your user agent to contain the string `gzip`. | |||
| + | ||||
| + | The sample HTTP headers below demonstrate these requirements for enabling gzip compression: | |||
| + | ||||
| + | ``` | |||
| + | Accept-Encoding: gzip | |||
| + | User-Agent: my program (gzip) | |||
| + | ``` | |||
| + | ||||
| + | Except as otherwise noted, the content of this page is licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/), and code samples are licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). For details, see the [Google Developers Site Policies](https://developers.google.com/site-policies). Java is a registered trademark of Oracle and/or its affiliates. | |||
| + | ||||
| + | Last updated 2026-03-13 UTC. | |||
| + | ||||
| + | [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-13 UTC."],[],["To utilize the YouTube Data API, you need a Google account, a project in the Google Developers Console with the API enabled, and potentially OAuth 2.0 authorization. Key actions include using `list`, `insert`, `update`, and `delete` operations on resources like `videos`, `channels`, and `playlists`. API usage is governed by quotas, with each operation incurring a cost; reading operations usually costs 1 unit, while writing or searching costs much more. Use the `part` and `fields` parameters to optimize requests, and utilize ETags and gzip compression to improve efficiency.\n"]] | |||
| + | ||||
| + | - [Blog](https://blog.youtube) | |||
| + | ||||
| + | The latest news on the YouTube blog | |||
| + | - [GitHub](https://github.com/youtube/api-samples) | |||
| + | ||||
| + | Find API code samples and other YouTube open-source projects. | |||
| + | - [Issue Tracker](https://issuetracker.google.com/issues/new?component=186600&template=874803) | |||
| + | ||||
| + | Something wrong? Send us a bug report! | |||
| + | - [Stack Overflow](http://stackoverflow.com/questions/ask?tags=youtube-api) | |||
| + | ||||
| + | Ask a question under the youtube-api tag | |||
| + | - [Videos](https://www.youtube.com/user/YouTubeDev) | |||
| + | ||||
| + | Check out the YouTube Developer Relations team's YouTube channel | |||
| + | ||||
| + | - ### Tools | |||
| + | ||||
| + | - [Google APIs Explorer](https://developers.google.com/apis-explorer/#p/) | |||
| + | - [YouTube Player Demo](https://developers.google.com/youtube/youtube_player_demo) | |||
| + | - [Configure a Subscribe Button](https://developers.google.com/youtube/youtube_subscribe_button) | |||
| + | - ### Issue Tracker | |||
| + | ||||
| + | - [File a bug](https://issuetracker.google.com/issues/new?component=186600&template=874803) | |||
| + | - [Request a feature](https://issuetracker.google.com/issues/new?component=186600&template=874803) | |||
| + | - [See open issues](https://issuetracker.google.com/issues?q=componentid:186600) | |||
| + | - ### Product Info | |||
| + | ||||
| + | - [Terms of Service](https://developers.google.com/youtube/terms) | |||
| + | - [Branding Guidelines](https://developers.google.com/youtube/branding_guidelines) | |||
| + | - [Monetization Guidelines](https://developers.google.com/youtube/creating_monetizable_applications) | |||
| + | - [APIs subject to Deprecation Policy](https://developers.google.com/youtube/youtube-api-list) | |||
| + | ||||
| + | - [Android](https://developer.android.com) | |||
| + | - [Chrome](https://developer.chrome.com/home) | |||
| + | - [Firebase](https://firebase.google.com) | |||
| + | - [Google Cloud Platform](https://cloud.google.com) | |||
| + | - [Google AI](https://ai.google.dev/) | |||
| + | - [All products](https://developers.google.com/products) | |||
| + | ||||
| + | - [Terms](https://developers.google.com/terms/site-terms) | |||
| + | - [Privacy](https://policies.google.com/privacy) | |||
| + | - [Manage cookies](https://developers.google.com/youtube/v3/getting-started/?target=_blank#) | |||
| + | ||||
| + | - English | |||
| + | - Deutsch | |||
| + | - Español | |||
| + | - Español – América Latina | |||
| + | - Français | |||
| + | - Indonesia | |||
| + | - Italiano | |||
| + | - Polski | |||
| + | - Português – Brasil | |||
| + | - Tiếng Việt | |||
| + | - Türkçe | |||
| + | - Русский | |||
| + | - עברית | |||
| + | - العربيّة | |||
| + | - فارسی | |||
| + | - हिंदी | |||
| + | - বাংলা | |||
| + | - ภาษาไทย | |||
| + | - 中文 – 简体 | |||
| + | - 中文 – 繁體 | |||
| + | - 日本語 | |||
| + | - 한국어 | |||