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

Rufen Sie die Methode playlists.list auf, um die Playlists des aktuell authentifizierten Nutzers abzurufen. Legen Sie in der Anfrage den Wert des Parameters mine auf true fest. Eine Anfrage mit dem Parameter mine 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 besteht aus zwei Schritten:

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 eine Anfrage zum Abrufen zusätzlicher Informationen über eine Gruppe von Playlists, die in einer Reihe von Suchergebnissen zurückgegeben werden. So können Sie beispielsweise 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 Informationen befinden sich im Attribut contentDetails.itemCount der Ressource playlist, sodass der Parameterwert part in der Anfrage auf contentDetails festgelegt wird. 

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. 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 zu 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 markiert:

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

Zugehörige 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

    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, könnte die API-Antwort so verarbeiten, dass eine Liste von Playlists angezeigt wird, wobei die ID jeder 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 beim Aufrufen dieser Methode das Attribut snippet.title erforderlich ist. Wenn die zu aktualisierende Playlist-Ressource außerdem Werte für die Eigenschaften snippet.description oder snippet.tags angibt, müssen diese Werte in der Aktualisierungsanfrage neu angegeben werden. Andernfalls werden sie gelöscht.

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

    Wie im obigen Beispiel 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, 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-Serie 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 den Ressourcentext durch eine gültige Playlist-ID ersetzen. Um eine Playlist-ID zu erhalten, empfehlen wir, zuerst die oben gezeigte Anfrage zum Hinzufügen einer Playlist auszufü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 Titel und die Beschreibung der Playlist in diesem Beispiel sind dieselben wie im Beispiel.

Playlist-Element hinzufügen

In diesem Beispiel wird ein Element zu einer Playlist hinzugefügt. Diese Anfrage muss mit OAuth 2.0 autorisiert werden. Dieses Beispiel besteht aus zwei Schritten:

  • Schritt 1: Geeignete 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, könnte die API-Antwort so verarbeiten, dass eine Liste von Playlists angezeigt wird, wobei die ID jeder Playlist als Schlüssel verwendet wird.

  • Schritt 2: Der 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:

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

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

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

    Um die Anfrage im APIs Explorer abzuschließen, 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 für die Methode playlistItems.insert sind die anderen Attributwerte aufgeführt, die du beim Hinzufügen eines Playlist-Elements festlegen kannst.

Playlist-Bild hinzufügen

Mit der playlistImages.insert-Methode der Version 3 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 wird.

Diese Abfrage kann nicht mit APIs Explorer getestet werden, da 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 aktualisiert, sodass es der erste Eintrag in einer Playlist ist. Diese Anfrage muss mit OAuth 2.0 autorisiert werden. Dieses Beispiel besteht aus drei Schritten:

  • Schritt 1: Geeignete 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, könnte die API-Antwort so verarbeiten, dass eine Liste von Playlists angezeigt wird, wobei die ID jeder 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. 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 ID des Playlist-Elements angibt, die diesen Artikel eindeutig identifiziert. Mit diesem Wert entfernen Sie im nächsten Schritt ein Element aus der Liste.

  • Schritt 3: Ausgewählten 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 id-Eigenschaft auf die ID des Playlist-Elements, die du in Schritt 2 erhalten hast.
    • Lege für das Attribut snippet.playlistId die Playlist-ID fest, die du in Schritt 1 erhalten hast.
    • Setzen Sie das Attribut snippet.resourceId.kind auf youtube#video.
    • Setze die snippet.resourceId.videoId-Eigenschaft auf die Video-ID, die das in der Playlist enthaltene Video eindeutig identifiziert.
    • Setzen Sie das Attribut snippet.position auf 0 oder auf die Position, an der das Element angezeigt werden soll (mithilfe eines 0-basierten Index).

    Mit der folgenden API-Anfrage wird ein Playlist-Element als erster 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
  }
}

    Damit die Anfrage im APIs Explorer abgeschlossen werden kann, 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-Bild aktualisieren

Du kannst die playlistImages.update-Methode der Version 3 des APIs verwenden, um das Thumbnail-Bild einer Playlist zu aktualisieren. In deiner Anfrage gibt der Wert des Parameters playlistId die Playlist an, für die das Thumbnail verwendet wird.

Diese Abfrage kann nicht mit APIs Explorer getestet werden, da 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 besteht aus drei Schritten. Die ersten beiden Schritte sind dieselben wie im Beispiel oben zum Aktualisieren eines Playlist-Elements.

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

Die Element-ID der Playlist, die zur Identifizierung eines Videos in einer Playlist verwendet wird, unterscheidet sich von der YouTube-Video-ID, die das Video eindeutig identifiziert. Die Element-ID der Playlist kennzeichnet das Video als Element in einer bestimmten Playlist.

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

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

Playlist-Bild entfernen

In diesem Beispiel wird ein Playlist-Image gelöscht. Das Beispiel besteht aus zwei Schritten:

  • 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, könnte die API-Antwort so verarbeiten, dass eine Liste von Playlists angezeigt wird, wobei die ID jeder Playlist als Schlüssel verwendet wird.

  • Schritt 2: Playlist-Bild-ID abrufen

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

  • Schritt 3: Playlist-Bild löschen

    Mit der Methode playlistImages.delete kannst du ein bestimmtes Playlist-Image 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 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.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 besteht aus zwei Schritten:

  • 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, könnte die API-Antwort so verarbeiten, dass eine Liste von Playlists angezeigt wird, wobei die ID jeder 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 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 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, empfehlen wir, zuerst die oben gezeigte Anfrage zum Hinzufügen einer Playlist auszufü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.