Comments: list

Gibt eine Liste von Kommentaren zurück, die den API-Anfrageparametern entsprechen.

Kontingentauswirkung: Ein Aufruf dieser Methode hat Kontingentkosten von 1 Einheit.

Gängige Anwendungsfälle

Anfragen

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 eines oder mehrerer comment-Ressourcenattribute angegeben, die in der API-Antwort enthalten sein werden.

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

Hinweis: YouTube unterstützt derzeit nur Antworten auf Top-Level-Kommentare. Antworten auf Antworten werden jedoch möglicherweise in Zukunft unterstützt.
Optionale Parameter
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl von Elementen an, die in der Ergebnismenge zurückgegeben werden sollen.

Hinweis:Dieser Parameter wird nicht in Verbindung mit dem Parameter id unterstützt. Zulässige Werte sind 1 bis 100 (einschließlich). Der Standardwert ist 20.
pageToken string
Der pageToken-Parameter gibt eine bestimmte Seite in der Ergebnismenge an, die zurückgegeben werden soll. In einer API-Antwort gibt das Attribut nextPageToken die nächste Seite des Ergebnisses an, das abgerufen werden kann.

Hinweis:Die Verwendung dieses Parameters in Verbindung mit dem Parameter id wird nicht unterstützt.
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. „Immer“ ist der Standardwert.
  • plainText: Gibt die Kommentare im Nur-Text-Format zurück.

Anfragetext

Geben Sie beim Aufrufen 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 werden die Attribute definiert, die in dieser Ressource angezeigt werden:

Attribute
kind string
Identifiziert den Typ der API-Ressource. 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 in der Ergebnismenge abzurufen.
pageInfo object
Das Objekt pageInfo enthält Seiteninformationen 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 der Kommentare, die den Kriterien der Anfrage entsprechen.

Fehler

In der folgenden Tabelle finden Sie Fehlermeldungen, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben könnte. 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 wurde nicht gefunden. Prüfen Sie, ob die Werte der Parameter id und parentId der Anfrage korrekt sind.

Jetzt testen

Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.