provider search GET
/youtube/v3/search @utdk/google/youtube
/youtube/v3/search search.list
Retrieves a list of search resources
- $.xgafv query
- V1 error format.
- enum: 1, 2
- access_token query
- OAuth access token.
- string
- alt query
- Data format for response.
- enum: json, media, proto
- callback query
- JSONP
- string
- fields query
- Selector specifying which fields to include in a partial response.
- string
- key query
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- string
- oauth_token query
- OAuth 2.0 token for the current user.
- string
- prettyPrint query
- Returns response with indentations and line breaks.
- boolean
- quotaUser query
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- string
- upload_protocol query
- Upload protocol for media (e.g. "raw", "multipart").
- string
- uploadType query
- Legacy upload protocol for media (e.g. "media", "multipart").
- string
- part query required
- The *part* parameter specifies a comma-separated list of one or more search resource properties that the API response will include. Set the parameter value to snippet.
- array
- channelId query
- Filter on resources belonging to this channelId.
- string
- channelType query
- Add a filter on the channel search.
- enum: channelTypeUnspecified, any, show
- eventType query
- Filter on the livestream status of the videos.
- enum: none, upcoming, live, completed
- forContentOwner query
- Search owned by a content owner.
- boolean
- forDeveloper query
- Restrict the search to only retrieve videos uploaded using the project id of the authenticated user.
- boolean
- forMine query
- Search for the private videos of the authenticated user.
- boolean
- location query
- Filter on location of the video
- string
- locationRadius query
- Filter on distance from the location (specified above).
- string
- maxResults query
- The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
- integer
- onBehalfOfContentOwner query
- *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
- string
- order query
- Sort order of the results.
- enum: searchSortUnspecified, date, rating, viewCount…
- pageToken query
- The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
- string
- publishedAfter query
- Filter on resources published after this date.
- string
- publishedBefore query
- Filter on resources published before this date.
- string
- q query
- Textual search terms to match.
- string
- regionCode query
- Display the content as seen by viewers in this country.
- string
- relevanceLanguage query
- Return results relevant to this language.
- string
- safeSearch query
- Indicates whether the search results should include restricted content as well as standard content.
- enum: safeSearchSettingUnspecified, none, moderate, strict
- topicId query
- Restrict results to a particular topic.
- string
- type query
- Restrict results to a particular set of resource types from One Platform.
- array
- videoCaption query
- Filter on the presence of captions on the videos.
- enum: videoCaptionUnspecified, any, closedCaption, none
- videoCategoryId query
- Filter on videos in a specific category.
- string
- videoDefinition query
- Filter on the definition of the videos.
- enum: any, standard, high
- videoDimension query
- Filter on 3d videos.
- enum: any, 2d, 3d
- videoDuration query
- Filter on the duration of the videos.
- enum: videoDurationUnspecified, any, short, medium…
- videoEmbeddable query
- Filter on embeddable videos.
- enum: videoEmbeddableUnspecified, any, true
- videoLicense query
- Filter on the license of the videos.
- enum: any, youtube, creativeCommon
- videoPaidProductPlacement query
- enum: videoPaidProductPlacementUnspecified, any, true
- videoSyndicated query
- Filter on syndicated videos.
- enum: videoSyndicatedUnspecified, any, true
- videoType query
- Filter on videos of a specific type.
- enum: videoTypeUnspecified, any, movie, episode
Try it
Authentication
Configure credentials for YouTube Data API v3
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import google_youtube from '@utdk/google/youtube';
await google_youtube.searchList()