CommentThreads: list

Zwraca listę wątków komentarzy pasujących do parametrów żądania do interfejsu API.

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

Typowe przypadki użycia

Prośba

Żądanie HTTP

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

Parametry

W tabeli poniżej znajdziesz parametry obsługiwane przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.

Parametry
Parametry wymagane
part string
Parametr part określa rozdzieloną przecinkami listę właściwości zasobu commentThread, które będzie zawierała odpowiedź interfejsu API.

Na tej liście znajdują się nazwy part, które możesz uwzględnić w wartości parametru:
  • id
  • replies
  • snippet
Filtry (określ dokładnie jeden z tych parametrów)
allThreadsRelatedToChannelId string
Parametr allThreadsRelatedToChannelId informuje interfejs API, że ma zwrócić wszystkie wątki komentarzy powiązane 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 informuje interfejs API, aby zwracał wątki komentarzy powiązane z podanym identyfikatorem filmu.
Parametry opcjonalne
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które powinny 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
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Ustaw ten parametr, by ograniczyć zwracane wątki komentarzy do konkretnego stanu moderacji.

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

Akceptowane wartości:
  • heldForReview – pobierz wątki 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 jedna z nich oczekuje na sprawdzenie.
  • likelySpam – pobieranie wątków komentarzy sklasyfikowanych jako potencjalnie spam. Wątek komentarzy może zostać uwzględniony w odpowiedzi, jeśli komentarz najwyższego poziomu lub co najmniej jedna z nich zostanie uznana za spam.
  • published – pobieranie wątków z opublikowanymi komentarzami. jest to wartość domyślna Wątek komentarza może zostać uwzględniony w odpowiedzi, jeśli został opublikowany komentarz najwyższego poziomu.
order string
Parametr order określa kolejność, w jakiej odpowiedź interfejsu API powinna wyświetlać wątki komentarzy. Prawidłowe wartości to:
  • time – wątki komentarzy są uporządkowane według czasu. Jest to jego ustawienie 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 wskazuje w zestawie wyników konkretną stronę, która ma zostać zwrócona. W odpowiedzi interfejsu API właściwość nextPageToken wskazuje następną stronę wyniku, 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, tak aby zawierała tylko komentarze zawierające 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 interfejs API zwracał komentarze użytkowników w formacie HTML lub w postaci zwykłego tekstu. Wartość domyślna to 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

Nie podawaj treści żądania podczas wywoływania tej metody.

Odpowiedź

Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:

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

Właściwości

Poniższa tabela przedstawia właściwości, które pojawiają się w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartością będzie youtube#commentThreadListResponse.
etag etag
ETag tego zasobu.
nextPageToken string
Token, który może być używany jako wartość parametru pageToken w celu pobrania następnej strony w zestawie wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu zbioru wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zestawie.
pageInfo.resultsPerPage integer
Liczba wyników uwzględnionych w odpowiedzi interfejsu API.
items[] list
Lista wątków komentarzy spełniających kryteria żą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ł przetworzyć żądania. Chociaż może to być błąd przejściowy, 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 udało się pobrać co najmniej jednego z żądanych wątków komentarzy z powodu niewystarczających uprawnień. Żądanie może nie być poprawnie 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 jednego z podanych wątków komentarzy. Sprawdź, czy wartości parametru id żądania są prawidłowe.
notFound (404) videoNotFound Nie udało się znaleźć filmu określonego przez parametr videoId.

Wypróbuj

Użyj interfejsu APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.