Comments: list

Zwraca listę 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/comments

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 comment, 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
  • snippet
Filtry (określ dokładnie 1 z tych parametrów)
id string
Parametr id określa rozdzieloną przecinkami listę identyfikatorów komentarzy do pobieranych zasobów. W zasobie comment właściwość id określa identyfikator komentarza.
parentId string
Parametr parentId określa identyfikator komentarza, dla którego mają zostać pobrane odpowiedzi.

Uwaga: YouTube obecnie obsługuje odpowiedzi tylko w przypadku komentarzy najwyższego poziomu. W przyszłości może być jednak obsługiwane odpowiadanie na odpowiedzi.
Parametry opcjonalne
maxResults unsigned integer
Parametr maxResults określa maksymalną liczbę elementów, które mają zostać zwrócone w zbiorze wyników.

Uwaga: ten parametr nie jest obsługiwany w połączeniu z parametrem id. Akceptowane wartości to liczby całkowite od 1 do 100 włącznie. Wartością domyślną jest 20.
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: ten parametr nie jest obsługiwany w połączeniu z parametrem id.
textFormat string
Ten parametr wskazuje, czy interfejs API ma zwracać komentarze sformatowane jako HTML czy jako zwykły tekst. 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#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment 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#commentListResponse.
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 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+.
forbidden (403) forbidden Nie można pobrać co najmniej 1 z żądanych komentarzy z powodu niewystarczających uprawnień. Żądanie może nie być prawidłowo autoryzowane.
notFound (404) commentNotFound Nie można znaleźć co najmniej 1 z podanych komentarzy. Sprawdź wartości parametrów id i parentId w żądaniu, aby upewnić się, że są prawidłowe.

Wypróbuj

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