CommentThreads: list

Gibt eine Liste von Kommentarthreads 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/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
Der Parameter part gibt eine durch Kommas getrennte Liste mit einer oder mehreren commentThread-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:
  • id
  • replies
  • snippet
Filter (genau einen der folgenden Parameter angeben)
allThreadsRelatedToChannelId string
Der Parameter allThreadsRelatedToChannelId weist die API an, alle mit dem angegebenen Kanal verknüpften Kommentarthreads zurückzugeben. Die Antwort kann Kommentare zum Kanal oder zu den Videos des Kanals enthalten.
channelId string
Der Parameter channelId weist die API an, Kommentarthreads mit Kommentaren zum angegebenen Kanal zurückzugeben. Die Antwort enthält keine Kommentare zu den Videos, die der Kanal hochgeladen hat.
id string
Der Parameter id gibt eine durch Kommas getrennte Liste von Kommentarthread-IDs für die Ressourcen an, die abgerufen werden sollen.
videoId string
Der Parameter videoId weist die API an, Kommentarthreads zurückzugeben, die der angegebenen Video-ID zugeordnet sind.
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.
moderationStatus string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Legen Sie diesen Parameter fest, um die zurückgegebenen Kommentarthreads auf einen bestimmten Moderationsstatus zu beschränken.

Hinweis: Die Verwendung dieses Parameters in Verbindung mit dem Parameter id wird nicht unterstützt. Der Standardwert ist published.

Zulässige Werte sind:
  • heldForReview: Damit kannst du Kommentarthreads abrufen, die von einem Moderator überprüft werden müssen. Ein Kommentarthread kann in die Antwort aufgenommen werden, wenn der übergeordnete Kommentar oder mindestens eine der Antworten auf diesen Kommentar noch aussteht.
  • likelySpam: Ruft Threads ab, die wahrscheinlich als Spam eingestuft werden. Ein Kommentarthread kann in die Antwort eingefügt werden, wenn der übergeordnete Kommentar oder mindestens eine der Antworten auf diesen Kommentar wahrscheinlich Spam sind.
  • published: Hiermit werden Threads veröffentlichter Kommentare abgerufen. „Immer“ ist der Standardwert. Ein Kommentarthread kann in die Antwort aufgenommen werden, wenn der Kommentar auf oberster Ebene 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 werden nach Zeit sortiert. Das ist das Standardverhalten.
  • relevance: Kommentarthreads sind nach Relevanz sortiert.
Hinweis:Dieser Parameter wird nicht in Verbindung mit dem Parameter id unterstützt.
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.
searchTerms string
Der Parameter searchTerms weist die API an, die API-Antwort auf Kommentare zu beschränken, die die angegebenen Suchbegriffe enthalten.

Hinweis: Dieser Parameter wird nicht in Verbindung mit dem Parameter id unterstützt.
textFormat string
Setzen Sie den Wert dieses Parameters auf html oder plainText, um die API anzuweisen, die Kommentare von Nutzern im HTML-Format oder im 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 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 von Kommentarthreads, 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.
badRequest (400) processingFailure Der API-Server konnte die Anfrage nicht verarbeiten. Dies kann zwar ein vorübergehender Fehler sein, weist jedoch normalerweise 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 identifizierte 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 channelId oder allThreadsRelatedToChannelId identifizierte 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 identifizierte Video wurde nicht gefunden.

Testen!

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