SuperChatEvents: list

Lista zdarzeń superczatu z transmisji na żywo z kanału z ostatnich 30 dni.

Typowe zastosowania

Żądanie

Żądanie HTTP

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

Autoryzacja

To żądanie wymaga autoryzacji z co najmniej jednym z tych zakresów. Więcej informacji o uwierzytelnianiu i autoryzacji znajdziesz w artykule Wdrażanie uwierzytelniania OAuth 2.0.

Zakres
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

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
Parametry part określają części zasobu superChatEvent, które będą uwzględnione w odpowiedzi interfejsu API. Obsługiwane wartości to id i snippet.
Parametry opcjonalne
hl string
Parametr hl instruuje serwer interfejsu API, aby sformatował wartość właściwości snippet.displayString, która pokazuje kwotę i walutę superczatu zgodnie z konwencjami danego języka. Wartość parametru musi być kodem języka uwzględnionym na liście zwróconej przez metodę i18nLanguages.list. Wartość domyślna to en, co oznacza, że domyślne działanie polega na formatowaniu ciągów tekstowych tak, jak byłyby używane w języku angielskim. Na przykład domyślnie ciąg znaków jest sformatowany jako $1.00, a nie $1,00.
maxResults unsigned integer
Parametry maxResults określają maksymalną liczbę elementów, które powinny zostać zwrócone w zbiorze wyników. Akceptowane wartości to od 1 do 50 (włącznie). Wartością domyślną jest 5.
pageToken string
Parametr pageToken identyfikuje konkretną stronę w zbiorze wyników, która powinna zostać zwrócona. W odpowiedzi interfejsu API właściwości nextPageToken i prevPageToken wskazują inne strony, które można pobrać.

Treść żądania

Podczas wywoływania tej metody nie podawaj treści żądania.

Odpowiedź

Jeśli operacja się powiedzie, metoda zwróci odpowiedź o tej strukturze:

{
  "kind": "youtube#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

Właściwości

Właściwości występujące w tym zasobie są opisane w tabeli poniżej:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#superChatEventListResponse.
etag etag
Etag tego zasobu.
nextPageToken string
Token, który można użyć jako wartości parametru pageToken, aby pobrać kolejną stronę zbioru wyników.
pageInfo object
Obiekt pageInfo zawiera informacje o podziałach na strony w przypadku 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 zakupów w superczacie, 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 dotyczącej komunikatów o błędach.

Typ błędu Szczegóły błędu Opis
forbidden (403) insufficientPermissions Żądanie nie jest prawidłowo autoryzowane do pobierania zdarzeń superczatu.

Wypróbuj

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