CommentThreads: list

Gibt eine Liste von Kommentar-Threads 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/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 einem oder mehreren Attributen der Ressource commentThread an, 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
  • replies
  • snippet
Filter (genau einen der folgenden Parameter angeben)
allThreadsRelatedToChannelId string
Der Parameter allThreadsRelatedToChannelId weist die API an, alle Kommentar-Threads zurückzugeben, die mit dem angegebenen Kanal verknüpft sind.
id string
Der Parameter id gibt eine durch Kommas getrennte Liste von Kommentar-Thread-IDs für die Ressourcen an, die abgerufen werden sollen.
videoId string
Der Parameter videoId weist die API an, Kommentar-Threads zurückzugeben, die mit der angegebenen Video-ID verknüpft sind.
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.
moderationStatus string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Legen Sie diesen Parameter fest, um die zurückgegebenen Kommentar-Threads auf einen bestimmten Moderationsstatus zu beschränken.

Hinweis: Dieser Parameter kann nicht zusammen mit dem Parameter id verwendet werden. Der Standardwert ist published.

Zulässige Werte sind:
  • heldForReview : Kommentar-Threads abrufen, die von einem Moderator überprüft werden müssen. Ein Kommentar-Thread kann in die Antwort aufgenommen werden, wenn der Kommentar der obersten Ebene oder mindestens eine der Antworten auf diesen Kommentar überprüft werden muss.
  • likelySpam : Kommentar-Threads abrufen, die als wahrscheinlich Spam eingestuft wurden. Ein Kommentar-Thread kann in die Antwort aufgenommen werden, wenn der Kommentar der obersten Ebene oder mindestens eine der Antworten auf diesen Kommentar wahrscheinlich Spam ist.
  • published : Threads mit veröffentlichten Kommentaren abrufen. „Immer“ ist der Standardwert. Ein Kommentar-Thread kann in die Antwort aufgenommen werden, wenn der Kommentar der obersten Ebene veröffentlicht wurde.
order string
Der Parameter order gibt die Reihenfolge an, in der die Kommentar-Threads in der API-Antwort aufgeführt werden sollen. Gültige Werte sind:
  • time : Kommentar-Threads werden nach Zeit sortiert. Das ist das Standardverhalten.
  • relevance : Kommentar-Threads werden nach Relevanz sortiert.
Hinweis:Dieser Parameter kann nicht zusammen mit dem Parameter id verwendet werden.
pageToken string
Der pageToken Parameter gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort gibt die nextPageToken Property die nächste Seite des Ergebnisses an, die abgerufen werden kann.

Hinweis: Dieser Parameter kann nicht zusammen mit dem id Parameter verwendet werden.
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 kann nicht zusammen mit dem Parameter id verwendet werden.
textFormat string
Legen Sie den Wert dieses Parameters auf html oder plainText fest, um die API anzuweisen, die von Nutzern hinterlassenen Kommentare im HTML-Format oder als Nur-Text 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 sind die Attribute definiert, die in dieser Ressource enthalten sind:

Attribute
kind string
Gibt den Typ der API-Ressource an. 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 Objekt pageInfo enthält Informationen zur Paginierung 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 Kommentar-Threads, 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 Filter id ist nur mit Kommentaren kompatibel, die auf Google+ basieren.
badRequest (400) processingFailure Der API-Server konnte die Anfrage nicht verarbeiten. Dies kann ein vorübergehender Fehler sein, deutet aber in der Regel darauf hin, dass die Eingabe der Anfrage ungültig ist. Prüfen Sie die Struktur der Ressource commentThread im Anfragetext, um sicherzustellen, dass sie gültig ist.
forbidden (403) commentsDisabled Für das Video, das durch den Parameter videoId angegeben wird, wurden Kommentare deaktiviert.
forbidden (403) forbidden Mindestens einer der angeforderten Kommentar-Threads kann aufgrund unzureichender Berechtigungen nicht abgerufen werden. Die Anfrage ist möglicherweise nicht ordnungsgemäß autorisiert.
notFound (404) channelNotFound Der Kanal, der durch den Parameter allThreadsRelatedToChannelId angegeben wird, konnte nicht gefunden werden.
notFound (404) commentThreadNotFound Mindestens einer der angegebenen Kommentar-Threads wurde nicht gefunden. Prüfen Sie die Werte des Parameters id der Anfrage, um sicherzustellen, dass sie korrekt sind.
notFound (404) videoNotFound Das Video, das durch den Parameter videoId angegeben wird, konnte nicht gefunden werden.

Testen!

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