YouTube Data API v3 . liveChatMessages

Instance Methods

delete(id, x__xgafv=None)

Deletes a chat message.

insert(part, body=None, x__xgafv=None)

Inserts a new resource into this collection.

list(liveChatId, part, pageToken=None, hl=None, maxResults=None, profileImageSize=None, x__xgafv=None)

Retrieves a list of resources, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(id, x__xgafv=None)
Deletes a chat message.

Args:
  id: string, A parameter (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
insert(part, body=None, x__xgafv=None)
Inserts a new resource into this collection.

Args:
  part: string, The <code><strong>part</strong></code> parameter serves two purposes. It
identifies the properties that the write operation will set as well as the
properties that the API response will include. Set the parameter value to
<code>snippet</code>. (required) (repeated)
  body: object, The request body.
    The object takes the form of:

{ # A <code><strong>liveChatMessage</strong></code> resource represents a chat
      # message in a YouTube Live Chat.
    "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string
        # <code>"youtube#liveChatMessage"</code>.
    "etag": "A String", # Etag of this resource.
    "snippet": { # The <code>snippet</code> object contains basic details about the message.
      "liveChatId": "A String",
      "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always
          # filled.
          # textMessageEvent - the user that wrote the message
          # fanFundingEvent - the user that funded the broadcast
          # newSponsorEvent - the user that just became a sponsor
          # messageDeletedEvent - the moderator that took the action
          # messageRetractedEvent - the author that retracted their message
          # userBannedEvent - the moderator that took the action
          # superChatEvent - the user that made the purchase
      "publishedAt": "A String", # The date and time when the message was orignally published. The value is
          # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
          # format.
      "userBannedDetails": {
        "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the
            # <code>banType</code> is <code>temporary</code>.
        "bannedUserDetails": { # The details of the user that was banned.
          "profileImageUrl": "A String", # The channels's avatar URL.
          "channelUrl": "A String", # The channel's URL.
          "displayName": "A String", # The channel's display name.
          "channelId": "A String", # The YouTube channel ID.
        },
        "banType": "A String", # The type of ban.
      },
      "messageRetractedDetails": {
        "retractedMessageId": "A String",
      },
      "superChatDetails": { # Details about the Super Chat event, this is only set if the type is
          # 'superChatEvent'.
        "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
        "userComment": "A String", # The comment added by the user to this Super Chat event.
        "currency": "A String", # The currency in which the purchase was made.
        "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
        "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower
            # tiers. The lowest tier is <code>1</code>.
      },
      "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is
          # 'superStickerEvent'.
        "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower
            # tiers. The lowest tier is <code>1</code>.
        "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
        "superStickerMetadata": { # Information about the Super Sticker.
          "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
          "altText": "A String", # Internationalized alt text that describes the sticker image and any
              # animation associated with it.
          "stickerId": "A String", # Unique identifier of the Super Sticker. This is a shorter form of the
              # alt_text that includes pack name and a recognizable characteristic of the
              # sticker.
        },
        "currency": "A String", # The currency in which the purchase was made.
        "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
      },
      "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is
          # 'fanFundingEvent'.
        "userComment": "A String", # The comment added by the user to this fan funding event.
        "amountMicros": "A String", # The amount of the fund.
        "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
        "currency": "A String", # The currency in which the fund was made.
      },
      "textMessageDetails": { # Details about the text message, this is only set if the type is
          # 'textMessageEvent'.
        "messageText": "A String", # The user's message.
      },
      "displayMessage": "A String", # Contains a string that can be displayed to the user.
          # If this field is not present the message is silent, at the moment only
          # messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
      "messageDeletedDetails": {
        "deletedMessageId": "A String",
      },
      "type": "A String", # The type of message, this will always be present, it determines the
          # contents of the message as well as which fields will be present.
      "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
    },
    "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
    "authorDetails": { # The <code>authorDetails</code> object contains basic details about the
        # user that posted this message.
      "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
      "channelUrl": "A String", # The channel's URL.
      "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
      "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
      "isChatOwner": True or False, # Whether the author is the owner of the live chat.
      "profileImageUrl": "A String", # The channels's avatar URL.
      "channelId": "A String", # The YouTube channel ID.
      "displayName": "A String", # The channel's display name.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A <code><strong>liveChatMessage</strong></code> resource represents a chat
        # message in a YouTube Live Chat.
      "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string
          # <code>"youtube#liveChatMessage"</code>.
      "etag": "A String", # Etag of this resource.
      "snippet": { # The <code>snippet</code> object contains basic details about the message.
        "liveChatId": "A String",
        "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always
            # filled.
            # textMessageEvent - the user that wrote the message
            # fanFundingEvent - the user that funded the broadcast
            # newSponsorEvent - the user that just became a sponsor
            # messageDeletedEvent - the moderator that took the action
            # messageRetractedEvent - the author that retracted their message
            # userBannedEvent - the moderator that took the action
            # superChatEvent - the user that made the purchase
        "publishedAt": "A String", # The date and time when the message was orignally published. The value is
            # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
            # format.
        "userBannedDetails": {
          "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the
              # <code>banType</code> is <code>temporary</code>.
          "bannedUserDetails": { # The details of the user that was banned.
            "profileImageUrl": "A String", # The channels's avatar URL.
            "channelUrl": "A String", # The channel's URL.
            "displayName": "A String", # The channel's display name.
            "channelId": "A String", # The YouTube channel ID.
          },
          "banType": "A String", # The type of ban.
        },
        "messageRetractedDetails": {
          "retractedMessageId": "A String",
        },
        "superChatDetails": { # Details about the Super Chat event, this is only set if the type is
            # 'superChatEvent'.
          "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
          "userComment": "A String", # The comment added by the user to this Super Chat event.
          "currency": "A String", # The currency in which the purchase was made.
          "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
          "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower
              # tiers. The lowest tier is <code>1</code>.
        },
        "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is
            # 'superStickerEvent'.
          "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower
              # tiers. The lowest tier is <code>1</code>.
          "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
          "superStickerMetadata": { # Information about the Super Sticker.
            "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
            "altText": "A String", # Internationalized alt text that describes the sticker image and any
                # animation associated with it.
            "stickerId": "A String", # Unique identifier of the Super Sticker. This is a shorter form of the
                # alt_text that includes pack name and a recognizable characteristic of the
                # sticker.
          },
          "currency": "A String", # The currency in which the purchase was made.
          "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
        },
        "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is
            # 'fanFundingEvent'.
          "userComment": "A String", # The comment added by the user to this fan funding event.
          "amountMicros": "A String", # The amount of the fund.
          "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
          "currency": "A String", # The currency in which the fund was made.
        },
        "textMessageDetails": { # Details about the text message, this is only set if the type is
            # 'textMessageEvent'.
          "messageText": "A String", # The user's message.
        },
        "displayMessage": "A String", # Contains a string that can be displayed to the user.
            # If this field is not present the message is silent, at the moment only
            # messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
        "messageDeletedDetails": {
          "deletedMessageId": "A String",
        },
        "type": "A String", # The type of message, this will always be present, it determines the
            # contents of the message as well as which fields will be present.
        "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
      },
      "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
      "authorDetails": { # The <code>authorDetails</code> object contains basic details about the
          # user that posted this message.
        "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
        "channelUrl": "A String", # The channel's URL.
        "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
        "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
        "isChatOwner": True or False, # Whether the author is the owner of the live chat.
        "profileImageUrl": "A String", # The channels's avatar URL.
        "channelId": "A String", # The YouTube channel ID.
        "displayName": "A String", # The channel's display name.
      },
    }
list(liveChatId, part, pageToken=None, hl=None, maxResults=None, profileImageSize=None, x__xgafv=None)
Retrieves a list of resources, possibly filtered.

Args:
  liveChatId: string, The id of the live chat for which comments should be returned. (required)
  part: string, The <code><strong>part</strong></code> parameter specifies the
<code>liveChatComment</code> resource parts that the API response will
include. Supported values are <code>id</code> and <code>snippet</code>. (required) (repeated)
  pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific
page in the result set that should be returned. In an API response, the
<code>nextPageToken</code> property identify other pages that could be
retrieved.
  hl: string, Specifies the localization language in which the system messages
should be returned.
  maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the
maximum number of items that should be returned in the result set.
  profileImageSize: integer, Specifies the size of the profile image that should be
returned for each user.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "pollingIntervalMillis": 42, # The amount of time the client should wait before polling again.
    "items": [
      { # A <code><strong>liveChatMessage</strong></code> resource represents a chat
            # message in a YouTube Live Chat.
          "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string
              # <code>"youtube#liveChatMessage"</code>.
          "etag": "A String", # Etag of this resource.
          "snippet": { # The <code>snippet</code> object contains basic details about the message.
            "liveChatId": "A String",
            "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always
                # filled.
                # textMessageEvent - the user that wrote the message
                # fanFundingEvent - the user that funded the broadcast
                # newSponsorEvent - the user that just became a sponsor
                # messageDeletedEvent - the moderator that took the action
                # messageRetractedEvent - the author that retracted their message
                # userBannedEvent - the moderator that took the action
                # superChatEvent - the user that made the purchase
            "publishedAt": "A String", # The date and time when the message was orignally published. The value is
                # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
                # format.
            "userBannedDetails": {
              "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the
                  # <code>banType</code> is <code>temporary</code>.
              "bannedUserDetails": { # The details of the user that was banned.
                "profileImageUrl": "A String", # The channels's avatar URL.
                "channelUrl": "A String", # The channel's URL.
                "displayName": "A String", # The channel's display name.
                "channelId": "A String", # The YouTube channel ID.
              },
              "banType": "A String", # The type of ban.
            },
            "messageRetractedDetails": {
              "retractedMessageId": "A String",
            },
            "superChatDetails": { # Details about the Super Chat event, this is only set if the type is
                # 'superChatEvent'.
              "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
              "userComment": "A String", # The comment added by the user to this Super Chat event.
              "currency": "A String", # The currency in which the purchase was made.
              "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
              "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower
                  # tiers. The lowest tier is <code>1</code>.
            },
            "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is
                # 'superStickerEvent'.
              "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower
                  # tiers. The lowest tier is <code>1</code>.
              "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
              "superStickerMetadata": { # Information about the Super Sticker.
                "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
                "altText": "A String", # Internationalized alt text that describes the sticker image and any
                    # animation associated with it.
                "stickerId": "A String", # Unique identifier of the Super Sticker. This is a shorter form of the
                    # alt_text that includes pack name and a recognizable characteristic of the
                    # sticker.
              },
              "currency": "A String", # The currency in which the purchase was made.
              "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
            },
            "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is
                # 'fanFundingEvent'.
              "userComment": "A String", # The comment added by the user to this fan funding event.
              "amountMicros": "A String", # The amount of the fund.
              "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
              "currency": "A String", # The currency in which the fund was made.
            },
            "textMessageDetails": { # Details about the text message, this is only set if the type is
                # 'textMessageEvent'.
              "messageText": "A String", # The user's message.
            },
            "displayMessage": "A String", # Contains a string that can be displayed to the user.
                # If this field is not present the message is silent, at the moment only
                # messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
            "messageDeletedDetails": {
              "deletedMessageId": "A String",
            },
            "type": "A String", # The type of message, this will always be present, it determines the
                # contents of the message as well as which fields will be present.
            "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
          },
          "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
          "authorDetails": { # The <code>authorDetails</code> object contains basic details about the
              # user that posted this message.
            "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
            "channelUrl": "A String", # The channel's URL.
            "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
            "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
            "isChatOwner": True or False, # Whether the author is the owner of the live chat.
            "profileImageUrl": "A String", # The channels's avatar URL.
            "channelId": "A String", # The YouTube channel ID.
            "displayName": "A String", # The channel's display name.
          },
        },
    ],
    "etag": "A String", # Etag of this resource.
    "kind": "youtube#liveChatMessageListResponse", # Identifies what kind of resource this is. Value: the fixed string
        # <code>"youtube#liveChatMessageListResponse"</code>.
    "pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information.
        # available and number of resources returned in a single page.
      "resultsPerPage": 42, # The number of results included in the API response.
      "totalResults": 42, # The total number of results in the result set.
    },
    "visitorId": "A String", # The <code>visitorId</code> identifies the visitor.
    "eventId": "A String", # Serialized EventId of the request which produced this response.
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "offlineAt": "A String", # The date and time when the underlying stream went offline. The value is
        # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
        # format.
    "nextPageToken": "A String",
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.