Zwraca listę 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/comments
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 comment , 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:
|
|
Filtry (określ dokładnie jeden z tych parametrów) | ||
id |
string Parametr id zawiera rozdzieloną przecinkami listę identyfikatorów komentarzy dla pobieranych zasobów. W zasobie comment właściwość id określa identyfikator komentarza. |
|
parentId |
string Parametr parentId określa identyfikator komentarza, na który należy pobrać odpowiedzi. Uwaga: obecnie YouTube odpowiada tylko na komentarze najwyższego poziomu. Odpowiedzi na nie mogą być jednak obsługiwane w przyszłości. |
|
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 . |
|
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 . |
|
textFormat |
string Ten parametr wskazuje, czy interfejs API powinien zwracać komentarze w formacie HTML czy zwykłego tekstu. Wartość domyślna to html .Akceptowane wartości:
|
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#commentListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ comment 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#commentListResponse . |
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 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 szczegółów znajdziesz w dokumentacji komunikatów o błędach.
Typ błędu | Szczegóły błędu | Opis |
---|---|---|
badRequest (400) |
operationNotSupported |
Filtr identyfikatora jest zgodny tylko z komentarzami opartymi na Google+. |
forbidden (403) |
forbidden |
Nie udało się pobrać co najmniej jednego z żądanych komentarzy z powodu niewystarczających uprawnień. Żądanie może nie być poprawnie autoryzowane. |
notFound (404) |
commentNotFound |
Nie udało się znaleźć co najmniej jednego z podanych komentarzy. Sprawdź, czy wartości parametrów id i parentId żądania są prawidłowe. |
Wypróbuj
Użyj interfejsu APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.