Eine liveChatMessage
-Ressource steht für eine Chatnachricht in einem YouTube-Livechat. Die Ressource kann Details zu verschiedenen Arten von Nachrichten enthalten, z. B. zu einer neu geposteten Textnachricht oder einer Veranstaltung zur Finanzierung durch Fans.
Die Livechat-Funktion ist standardmäßig für Liveübertragungen aktiviert und verfügbar, solange die Live-Veranstaltung aktiv ist. Nach dem Ende der Veranstaltung steht der Livechat für diese Veranstaltung nicht mehr zur Verfügung.
Methoden
Die API unterstützt die folgenden Methoden für liveChatMessages
-Ressourcen:
- list
- Listet Livechat-Nachrichten für einen bestimmten Chat auf Hier kannst du die Funktion ausprobieren.
- einfügen
- Fügt einem Livechat eine Nachricht hinzu. Hier kannst du die Funktion ausprobieren.
- delete
- Löscht eine Chatnachricht. Die API-Anfrage muss vom Kanalinhaber oder Moderator des Livechats autorisiert werden. Hier kannst du die Funktion ausprobieren.
Ressourcendarstellung
Die folgende JSON-Struktur zeigt das Format einer liveChatMessages
-Ressource:
{ "kind": "youtube#liveChatMessage", "etag": etag, "id": string, "snippet": { "type": string, "liveChatId": string, "authorChannelId": string, "publishedAt": datetime, "hasDisplayContent": boolean, "displayMessage": string, "fanFundingEventDetails": { "amountMicros": unsigned long, "currency": string, "amountDisplayString": string, "userComment": string }, "textMessageDetails": { "messageText": string }, "messageDeletedDetails": { "deletedMessageId": string }, "userBannedDetails": { "bannedUserDetails": { "channelId": string, "channelUrl": string, "displayName": string, "profileImageUrl": string }, "banType": string, "banDurationSeconds": unsigned long }, "memberMilestoneChatDetails": { "userComment": string, "memberMonth": unsigned integer, "memberLevelName": string }, "newSponsorDetails": { "memberLevelName": string, "isUpgrade": bool }, "superChatDetails": { "amountMicros": unsigned long, "currency": string, "amountDisplayString": string, "userComment": string, "tier": unsigned integer }, "superStickerDetails": { "superStickerMetadata": { "stickerId": string, "altText": string, "language": string }, "amountMicros": unsigned long, "currency": string, "amountDisplayString": string, "tier": unsigned integer }, "membershipGiftingDetails": { "giftMembershipsCount": integer, "giftMembershipsLevelName": string }, "giftMembershipReceivedDetails": { "memberLevelName": string, "gifterChannelId": string, "associatedMembershipGiftingMessageId": string } }, "authorDetails": { "channelId": string, "channelUrl": string, "displayName": string, "profileImageUrl": string, "isVerified": boolean, "isChatOwner": boolean, "isChatSponsor": boolean, "isChatModerator": boolean } }
Attribute
In der folgenden Tabelle werden die Attribute definiert, die in dieser Ressource angezeigt werden:
Attribute | |
---|---|
kind |
string Identifiziert den Typ der API-Ressource. Der Wert ist youtube#liveChatMessage . |
etag |
etag Das ETag dieser Ressource. |
id |
string Die ID, die YouTube zur eindeutigen Identifizierung der Nachricht zuweist. |
snippet |
object Das Objekt snippet enthält wichtige Details zur Chatnachricht. |
snippet.type |
string Der Typ der Mitteilung. Dieses Attribut ist immer vorhanden und sein Wert bestimmt, welche Felder in der Ressource vorhanden sind. Gültige Werte für dieses Attribut sind:
|
snippet.liveChatId |
string Die ID, die den Livechat eindeutig identifiziert, mit dem die Nachricht verknüpft ist. Die mit einer Übertragung verknüpfte Livechat-ID wird im Attribut snippet.liveChatId der liveBroadcast -Ressource zurückgegeben. |
snippet.authorChannelId |
string Die ID des Nutzers, der die Nachricht verfasst hat. Dieses Feld wird nur bei den folgenden Mitteilungstypen ausgefüllt:
|
snippet.publishedAt |
datetime Datum und Uhrzeit der ursprünglichen Veröffentlichung der Nachricht. Der Wert wird im Format ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ) angegeben. |
snippet.hasDisplayContent |
boolean Gibt an, ob die Nachricht Inhalte enthält, die Nutzern angezeigt werden sollen. |
snippet.displayMessage |
string Enthält einen String, der Nutzern angezeigt wird. Dieses Feld ist nicht vorhanden, wenn der Nachrichtentyp chatEndedEvent oder tombstone ist. |
snippet.fanFundingEventDetails |
object Hinweis: Dieses Objekt und seine untergeordneten Attribute wurden verworfen. Ab dem 28. Februar 2017 werden für Ressourcen vom Typ liveChatMessage keine Details zu Veranstaltungen zur Finanzierung durch Fans mehr zurückgegeben.Dieses Objekt enthält Details zum Finanzierungsereignis. Er ist nur vorhanden, wenn der Nachrichtentyp fanFundingEvent ist. |
snippet.fanFundingEventDetails.amountMicros |
unsigned long Hinweis: Diese Property wurde eingestellt. Der Betrag des Fonds. |
snippet.fanFundingEventDetails.currency |
string Hinweis: Diese Property wurde eingestellt. Die Währung, in der der Fonds eingerichtet wurde. |
snippet.fanFundingEventDetails.amountDisplayString |
string Hinweis: Diese Property wurde eingestellt. Ein gerenderter String, der dem Nutzer den Betrag und die Währung des Guthabens anzeigt. |
snippet.fanFundingEventDetails.userComment |
string Hinweis: Diese Property wurde eingestellt. Der Kommentar, der vom Nutzer zu diesem Fan-Funding-Ereignis hinzugefügt wurde. |
snippet.textMessageDetails |
object Dieses Objekt enthält Details zur Textnachricht. Er ist nur vorhanden, wenn der Nachrichtentyp textMessageEvent ist. |
snippet.textMessageDetails.messageText |
string Die Nachricht des Nutzers. |
snippet.messageDeletedDetails |
object Dieses Objekt enthält Details zu einer Nachricht, die von einem Chatmoderator oder vom Inhaber des Kanals der Liveübertragung gelöscht wurde. Er ist nur vorhanden, wenn der Nachrichtentyp messageDeletedEvent ist. |
snippet.messageDeletedDetails.deletedMessageId |
string Die ID, die die gelöschte Nachricht eindeutig identifiziert. Der Wert entspricht dem Attributwert id der ursprünglichen Textnachricht. Beispiel: Wenn eine textMessageEvent den Eigenschaftswert 123 hat und diese Nachricht anschließend gelöscht wird, ist der snippet.messageDeletedDetails.deletedMessageId -Wert für diese Nachricht 123 .Wenn Sie Chatnachrichten nach dem Abrufen im Cache speichern, verwenden Sie den Wert dieser Eigenschaft, um die Nachricht anzugeben, die nicht mehr angezeigt werden soll. id |
snippet.userBannedDetails |
object Dieses Objekt enthält Details zu einem Nutzer, der für den Chat gesperrt wurde. Sie enthält auch Details zur Sperre selbst. Nutzer können dauerhaft oder vorübergehend aus einem Chat ausgeschlossen werden. |
snippet.userBannedDetails.bannedUserDetails |
object Dieses Objekt enthält Informationen über den gesperrten Nutzer. |
snippet.userBannedDetails.bannedUserDetails.channelId |
string Die YouTube-Kanal-ID des gesperrten Nutzers. |
snippet.userBannedDetails.bannedUserDetails.channelUrl |
string Die URL des YouTube-Kanals des gesperrten Nutzers. |
snippet.userBannedDetails.bannedUserDetails.displayName |
string Der Anzeigename des YouTube-Kanals des gesperrten Nutzers. |
snippet.userBannedDetails.bannedUserDetails.profileImageUrl |
string Der Avatar des YouTube-Kanals des gesperrten Nutzers. |
snippet.userBannedDetails.banType |
string Die Art der Sperre. Gültige Werte für dieses Attribut sind:
|
snippet.userBannedDetails.banDurationSeconds |
unsigned long Die Dauer der Sperre. Dieses Attribut ist nur vorhanden, wenn der Attributwert snippet.userBannedDetails.banType temporary ist. |
snippet.memberMilestoneChatDetails |
object Dieses Objekt enthält Details zu einem Meilensteinereignis für Mitglieder. Er ist nur vorhanden, wenn der Nachrichtentyp memberMilestoneChatEvent ist. |
snippet.memberMilestoneChatDetails.userComment |
string Der Kommentar, den das Mitglied dieser Chatnachricht für treue Mitglieder hinzugefügt hat. Dieses Feld ist bei Nachrichten ohne Kommentar des Mitglieds leer. |
snippet.memberMilestoneChatDetails.memberMonth |
unsigned integer Die Gesamtzahl der Monate (aufgerundet), während der ein Zuschauer Mitglied war und ihm diese Chatnachricht für treue Mitglieder gewährt hat. Dies entspricht der Anzahl von Monaten, die YouTube-Nutzern angezeigt wird. |
snippet.memberMilestoneChatDetails.memberLevelName |
string Der Name der Stufe, auf der der Betrachter Mitglied ist. Die Namen der Stufen werden durch den YouTube-Kanal bestimmt, der die Mitgliedschaft anbietet. In einigen Fällen ist dieses Feld nicht ausgefüllt. |
snippet.newSponsorDetails |
object Dieses Objekt enthält Details zum Ereignis „Benachrichtigung über neue Mitglieder“. Es wird nur festgelegt, wenn der Typ newSponsorEvent ist. Bitte beachte, dass „Mitglied“ der neue Begriff für „Unterstützer“ ist.
|
snippet.newSponsorDetails.memberLevelName |
string Der Name der Stufe, auf der der Betrachter Mitglied ist. Die Namen der Stufen werden durch den YouTube-Kanal bestimmt, der die Mitgliedschaft anbietet. In einigen Fällen wird dieses Feld nicht ausgefüllt. |
snippet.newSponsorDetails.isUpgrade |
bool Gibt an, ob der Betrachter gerade ein Upgrade von einer niedrigeren Ebene ausgeführt hat. Für Zuschauer, die zum Zeitpunkt des Kaufs kein Mitglied waren, lautet der Feldwert false .
|
snippet.superChatDetails |
object Dieses Objekt enthält Details zu einem Super Chat-Ereignis. Er ist nur vorhanden, wenn der Nachrichtentyp superChatEvent ist. |
snippet.superChatDetails.amountMicros |
unsigned long Der Kaufbetrag in millionstel Einheiten der Kaufwährung. Beträgt der Kaufbetrag beispielsweise einen Dollar, so lautet der Wert der snippet.amountMicros -Property 1000000 . |
snippet.superChatDetails.currency |
string Die Währung, in der der Kauf getätigt wurde. Der Wert ist ein ISO 4217-Währungscode. |
snippet.superChatDetails.amountDisplayString |
string Ein String wie $1.00 , der den Kaufbetrag und die Währung enthält. Der String ist für den Nutzer vorgesehen. |
snippet.superChatDetails.userComment |
string Der Kommentar, den der Nutzer dieser Super Chat-Veranstaltung hinzugefügt hat. |
snippet.superChatDetails.tier |
unsigned integer Die Stufe für die kostenpflichtige Nachricht. In einer superChatEvent -Ressource enthält die Property snippet.messageType diesen Wert.Die Stufe basiert auf dem Geldbetrag, der für den Kauf der Nachricht ausgegeben wurde. Sie bestimmt auch die Farbe, mit der die Nachricht im Livechat hervorgehoben wird, die maximale Nachrichtenlänge und die Zeit, in der die Nachricht im Ticker angepinnt wird. Die Super Chat-Ebenen findest du in der YouTube-Hilfe. Weitere Informationen findest du im maximierbaren Abschnitt zu den Kaufdetails für Super Chat. In dieser Liste ist die Stufe mit dem niedrigsten Kaufbetrag Stufe 1, der nächstniedrigere Betrag ist Stufe 2 usw. |
snippet.superStickerDetails |
object Dieses Objekt enthält Details zu einem Super Sticker-Ereignis. Er ist nur vorhanden, wenn der Nachrichtentyp superStickerEvent ist. |
snippet.superStickerDetails.superStickerMetadata |
object Details zum Super Sticker. |
snippet.superStickerDetails.superStickerMetadata.stickerId |
string Eine eindeutige ID, die das Stickerbild identifiziert. Das Bild wird nur als Teil der Super Sticker-Nachricht angezeigt, wenn Nutzer das Chatfenster auf YouTube ansehen. Die Bild-URL ist jedoch nicht über die API verfügbar. In dieser CSV-Datei kannst du nachsehen, welche Sticker-IDs zu welchen Super Stickern gehören. |
snippet.superStickerDetails.superStickerMetadata.altText |
string Ein Textstring, der den Sticker beschreibt. Das Feld snippet.superStickerDetails.superStickerMetadata.language gibt die Sprache des Textes an. Legen Sie beim Aufrufen der Methode liveChatMessages.list für den Parameter hl die gewünschte Textsprache fest. |
snippet.superStickerDetails.superStickerMetadata.language |
string Die Sprache des Property-Werts snippet.superStickerDetails.superStickerMetadata.altText . |
snippet.superStickerDetails.amountMicros |
unsigned long Der Kaufbetrag in millionstel Einheiten der Kaufwährung. Beträgt der Kaufbetrag beispielsweise einen Dollar, so lautet der Wert der snippet.amountMicros -Property 1000000 . |
snippet.superStickerDetails.currency |
string Die Währung, in der der Kauf getätigt wurde. Der Wert ist ein ISO 4217-Währungscode. |
snippet.superStickerDetails.amountDisplayString |
string Ein String wie $1.00 , der den Kaufbetrag und die Währung enthält. Der String ist für den Nutzer vorgesehen. |
snippet.superStickerDetails.tier |
unsigned integer Die Stufe für die kostenpflichtige Nachricht. In einer superChatEvent -Ressource enthält die Property snippet.messageType diesen Wert.Die Stufe basiert auf dem Geldbetrag, der für den Kauf der Nachricht ausgegeben wurde. Er bestimmt auch die Farbe, mit der die Nachricht im Livechat hervorgehoben wird, die maximale Nachrichtenlänge und die Zeit, in der die Nachricht im Ticker angepinnt ist. Die Super Chat-Stufen, die auch Super Sticker abdecken, findest du in der YouTube-Hilfe. Weitere Informationen findest du im maximierbaren Abschnitt zu den Kaufdetails für Super Chat. In dieser Liste ist die Stufe mit dem niedrigsten Kaufbetrag Stufe 1, der nächstniedrigere Betrag ist Stufe 2 usw. |
snippet.membershipGiftingDetails |
object Dieses Objekt enthält Details zu einem Ereignis zum Verschenken von Mitgliedschaften. Es ist nur vorhanden, wenn message type den Wert membershipGiftingEvent hat. |
snippet.membershipGiftingDetails.giftMembershipsCount |
integer Die Anzahl der vom Nutzer gekauften Mitgliedschaften zum Verschenken. |
snippet.membershipGiftingDetails.giftMembershipsLevelName |
string Der Name der Stufe der vom Nutzer gekauften Mitgliedschaften zum Verschenken. Die Namen der Stufen werden durch den YouTube-Kanal definiert, der die Mitgliedschaft anbietet. In einigen Fällen wird dieses Feld nicht ausgefüllt. |
snippet.giftMembershipReceivedDetails |
object Dieses Objekt enthält Details zu einem Ereignis zum Erhalt einer Geschenkmitgliedschaft. Es ist nur vorhanden, wenn message type den Wert giftMembershipReceivedEvent hat. |
snippet.giftMembershipReceivedDetails.memberLevelName |
string Der Name der Stufe, auf der der Betrachter Mitglied ist. Dies stimmt mit den snippet.membershipGiftingDetails.giftMembershipsLevelName der verknüpften Nachricht zum Verschenken von Mitgliedschaften überein. Die Namen der Stufen werden durch den YouTube-Kanal definiert, der die Mitgliedschaft anbietet. In einigen Fällen wird dieses Feld nicht ausgefüllt. |
snippet.giftMembershipReceivedDetails.gifterChannelId |
string Die ID des Nutzers, der die Mitgliedschaft zum Verschenken gekauft hat. Dies stimmt mit den snippet.authorChannelId der verknüpften Nachricht zum Verschenken von Mitgliedschaften überein. |
snippet.giftMembershipReceivedDetails.associatedMembershipGiftingMessageId |
string Die ID der Nachricht zum Verschenken von Mitgliedschaften, die sich auf diese geschenkte Mitgliedschaft bezieht. Diese ID bezieht sich immer auf eine Nachricht, deren type membershipGiftingEvent ist. |
authorDetails |
object Das Objekt authorDetails enthält zusätzliche Details zu dem Nutzer, der diese Nachricht gepostet hat. |
authorDetails.channelId |
string Die YouTube-Kanal-ID des Autors. |
authorDetails.channelUrl |
string Die URL des YouTube-Kanals des Autors. |
authorDetails.displayName |
string Der Anzeigename des YouTube-Kanals des Autors. |
authorDetails.profileImageUrl |
string Die Avatar-URL des YouTube-Kanals des Autors. |
authorDetails.isVerified |
boolean Dieser Wert gibt an, ob die Identität des Autors von YouTube bestätigt wurde. |
authorDetails.isChatOwner |
boolean Dieser Wert gibt an, ob der Autor der Inhaber des Livechats ist. |
authorDetails.isChatSponsor |
boolean Dieser Wert gibt an, ob der Autor ein Sponsor des Livechats ist. |
authorDetails.isChatModerator |
boolean Dieser Wert gibt an, ob der Autor ein Moderator des Livechats ist. |