CommentThreads: list

Zwraca listę wątków komentarzy zgodnych z parametrami żądania do interfejsu API.

Wpływ na limit: wywołanie tej metody ma koszt limitu wynoszący 1 jednostkę.

Częste zastosowania

Żądanie

Żądanie HTTP

GET https://www.googleapis.com/youtube/v3/commentThreads

Parametry

W tabeli poniżej znajdziesz listę parametrów obsługiwanych przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
part string
Parametr part określa rozdzieloną przecinkami listę co najmniej 1 właściwości zasobu commentThread, które mają być uwzględnione w odpowiedzi interfejsu API.

Poniższa lista zawiera nazwy part, które możesz uwzględnić w wartości parametru:
  • id
  • replies
  • snippet
Filtry (określ dokładnie 1 z tych parametrów)
allThreadsRelatedToChannelId string
Parametr allThreadsRelatedToChannelId nakazuje interfejsowi API zwrócenie wszystkich wątków komentarzy powiązanych z określonym kanałem.
id string
Parametr id określa rozdzieloną przecinkami listę identyfikatorów wątków komentarzy, które mają zostać pobrane.
videoId string
Parametr videoId nakazuje interfejsowi API zwrócenie wątków komentarzy powiązanych z określonym identyfikatorem filmu.
Parametry opcjonalne
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które mają zostać zwrócone w zbiorze wyników.

Uwaga: tego parametru nie można używać w połączeniu z parametrem id. Akceptowane wartości to od 1 do 100 włącznie. Wartością domyślną jest 20.
moderationStatus string
Ten parametr można używać tylko w prawidłowo autoryzowanym żądaniu. Ustaw ten parametr, aby ograniczyć zwracane wątki komentarzy do określonego stanu moderacji.

Uwaga: tego parametru nie można używać w połączeniu z parametrem id. Wartością domyślną jest published.

Akceptowane wartości:
  • heldForReview – pobieranie wątków komentarzy, które czekają na sprawdzenie przez moderatora. Wątek komentarzy może zostać uwzględniony w odpowiedzi, jeśli komentarz najwyższego poziomu lub co najmniej 1 odpowiedź na ten komentarz oczekuje na sprawdzenie.
  • likelySpam – pobieranie wątków komentarzy zaklasyfikowanych jako prawdopodobny spam. Wątek komentarzy może zostać uwzględniony w odpowiedzi, jeśli komentarz najwyższego poziomu lub co najmniej 1 odpowiedź na ten komentarz jest uznawana za prawdopodobny spam.
  • published – pobieranie wątków opublikowanych komentarzy. Jest to wartość domyślna. Wątek komentarzy może zostać uwzględniony w odpowiedzi, jeśli jego komentarz najwyższego poziomu został opublikowany.
order string
Parametr order określa kolejność, w jakiej wątki komentarzy mają być wyświetlane w odpowiedzi interfejsu API. Prawidłowe wartości to:
  • time – wątki komentarzy są uporządkowane według czasu. Jest to zachowanie domyślne.
  • relevance – wątki komentarzy są uporządkowane według trafności.
Uwaga: tego parametru nie można używać w połączeniu z parametrem id.
pageToken string
Parametr pageToken określa konkretną stronę w zbiorze wyników, która ma zostać zwrócona. W odpowiedzi interfejsu API właściwość nextPageToken określa następną stronę wyników, którą można pobrać.

Uwaga: tego parametru nie można używać w połączeniu z parametrem id.
searchTerms string
Parametr searchTerms nakazuje interfejsowi API ograniczenie odpowiedzi interfejsu API do komentarzy zawierających określone wyszukiwane hasła.

Uwaga: tego parametru nie można używać w połączeniu z parametrem id.
textFormat string
Ustaw wartość tego parametru na html lub plainText, aby nakazać interfejsowi API zwracanie komentarzy pozostawionych przez użytkowników w formacie HTML lub w postaci zwykłego tekstu. Wartością domyślną jest html.

Akceptowane wartości:
  • html – zwraca komentarze w formacie HTML. Jest to wartość domyślna.
  • plainText – zwraca komentarze w formacie zwykłego tekstu.

Treść żądania

Podczas wywoływania tej metody nie podawaj treści żądania.

Odpowiedź

Jeśli operacja się uda, ta metoda zwróci treść odpowiedzi o tej strukturze:

{
  "kind": "youtube#commentThreadListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    commentThread Resource
  ]
}

Właściwości

W tabeli poniżej znajdziesz definicje właściwości, które występują w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość to youtube#commentThreadListResponse.
etag etag
Etag tego zasobu.
nextPageToken string
Token, którego można użyć jako wartości parametru pageToken, aby pobrać następną stronę w zbiorze wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu zbioru wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zbiorze wyników.
pageInfo.resultsPerPage integer
Liczba wyników uwzględnionych w odpowiedzi interfejsu API.
items[] list
Lista wątków komentarzy zgodnych z kryteriami żądania.

Błędy

W tabeli poniżej znajdziesz komunikaty o błędach, które interfejs API może zwrócić w odpowiedzi na wywołanie tej metody. Więcej informacji znajdziesz w dokumentacji komunikatów o błędach.

Typ błędu Szczegóły błędu Opis
badRequest (400) operationNotSupported Filtr id jest zgodny tylko z komentarzami opartymi na Google+.
badRequest (400) processingFailure Serwer interfejsu API nie mógł prawidłowo przetworzyć żądania. Może to być błąd przejściowy, ale zwykle oznacza, że dane wejściowe żądania są nieprawidłowe. Sprawdź strukturę zasobu commentThread w treści żądania, aby upewnić się, że jest prawidłowa.
forbidden (403) commentsDisabled W filmie określonym przez parametr videoId wyłączono komentarze.
forbidden (403) forbidden Nie można pobrać co najmniej 1 żądanego wątku komentarzy z powodu niewystarczających uprawnień. Żądanie może nie być prawidłowo autoryzowane.
notFound (404) channelNotFound Nie udało się znaleźć kanału określonego przez parametr allThreadsRelatedToChannelId.
notFound (404) commentThreadNotFound Nie udało się znaleźć co najmniej 1 określonego wątku komentarzy. Sprawdź wartości parametru id żądania, aby upewnić się, że są prawidłowe.
notFound (404) videoNotFound Nie udało się znaleźć filmu określonego przez parametr videoId.

Wypróbuj

Aby wywołać ten interfejs API i zobaczyć żądanie do interfejsu API oraz odpowiedź, użyj APIs Explorer.