CommentThreads: list

Gibt eine Liste von Kommentarthreads 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/commentThreads

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 commentThread-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
  • replies
  • snippet
Filter (geben Sie genau einen der folgenden Parameter an)
allThreadsRelatedToChannelId string
Mit dem Parameter allThreadsRelatedToChannelId wird die API angewiesen, alle Kommentarthreads zurückzugeben, die mit dem angegebenen Kanal verknüpft sind.
id string
Der Parameter id gibt eine durch Kommas getrennte Liste von Kommentarthread-IDs für die abzurufenden Ressourcen an.
videoId string
Mit dem Parameter videoId wird die API angewiesen, Kommentarthreads zurückzugeben, die mit der angegebenen Video-ID verknüpft sind.
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.
moderationStatus string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Du kannst diesen Parameter festlegen, um die zurückgegebenen Kommentarthreads auf einen bestimmten Moderationsstatus zu beschränken.

Hinweis:Dieser Parameter wird in Verbindung mit dem Parameter id nicht unterstützt. Der Standardwert ist published.

Zulässige Werte sind:
  • heldForReview: Hiermit werden Kommentarthreads abgerufen, die noch von einem Moderator geprüft werden müssen. Ein Kommentarthread kann in die Antwort aufgenommen werden, wenn der Kommentar der obersten Ebene oder mindestens eine der Antworten auf diesen Kommentar noch überprüft werden muss.
  • likelySpam: Hiermit werden Kommentarthreads abgerufen, die als wahrscheinlich Spam eingestuft wurden. Eine Kommentarunterhaltung kann in die Antwort aufgenommen werden, wenn der Kommentar der obersten Ebene oder mindestens eine Antwort auf diesen Kommentar als wahrscheinlich Spam eingestuft wird.
  • published: Threads von veröffentlichten Kommentaren abrufen. „Immer“ ist der Standardwert. Ein Kommentarthread kann in die Antwort aufgenommen werden, wenn der zugehörige Top-Level-Kommentar veröffentlicht wurde.
order string
Der Parameter order gibt die Reihenfolge an, in der die API-Antwort Kommentarthreads auflisten soll. Gültige Werte:
  • time: Kommentarthreads sind nach Zeit sortiert. Das ist das Standardverhalten.
  • relevance: Kommentarthreads sind nach Relevanz sortiert.
Hinweis:Dieser Parameter wird in Verbindung mit dem Parameter id nicht unterstützt.
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.
searchTerms string
Mit dem Parameter searchTerms wird die API angewiesen, die API-Antwort auf Kommentare zu beschränken, die die angegebenen Suchbegriffe enthalten.

Hinweis:Dieser Parameter wird in Verbindung mit dem Parameter id nicht unterstützt.
textFormat string
Setzen Sie den Wert dieses Parameters auf html oder plainText, um die API anzuweisen, von Nutzern hinterlassene Kommentare im HTML- oder Nur-Text-Format zurückzugeben. 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#commentThreadListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    commentThread 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#commentThreadListResponse.
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 Kommentarthreads, die den Anfragekriterien 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 Filter id ist nur mit Kommentaren kompatibel, die auf Google+ basieren.
badRequest (400) processingFailure Die Anfrage konnte vom API-Server nicht verarbeitet werden. Dies kann zwar ein vorübergehender Fehler sein, weist aber in der Regel darauf hin, dass die Eingabe der Anfrage ungültig ist. Prüfen Sie die Struktur der commentThread-Ressource im Anfragetext, um sicherzustellen, dass sie gültig ist.
forbidden (403) commentsDisabled Für das durch den Parameter videoId angegebene Video wurden Kommentare deaktiviert.
forbidden (403) forbidden Mindestens einer der angeforderten Kommentarthreads kann aufgrund unzureichender Berechtigungen nicht abgerufen werden. Die Anfrage ist möglicherweise nicht ordnungsgemäß autorisiert.
notFound (404) channelNotFound Der durch den Parameter allThreadsRelatedToChannelId angegebene Kanal wurde nicht gefunden.
notFound (404) commentThreadNotFound Mindestens einer der angegebenen Kommentarthreads wurde nicht gefunden. Prüfen Sie, ob die Werte des id-Parameters der Anfrage korrekt sind.
notFound (404) videoNotFound Das durch den Parameter videoId angegebene Video wurde nicht gefunden.

Jetzt testen

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