Comments: list

Zwraca listę komentarzy pasujących 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/comments

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 comment, która będzie zawierać odpowiedź interfejsu API.

Ta lista zawiera nazwy part, które możesz uwzględnić w wartości parametru:
  • id
  • snippet
Filtry (podaj jeden z tych parametrów)
id string
Parametr id określa oddzieloną 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, którego odpowiedzi chcesz pobrać.

Uwaga: obecnie YouTube obsługuje tylko odpowiedzi na komentarze najwyższego poziomu. Jednak w przyszłości odpowiedzi mogą być obsługiwane.
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.
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.
textFormat string
Ten parametr wskazuje, czy interfejs API powinien zwracać komentarze w formacie HTML czy jako zwykły tekst. 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#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment 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#commentListResponse.
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 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+.
forbidden (403) forbidden Nie można pobrać co najmniej 1 z żądanych komentarzy z powodu niewystarczających uprawnień. Żądanie może nie zostać prawidłowo 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 APIs Explorer, aby wywołać ten interfejs API i wyświetlić żądanie oraz odpowiedź interfejsu API.