Implementierung: Playlists

Die folgenden Beispiele zeigen, wie du mit der YouTube Data API (Version 3) Funktionen für Playlists und Playlist-Elemente ausführen kannst.

Playlists des aktuellen Nutzers abrufen

Mit der Methode playlists.list kannst du die Playlists des aktuell authentifizierten Nutzers abrufen. Legen Sie in der Anfrage den Wert des Parameters mine auf true fest. Anfragen mit dem Parameter mine müssen 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 besteht aus zwei Schritten:

Informationen zu einer bestimmten Playlist abrufen

Um Informationen zu einer oder mehreren Playlists abzurufen, rufe die Methode playlists.list auf und setze den Parameter id auf eine durch Kommas getrennte Liste der YouTube-Playlist-IDs, die die gewünschten Ressourcen identifizieren. Ein häufiger Anwendungsfall für diese Funktion ist eine Anfrage zum Abrufen zusätzlicher Informationen über eine Gruppe von Playlists, die in einer Reihe von Suchergebnissen zurückgegeben wird. Beispielsweise möchten Sie vielleicht die Anzahl der Elemente in jeder Playlist abrufen.

Die folgende Anfrage ruft die Methode playlists.list auf, um die Anzahl der Elemente in zwei Playlists abzurufen, die mit dem Suchbegriff „GoogleDevelopers“ übereinstimmen. Diese Information befindet sich in der Eigenschaft contentDetails.itemCount der Ressource playlist, sodass die Anfrage den Parameterwert part auf contentDetails setzt.

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 im Kanal des authentifizierten Nutzers zu erstellen. Jede API-Anfrage an diese Methode muss 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 Text der API-Anfrage angibt. Der Anfragetext enthält eine playlist-Ressource mit Informationen wie dem Titel, der Beschreibung und dem Datenschutzstatus der Playlist. In diesem Beispiel lautet der Anfragetext:

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

Ähnliche Codebeispiele: Java, JavaScript, .NET, PHP, Python

Playlist aktualisieren

In diesem Beispiel wird der Datenschutzstatus einer Playlist von private zu public geändert. Das Beispiel besteht aus zwei Schritten:

  • Schritt 1: Playlist-ID abrufen

    Rufen Sie die Methode playlist.list auf, um die Playlists im Kanal des aktuell authentifizierten Nutzers abzurufen. Die oben stehende Beispielanfrage zum Abrufen der Playlists des aktuellen Nutzers zeigt diese Anfrage. Die API, die die API aufruft, könnte die API-Antwort verarbeiten, um eine Liste von Playlists anzuzeigen, wobei die ID der jeweiligen 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 snippet-Teil der Ressource playlist enthalten, da das Attribut snippet.title beim Aufrufen dieser Methode erforderlich ist. Wenn die zu aktualisierende Playlist-Ressource Werte für die Properties snippet.description oder snippet.tags angibt, müssen diese ebenfalls in der Aktualisierungsanfrage angegeben werden. Andernfalls werden sie gelöscht.

    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 Text der API-Anfrage angibt. Der Anfragetext enthält eine playlist-Ressource mit Informationen wie dem Titel, der Beschreibung und dem Datenschutzstatus der Playlist. In diesem Beispiel wird der folgende Anfragetext verwendet:

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

    Hinweis: Wenn Sie diese Abfrage im APIs Explorer testen, müssen Sie im Ressourcentext eine gültige Playlist-ID ersetzen. Um eine Playlist-ID zu erhalten, sollten Sie zuerst die oben gezeigte Anfrage zum Hinzufügen einer Playlist ausführen. Extrahieren Sie die Playlist-ID aus der API-Antwort und verwenden Sie diesen Wert für die Playlist, die Sie aktualisieren möchten. Der in diesem Beispiel verwendete Playlist-Titel und die Beschreibung sind mit dem in diesem Beispiel verwendeten 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 besteht aus zwei Schritten:

  • Schritt 1: Passende Playlist-ID abrufen

    Rufen Sie die Methode playlist.list auf, um die Playlists im Kanal des aktuell authentifizierten Nutzers abzurufen. Die oben stehende Beispielanfrage zum Abrufen der Playlists des aktuellen Nutzers zeigt diese Anfrage. Die API, die die API aufruft, könnte die API-Antwort verarbeiten, um eine Liste von Playlists anzuzeigen, wobei die ID der jeweiligen Playlist als Schlüssel verwendet wird.

  • Schritt 2: Video zur Playlist 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:

    • snippet.playlistId gibt die Playlist an, zu der du das Video hinzufügst. Dies ist die Playlist-ID, die Sie in Schritt 1 erhalten haben.
    • snippet.resourceId.kind enthält den Wert youtube#video.
    • Das snippet.resourceId.videoId identifiziert das Video, das du der Playlist hinzufügst. Der Property-Wert ist eine eindeutige YouTube-Video-ID.

    Durch die folgende API-Anfrage wird ein Video zu einer Playlist hinzugefügt. Der Anfragetext lautet:

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

    Zum Abschließen der Anfrage im APIs Explorer müssen Sie Werte für die Attribute 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 sind die anderen Property-Werte aufgeführt, die du beim Hinzufügen eines Playlist-Elements festlegen kannst.

Playlist-Element aktualisieren

In diesem Beispiel wird ein Playlist-Element aktualisiert, sodass es das erste Element in einer Playlist ist. Diese Anfrage muss mit OAuth 2.0 autorisiert werden. Dieses Beispiel besteht aus drei Schritten:

  • Schritt 1: Passende Playlist-ID abrufen

    Rufen Sie die Methode playlist.list auf, um die Playlists im Kanal des aktuell authentifizierten Nutzers abzurufen. Die oben stehende Beispielanfrage zum Abrufen der Playlists des aktuellen Nutzers zeigt diese Anfrage. Die API, die die API aufruft, könnte die API-Antwort verarbeiten, um eine Liste von Playlists anzuzeigen, wobei die ID der jeweiligen Playlist als Schlüssel verwendet wird.

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

    Mit der Methode playlistItems.list kannst du die Liste der Videos in der ausgewählten Playlist abrufen. Setze den Wert des Parameters playlistId auf die Playlist-ID, die du in Schritt 1 erhalten hast.

    Jede Ressource in der API-Antwort enthält eine id-Eigenschaft, die die Playlist-Element-ID angibt, die dieses Element eindeutig identifiziert. Damit wird im nächsten Schritt ein Element aus der Liste entfernt.

  • 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 Wert des Parameters part auf snippet fest. Der Anfragetext muss eine playlistItem-Ressource sein, die mindestens die folgenden Werte festlegt:

    • Setze die Eigenschaft id auf die Playlist-Artikel-ID, die du in Schritt 2 erhalten hast.
    • Setze die Eigenschaft snippet.playlistId auf die Playlist-ID, die du in Schritt 1 erhalten hast.
    • Setzen Sie die Eigenschaft snippet.resourceId.kind auf youtube#video.
    • Setze die Eigenschaft snippet.resourceId.videoId auf die Video-ID, die das in der Playlist enthaltene Video eindeutig identifiziert.
    • Setzen Sie die Eigenschaft snippet.position auf 0 oder an eine andere Position, an der das Element erscheinen soll (mit einem 0-basierten Index).

    Die unten stehende API-Anfrage aktualisiert ein Playlist-Element als erstes Element in einer Playlist. 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 Attribute id, snippet.playlistId und snippet.resourceId.videoId festlegen.

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

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 besteht aus drei Schritten. Die ersten beiden Schritte sind mit denen im Beispiel oben zum Aktualisieren eines Playlist-Elements identisch.

Rufe anschließend die Methode playlistItems.delete auf, um ein Video aus der Playlist zu entfernen. Setze den id-Parameter der Anfrage auf die Playlist-Artikel-ID für das Element, das du entfernen möchtest. Diese Anfrage muss mit OAuth 2.0 autorisiert werden.

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

Zum Abschließen der Anfrage im APIs Explorer 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

Playlist entfernen

In diesem Beispiel wird eine Playlist gelöscht. Das Beispiel besteht aus zwei Schritten:

  • Schritt 1: Playlist-ID abrufen

    Rufen Sie die Methode playlist.list auf, um die Playlists im Kanal des aktuell authentifizierten Nutzers abzurufen. Die oben stehende Beispielanfrage zum Abrufen der Playlists des aktuellen Nutzers zeigt diese Anfrage. Die API, die die API aufruft, könnte die API-Antwort verarbeiten, um eine Liste von Playlists anzuzeigen, wobei die ID der jeweiligen 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 Playlist an, die gelöscht wird. Für diese Methode ist ein gültiges OAuth 2.0-Autorisierungstoken erforderlich. Wenn du diese Abfrage im APIs 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 im APIs Explorer testest, musst du den Parameterwert id durch eine gültige Playlist-ID ersetzen. Um eine Playlist-ID zu erhalten, sollten Sie zuerst die oben gezeigte Anfrage zum Hinzufügen einer Playlist ausführen. Extrahieren Sie die Playlist-ID aus der API-Antwort und verwenden Sie diesen Wert für die Playlist, die Sie löschen möchten.