Using the YouTube Data API

The YouTube Data API offers read and write access to YouTube's content. Users can perform unauthenticated requests to Google Data feeds to retrieve feeds of popular videos, comments, public information about YouTube user profiles, user playlists, favorites, subscriptions and so on.

For more information on the YouTube Data API, please refer to the official » PHP Developer's Guide on code.google.com.

Authentication

The YouTube Data API allows read-only access to public data, which does not require authentication. For any write requests, a user needs to authenticate either using ClientLogin or AuthSub authentication. Please refer to the » Authentication section in the PHP Developer's Guide for more detail.

Developer Keys and Client ID

A developer key identifies the YouTube developer that is submitting an API request. A client ID identifies your application for logging and debugging purposes. Please visit » http://code.google.com/apis/youtube/dashboard/ to obtain a developer key and client ID. The example below demonstrates how to pass the developer key and client ID to the » Zend_Gdata_YouTube service object.

Example #1 Passing a Developer Key and ClientID to Zend_Gdata_YouTube

  1. $yt = new Zend_Gdata_YouTube($httpClient,
  2.                              $applicationId,
  3.                              $clientId,
  4.                              $developerKey);

Retrieving public video feeds

The YouTube Data API provides numerous feeds that return a list of videos, such as standard feeds, related videos, video responses, user's uploads, and user's favorites. For example, the user's uploads feed returns all videos uploaded by a specific user. See the » YouTube API reference guide for a detailed list of available feeds.

Searching for videos by metadata

You can retrieve a list of videos that match specified search criteria, using the YouTubeQuery class. The following query looks for videos which contain the word "cat" in their metadata, starting with the 10th video and displaying 20 videos per page, ordered by the view count.

Example #2 Searching for videos

  1. $yt = new Zend_Gdata_YouTube();
  2. $query = $yt->newVideoQuery();
  3. $query->videoQuery = 'cat';
  4. $query->startIndex = 10;
  5. $query->maxResults = 20;
  6. $query->orderBy = 'viewCount';
  7.  
  8. echo $query->queryUrl . "\n";
  9. $videoFeed = $yt->getVideoFeed($query);
  10.  
  11. foreach ($videoFeed as $videoEntry) {
  12.     echo "---------VIDEO----------\n";
  13.     echo "Title: " . $videoEntry->getVideoTitle() . "\n";
  14.     echo "\nDescription:\n";
  15.     echo $videoEntry->getVideoDescription();
  16.     echo "\n\n\n";
  17. }

For more details on the different query parameters, please refer to the » Reference Guide. The available helper functions in » Zend_Gdata_YouTube_VideoQuery for each of these parameters are described in more detail in the » PHP Developer's Guide.

Searching for videos by categories and tags/keywords

Searching for videos in specific categories is done by generating a » specially formatted URL. For example, to search for comedy videos which contain the keyword dog:

Example #3 Searching for videos in specific categories

  1. $yt = new Zend_Gdata_YouTube();
  2. $query = $yt->newVideoQuery();
  3. $query->category = 'Comedy/dog';
  4.  
  5. echo $query->queryUrl . "\n";
  6. $videoFeed = $yt->getVideoFeed($query);

Retrieving standard feeds

The YouTube Data API has a number of » standard feeds. These standard feeds can be retrieved as » Zend_Gdata_YouTube_VideoFeed objects using the specified URLs, using the predefined constants within the » Zend_Gdata_YouTube class (Zend_Gdata_YouTube::STANDARD_TOP_RATED_URI for example) or using the predefined helper methods (see code listing below).

To retrieve the top rated videos using the helper method:

Example #4 Retrieving a standard video feed

  1. $yt = new Zend_Gdata_YouTube();
  2. $videoFeed = $yt->getTopRatedVideoFeed();

There are also query parameters to specify the time period over which the standard feed is computed.

For example, to retrieve the top rated videos for today:

Example #5 Using a Zend_Gdata_YouTube_VideoQuery to Retrieve Videos

  1. $yt = new Zend_Gdata_YouTube();
  2. $query = $yt->newVideoQuery();
  3. $query->setTime('today');
  4. $videoFeed = $yt->getTopRatedVideoFeed($query);

Alternatively, you could just retrieve the feed using the URL:

Example #6 Retrieving a video feed by URL

  1. $yt = new Zend_Gdata_YouTube();
  2. $url = 'http://gdata.youtube.com/feeds/standardfeeds/top_rated?time=today'
  3. $videoFeed = $yt->getVideoFeed($url);

Retrieving videos uploaded by a user

You can retrieve a list of videos uploaded by a particular user using a simple helper method. This example retrieves videos uploaded by the user 'liz'.

Example #7 Retrieving videos uploaded by a specific user

  1. $yt = new Zend_Gdata_YouTube();
  2. $videoFeed = $yt->getUserUploads('liz');

Retrieving videos favorited by a user

You can retrieve a list of a user's favorite videos using a simple helper method. This example retrieves videos favorited by the user 'liz'.

Example #8 Retrieving a user's favorite videos

  1. $yt = new Zend_Gdata_YouTube();
  2. $videoFeed = $yt->getUserFavorites('liz');

Retrieving video responses for a video

You can retrieve a list of a video's video responses using a simple helper method. This example retrieves video response for a video with the ID 'abc123813abc'.

Example #9 Retrieving a feed of video responses

  1. $yt = new Zend_Gdata_YouTube();
  2. $videoFeed = $yt->getVideoResponseFeed('abc123813abc');

Retrieving video comments

The comments for each YouTube video can be retrieved in several ways. To retrieve the comments for the video with the ID 'abc123813abc', use the following code:

Example #10 Retrieving a feed of video comments from a video ID

  1. $yt = new Zend_Gdata_YouTube();
  2. $commentFeed = $yt->getVideoCommentFeed('abc123813abc');
  3.  
  4. foreach ($commentFeed as $commentEntry) {
  5.     echo $commentEntry->title->text . "\n";
  6.     echo $commentEntry->content->text . "\n\n\n";
  7. }

Comments can also be retrieved for a video if you have a copy of the » Zend_Gdata_YouTube_VideoEntry object:

Example #11 Retrieving a Feed of Video Comments from a Zend_Gdata_YouTube_VideoEntry

  1. $yt = new Zend_Gdata_YouTube();
  2. $videoEntry = $yt->getVideoEntry('abc123813abc');
  3. // we don't know the video ID in this example, but we do have the URL
  4. $commentFeed = $yt->getVideoCommentFeed(null,
  5.                                         $videoEntry->comments->href);

Retrieving playlist feeds

The YouTube Data API provides information about users, including profiles, playlists, subscriptions, and more.

Retrieving the playlists of a user

The library provides a helper method to retrieve the playlists associated with a given user. To retrieve the playlists for the user 'liz':

Example #12 Retrieving the playlists of a user

  1. $yt = new Zend_Gdata_YouTube();
  2. $playlistListFeed = $yt->getPlaylistListFeed('liz');
  3.  
  4. foreach ($playlistListFeed as $playlistEntry) {
  5.     echo $playlistEntry->title->text . "\n";
  6.     echo $playlistEntry->description->text . "\n";
  7.     echo $playlistEntry->getPlaylistVideoFeedUrl() . "\n\n\n";
  8. }

Retrieving a specific playlist

The library provides a helper method to retrieve the videos associated with a given playlist. To retrieve the playlists for a specific playlist entry:

Example #13 Retrieving a specific playlist

  1. $feedUrl = $playlistEntry->getPlaylistVideoFeedUrl();
  2. $playlistVideoFeed = $yt->getPlaylistVideoFeed($feedUrl);

Retrieving a list of a user's subscriptions

A user can have several types of subscriptions: channel subscription, tag subscription, or favorites subscription. A » Zend_Gdata_YouTube_SubscriptionEntry is used to represent individual subscriptions.

To retrieve all subscriptions for the user 'liz':

Example #14 Retrieving all subscriptions for a user

  1. $yt = new Zend_Gdata_YouTube();
  2. $subscriptionFeed = $yt->getSubscriptionFeed('liz');
  3.  
  4. foreach ($subscriptionFeed as $subscriptionEntry) {
  5.     echo $subscriptionEntry->title->text . "\n";
  6. }

Retrieving a user's profile

You can retrieve the public profile information for any YouTube user. To retrieve the profile for the user 'liz':

Example #15 Retrieving a user's profile

  1. $yt = new Zend_Gdata_YouTube();
  2. $userProfile = $yt->getUserProfile('liz');
  3. echo "username: " . $userProfile->username->text . "\n";
  4. echo "age: " . $userProfile->age->text . "\n";
  5. echo "hometown: " . $userProfile->hometown->text . "\n";

Uploading Videos to YouTube

Please make sure to review the diagrams in the » protocol guide on code.google.com for a high-level overview of the upload process. Uploading videos can be done in one of two ways: either by uploading the video directly or by sending just the video meta-data and having a user upload the video through an HTML form.

In order to upload a video directly, you must first construct a new » Zend_Gdata_YouTube_VideoEntry object and specify some required meta-data. The following example shows uploading the Quicktime video "mytestmovie.mov" to YouTube with the following properties:

Metadata used in the code-sample below
Property Value
Title My Test Movie
Category Autos
Keywords cars, funny
Description My description
Filename mytestmovie.mov
File MIME type video/quicktime
Video private? FALSE
Video location 37, -122 (lat, long)
Developer Tags mydevelopertag, anotherdevelopertag

The code below creates a blank » Zend_Gdata_YouTube_VideoEntry to be uploaded. A » Zend_Gdata_App_MediaFileSource object is then used to hold the actual video file. Under the hood, the » Zend_Gdata_YouTube_Extension_MediaGroup object is used to hold all of the video's meta-data. Our helper methods detailed below allow you to just set the video meta-data without having to worry about the media group object. The $uploadUrl is the location where the new entry gets posted to. This can be specified either with the $userName of the currently authenticated user, or, alternatively, you can simply use the string 'default' to refer to the currently authenticated user.

Example #16 Uploading a video

  1. $yt = new Zend_Gdata_YouTube($httpClient);
  2. $myVideoEntry = new Zend_Gdata_YouTube_VideoEntry();
  3.  
  4. $filesource = $yt->newMediaFileSource('mytestmovie.mov');
  5. $filesource->setContentType('video/quicktime');
  6. $filesource->setSlug('mytestmovie.mov');
  7.  
  8. $myVideoEntry->setMediaSource($filesource);
  9.  
  10. $myVideoEntry->setVideoTitle('My Test Movie');
  11. $myVideoEntry->setVideoDescription('My Test Movie');
  12. // Note that category must be a valid YouTube category !
  13. $myVideoEntry->setVideoCategory('Comedy');
  14.  
  15. // Set keywords, note that this must be a comma separated string
  16. // and that each keyword cannot contain whitespace
  17. $myVideoEntry->SetVideoTags('cars, funny');
  18.  
  19. // Optionally set some developer tags
  20. $myVideoEntry->setVideoDeveloperTags(array('mydevelopertag',
  21.                                            'anotherdevelopertag'));
  22.  
  23. // Optionally set the video's location
  24. $yt->registerPackage('Zend_Gdata_Geo');
  25. $yt->registerPackage('Zend_Gdata_Geo_Extension');
  26. $where = $yt->newGeoRssWhere();
  27. $position = $yt->newGmlPos('37.0 -122.0');
  28. $where->point = $yt->newGmlPoint($position);
  29. $myVideoEntry->setWhere($where);
  30.  
  31. // Upload URI for the currently authenticated user
  32. $uploadUrl =
  33.     'http://uploads.gdata.youtube.com/feeds/users/default/uploads';
  34.  
  35. // Try to upload the video, catching a Zend_Gdata_App_HttpException
  36. // if availableor just a regular Zend_Gdata_App_Exception
  37.  
  38. try {
  39.     $newEntry = $yt->insertEntry($myVideoEntry,
  40.                                  $uploadUrl,
  41.                                  'Zend_Gdata_YouTube_VideoEntry');
  42. } catch (Zend_Gdata_App_HttpException $httpException) {
  43.     echo $httpException->getRawResponseBody();
  44. } catch (Zend_Gdata_App_Exception $e) {
  45.     echo $e->getMessage();
  46. }

To upload a video as private, simply use: $myVideoEntry->setVideoPrivate(); prior to performing the upload. $videoEntry->isVideoPrivate() can be used to check whether a video entry is private or not.

Browser-based upload

Browser-based uploading is performed almost identically to direct uploading, except that you do not attach a » Zend_Gdata_App_MediaFileSource object to the » Zend_Gdata_YouTube_VideoEntry you are constructing. Instead you simply submit all of your video's meta-data to receive back a token element which can be used to construct an HTML upload form.

Example #17 Browser-based upload

  1. $yt = new Zend_Gdata_YouTube($httpClient);
  2.  
  3. $myVideoEntry= new Zend_Gdata_YouTube_VideoEntry();
  4. $myVideoEntry->setVideoTitle('My Test Movie');
  5. $myVideoEntry->setVideoDescription('My Test Movie');
  6.  
  7. // Note that category must be a valid YouTube category
  8. $myVideoEntry->setVideoCategory('Comedy');
  9. $myVideoEntry->SetVideoTags('cars, funny');
  10.  
  11. $tokenHandlerUrl = 'http://gdata.youtube.com/action/GetUploadToken';
  12. $tokenArray = $yt->getFormUploadToken($myVideoEntry, $tokenHandlerUrl);
  13. $tokenValue = $tokenArray['token'];
  14. $postUrl = $tokenArray['url'];

The above code prints out a link and a token that is used to construct an HTML form to display in the user's browser. A simple example form is shown below with $tokenValue representing the content of the returned token element, as shown being retrieved from $myVideoEntry above. In order for the user to be redirected to your website after submitting the form, make sure to append a $nextUrl parameter to the $postUrl above, which functions in the same way as the $next parameter of an AuthSub link. The only difference is that here, instead of a single-use token, a status and an id variable are returned in the URL.

Example #18 Browser-based upload: Creating the HTML form

  1. // place to redirect user after upload
  2. $nextUrl = 'http://mysite.com/youtube_uploads';
  3.  
  4. $form = '<form action="'. $postUrl .'?nexturl='. $nextUrl .
  5.         '" method="post" enctype="multipart/form-data">'.
  6.         '<input name="file" type="file"/>'.
  7.         '<input name="token" type="hidden" value="'. $tokenValue .'"/>'.
  8.         '<input value="Upload Video File" type="submit" />'.
  9.         '</form>';

Checking upload status

After uploading a video, it will immediately be visible in an authenticated user's uploads feed. However, it will not be public on the site until it has been processed. Videos that have been rejected or failed to upload successfully will also only be in the authenticated user's uploads feed. The following code checks the status of a » Zend_Gdata_YouTube_VideoEntry to see if it is not live yet or if it has been rejected.

Example #19 Checking video upload status

  1. try {
  2.     $control = $videoEntry->getControl();
  3. } catch (Zend_Gdata_App_Exception $e) {
  4.     echo $e->getMessage();
  5. }
  6.  
  7. if ($control instanceof Zend_Gdata_App_Extension_Control) {
  8.     if ($control->getDraft() != null &&
  9.         $control->getDraft()->getText() == 'yes') {
  10.         $state = $videoEntry->getVideoState();
  11.  
  12.         if ($state instanceof Zend_Gdata_YouTube_Extension_State) {
  13.             print 'Upload status: '
  14.                   . $state->getName()
  15.                   .' '. $state->getText();
  16.         } else {
  17.             print 'Not able to retrieve the video status information'
  18.                   .' yet. ' . "Please try again shortly.\n";
  19.         }
  20.     }
  21. }

Other Functions

In addition to the functionality described above, the YouTube API contains many other functions that allow you to modify video meta-data, delete video entries and use the full range of community features on the site. Some of the community features that can be modified through the API include: ratings, comments, playlists, subscriptions, user profiles, contacts and messages.

Please refer to the full documentation available in the » PHP Developer's Guide on code.google.com.

blog comments powered by Disqus