Comments: list

Gibt eine Liste von Kommentaren zurück, die den Parametern der API-Anfrage entsprechen.

Auswirkungen auf das Kontingent:Ein Aufruf dieser Methode kostet 1 Kontingenteinheit.

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

GET https://www.googleapis.com/youtube/v3/comments

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.

Parameter
Erforderliche Parameter
part string
Mit dem Parameter part wird eine durch Kommas getrennte Liste mit einem oder mehreren Attributen der Ressource comment angegeben, die in der API-Antwort enthalten sein sollen.

Die folgende Liste enthält die part-Namen, die Sie in den Parameterwert aufnehmen können:
  • id
  • snippet
Filter (genau einen der folgenden Parameter angeben)
id string
Mit dem Parameter id wird eine durch Kommas getrennte Liste von Kommentar-IDs für die abzurufenden Ressourcen angegeben. In einer comment-Ressource gibt das Attribut id die ID des Kommentars an.
parentId string
Mit dem Parameter parentId wird die ID des Kommentars angegeben, für den Antworten abgerufen werden sollen.

Hinweis:YouTube unterstützt derzeit nur Antworten auf Kommentare der obersten Ebene. Antworten auf Antworten werden möglicherweise in Zukunft unterstützt.
Optionale Parameter
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl der Elemente an, die im Ergebnissatz zurückgegeben werden sollen.

Hinweis: Dieser Parameter kann nicht zusammen mit dem Parameter id verwendet werden. Zulässige Werte sind 1 bis 100. Der Standardwert ist 20.
pageToken string
Mit dem Parameter pageToken wird eine bestimmte Seite im Ergebnissatz angegeben, die zurückgegeben werden soll. In einer API-Antwort gibt das Attribut nextPageToken die nächste Seite des Ergebnisses an, die abgerufen werden kann.

Hinweis: Dieser Parameter kann nicht zusammen mit dem Parameter id verwendet werden.
textFormat string
Dieser Parameter gibt an, ob die API Kommentare im HTML- oder Nur-Text-Format zurückgeben soll. Der Standardwert ist html.

Zulässige Werte sind:
  • html : Gibt die Kommentare im HTML-Format zurück. Dies ist der Standardwert.
  • plainText : Gibt die Kommentare im Nur-Text-Format zurück.

Anfragetext

Geben Sie beim Aufruf dieser Methode keinen Anfragetext an.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "kind": "youtube#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment Resource
  ]
}

Attribute

In der folgenden Tabelle sind die Attribute definiert, die in dieser Ressource enthalten sind:

Attribute
kind string
Gibt den Typ der API-Ressource an. Der Wert ist youtube#commentListResponse.
etag etag
Das ETag dieser Ressource.
nextPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die nächste Seite im Ergebnissatz abzurufen.
pageInfo object
Das Objekt pageInfo enthält Paging-Informationen für den Ergebnissatz.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse im Ergebnissatz.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse, die in der API-Antwort enthalten sind.
items[] list
Eine Liste von Kommentaren, die den Anfragekriterien entsprechen.

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben kann. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetails Beschreibung
badRequest (400) operationNotSupported Der ID-Filter ist nur mit Kommentaren kompatibel, die auf Google+ basieren.
forbidden (403) forbidden Mindestens einer der angeforderten Kommentare kann aufgrund unzureichender Berechtigungen nicht abgerufen werden. Die Anfrage ist möglicherweise nicht ordnungsgemäß autorisiert.
notFound (404) commentNotFound Mindestens einer der angegebenen Kommentare kann nicht gefunden werden. Prüfen Sie die Werte der Parameter id und parentId der Anfrage, um sicherzustellen, dass sie korrekt sind.

Testen!

Mit dem APIs Explorer können Sie diese API aufrufen und die API-Anfrage und -Antwort ansehen.