CommentThreads: list

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

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

Typowe przypadki użycia

Żądanie

Żądanie HTTP

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

Parametry

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

Parametry
Parametry wymagane
part string
Parametr part określa oddzieloną przecinkami listę co najmniej jednej właściwości zasobu commentThread, która będzie zawierać odpowiedź interfejsu API.

Ta lista zawiera nazwy part, które możesz uwzględnić w wartości parametru:
  • id
  • replies
  • snippet
Filtry (podaj jeden z tych parametrów)
allThreadsRelatedToChannelId string
Parametr allThreadsRelatedToChannelId nakazuje interfejsowi API zwracanie wszystkich wątków komentarzy powiązanych z określonym kanałem. Odpowiedź może zawierać komentarze dotyczące kanału lub filmów na nim.
channelId string
Parametr channelId nakazuje interfejsowi API zwracanie wątków komentarzy zawierających komentarze na temat określonego kanału. (Odpowiedź nie będzie zawierać komentarzy dodanych do filmów przesłanych przez kanał).
id string
Parametr id określa oddzieloną przecinkami listę identyfikatorów wątków komentarzy dla zasobów, które powinny zostać pobrane.
videoId string
Parametr videoId nakazuje interfejsowi API zwracanie wątków komentarzy powiązanych z podanym identyfikatorem filmu.
Parametry opcjonalne
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które powinny zostać zwrócone w zestawie wyników.

Uwaga: ten parametr nie jest obsługiwany w połączeniu z parametrem id. Akceptowane wartości to 1–100 (włącznie). Wartością domyślną jest 20.
moderationStatus string
Ten parametr może być używany tylko w poprawnie autoryzowanym żądaniu. Ustaw ten parametr, aby ograniczyć zwracane wątki komentarzy do określonego stanu moderacji.

Uwaga: ten parametr nie jest obsługiwany w połączeniu z parametrem id. Wartość domyślna to published.

Akceptowane wartości to:
  • heldForReview – pobierz wątki komentarzy oczekujące na sprawdzenie przez moderatora. Wątek komentarza może zawierać odpowiedź, jeśli komentarz najwyższego poziomu lub co najmniej jedna z odpowiedzi na ten komentarz oczekuje na sprawdzenie.
  • likelySpam – pobiera wątki komentarzy sklasyfikowane jako prawdopodobny spam. Wątek komentarza może zostać dodany do odpowiedzi, jeśli komentarz najwyższego poziomu lub co najmniej 1 z odpowiedzi są uważane za 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 został opublikowany jej komentarz najwyższego poziomu.
order string
Parametr order określa kolejność, w jakiej odpowiedź interfejsu API powinna wyświetlać listę wątków. Prawidłowe wartości to:
  • time – wątki są uporządkowane według czasu. Jest to zachowanie domyślne.
  • relevance – wątki są uporządkowane według trafności.
Uwaga: ten parametr nie jest obsługiwany w połączeniu z parametrem id.
pageToken string
Parametr pageToken wskazuje konkretną stronę w zestawie wyników, która powinna zostać zwrócona. W odpowiedzi interfejsu API właściwość nextPageToken wskazuje następną stronę wyników, którą można pobrać.

Uwaga: ten parametr nie jest obsługiwany w połączeniu z parametrem id.
searchTerms string
Parametr searchTerms nakazuje interfejsowi API ograniczyć odpowiedzi tylko do tych zapytań, które zawierają podane wyszukiwane słowa.

Uwaga: ten parametr nie jest obsługiwany w połączeniu z parametrem id.
textFormat string
Ustaw wartość tego parametru na html lub plainText, aby interfejs API zwrócił komentarze dodane przez użytkowników w formacie HTML lub zwykłym tekście. Wartość domyślna to html.

Akceptowane wartości to:
  • 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, metoda zwróci odpowiedź w następującym formacie:

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

Usługi

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

Usługi
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#commentThreadListResponse.
etag etag
Otagowanie tego zasobu.
nextPageToken string
Token, który może zostać użyty jako wartość parametru pageToken, by pobrać następną stronę z zestawu wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o stronicowaniu dla zestawu wyników.
pageInfo.totalResults integer
Łączna liczba wyników w zestawie wyników.
pageInfo.resultsPerPage integer
Liczba wyników zawartych w odpowiedzi interfejsu API.
items[] list
Lista wątków komentarzy, które spełniają 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 Serwerowi interfejsu API nie udało się przetworzyć żądania. Może to być błąd przejściowy, ale zwykle wskazuje, że dane wejściowe żądania są nieprawidłowe. Sprawdź strukturę zasobu commentThread w treści żądania, aby upewnić się, że jest on prawidłowy.
forbidden (403) commentsDisabled Film zidentyfikowany przez parametr videoId wyłączył komentarze.
forbidden (403) forbidden Nie można pobrać co najmniej 1 z wątków komentarzy z powodu niewystarczających uprawnień. Żądanie może nie zostać prawidłowo autoryzowane.
notFound (404) channelNotFound Nie udało się znaleźć kanału wskazanego w parametrze channelId lub allThreadsRelatedToChannelId.
notFound (404) commentThreadNotFound Nie udało się znaleźć co najmniej 1 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 APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.