Gibt eine Liste von Kommentaren zurück, die den API-Anfrageparametern entsprechen.
Auswirkungen auf Kontingente: Bei einem Aufruf dieser Methode fallen Kontingentkosten von 1 Einheit an.
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 Der Parameter part gibt eine durch Kommas getrennte Liste mit einer oder mehreren comment -Ressourceneigenschaften an, die in der API-Antwort enthalten sein werden.Die folgende Liste enthält die part -Namen, die Sie in den Parameterwert aufnehmen können:
|
|
Filter (genau einen der folgenden Parameter angeben) | ||
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 die Eigenschaft 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 Kommentare der obersten Ebene. In Zukunft werden Antworten auf Antworten jedoch möglicherweise unterstützt. |
|
Optionale Parameter | ||
maxResults |
unsigned integer Der Parameter maxResults gibt die maximale Anzahl von Elementen an, die in den Ergebnissen zurückgegeben werden sollen.Hinweis:Dieser Parameter kann nicht in Verbindung mit dem Parameter id verwendet werden. Zulässige Werte sind 1 bis 100 . Der Standardwert ist 20 . |
|
pageToken |
string Der Parameter pageToken gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort gibt die Eigenschaft nextPageToken die nächste Seite des Ergebnisses an, die 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:
|
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 im Ergebnissatz abzurufen. |
pageInfo |
object Das pageInfo -Objekt enthält Seiteninformationen für die Ergebnismenge. |
pageInfo.totalResults |
integer Die Gesamtzahl der Ergebnisse in der Ergebnismenge. |
pageInfo.resultsPerPage |
integer Die Anzahl der Ergebnisse, die in der API-Antwort enthalten sind. |
items[] |
list Eine Liste der Kommentare, die den Anfragekriterien entsprechen. |
Fehler
In der folgenden Tabelle sind Fehlermeldungen aufgeführt, die von der API möglicherweise als Antwort auf einen Aufruf dieser Methode zurückgegeben werden. 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. |
Testen!
Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.