Youtube · Schema

LiveChatMessage

A liveChatMessage resource represents a chat message in a YouTube live broadcast.

GoogleMediaSocialStreamingVideoVideos

Properties

Name	Type	Description
kind	string	Identifies the API resource's type. Value is youtube#liveChatMessage.
etag	string	The Etag of this resource.
id	string	The ID that YouTube assigns to uniquely identify the message.
snippet	object	The snippet object contains basic details about the message.
authorDetails	object	The authorDetails object contains basic details about the user that posted this message.

View JSON Schema on GitHub

JSON Schema

{
  "type": "object",
  "description": "A liveChatMessage resource represents a chat message in a YouTube live broadcast.",
  "properties": {
    "kind": {
      "type": "string",
      "description": "Identifies the API resource's type. Value is youtube#liveChatMessage.",
      "example": "youtube#video"
    },
    "etag": {
      "type": "string",
      "description": "The Etag of this resource.",
      "example": "XI7nbFXulYBIpL0ayR_gDh3eu1k"
    },
    "id": {
      "type": "string",
      "description": "The ID that YouTube assigns to uniquely identify the message.",
      "example": "abc123def456"
    },
    "snippet": {
      "type": "object",
      "description": "The snippet object contains basic details about the message.",
      "example": "example_value",
      "properties": {
        "liveChatId": {
          "type": "string",
          "description": "The ID of the live chat to which this message belongs."
        },
        "type": {
          "type": "string",
          "description": "The type of message.",
          "enum": [
            "chatEndedEvent",
            "fanFundingEvent",
            "giftMembershipReceivedEvent",
            "memberMilestoneChatEvent",
            "membershipGiftingEvent",
            "messageDeletedEvent",
            "newSponsorEvent",
            "pollClosedEvent",
            "pollEditedEvent",
            "pollOpenedEvent",
            "pollVotedEvent",
            "sponsorOnlyModeEndedEvent",
            "sponsorOnlyModeStartedEvent",
            "superChatEvent",
            "superStickerEvent",
            "textMessageEvent",
            "tombstone",
            "userBannedEvent"
          ]
        },
        "displayMessage": {
          "type": "string",
          "description": "Contains a string that can be displayed to the user. The string is not necessarily the message text itself."
        },
        "authorChannelId": {
          "type": "string",
          "description": "The ID of the user that authored this message."
        },
        "publishedAt": {
          "type": "string",
          "description": "The date and time when the message was orignally published.",
          "format": "date-time"
        },
        "hasDisplayContent": {
          "type": "boolean",
          "description": "Whether the message has display content that should be displayed to users."
        },
        "textMessageDetails": {
          "type": "object",
          "description": "Details about the text message. This object is only present if the type is textMessageEvent.",
          "properties": {
            "messageText": {
              "type": "string",
              "description": "The user's message."
            }
          }
        }
      }
    },
    "authorDetails": {
      "type": "object",
      "description": "The authorDetails object contains basic details about the user that posted this message.",
      "example": "example_value",
      "properties": {
        "channelId": {
          "type": "string",
          "description": "The YouTube channel ID of the message author."
        },
        "channelUrl": {
          "type": "string",
          "description": "The channel URL of the message author."
        },
        "displayName": {
          "type": "string",
          "description": "The channel's display name."
        },
        "profileImageUrl": {
          "type": "string",
          "description": "The channel's avatar URL."
        },
        "isVerified": {
          "type": "boolean",
          "description": "Indicates whether YouTube has verified the authenticity of the channel owner's identity."
        },
        "isChatOwner": {
          "type": "boolean",
          "description": "Indicates whether the user is the owner of the live chat."
        },
        "isChatSponsor": {
          "type": "boolean",
          "description": "Indicates whether the user is a sponsor of the live chat."
        },
        "isChatModerator": {
          "type": "boolean",
          "description": "Indicates whether the user is a moderator of the live chat."
        }
      }
    }
  },
  "required": [
    "kind",
    "etag"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "LiveChatMessage",
  "x-schema-source": "openapi",
  "x-source-url": "openapi/youtube-live-streaming-openapi.yml"
}