Implementierung: Playlists

In den folgenden Beispielen wird gezeigt, wie du mit der YouTube Data API (Version 3) Funktionen im Zusammenhang mit Playlists und Playlist-Elementen ausführen kannst.

Playlists des aktuellen Nutzers abrufen

Rufe die Methode playlists.list auf, um die Playlists des aktuell authentifizierten Nutzers abzurufen. Legen Sie in Ihrer Anfrage den Wert des Parameters mine auf true fest. Eine Anfrage, die den Parameter mine verwendet, muss mit OAuth 2.0 autorisiert werden.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &mine=true

Playlists eines Nutzers abrufen

In diesem Beispiel werden die Playlists abgerufen, die von einem bestimmten Kanal erstellt wurden. Das Beispiel umfasst zwei Schritte:

Informationen zu einer bestimmten Playlist abrufen

Wenn du Informationen zu einer oder mehreren bestimmten Playlists abrufen möchtest, rufe die Methode playlists.list auf und setze den Parameter id auf eine durch Kommas getrennte Liste von YouTube-Playlist-IDs, die die gewünschten Ressourcen identifizieren. Ein häufiger Anwendungsfall für diese Funktion ist die Abfrage zusätzlicher Informationen zu einer Gruppe von Playlists, die in einer Reihe von Suchergebnissen zurückgegeben werden. Du kannst beispielsweise die Anzahl der Elemente in jeder Playlist abrufen.

In der folgenden Anfrage wird die Methode playlists.list aufgerufen, um die Anzahl der Elemente in zwei Playlists abzurufen, die mit dem Suchbegriff „GoogleDevelopers“ übereinstimmen. Diese Informationen befinden sich im Attribut contentDetails.itemCount der Ressource playlist. Daher wird in der Anfrage der Parameterwert part auf contentDetails festgelegt. 

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=contentDetails
        &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w

Playlist hinzufügen

In diesem Beispiel wird die Methode playlists.insert aufgerufen, um eine private Playlist auf dem Kanal des authentifizierten Nutzers zu erstellen. Alle API-Anfragen an diese Methode müssen mit OAuth 2.0 autorisiert werden.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert?
        part=snippet,status

Über den Link zum APIs Explorer wird auch ein Parameter festgelegt, der den Textkörper der API-Anfrage angibt. Der Anfragetext enthält eine playlist-Ressource, die Informationen wie den Titel, die Beschreibung und den Datenschutzstatus der Playlist definiert. In diesem Beispiel lautet der Anfragetext:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "private"
  }
}

Im folgenden Beispiel wird die neue Playlist als Podcast-Serie gekennzeichnet:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

Weitere Codebeispiele: Java, JavaScript, .NET, PHP, Python

Playlist aktualisieren

In diesem Beispiel wird der Datenschutzstatus einer Playlist von private auf public aktualisiert. Das Beispiel umfasst zwei Schritte:

  • Schritt 1: Playlist-ID abrufen

    Rufe die Methode playlists.list auf, um die Playlists im Kanal des aktuell authentifizierten Nutzers abzurufen. Die obige Beispielanfrage zum Abrufen der Playlists des aktuellen Nutzers veranschaulicht diese Anfrage. Die Anwendung, die die API aufruft, kann die API-Antwort verarbeiten, um eine Liste von Playlists anzuzeigen, wobei die ID der einzelnen Playlist als Schlüssel verwendet wird.

  • Schritt 2: Playlist aktualisieren

    Rufe die Methode playlists.update auf, um eine bestimmte Playlist zu ändern. Für diese Methode ist ein gültiges OAuth 2.0-Autorisierungstoken erforderlich.

    Der Anfragetext muss den Teil snippet der Ressource playlist enthalten, da das Attribut snippet.title beim Aufrufen dieser Methode erforderlich ist. Wenn für die aktualisierte Playlist-Ressource Werte für die Properties snippet.description oder snippet.tags angegeben sind, müssen diese Werte in der Aktualisierungsanfrage neu angegeben werden, da sie andernfalls gelöscht werden.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
        part=snippet,status

    Wie im Beispiel oben zum Hinzufügen einer Playlist wird über den Link zum APIs Explorer ein Parameter festgelegt, der den Textkörper der API-Anfrage angibt. Der Anfragetext enthält eine playlist-Ressource, die Informationen wie den Titel, die Beschreibung und den Datenschutzstatus der Playlist definiert. In diesem Beispiel wird der folgende Anfragetext verwendet:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}

    Im folgenden Beispiel wird die Playlist als Podcast gekennzeichnet:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

    Hinweis:Wenn du diese Abfrage im APIs Explorer testest, musst du im Ressourcentext eine gültige Playlist-ID einfügen. Wenn du eine Playlist-ID abrufen möchtest, empfehlen wir dir, zuerst die oben gezeigte Anfrage zum Hinzufügen einer Playlist auszuführen. Erfasse die Playlist-ID aus der API-Antwort und verwende diesen Wert für die Playlist, die du aktualisieren möchtest. Der Titel und die Beschreibung der Playlist in diesem Beispiel sind mit denen in diesem Beispiel identisch.

Playlist-Element hinzufügen

In diesem Beispiel wird einer Playlist ein Element hinzugefügt. Diese Anfrage muss mit OAuth 2.0 autorisiert werden. Dieses Beispiel umfasst zwei Schritte:

  • Schritt 1: Playlist-ID abrufen

    Rufe die Methode playlists.list auf, um die Playlists im Kanal des aktuell authentifizierten Nutzers abzurufen. Die obige Beispielanfrage zum Abrufen der Playlists des aktuellen Nutzers veranschaulicht diese Anfrage. Die Anwendung, die die API aufruft, kann die API-Antwort verarbeiten, um eine Liste von Playlists anzuzeigen, wobei die ID der einzelnen Playlist als Schlüssel verwendet wird.

  • Schritt 2: Playlist ein Video hinzufügen

    Rufe die Methode playlistItems.insert auf, um der Playlist ein Video hinzuzufügen. Diese Anfrage muss mit OAuth 2.0 autorisiert werden. Der Anfragetext ist eine playlistItem-Ressource, die mindestens die folgenden Werte angibt:

    • Mit snippet.playlistId wird die Playlist angegeben, der du das Video hinzufügst. Das ist die Playlist-ID, die du in Schritt 1 erhalten hast.
    • snippet.resourceId.kind enthält den Wert youtube#video.
    • Mit snippet.resourceId.videoId wird das Video identifiziert, das du der Playlist hinzufügst. Der Property-Wert ist eine eindeutige YouTube-Video-ID.

    Mit der folgenden API-Anfrage wird einer Playlist ein Video hinzugefügt. Der Anfragetext lautet:

    {
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    }
  }
}

    Um die Anfrage in APIs Explorer abzuschließen, müssen Sie Werte für die Eigenschaften snippet.playlistId und snippet.resourceId.videoId festlegen.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
        part=snippet

    Hinweis:In der Dokumentation zur Methode playlistItems.insert werden die anderen Attributwerte aufgeführt, die du beim Hinzufügen eines Playlist-Elements festlegen kannst.

Playlist-Bild hinzufügen

Mit der Methode playlistImages.insert der V3 API kannst du ein benutzerdefiniertes Thumbnail-Bild hochladen und für eine Playlist festlegen. In deiner Anfrage gibt der Wert des Parameters playlistId die Playlist an, für die das Thumbnail verwendet werden soll.

Diese Abfrage kann nicht mit dem APIs Explorer getestet werden, da der APIs Explorer das Hochladen von Mediendateien nicht unterstützt, was für diese Methode erforderlich ist.

Playlist-Element aktualisieren

In diesem Beispiel wird ein Playlist-Element so aktualisiert, dass es das erste Element in der Playlist ist. Diese Anfrage muss mit OAuth 2.0 autorisiert werden. Dieses Beispiel umfasst drei Schritte:

  • Schritt 1: Playlist-ID abrufen

    Rufe die Methode playlists.list auf, um die Playlists im Kanal des aktuell authentifizierten Nutzers abzurufen. Die obige Beispielanfrage zum Abrufen der Playlists des aktuellen Nutzers veranschaulicht diese Anfrage. Die Anwendung, die die API aufruft, kann die API-Antwort verarbeiten, um eine Liste von Playlists anzuzeigen, wobei die ID der einzelnen Playlist als Schlüssel verwendet wird.

  • Schritt 2: Elemente in der ausgewählten Playlist abrufen

    Rufe die Methode playlistItems.list auf, um die Liste der Videos in der ausgewählten Playlist abzurufen. Lege als Wert für den Parameter playlistId die Playlist-ID fest, die du in Schritt 1 erhalten hast.

    Jede Ressource in der API-Antwort enthält das Attribut id, das die Playlist-Element-ID angibt, mit der sich das Element eindeutig identifizieren lässt. Mit diesem Wert entfernen Sie im nächsten Schritt ein Element aus der Liste.

  • Schritt 3: Ausgewähltes Playlist-Element aktualisieren

    Rufe die Methode playlistItems.update auf, um die Position des Videos in der Playlist zu ändern. Legen Sie den Parameterwert part auf snippet fest. Der Anfragetext muss eine playlistItem-Ressource sein, für die mindestens die folgenden Werte festgelegt sind:

    • Lege die Property id auf die Playlist-Element-ID fest, die du in Schritt 2 erhalten hast.
    • Legen Sie die Property snippet.playlistId auf die in Schritt 1 ermittelte Playlist-ID fest.
    • Legen Sie die Property snippet.resourceId.kind auf youtube#video fest.
    • Lege für die Property „snippet.resourceId.videoId“ die Video-ID fest, mit der das in der Playlist enthaltene Video eindeutig identifiziert wird.
    • Legen Sie die Eigenschaft snippet.position auf 0 oder auf die Position fest, an der das Element angezeigt werden soll (mit einem Index, der auf 0 basiert).

    Mit der folgenden API-Anfrage wird ein Playlist-Element zum ersten Element in einer Playlist aktualisiert. Der Anfragetext lautet:

    {
  "id": "PLAYLIST_ITEM_ID",
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    },
    "position": 0
  }
}

    Um die Anfrage im APIs Explorer abzuschließen, müssen Sie Werte für die Eigenschaften id, snippet.playlistId und snippet.resourceId.videoId festlegen.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet

Playlist-Bild aktualisieren

Mit der Methode playlistImages.update der V3 API kannst du das Thumbnail einer Playlist aktualisieren. In deiner Anfrage gibt der Wert des Parameters playlistId die Playlist an, für die das Thumbnail verwendet werden soll.

Diese Abfrage kann nicht mit dem APIs Explorer getestet werden, da der APIs Explorer das Hochladen von Mediendateien nicht unterstützt, was für diese Methode erforderlich ist.

Playlist-Element entfernen

In diesem Beispiel wird ein Video aus einer Playlist gelöscht. Diese Anfrage muss mit OAuth 2.0 autorisiert werden. Dieses Beispiel umfasst drei Schritte. Die ersten beiden Schritte sind mit denen im Beispiel oben zum Aktualisieren eines Playlist-Elements identisch.

Rufe danach die Methode playlistItems.delete auf, um ein Video aus der Playlist zu entfernen. Lege den Parameter id der Anfrage auf die Playlist-Element-ID des Elements fest, das du entfernen möchtest. Diese Anfrage muss mit OAuth 2.0 autorisiert werden.

Die Playlist-Element-ID, mit der ein Video in einer Playlist identifiziert wird, unterscheidet sich von der YouTube-Video-ID, die das Video eindeutig identifiziert. Die Playlist-Element-ID identifiziert das Video als Element in einer bestimmten Playlist.

Um die Anfrage im APIs Explorer abzuschließen, müssen Sie den Wert der Property id festlegen.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete?
        id=PLAYLIST_ITEM_ID

Playlistbild entfernen

In diesem Beispiel wird ein Playlist-Bild gelöscht. Das Beispiel umfasst zwei Schritte:

  • Schritt 1: Playlist abrufen

    Rufe die Methode playlists.list auf, um die Playlists im Kanal des aktuell authentifizierten Nutzers abzurufen. Die obige Beispielanfrage zum Abrufen der Playlists des aktuellen Nutzers veranschaulicht diese Anfrage. Die Anwendung, die die API aufruft, kann die API-Antwort verarbeiten, um eine Liste von Playlists anzuzeigen, wobei die ID der einzelnen Playlist als Schlüssel verwendet wird.

  • Schritt 2: Bild-ID der Playlist abrufen

    Rufe die Methode playlistImages.list auf, um das Thumbnail-Bild einer Playlist abzurufen. Verwende die Playlist-ID der Playlist, die du ändern möchtest.

  • Schritt 3: Playlist-Bild löschen

    Rufe die Methode playlistImages.delete auf, um ein bestimmtes Playlist-Bild zu löschen. In der Anfrage gibt der Parameter id die ID des zu löschenden Playlist-Bilds an. Für diese Methode ist ein gültiges OAuth 2.0-Autorisierungstoken erforderlich. Wenn du diese Abfrage im API Explorer testest, musst du den Parameterwert id durch eine gültige Playlist-ID ersetzen.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete?
        id=ID

    Hinweis:Wenn du diese Abfrage im APIs Explorer testest, musst du den Parameterwert id durch eine gültige Playlist-Bild-ID ersetzen.

Playlist entfernen

In diesem Beispiel wird eine Playlist gelöscht. Das Beispiel umfasst zwei Schritte:

  • Schritt 1: Playlist-ID abrufen

    Rufe die Methode playlists.list auf, um die Playlists im Kanal des aktuell authentifizierten Nutzers abzurufen. Die obige Beispielanfrage zum Abrufen der Playlists des aktuellen Nutzers veranschaulicht diese Anfrage. Die Anwendung, die die API aufruft, kann die API-Antwort verarbeiten, um eine Liste von Playlists anzuzeigen, wobei die ID der einzelnen Playlist als Schlüssel verwendet wird.

  • Schritt 2: Playlist löschen

    Rufe die Methode playlists.delete auf, um eine bestimmte Playlist zu löschen. In der Anfrage gibt der Parameter id die Playlist-ID der zu löschenden Playlist an. Für diese Methode ist ein gültiges OAuth 2.0-Autorisierungstoken erforderlich. Wenn du diese Abfrage im API Explorer testest, musst du den Parameterwert id durch eine gültige Playlist-ID ersetzen.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
        id=PLAYLIST_ID

    Hinweis:Wenn du diese Abfrage in APIs Explorer testest, musst du den Parameterwert id durch eine gültige Playlist-ID ersetzen. Wenn du eine Playlist-ID abrufen möchtest, empfehlen wir dir, zuerst die oben gezeigte Anfrage zum Hinzufügen einer Playlist auszuführen. Erfasse die Playlist-ID aus der API-Antwort und verwende diesen Wert für die Playlist, die du löschen möchtest.