SuperChatEvents

Zasób superChatEvent dotyczy superczatu kupionego przez fana podczas transmisji na żywo w YouTube. W transmisji na żywo w YouTube superczaty wyróżniają się na tle innych wiadomości na 2 sposoby:

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

Kolor superczatu, okres przypięcia go na pasku aktywności oraz maksymalna długość wiadomości zależą od kwoty zakupu. Więcej informacji o superczacie znajdziesz w Centrum pomocy YouTube.

Metody

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

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

Reprezentacja zasobu

Poniższa 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

Poniższa tabela definiuje właściwości, które pojawiają się w tym zasobie:

Właściwości
kind string
Określa typ zasobu API. Wartością będzie youtube#superChatEvent.
etag etag
Tag ETag tego zasobu.
id string
Identyfikator przypisywany przez YouTube w celu jednoznacznego identyfikowania wydarzenia superczatu
snippet object
Obiekt snippet zawiera podstawowe informacje o zdarzeniu superczatu.
snippet.channelId string
Identyfikator kanału w YouTube identyfikujący kanał, który transmituje transmisję na żywo powiązaną z wydarzeniem superczatu.
snippet.supporterDetails object
Szczegółowe informacje o kanale wspierającego.
snippet.supporterDetails.channelId string
Identyfikator kanału YouTube osoby wspierającej kanał.
snippet.supporterDetails.channelUrl string
Adres URL kanału osoby wspierającej.
snippet.supporterDetails.displayName string
Wyświetlana nazwa kanału osoby wspierającej kanał.
snippet.supporterDetails.profileImageUrl string
Adres URL awatara kanału osoby wspierającej.
snippet.commentText string
Tekst komentarza osoby wspierającej.
snippet.createdAt datetime
Data i godzina zakupu superczatu. Wartość musi być podana w formacie ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.amountMicros unsigned long
Kwota zakupu w milionach waluty zakupu. Jeśli np. kwota zakupu to 1 zł, wartością właściwości snippet.amountMicros jest 1000000.
snippet.currency string
Waluta, w której dokonano zakupu. Wartością jest kod waluty zgodny z normą ISO 4217.
snippet.displayString string
Ciąg tekstowy, np. $1.00, zawierający kwotę do zapłaty i walutę. Wyświetlany ciąg znaków jest sformatowany na podstawie konwencji języka określonego w parametrze żądania hl. Domyślnie wyświetlane ciągi znaków są sformatowane tak, jak będą po angielsku. Na przykład domyślnie ciąg znaków ma format $1.00, a nie $1,00.
snippet.messageType unsigned integer
Poziom płatnej wiadomości. Pamiętaj, że gdy zasób liveChatMessage identyfikuje superczat, właściwość snippet.superChatDetails.tier zawiera tę wartość.

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

Poziomy superczatu znajdziesz w Centrum pomocy YouTube. (patrz sekcja rozwijana ze szczegółami zakupu Superczatu). Z tej listy poziom z najniższą kwotą zakupu to poziom 1, kolejna niższa kwota to poziom 2 itd.
snippet.isSuperStickerEvent boolean
Wskazuje, czy zasób to supernaklejka, czyli konkretny typ wiadomości superczatu, z którym jest powiązany obraz. Jeśli wartość tego pola to true, pole superStickerMetadata zawiera informacje, które pozwalają wyświetlić obraz.
snippet.superStickerMetadata object
Szczegółowe informacje o supernaklejce. Ten obiekt jest zwracany tylko wtedy, gdy wartość pola snippet.isSuperStickerEvent to true.
snippet.superStickerMetadata.stickerId string
Unikalny identyfikator, który identyfikuje obraz naklejki. Pamiętaj, że obraz jest wyświetlany tylko jako część wiadomości z supernaklejką, gdy użytkownicy wyświetlają okno czatu w YouTube. Jednak adres URL obrazu nie jest dostępny za pośrednictwem interfejsu API. Informację o tym, które identyfikatory naklejek są powiązane z poszczególnymi supernaklejkami, znajdziesz w tym pliku CSV.
snippet.superStickerMetadata.altText string
Ciąg tekstowy opisujący naklejkę. Pole snippet.superStickerMetadata.language określa język tekstu. Przy wywoływaniu metody superChatEvents.list ustaw wartość parametru hl na wybrany język tekstu.
snippet.superStickerMetadata.language string
Język wartości właściwości snippet.superStickerMetadata.altText. Jeśli naklejka Super Sticker wyświetla tekst, on również jest w tym języku.