SuperChatEvents

Zasób superChatEvent reprezentuje wiadomość superczatu kupioną przez fana podczas transmisji na żywo w YouTube. W strumieniu czatu na żywo w YouTube superczaty wyróżniają się na 2 sposoby:

  • Superczaty są wyróżnione kolorem.
  • Superczaty pozostają przypięte na pasku aktywności przez określony czas.

Kolor superczatu, czas, przez jaki pozostaje on przypięty na pasku aktywności, oraz maksymalna długość wiadomości są określane przez kwotę płatności. Więcej informacji o superczatach znajdziesz w Centrum pomocy YouTube.

Metody

Interfejs API obsługuje te metody w przypadku zasobów superChatEvents:

list
Wyświetla listę zdarzeń superczatu z transmisji na żywo na kanale w ciągu ostatnich 30 dni. Wypróbuj teraz.

Prezentacja zasobów

Ta struktura JSON pokazuje format zasobu superChatEvent:

{
  "kind": "youtube#superChatEvent",
  "etag": etag,
  "id": string,
  "snippet": {
    "channelId": string,
    "supporterDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "commentText": string,
    "createdAt": datetime,
    "amountMicros": unsigned long,
    "currency": string,
    "displayString": string,
    "messageType": unsigned integer,
    "isSuperStickerEvent": boolean,
    "superStickerMetadata": {
      "stickerId": string,
      "altText": string,
      "language": string
    }
  }
}

Właściwości

W tej tabeli zdefiniowano właściwości, które pojawiają się w tym zasobie:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość to youtube#superChatEvent.
etag etag
Etag tego zasobu.
id string
Identyfikator przypisany przez YouTube, który jednoznacznie identyfikuje zdarzenie superczatu.
snippet object
Obiekt snippet zawiera podstawowe informacje o zdarzeniu superczatu.
snippet.channelId string
Identyfikator kanału w YouTube, który identyfikuje kanał, który transmitował na żywo transmisję powiązaną ze zdarzeniem superczatu.
snippet.supporterDetails object
Szczegóły dotyczące kanału wspierającego.
snippet.supporterDetails.channelId string
Identyfikator kanału wspierającego w YouTube.
snippet.supporterDetails.channelUrl string
Adres URL kanału wspierającego.
snippet.supporterDetails.displayName string
Wyświetlana nazwa kanału wspierającego.
snippet.supporterDetails.profileImageUrl string
Adres URL awatara kanału wspierającego.
snippet.commentText string
Treść komentarza wspierającego.
snippet.createdAt datetime
Data i godzina zakupu superczatu. Wartość jest podana w formacie ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.amountMicros unsigned long
Kwota płatności w mikrojednostkach waluty zakupu. Jeśli na przykład kwota zakupu wynosi 1 USD, wartość właściwości snippet.amountMicros to 1000000.
snippet.currency string
Waluta, w której dokonano zakupu. Wartość jest kodem waluty w formacie ISO 4217.
snippet.displayString string
Ciąg znaków, np. $1.00, który pokazuje kwotę płatności i walutę. Ciąg znaków jest formatowany zgodnie z konwencjami języka określonego przez parametr żądania hl. Domyślnie ciągi znaków są formatowane tak, jak w języku angielskim. Na przykład domyślnie ciąg znaków jest formatowany jako $1.00 zamiast $1,00.
snippet.messageType unsigned integer
Poziom płatnej wiadomości. Gdy zasób liveChatMessage identyfikuje wiadomość superczatu, właściwość snippet.superChatDetails.tier zawiera tę wartość.

Poziom zależy od kwoty wydanej na zakup wiadomości. Określa też kolor używany do wyróżnienia wiadomości w interfejsie czatu na żywo, maksymalną długość wiadomości i czas, przez jaki wiadomość jest przypięta na pasku aktywności.

Poziomy superczatu są opisane w Centrum pomocy YouTube. (Zobacz rozwijaną sekcję o szczegółach zakupu superczatu). Na tej liście poziom z najniższą kwotą płatności to poziom 1, następny najniższy poziom to poziom 2 itd.
snippet.isSuperStickerEvent boolean
Wskazuje, czy zasób jest supernaklejką, czyli szczególnym typem wiadomości superczatu, która ma powiązany obraz. Jeśli wartość tego pola to true, pole superStickerMetadata będzie zawierać informacje, które można wykorzystać do wyświetlenia obrazu.
snippet.superStickerMetadata object
Szczegóły dotyczące supernaklejki. Ten obiekt jest zwracany tylko wtedy, gdy wartość pola snippet.isSuperStickerEvent to true.
snippet.superStickerMetadata.stickerId string
Unikalny identyfikator, który identyfikuje obraz naklejki. Obraz jest wyświetlany jako część wiadomości supernaklejki tylko wtedy, gdy użytkownicy wyświetlają okno czatu w YouTube. Adres URL obrazu nie jest jednak dostępny przez interfejs API. W tym pliku CSV znajdziesz informacje o tym, które identyfikatory naklejek odnoszą się do których supernaklejek.
snippet.superStickerMetadata.altText string
Ciąg znaków opisujący naklejkę. Pole snippet.superStickerMetadata.language określa język tekstu. Podczas wywoływania metody superChatEvents.list ustaw wartość parametru hl na żądany język tekstu.
snippet.superStickerMetadata.language string
Język wartości właściwości snippet.superStickerMetadata.altText. Jeśli supernaklejka zawiera też tekst, jest on również w tym języku.