PHP-Kurzanleitung

In dieser Kurzanleitung wird beschrieben, wie Sie eine einfache PHP-Befehlszeilenanwendung einrichten, die Anfragen an die YouTube Data API sendet. In dieser Kurzanleitung wird beschrieben, wie Sie zwei API-Anfragen stellen:

  1. Sie verwenden einen API-Schlüssel, der Ihre Anwendung identifiziert, um Informationen zum YouTube-Kanal GoogleDevelopers abzurufen.
  2. Sie verwenden eine OAuth 2.0-Client-ID, um eine autorisierte Anfrage zu senden, mit der Informationen zu Ihrem eigenen YouTube-Kanal abgerufen werden.

Vorbereitung

Für diese Kurzanleitung benötigen Sie Folgendes:

  • PHP 5.4 oder höher mit installierter Befehlszeile (Command Line Interface, CLI) und JSON-Erweiterung.
  • Das Composer-Tool zur Abhängigkeitsverwaltung ist global installiert {: target="_blank"}.
  • Die Google APIs-Clientbibliothek für PHP:
    • Wenn Sie die Clientbibliothek noch nicht installiert haben: 
      composer require google/apiclient:^2.0
    • Wenn Sie die Clientbibliothek bereits installiert haben, empfehlen wir, sie zu aktualisieren, damit Sie die neuesten Klassen für die Bibliothek haben, die Sie testen: 
      composer update google/apiclient --with-dependencies

Schritt 1: Projekt und Anmeldedaten einrichten

Erstellen oder wählen Sie ein Projekt in der API Console aus. Führen Sie in der API Console die folgenden Aufgaben für Ihr Projekt aus:

  1. Suchen Sie in der Bibliothek nach der YouTube Data API v3. Klicken Sie auf den Eintrag für diese API und prüfen Sie, ob die API für Ihr Projekt aktiviert ist.

  2. Erstellen Sie im Bereich „Anmeldedaten“ zwei Anmeldedaten:

    1. API-Schlüssel erstellen Sie verwenden den API-Schlüssel, um API-Anfragen zu stellen, für die keine Nutzerautorisierung erforderlich ist. So benötigen Sie beispielsweise keine Nutzerautorisierung, um Informationen zu einem öffentlichen YouTube-Kanal abzurufen.

    2. OAuth 2.0-Client-ID erstellen Setzen Sie den Anwendungstyp auf Sonstiges. Für Anfragen, die eine Nutzerautorisierung erfordern, müssen Sie OAuth 2.0-Anmeldedaten verwenden. Sie benötigen beispielsweise eine Nutzerautorisierung, um Informationen zum YouTube-Kanal des aktuell authentifizierten Nutzers abzurufen.

      Laden Sie die JSON-Datei mit Ihren OAuth 2.0-Anmeldedaten herunter. Die Datei hat einen Namen wie client_secret_CLIENTID.json, wobei CLIENTID die Client-ID für Ihr Projekt ist.

Schritt 2: Beispiel einrichten und ausführen

Verwenden Sie das APIs Explorer-Widget in der Seitenleiste, um Beispielcode zum Abrufen von Informationen zum YouTube-Kanal „GoogleDevelopers“ zu erhalten. Bei dieser Anfrage wird ein API-Schlüssel verwendet, um Ihre Anwendung zu identifizieren. Sie erfordert keine Nutzerautorisierung oder spezielle Berechtigungen des Nutzers, der das Beispiel ausführt.

  1. Öffnen Sie die Dokumentation für die Methode channels.list der API.

  2. Auf dieser Seite finden Sie im Abschnitt „Häufige Anwendungsfälle“ eine Tabelle, in der verschiedene gängige Verwendungsarten der Methode beschrieben werden. Der erste Eintrag in der Tabelle bezieht sich auf die Auflistung von Ergebnissen nach Channel-ID.

    Klicken Sie auf das Codesymbol für den ersten Eintrag, um den Vollbild-APIs Explorer zu öffnen und auszufüllen.

    Bild, auf dem die Position des Links zum Codesymbol in der Tabelle mit Anwendungsfällen für die Dokumentation zu channels.list zu sehen ist. Der Alt-Text für dieses Bild identifiziert das Bild als Codesymbol und gibt den mit diesem Link verbundenen Anwendungsfall an.

  3. Auf der linken Seite des Vollbild-APIs Explorer wird Folgendes angezeigt:

    1. Unter der Überschrift Request parameters (Anfrageparameter) finden Sie eine Liste der Parameter, die von der Methode unterstützt werden. Die Parameterwerte part und id sollten festgelegt werden. Der Parameterwert id, UC_x5XG1OV2P6uZZ5FSM9Ttw, ist die ID für den YouTube-Kanal GoogleDevelopers.

    2. Unter den Parametern befindet sich der Abschnitt Anmeldedaten. Im Drop-down-Menü in diesem Bereich sollte der Wert API-Schlüssel angezeigt werden. Im APIs Explorer werden standardmäßig Demozugangsdaten verwendet, um den Einstieg zu erleichtern. Sie verwenden jedoch Ihren eigenen API-Schlüssel, um das Beispiel lokal auszuführen.

      Bild, das die Anmeldedaten im Vollbild-APIs Explorer und das Drop-down-Menü mit der ausgewählten Option „API-Schlüssel“ zeigt.

  4. Rechts im Vollbild-API Explorer werden Tabs mit Codebeispielen in verschiedenen Sprachen angezeigt. Wählen Sie den Tab PHP aus.

  5. Kopieren Sie das Codebeispiel und speichern Sie es in einer Datei mit dem Namen example.php.

  6. Suchen Sie in dem heruntergeladenen Beispiel nach dem String YOUR_API_KEY und ersetzen Sie ihn durch den API-Schlüssel, den Sie in Schritt 1 dieser Kurzanleitung erstellt haben.

  7. Führen Sie das Beispiel über die Befehlszeile aus. Führen Sie in Ihrem Arbeitsverzeichnis folgenden Befehl aus:

    php example.php

  8. Das Beispiel sollte die Anfrage ausführen und die Antwort in STDOUT ausgeben.

Schritt 3: Autorisierte Anfrage ausführen

In diesem Schritt ändern Sie das Codebeispiel so, dass anstelle von Informationen zum YouTube-Kanal „GoogleDevelopers“ Informationen zu Ihrem YouTube-Kanal abgerufen werden. Für diese Anfrage ist eine Nutzerautorisierung erforderlich.

  1. Kehren Sie zur Dokumentation für die Methode channels.list der API zurück.

  2. Klicken Sie im Abschnitt „Häufige Anwendungsfälle“ auf das Codesymbol für den dritten Eintrag in der Tabelle. In diesem Anwendungsfall wird die Methode list für „mychannel“ aufgerufen.

  3. Auf der linken Seite des Vollbild-APIs Explorer sehen Sie wieder eine Liste von Parametern, gefolgt vom Abschnitt Anmeldedaten. Es gibt jedoch zwei Änderungen im Vergleich zum Beispiel, in dem Sie Informationen zum GoogleDevelopers-Kanal abgerufen haben:

    1. Im Parameterabschnitt sollte der Parameterwert mine auf true festgelegt werden, anstatt den Parameterwert id festzulegen. Dadurch wird der API-Server angewiesen, Informationen zum Kanal des aktuell authentifizierten Nutzers abzurufen.

    2. Im Bereich Anmeldedaten sollte im Drop-down-Menü die Option für Google OAuth 2.0 ausgewählt sein.

      Wenn Sie auf den Link Bereiche anzeigen klicken, sollte außerdem der Bereich https://www.googleapis.com/auth/youtube.readonly aktiviert sein.

      Bild mit Bereichen im Vollbild-APIs Explorer und der Option zur Verwendung von „Google OAuth 2.0“-Anmeldedaten.

  4. Wählen Sie wie im vorherigen Beispiel den Tab PHP aus, kopieren Sie das Codebeispiel und speichern Sie es unter example.php.

    Suchen Sie im Code nach dem String YOUR_CLIENT_SECRET_FILE.json und ersetzen Sie ihn durch den Speicherort der Clientschlüsseldatei, die Sie in Schritt 1 dieses Schnellstarts heruntergeladen haben.

  5. Führen Sie das Beispiel über die Befehlszeile aus. Führen Sie in Ihrem Arbeitsverzeichnis folgenden Befehl aus:

    php example.php

  6. Kopieren Sie die URL aus der Konsole und öffnen Sie sie in Ihrem Browser.

    Wenn Sie noch nicht in Ihrem Google-Konto angemeldet sind, werden Sie aufgefordert, sich anzumelden. Wenn Sie in mehreren Google-Konten angemeldet sind, werden Sie aufgefordert, ein Konto für die Autorisierung auszuwählen.

  7. Klicken Sie auf die Schaltfläche, um Ihrer Anwendung Zugriff auf die in Ihrem Codebeispiel angegebenen Bereiche zu gewähren.

  8. Kopieren Sie den Autorisierungscode aus dem Browser und fügen Sie ihn in das Terminal ein. Sie können dann den Browsertab schließen, der für den Autorisierungsprozess verwendet wurde.

    Die API-Antwort sollte wieder in STDOUT ausgegeben werden.

Weitere Informationen