YouTube API v3
This documentation has been automatically generated using information supplied by the Google API Discovery service.
1 API Parameters
procedure
(_ [ #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.
fields: Selector specifying which fields to include in a partial response.
key: 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.
oauth_token: OAuth 2.0 token for the current user.
prettyPrint: Returns response with indentations and line breaks.
quotaUser: 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. Overrides userIp if both are provided.
userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.
2 Resources
2.1 subscription
procedure
→ jsexpr? part : string? id : string? = 'N/A channelId : string? = 'N/A contentOwnerId : string? = 'N/A mine : string? = 'N/A order : string? = 'N/A forChannelId : string? = 'N/A maxResults : string? = 'N/A pageToken : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
id: YouTube IDs of the subscriptions to be returned.
channelId: Only return subscriptions to given channelId.
contentOwnerId: The authenticated user acts on behalf of this content owner.
mine: Flag indicating only return the subscriptions of the authenticated user.
order: Sort order.
forChannelId: Takes a comma separated list of channel IDs. Filters the returned list to only those matching these channels
maxResults: Maximum number of search results to return per page.
pageToken: Token for the page selection.
procedure
→ jsexpr? part : string? contentOwnerId : string? = 'N/A id : string? = 'N/A contentDetails : string? = 'N/A snippet : string? = 'N/A kind : string? = 'N/A etag : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
contentOwnerId: The authenticated user acts on behalf of this content owner.
id: The unique id of the subscription.
contentDetails: Basic statistics about the subscription
snippet: Basic details about the subscription
kind: The type of this API resource.
etag: The eTag of the subscription.
procedure
(youtube-subscription-delete #:id id [ #:contentOwnerId contentOwnerId #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? id : string? contentOwnerId : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
id: YouTube IDs of the subscription to be deleted.
contentOwnerId: The authenticated user acts on behalf of this content owner.
2.2 activities
procedure
→ jsexpr? part : string? channelId : string? = 'N/A contentOwnerId : string? = 'N/A home : string? = 'N/A mine : string? = 'N/A publishedAfter : string? = 'N/A publishedBefore : string? = 'N/A maxResults : string? = 'N/A pageToken : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
channelId: YouTube ID of the channel.
contentOwnerId: The authenticated user acts on behalf of this content owner.
home: Flag indicating to return user’s homepage feed.
mine: Flag indicating to return user’s activities.
publishedAfter: Only return activities published after given date (inclusive).
publishedBefore: Only return activities published before given date (exclusive).
maxResults: Maximum number of results to return
pageToken: Token for the page selection.
procedure
→ jsexpr? part : string? contentOwnerId : string? = 'N/A id : string? = 'N/A contentDetails : string? = 'N/A snippet : string? = 'N/A kind : string? = 'N/A etag : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
contentOwnerId: The authenticated user acts on behalf of this content owner.
id: The unique ID of the activity.
contentDetails: Type specific information about the activity.
snippet: Basic details about the activity: title, description, thumbnails.
kind: The type of this API response.
etag: The eTag of the activity.
2.3 channelCategories
procedure
→ jsexpr? part : string? id : string? = 'N/A contentOwnerId : string? = 'N/A hl : string? = 'N/A regionCode : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
id: Comma-separated YouTube IDs of the channelCategories to be returned.
contentOwnerId: The authenticated user acts on behalf of this content owner.
hl: Language for the returned channelCategories.
regionCode: Return the channelCategories in the given region code.
2.4 channels
procedure
→ jsexpr? part : string? id : string? = 'N/A categoryId : string? = 'N/A contentOwnerId : string? = 'N/A mine : string? = 'N/A mySubscribers : string? = 'N/A maxResults : string? = 'N/A pageToken : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
id: YouTube IDs of the channels to be returned.
categoryId: Filter to retrieve the channels within the given category ID.
contentOwnerId: The authenticated user acts on behalf of this content owner.
mine: Filter to only channels owned by authenticated user.
mySubscribers: Filter to channels that subscribed to the channel of the authenticated user.
maxResults: Maximum number of results to return
pageToken: Token for the page selection.
2.5 playlistItems
procedure
→ jsexpr? part : string? id : string? = 'N/A playlistId : string? = 'N/A contentOwnerId : string? = 'N/A maxResults : string? = 'N/A pageToken : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
id: YouTube IDs of the playlist items to be returned.
playlistId: Retrieves playlist items from the given playlist id.
contentOwnerId: The authenticated user acts on behalf of this content owner.
maxResults: Maximum number of results to return
pageToken: Token for the page selection.
procedure
→ jsexpr? part : string? contentOwnerId : string? = 'N/A id : string? = 'N/A contentDetails : string? = 'N/A snippet : string? = 'N/A kind : string? = 'N/A etag : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
contentOwnerId: The authenticated user acts on behalf of this content owner.
id: The unique id of the playlist item.
contentDetails: Content details about the playlist item: start and end clipping time.
snippet: Basic details about the playlist item: title, description, thumbnails.
kind: The type of this API resource.
etag: The eTag of the playlist item.
procedure
→ jsexpr? part : string? contentOwnerId : string? = 'N/A id : string? = 'N/A contentDetails : string? = 'N/A snippet : string? = 'N/A kind : string? = 'N/A etag : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
contentOwnerId: The authenticated user acts on behalf of this content owner.
id: The unique id of the playlist item.
contentDetails: Content details about the playlist item: start and end clipping time.
snippet: Basic details about the playlist item: title, description, thumbnails.
kind: The type of this API resource.
etag: The eTag of the playlist item.
procedure
(youtube-playlistItems-delete #:id id [ #:contentOwnerId contentOwnerId #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? id : string? contentOwnerId : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
id: YouTube IDs of the playlist items to be deleted.
contentOwnerId: The authenticated user acts on behalf of this content owner.
2.6 playlists
procedure
→ jsexpr? part : string? id : string? = 'N/A contentOwnerId : string? = 'N/A mine : string? = 'N/A maxResults : string? = 'N/A pageToken : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
id: Comma-separated YouTube IDs of the playlists to be returned.
contentOwnerId: The authenticated user acts on behalf of this content owner.
mine: Flag indicating only return the playlists of the authenticated user.
maxResults: Maximum number of results to return
pageToken: Token for the page selection.
procedure
→ jsexpr? part : string? contentOwnerId : string? = 'N/A id : string? = 'N/A snippet : string? = 'N/A kind : string? = 'N/A etag : string? = 'N/A status : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
contentOwnerId: The authenticated user acts on behalf of this content owner.
id: The unique id of the playlist.
snippet: Basic details about the playlist: title, description, thumbnails.
kind: The type of this API resource.
etag: The eTag of the playlist.
status: Status of the playlist: only privacy_status for now.
procedure
→ jsexpr? part : string? contentOwnerId : string? = 'N/A id : string? = 'N/A snippet : string? = 'N/A kind : string? = 'N/A etag : string? = 'N/A status : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
contentOwnerId: The authenticated user acts on behalf of this content owner.
id: The unique id of the playlist.
snippet: Basic details about the playlist: title, description, thumbnails.
kind: The type of this API resource.
etag: The eTag of the playlist.
status: Status of the playlist: only privacy_status for now.
procedure
(youtube-playlists-delete #:id id [ #:contentOwnerId contentOwnerId #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? id : string? contentOwnerId : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
id: YouTube IDs of the playlists to be deleted.
contentOwnerId: The authenticated user acts on behalf of this content owner.
2.7 videos
procedure
id : string? part : string? contentOwnerId : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
id: YouTube IDs of the videos to be returned.
part: One or more parts to return on the current request.
contentOwnerId: The authenticated user acts on behalf of this content owner.
procedure
→ jsexpr? part : string? contentOwnerId : string? = 'N/A id : string? = 'N/A contentDetails : string? = 'N/A snippet : string? = 'N/A statistics : string? = 'N/A player : string? = 'N/A kind : string? = 'N/A etag : string? = 'N/A status : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
contentOwnerId: The authenticated user acts on behalf of this content owner.
id: The unique id of the video.
contentDetails: Information about the video content, media file.
snippet: Basic details about the video: title, description, thumbnails.
statistics: Statistics about the video: number of views, ratings.
player: Information used to play the video.
kind: The type of this API resource.
etag: The eTag of the video.
status: Status of the video upload, privacy status.
procedure
→ jsexpr? part : string? contentOwnerId : string? = 'N/A id : string? = 'N/A contentDetails : string? = 'N/A snippet : string? = 'N/A statistics : string? = 'N/A player : string? = 'N/A kind : string? = 'N/A etag : string? = 'N/A status : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
contentOwnerId: The authenticated user acts on behalf of this content owner.
id: The unique id of the video.
contentDetails: Information about the video content, media file.
snippet: Basic details about the video: title, description, thumbnails.
statistics: Statistics about the video: number of views, ratings.
player: Information used to play the video.
kind: The type of this API resource.
etag: The eTag of the video.
status: Status of the video upload, privacy status.
procedure
(youtube-videos-delete #:id id [ #:contentOwnerId contentOwnerId #:alt alt #:fields fields #:key key #:oauth_token oauth_token #:prettyPrint prettyPrint #:quotaUser quotaUser #:userIp userIp]) → jsexpr? id : string? contentOwnerId : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
id: YouTube ID of the video to be deleted.
contentOwnerId: The authenticated user acts on behalf of this content owner.
2.8 search
procedure
→ jsexpr? part : string? q : string? = 'N/A topicId : string? = 'N/A contentOwnerId : string? = 'N/A order : string? = 'N/A published : string? = 'N/A relatedToVideo : string? = 'N/A videoCaption : string? = 'N/A videoDefinition : string? = 'N/A videoDimension : string? = 'N/A videoDuration : string? = 'N/A videoLicense : string? = 'N/A type : string? = 'N/A maxResults : string? = 'N/A pageToken : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
q: Query to search in Youtube.
topicId: Only search for resources with the specified topic
contentOwnerId: The authenticated user acts on behalf of this content owner.
order: Sort order.
published: Only search for resources uploaded at a specific pediod
relatedToVideo: Search for resources related to this video. Need to be used with type set to ’video’
videoCaption: Add a filter on the the presence of captions on the videos.
videoDefinition: Add a filter for the definition of the videos.
videoDimension: Add a filter for the number of dimensions in the videos.
videoDuration: Add a filter on the duration of the videos.
videoLicense: Add a filter on the licensing of the videos.
type: Type of resource to search.
maxResults: Maximum number of search results to return per page.
pageToken: Token for the page selection.
2.9 videocategory
procedure
→ jsexpr? part : string? id : string? = 'N/A contentOwnerId : string? = 'N/A hl : string? = 'N/A regionCode : string? = 'N/A alt : string? = 'N/A fields : string? = 'N/A key : string? = (api-key) oauth_token : string? = 'N/A prettyPrint : string? = 'N/A quotaUser : string? = 'N/A userIp : string? = 'N/A
part: One or more parts to return on the current request.
id: IDs of the categories to be returned.
contentOwnerId: The authenticated user acts on behalf of this content owner.
hl: Language used for the title of the categories.
regionCode: Return all the categories in this region.