Un recurso liveChatMessage
representa un mensaje de chat en un chat en vivo de YouTube. El recurso puede contener detalles sobre varios tipos de mensajes, como mensajes de texto publicados recientemente o eventos de financiación de fans.
La función de chat en vivo está habilitada de forma predeterminada para las transmisiones en vivo y está disponible mientras el evento en vivo está activo. (Una vez finalizado el evento, el chat en vivo ya no estará disponible).
Métodos
La API admite los siguientes métodos para los recursos liveChatMessages
:
- list
- Enumera los mensajes del chat en vivo de un chat específico. Pruébala ahora.
- insertar
- Agrega un mensaje a un chat en vivo. Pruébala ahora.
- borrar
- Borra un mensaje de chat. El propietario del canal o un moderador del chat en vivo debe autorizar la solicitud a la API. Pruébala ahora.
Representación de recursos
En la siguiente estructura JSON, se muestra el formato de un recurso liveChatMessages
:
{ "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 } }
Propiedades
La siguiente tabla define las propiedades que aparecen en este recurso:
Propiedades | |
---|---|
kind |
string Identifica el tipo de recurso de la API. El valor será youtube#liveChatMessage . |
etag |
etag La Etag de este recurso. |
id |
string Es el ID que YouTube asigna para identificar de forma única el mensaje. |
snippet |
object El objeto snippet contiene detalles principales sobre el mensaje de chat. |
snippet.type |
string El tipo de mensaje. Esta propiedad siempre está presente, y su valor determina qué campos están presentes en el recurso. Los valores válidos para esta propiedad son los siguientes:
|
snippet.liveChatId |
string Es el ID que identifica de manera inequívoca el chat en vivo con el que se asocia el mensaje. El ID del chat en vivo asociado con una transmisión se muestra en la propiedad snippet.liveChatId del recurso liveBroadcast . |
snippet.authorChannelId |
string Es el ID del usuario que autorizó el mensaje. Este campo solo se completa para los siguientes tipos de mensajes:
|
snippet.publishedAt |
datetime Fecha y hora en que se publicó originalmente el mensaje. El valor se especifica en formato ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ). |
snippet.hasDisplayContent |
boolean Indica si el mensaje tiene contenido en pantalla que se debe mostrar a los usuarios. |
snippet.displayMessage |
string Contiene una cadena que se muestra a los usuarios. Este campo no está presente si el tipo de mensaje es chatEndedEvent o tombstone . |
snippet.fanFundingEventDetails |
object Nota: Este objeto y sus propiedades secundarias dejaron de estar disponibles. A partir del 28 de febrero de 2017, los recursos de liveChatMessage ya no mostrarán los detalles de los eventos de financiación de fans.El objeto contiene detalles sobre el evento de financiación. Solo está presente si el tipo de mensaje es fanFundingEvent . |
snippet.fanFundingEventDetails.amountMicros |
unsigned long Nota: Esta propiedad dejó de estar disponible. El importe del fondo. |
snippet.fanFundingEventDetails.currency |
string Nota: Esta propiedad dejó de estar disponible. La moneda en la que se realizó el fondo. |
snippet.fanFundingEventDetails.amountDisplayString |
string Nota: Esta propiedad dejó de estar disponible. Es una cadena renderizada que le muestra al usuario el importe y la moneda del fondo. |
snippet.fanFundingEventDetails.userComment |
string Nota: Esta propiedad dejó de estar disponible. El comentario que agregó el usuario a este evento de financiación de fans. |
snippet.textMessageDetails |
object Este objeto contiene detalles sobre el mensaje de texto. Solo está presente si el tipo de mensaje es textMessageEvent . |
snippet.textMessageDetails.messageText |
string El mensaje del usuario. |
snippet.messageDeletedDetails |
object Este objeto contiene detalles sobre un mensaje borrado por un moderador del chat o por el propietario del canal de la transmisión en vivo. Solo está presente si el tipo de mensaje es messageDeletedEvent . |
snippet.messageDeletedDetails.deletedMessageId |
string El ID que identifica de forma exclusiva el mensaje borrado. El valor es el mismo que el de la propiedad id del mensaje de texto original. Por ejemplo, si un textMessageEvent tiene un valor de propiedad id de 123 y, luego, ese mensaje se borra, el valor snippet.messageDeletedDetails.deletedMessageId será 123 para ese mensaje.Si almacenas en caché los mensajes de chat después de recuperarlos, usa el valor de esta propiedad para identificar el mensaje que ya no se debe mostrar. |
snippet.userBannedDetails |
object Este objeto contiene detalles sobre un usuario que se bloqueó en el chat. También incluye detalles sobre la prohibición. Se puede bloquear a los usuarios de un chat de forma permanente o temporal. |
snippet.userBannedDetails.bannedUserDetails |
object Este objeto contiene información sobre el usuario bloqueado. |
snippet.userBannedDetails.bannedUserDetails.channelId |
string El ID del canal de YouTube del usuario bloqueado. |
snippet.userBannedDetails.bannedUserDetails.channelUrl |
string La URL del canal de YouTube del usuario bloqueado. |
snippet.userBannedDetails.bannedUserDetails.displayName |
string El nombre visible del canal de YouTube del usuario bloqueado. |
snippet.userBannedDetails.bannedUserDetails.profileImageUrl |
string El avatar del canal de YouTube del usuario bloqueado. |
snippet.userBannedDetails.banType |
string El tipo de bloqueo Los valores válidos para esta propiedad son los siguientes:
|
snippet.userBannedDetails.banDurationSeconds |
unsigned long Duración del bloqueo Esta propiedad solo está presente si el valor de la propiedad snippet.userBannedDetails.banType es temporary . |
snippet.memberMilestoneChatDetails |
object Este objeto contiene detalles sobre un evento de logro para miembros. Solo está presente si el tipo de mensaje es memberMilestoneChatEvent . |
snippet.memberMilestoneChatDetails.userComment |
string El comentario que agregó el miembro a este mensaje de recompensa para miembros Este campo está vacío para los mensajes sin comentarios del miembro. |
snippet.memberMilestoneChatDetails.memberMonth |
unsigned integer La cantidad total de meses (redondeados hacia arriba) en los que el usuario fue miembro y le otorgó este mensaje de recompensa para miembros. Es la misma cantidad de meses que se muestra a los usuarios de YouTube. |
snippet.memberMilestoneChatDetails.memberLevelName |
string Corresponde al nombre del nivel al que pertenece el usuario. El canal de YouTube que ofrece la Membresía define los nombres de los niveles. En algunas situaciones, este campo no se completa. |
snippet.newSponsorDetails |
object Este objeto contiene detalles sobre el evento Anuncio para miembros nuevos. Solo se establece si el tipo es newSponsorEvent . Ten en cuenta que "miembro" es el nuevo término para "patrocinador".
|
snippet.newSponsorDetails.memberLevelName |
string Corresponde al nombre del nivel al que pertenece el usuario. El canal de YouTube que ofrece la Membresía define los nombres de los niveles. En algunas situaciones, este campo no se completa. |
snippet.newSponsorDetails.isUpgrade |
bool Indica si el usuario acaba de actualizar su cuenta desde un nivel inferior. Para los usuarios que no eran miembros en el momento de la compra, el valor del campo es false .
|
snippet.superChatDetails |
object Este objeto contiene detalles sobre un evento de Súper chat. Solo está presente si el tipo de mensaje es superChatEvent . |
snippet.superChatDetails.amountMicros |
unsigned long Es el importe de la compra, en micros de la moneda de compra. Por ejemplo, si el importe de la compra es de un dólar, el valor de la propiedad snippet.amountMicros es 1000000 . |
snippet.superChatDetails.currency |
string Es la moneda en la que se realizó la compra. El valor es un código de moneda ISO 4217. |
snippet.superChatDetails.amountDisplayString |
string Es una string, como $1.00 , que contiene el importe de la compra y la moneda. La string debe mostrarse al usuario. |
snippet.superChatDetails.userComment |
string El comentario que agregó el usuario a este evento de Súper chat |
snippet.superChatDetails.tier |
unsigned integer Es el nivel del mensaje pagado. Ten en cuenta que, en un recurso superChatEvent , la propiedad snippet.messageType contiene este valor.El nivel se basa en la cantidad de dinero gastado para comprar el mensaje. También determina el color que se usará para destacar el mensaje en la IU del chat en vivo, la longitud máxima del mensaje y la cantidad de tiempo que el mensaje permanecerá fijo en el visor. Los niveles de Súper chat se documentan en el Centro de ayuda de YouTube. Consulta la sección expandible sobre los detalles de compra de Súper chat. En esa lista, el nivel con el menor importe de compra es el 1, el siguiente importe más bajo es el 2, y así sucesivamente. |
snippet.superStickerDetails |
object Este objeto contiene detalles sobre un evento de Súper calcomanías. Solo está presente si el tipo de mensaje es superStickerEvent . |
snippet.superStickerDetails.superStickerMetadata |
object Detalles sobre la Súper calcomanía. |
snippet.superStickerDetails.superStickerMetadata.stickerId |
string Es un ID único que identifica la imagen de la calcomanía. Ten en cuenta que la imagen solo se muestra como parte del mensaje de Súper calcomanías cuando los usuarios ven la ventana de chat en YouTube. Sin embargo, la URL de la imagen no está disponible a través de la API. A modo de referencia, en este archivo CSV puedes encontrar los IDs de calcomanías relacionados con las Súper calcomanías. |
snippet.superStickerDetails.superStickerMetadata.altText |
string Es una cadena de texto que describe la calcomanía. El campo snippet.superStickerDetails.superStickerMetadata.language identifica el idioma del texto. Cuando llames al método liveChatMessages.list , establece el valor del parámetro hl en el idioma deseado para el texto. |
snippet.superStickerDetails.superStickerMetadata.language |
string El idioma del valor de la propiedad snippet.superStickerDetails.superStickerMetadata.altText . |
snippet.superStickerDetails.amountMicros |
unsigned long Es el importe de la compra, en micros de la moneda de compra. Por ejemplo, si el importe de la compra es de un dólar, el valor de la propiedad snippet.amountMicros es 1000000 . |
snippet.superStickerDetails.currency |
string Es la moneda en la que se realizó la compra. El valor es un código de moneda ISO 4217. |
snippet.superStickerDetails.amountDisplayString |
string Es una string, como $1.00 , que contiene el importe de la compra y la moneda. La string debe mostrarse al usuario. |
snippet.superStickerDetails.tier |
unsigned integer Es el nivel del mensaje pagado. Ten en cuenta que, en un recurso superChatEvent , la propiedad snippet.messageType contiene este valor.El nivel se basa en la cantidad de dinero gastado para comprar el mensaje. También determina el color que se usará para destacar el mensaje en la IU del chat en vivo, su longitud máxima y el tiempo que el mensaje permanecerá fijo en el visor. Los niveles de Súper chat, que también abarcan las Súper calcomanías, se documentan en el Centro de ayuda de YouTube. Consulta la sección expandible sobre los detalles de compra de Súper chat. En esa lista, el nivel con el menor importe de compra es el 1, el siguiente importe más bajo es el 2, y así sucesivamente. |
snippet.membershipGiftingDetails |
object Este objeto contiene detalles sobre un evento de Regalar membresía. Solo está presente si el message type es membershipGiftingEvent . |
snippet.membershipGiftingDetails.giftMembershipsCount |
integer La cantidad de membresías de regalo que compró el usuario. |
snippet.membershipGiftingDetails.giftMembershipsLevelName |
string Corresponde al nombre del nivel de las membresías de regalo que compró el usuario. El canal de YouTube que ofrece la Membresía define los nombres de los niveles. En algunas situaciones, este campo no se completa. |
snippet.giftMembershipReceivedDetails |
object Este objeto contiene detalles sobre un evento de membresía de regalo recibida. Solo está presente si el message type es giftMembershipReceivedEvent . |
snippet.giftMembershipReceivedDetails.memberLevelName |
string Corresponde al nombre del nivel al que pertenece el usuario. Esto coincide con el snippet.membershipGiftingDetails.giftMembershipsLevelName del mensaje de regalo de membresías asociado. El canal de YouTube que ofrece la Membresía define los nombres de los niveles. En algunas situaciones, este campo no se completa. |
snippet.giftMembershipReceivedDetails.gifterChannelId |
string Es el ID del usuario que realizó la compra de la membresía como regalo. Esto coincide con el snippet.authorChannelId del mensaje de regalo de membresías asociado. |
snippet.giftMembershipReceivedDetails.associatedMembershipGiftingMessageId |
string El ID del mensaje de regalo de membresía relacionado con esta membresía de regalo. Este ID siempre hará referencia a un mensaje cuyo type sea membershipGiftingEvent . |
authorDetails |
object El objeto authorDetails contiene detalles adicionales sobre el usuario que publicó este mensaje. |
authorDetails.channelId |
string El ID del canal de YouTube del autor. |
authorDetails.channelUrl |
string Corresponde a la URL del canal de YouTube del autor. |
authorDetails.displayName |
string Corresponde al nombre visible del canal de YouTube del autor. |
authorDetails.profileImageUrl |
string URL de avatar del canal de YouTube del autor. |
authorDetails.isVerified |
boolean Este valor indica si YouTube verificó la identidad del autor. |
authorDetails.isChatOwner |
boolean Este valor indica si el autor es el propietario del chat en vivo. |
authorDetails.isChatSponsor |
boolean Este valor indica si el autor es un patrocinador del chat en vivo. |
authorDetails.isChatModerator |
boolean Este valor indica si el autor es moderador del chat en vivo. |