Verwenden der YouTube Daten API

Die YouTube Daten API bietet einen Lese- und Schreibzugriff auf YouTube Inhalte. Benutzer können nicht authentifizierte Anfragen zu Google Daten Feeds durchführen um Feeds von populären Videos, Kommentare, öffentliche Informationen über YouTube Benutzerprofilen, Benutzer PlayListen, Favoriten, Einschreibungen und so weiter zu erhalten.

Für weitere Informationen über die YouTube Daten API schauen Sie in die offizielle » PHP Entwickler Dokumentation auf code.google.com.

Authentifizierung

Die YouTube Daten API erlaubt aktuell einen nur-lesenden Zugriff auf öffentliche Daten, welcher keine Authentifizierung benötigt. Für alle schreibenden Anfragen muß sich ein Benutzer entweder mit ClientLogin oder AuthSub authentifizieren. Schauen Sie bitte in das » Kapitel über Authentifizierung in der PHP Entwickler Dokumentation für weitere Details.

Entwickler Schlüssel und Client ID

Ein Entwickler Schlüssel identifiziert den QouTube Entwickler der die API Anfrage schickt. Eine Client ID identifiziert die Anwendung für Logging und Debugging Zwecke. Schauen Sie bitte auf » http://code.google.com/apis/youtube/dashboard/ um einen Entwickler Schlüssel und eine Client ID zu erhalten. Das angefügte Beispiel demonstriert wie der Entwickler Schlüssel und die Client ID an das » Zend_Gdata_YouTube Service Pbjekt übergeben werden.

Example #1 Einen Entwicklerschlüssel und eine ClientID an Zend_Gdata_YouTube übergeben

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

Öffentliche Video Feeds empfangen

Die YouTube Daten API bietet eine Vielzahl von Feeds die eine Liste von Videos zurückgeben, wie zum Beispiel Standard Feeds, Abhängige Videos, Antworten auf Videos, Videobewertungen, Benutzer Uploads, und Benutzer Favoriten. Zum Beispiel gibt der Benutzer Upload Feed alle Videos zurück die von einem speziellen Benutzer hochgeladen wurden. Sehen Sie in den » You Tube API Referenz Guide für eine detailierte Liste aller vorhandenen Feeds.

Suchen nach Videos durch Metadaten

Man kann eine Liste von Videos erhalten die einem speziellen Suchkriterium entsprechen, indem die YouTubeQuery Klasse verwendet wird. Die folgende Abfrage schaut nach Videos welche das Wort "Katze" in Ihren Metadaten enthalten, beginnend mit dem 10ten Video und 20 Videos pro Seite anzeigt, sortiert nach der Anzahl der Ansichten.

Example #2 Suchen nach 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 "Titel: " . $videoEntry->mediaGroup->title->text . "\n";
  14.     echo "\nBeschreibung:\n";
  15.     echo $videoEntry->mediaGroup->description->text;
  16.     echo "\n\n\n";
  17. }

Für weitere Details über die verschiedenen Abfrageparameter, kann der » Referenz Guide hilfreich sein. Die vorhandenen Hilfsfunktionen in » Zend_Gdata_YouTube_VideoQuery für jeden dieser Parameter werden im » PHP Entwickler Guide detailierter beschrieben.

Suchen nach Videos durch Kategorien und Tags/Schlüsselwörter

Die Suche nach Videos in speziellen Kategorien wird durch die Erstellung einer » speziell formatierten URL durchgeführt. Um, zum Beispiel, nach Komödien-Videos zu suchen die das Schlüsselwort Hund enthalten:

Example #3 Suchen nach Videos in speziellen Kategorien

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

Standard Feeds empfangen

Die YouTube Daten API hat eine Anzahl an » Standard Feeds. Diese Standard Feeds können als » Zend_Gdata_YouTube_VideoFeed Objekte empfangen werden indem die spezifizierten URLs und die in der » Zend_Gdata_YouTube Klasse vordefinierten Konstanten (zum Beispiel Zend_Gdata_YouTube::STANDARD_TOP_RATED_URI) oder die vordefinierten Hilfsmethoden verwendet verwendet werden (siehe das Codebeispiel anbei).

Um die Top gereihten Videos zu erhalten kann die folgende Helfermethode verwendet werden:

Example #4 Empfangen eines Standard Videofeeds

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

Es gibt auch Abfrageparameter um eine Zeitperiode zu spezifizieren über die der Standardfeed berechnet wird.

Um zum Beispiel die Top gereihten Videos von Heute zu erhalten:

Example #5 Verwenden von Zend_Gdata_YouTube_VideoQuery um Videos zu empfangen

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

Alternativ kann man den Feed erhalten indem die URL verwendet wird:

Example #6 Empfangen eines Video Feeds durch die URL

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

Videos erhalten die von einem Benutzer hochgeladen wurden

Man kann eine Liste von Videos erhalten die von einem bestimmten Benutzer hochgeladen wurden indem eine einfache Helfermethode verwendet wird. Dieses Beispiel empfängt Videos die vom Benutzer 'liz' hochgeladen wurden.

Example #7 Empfangen von Videos die von einem spezifischen Benutzer hochgeladen wurden

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

Videos empfangen die von einem Benutzer bevorzugt werden

Man kann eine Liste von bevorzugten Videos eines Benutzer erhalten indem eine einfache Helfermethode verwendet wird. Dieses Beispiel empfängt Videos die vom Benutzer 'liz' bevorzugt werden.

Example #8 Empfangen von den bevorzugten Videos eines Benutzers

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

Videobewertungen für ein Video erhalten

Man kann eine Liste von Videobewertungen eines Videos erhalten indem eine einfache Helfermethode verwendet wird. Dieses Beispiel empfängt Videobewertungen für ein Video mit der ID 'abc123813abc'.

Example #9 Empfangen eines Feeds von Video Antworten

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

Videokommentare erhalten

Die Kommentare für jedes YouTube Video können auf unterschiedlichen Wegen empfangen werden. Um die Kommentare für das Video mit der ID 'abc123813abc' zu empfangen kann der folgende Code verwendet werden:

Example #10 Empfangen eines Feeds von Videokommentaren von einer 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. }

Kommentare können für ein Video auch empfangen werden wenn man eine Kopie des » Zend_Gdata_YouTube_VideoEntry Objektes hat:

Example #11 Empfangen eines Feeds von Videokommentaren von einem Zend_Gdata_YouTube_VideoEntry

  1. $yt = new Zend_Gdata_YouTube();
  2. $videoEntry = $yt->getVideoEntry('abc123813abc');
  3. // Die ID des Videos in diesem Beispiel ist unbekannt, aber wir haben die URL
  4. $commentFeed = $yt->getVideoCommentFeed(null,
  5.                                         $videoEntry->comments->href);

PlayList Feeds erhalten

Die YouTube Daten API bietet Informationen über Benutzer, inklusive Profile, PlayListen, Einschreibungen, und weitere.

Die PlayListen eines Benutzer erhalten

Die Bibliothek bietet eine Helfermethode um die PlayListen, die einem angegebenen Benutzer zugeordnet sind, zu erhalten. Um die PlayListen des Benutzers 'liz' zu erhalten kann der folgende Code verwendet werden:

Example #12 Empfangen von Playlisten eines Benutzers

  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. }

Eine spezielle PlayListe erhalten

Die Bibliothek bietet eine Helfermethode um Videos zu erhalten die mit einer gegebenen PlayListe assoziiert sind. Um die PlayListe für einen speziellen PlayList Eintrag zu erhalten kann der folgende Code verwendet werden:

Example #13 Empfangen von speziellen Playlisten

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

Eine Liste von Einschreibungen eines Benutzers erhalten

Ein Benutzer kann verschiedene Arten von Einschreibungen besitzen: Kanal Einschreibungen, Tag Einschreibungen, oder Favoriten Einschreibungen. Ein » Zend_Gdata_YouTube_SubscriptionEntry wird verwendet um individuelle Einschreibungen zu repräsentieren.

Um alle Einschreibungen für den Benutzer 'liz' zu erhalten kann der folgende Code verwendet werden:

Example #14 Empfangen aller Einschreibungen eines Benutzers

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

Ein Benutzerprofil erhalten

Die öffentlichen Profil Informationen kann man für jeden YouTube Benutzer erhalten. Um das Profil für den Benutzer 'liz' zu erhalten kann der folgende Code verwendet werden:

Example #15 Empfangen des Profils eines Benutzers

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

Videos auf YouTube hochladen

Stellen Sie sicher das Sie die Diagramme im » Protokoll Guide auf code.google.com für eine Übersicht des Upload Prozesses betrachtet haben. Das Hochladen von Videos kann auf 2 Wegen durchgeführt werden: Entweder durch das direkte Hochladen des Videos oder durch das Senden der Video Meta-Daten und indem der Benutzer das Video über ein HTML Formular hochlädt.

Um ein Video direkt hochzuladen, muß zuerst ein neues » Zend_Gdata_YouTube_VideoEntry Objekt erstellt und einige benötigte Meta-Daten spezifiziert werden. Das folgende Beispiel zeigt das Hochladen des Quicktime Videos "mytestmovie.mov" auf YouTube mit den folgenden Eigenschaften:

Metadaten die im folgenden Code-Beispiel verwendet werden
Eigenschaft Wert
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

Der folgende Code erzeugt einen leeren » Zend_Gdata_YouTube_VideoEntry der Hochgeladen werden kann. Ein » Zend_Gdata_App_MediaFileSource wird dann verwendet um die aktuelle Video Datei zu speichern. Unter der Hand wird ein » Zend_Gdata_YouTube_Extension_MediaGroup Objekt verwendet um alle Metadaten des Videos zu speichern. Die anbei beschriebenen Helfermethoden erlauben es die Metadaten des Videos zu setzen ohne das man sich um das Medien Gruppen Objekt kümmern muß. $uploadUrl ist der Ort an den der neue Eintrag gepostet wird. Er kann entweder durch $userName des aktuell authentifizierten Benutzers spezifiziert werden, oder, alternativ indem einfach der String 'default' verwendet wird um auf den aktuell authentifizierten Benutzer zu verweisen.

Example #16 Ein Video hochladen

  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. // Beachte das category eine gültige YouTube Kategorie sein muß !
  13. $myVideoEntry->setVideoCategory('Comedy');
  14.  
  15. // Setzt Keywords, beachte das es ein Komma getrennter String ist
  16. // und das keines der Schlüsselwörter ein Leerzeichen enthalten darf
  17. $myVideoEntry->SetVideoTags('cars, funny');
  18.  
  19. // Optional Entwickler Tags setzen
  20. $myVideoEntry->setVideoDeveloperTags(array('mydevelopertag',
  21.                                            'anotherdevelopertag'));
  22.  
  23. // Optional den Ort des Videos setzen
  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. // URI hochladen für den aktuell authentifizierten Benutzer
  32. $uploadUrl =
  33.     'http://uploads.gdata.youtube.com/feeds/users/default/uploads';
  34.  
  35. // Versuch das Video hochzuladen, eine Zend_Gdata_App_HttpException fangen wenn
  36. // Sie vorhanden ist oder nur eine reguläre 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. }

Um ein Video als privat hochzuladen muß einfach $myVideoEntry->setVideoPrivate(); verwendet werden; bevor das Hochladen durchgeführt wird. $videoEntry->isVideoPrivate() kann verwendet werden um zu prüfen ob ein Video Eintrag privat ist oder nicht.

Browser-basierender Upload

Browser-basierendes hochladen wird fast auf die gleiche Weise durchgeführt wie direktes Hochladen, ausser das man kein » Zend_Gdata_App_MediaFileSource Objekt an den » Zend_Gdata_YouTube_VideoEntry anhängt den man erstellt. Stattdessen überträgt man einfach alle Metadaten des Videos um ein Token Element zurück zu erhalten welches verwendet werden kann um ein HTML Upload Formular zu erstellen.

Example #17 Browser-basierender 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. // Beachte das die Kategorie eine gültige YouTube Kategorie sein muß !
  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'];

Der obige Code gibt einen Link und ein Token aus das verwendet wird um ein HTML Formular zu erstellen und im Browser des Benutzers anzuzeigen. Ein einfaches Beispielformular wird unten gezeigt mit $tokenValue welches den Inhalt des zurückgegebenen Token Elements darstellt, welches wie gezeigt, oben von $myVideoEntry empfangen wird. Damit der Benutzer, nachdem das Formular übermittelt wurde, auf die Website umgeleitet wird, muß ein $nextUrl Parameter an die $postUrl von oben angehängt werden, was auf die gleiche Weise funktioniert wie der $next Parameter eines AuthSub Links. Der einzige Unterschied ist hier das, statt eines einmal zu verwendenden Tokens, ein Status und eine ID Variable in der URL zurückgegeben werden.

Example #18 Browser-basierender Upload: Erstellen des HTML Formulars

  1. // Platzieren um den Benutzer nach dem Upload umzuleiten
  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="Video Daten hochladen" type="submit" />'.
  9.         '</form>';

Den Upload Status prüfen

Nachdem ein Video hochgeladen wurde, wird es im Upload Feed des authentifizierten Benutzer unmittelbar sichtbar sein. Trotzdem wird es auf der Site nicht öffentlich sein solange es nicht bearbeitet wurde. Videos die ausgeschlossen oder nicht erfolgreich hochgeladen wurden werden auch nur im Upload Feed des authentifizierten Benutzers sichtbar sein. Der folgende Code prüft den Status eines » Zend_Gdata_YouTube_VideoEntry um zu sehen ob er jetzt noch nicht live ist oder ob er nicht akzeptiert wurde.

Example #19 Den Status von Video Uploads checken

  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 'Die Status Informationen des Videos konnten bis jetzt nicht'
  18.                 . ' empfangen werden. Bitte versuchen Sie es etwas später'
  19.                 . ' nochmals.\n";
  20.         }
  21.     }
  22. }

Andere Funktionen

Zusätzlich zur oben beschriebenen Funktionalität, enthält die YouTube API viele andere Funktionen die es erlauben Video Metadaten zu verändern, Video Einträge zu löschen und den kompletten Bereich an Community Features der Site zu verwenden. Einige der Community Features die durch die API verändert werden können enthalten: Ratings, Kommentare, Playlisten, Einschreibungen, Benutzer Profile, Kontakte und Nachrichten.

Bitte schauen Sie in die komplette Dokumentation die im » PHP Entwickler Guide auf code.google.com zu finden ist.

blog comments powered by Disqus