docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/youtube_v3.liveChatMessages.html b/docs/dyn/youtube_v3.liveChatMessages.html
index 1452e35..4e51968 100644
--- a/docs/dyn/youtube_v3.liveChatMessages.html
+++ b/docs/dyn/youtube_v3.liveChatMessages.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(part, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new resource into this collection.</p>
<p class="toc_element">
- <code><a href="#list">list(liveChatId, part, maxResults=None, pageToken=None, profileImageSize=None, hl=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(liveChatId, part, profileImageSize=None, pageToken=None, hl=None, maxResults=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of resources, possibly filtered.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -118,71 +118,71 @@
The object takes the form of:
{ # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
- "snippet": { # The snippet object contains basic details about the message.
- "messageDeletedDetails": {
- "deletedMessageId": "A String",
- },
- "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
- "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
- "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
- "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.
- },
- "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
- "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.
- "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 ISO 8601 format.
- "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.
- "liveChatId": "A String",
- "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
- "messageText": "A String", # The user's message.
- },
- "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.
- "currency": "A String", # The currency in which the fund was made.
- "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
- "amountMicros": "A String", # The amount of the fund.
- },
- "userBannedDetails": {
- "banType": "A String", # The type of ban.
- "bannedUserDetails": { # The details of the user that was banned.
- "channelId": "A String", # The YouTube channel ID.
- "displayName": "A String", # The channel's display name.
- "profileImageUrl": "A String", # The channels's avatar URL.
- "channelUrl": "A String", # The channel's URL.
- },
- "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
- },
- "messageRetractedDetails": {
- "retractedMessageId": "A String",
- },
- "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
- "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
- "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.
- "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
- },
+ "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
+ "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
+ "snippet": { # The snippet object contains basic details about the message.
+ "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
+ "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
+ "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+ "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.
+ "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
},
- "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
- "displayName": "A String", # The channel's display name.
- "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
- "channelUrl": "A String", # The channel's URL.
- "profileImageUrl": "A String", # The channels's avatar URL.
- "channelId": "A String", # The YouTube channel ID.
- "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
- "isChatOwner": True or False, # Whether the author is the owner of the live chat.
- "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
+ "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
+ "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.
+ "userBannedDetails": {
+ "banType": "A String", # The type of ban.
+ "bannedUserDetails": { # The details of the user that was banned.
+ "profileImageUrl": "A String", # The channels's avatar URL.
+ "displayName": "A String", # The channel's display name.
+ "channelUrl": "A String", # The channel's URL.
+ "channelId": "A String", # The YouTube channel ID.
+ },
+ "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
},
- "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
- "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
- "etag": "A String", # Etag of this resource.
- }
+ "messageRetractedDetails": {
+ "retractedMessageId": "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
+ "messageDeletedDetails": {
+ "deletedMessageId": "A String",
+ },
+ "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
+ "superStickerMetadata": { # Information about the Super Sticker.
+ "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.
+ "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
+ },
+ "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
+ "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
+ "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.
+ },
+ "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
+ "messageText": "A String", # The user's message.
+ },
+ "liveChatId": "A String",
+ "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
+ "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+ "userComment": "A String", # The comment added by the user to this fan funding event.
+ "amountMicros": "A String", # The amount of the fund.
+ "currency": "A String", # The currency in which the fund was made.
+ },
+ "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 format.
+ "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.
+ },
+ "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
+ "profileImageUrl": "A String", # The channels's avatar URL.
+ "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
+ "channelUrl": "A String", # The channel's URL.
+ "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
+ "isChatOwner": True or False, # Whether the author is the owner of the live chat.
+ "displayName": "A String", # The channel's display name.
+ "channelId": "A String", # The YouTube channel ID.
+ "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
+ },
+ "etag": "A String", # Etag of this resource.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -193,84 +193,84 @@
An object of the form:
{ # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
- "snippet": { # The snippet object contains basic details about the message.
- "messageDeletedDetails": {
- "deletedMessageId": "A String",
- },
- "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
- "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
- "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
- "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.
- },
- "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
- "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.
- "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 ISO 8601 format.
- "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.
- "liveChatId": "A String",
- "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
- "messageText": "A String", # The user's message.
- },
- "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.
- "currency": "A String", # The currency in which the fund was made.
- "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
- "amountMicros": "A String", # The amount of the fund.
- },
- "userBannedDetails": {
- "banType": "A String", # The type of ban.
- "bannedUserDetails": { # The details of the user that was banned.
- "channelId": "A String", # The YouTube channel ID.
- "displayName": "A String", # The channel's display name.
- "profileImageUrl": "A String", # The channels's avatar URL.
- "channelUrl": "A String", # The channel's URL.
- },
- "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
- },
- "messageRetractedDetails": {
- "retractedMessageId": "A String",
- },
- "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
- "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
- "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.
- "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
- },
+ "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
+ "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
+ "snippet": { # The snippet object contains basic details about the message.
+ "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
+ "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
+ "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+ "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.
+ "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
},
- "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
- "displayName": "A String", # The channel's display name.
- "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
- "channelUrl": "A String", # The channel's URL.
- "profileImageUrl": "A String", # The channels's avatar URL.
- "channelId": "A String", # The YouTube channel ID.
- "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
- "isChatOwner": True or False, # Whether the author is the owner of the live chat.
- "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
+ "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
+ "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.
+ "userBannedDetails": {
+ "banType": "A String", # The type of ban.
+ "bannedUserDetails": { # The details of the user that was banned.
+ "profileImageUrl": "A String", # The channels's avatar URL.
+ "displayName": "A String", # The channel's display name.
+ "channelUrl": "A String", # The channel's URL.
+ "channelId": "A String", # The YouTube channel ID.
+ },
+ "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
},
- "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
- "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
- "etag": "A String", # Etag of this resource.
- }</pre>
+ "messageRetractedDetails": {
+ "retractedMessageId": "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
+ "messageDeletedDetails": {
+ "deletedMessageId": "A String",
+ },
+ "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
+ "superStickerMetadata": { # Information about the Super Sticker.
+ "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.
+ "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
+ },
+ "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
+ "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
+ "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.
+ },
+ "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
+ "messageText": "A String", # The user's message.
+ },
+ "liveChatId": "A String",
+ "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
+ "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+ "userComment": "A String", # The comment added by the user to this fan funding event.
+ "amountMicros": "A String", # The amount of the fund.
+ "currency": "A String", # The currency in which the fund was made.
+ },
+ "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 format.
+ "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.
+ },
+ "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
+ "profileImageUrl": "A String", # The channels's avatar URL.
+ "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
+ "channelUrl": "A String", # The channel's URL.
+ "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
+ "isChatOwner": True or False, # Whether the author is the owner of the live chat.
+ "displayName": "A String", # The channel's display name.
+ "channelId": "A String", # The YouTube channel ID.
+ "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
+ },
+ "etag": "A String", # Etag of this resource.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(liveChatId, part, maxResults=None, pageToken=None, profileImageSize=None, hl=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(liveChatId, part, profileImageSize=None, pageToken=None, hl=None, maxResults=None, x__xgafv=None)</code>
<pre>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 *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet. (required) (repeated)
- maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
- pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.
profileImageSize: integer, Specifies the size of the profile image that should be returned for each user.
+ pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken 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 *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -280,87 +280,87 @@
An object of the form:
{
- "visitorId": "A String", # The visitorId identifies the visitor.
- "etag": "A String", # Etag of this resource.
- "kind": "youtube#liveChatMessageListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse".
- "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 ISO 8601 format.
+ "kind": "youtube#liveChatMessageListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse".
+ "eventId": "A String", # Serialized EventId of the request which produced this response.
"pollingIntervalMillis": 42, # The amount of time the client should wait before polling again.
+ "items": [
+ { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
+ "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
+ "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
+ "snippet": { # The snippet object contains basic details about the message.
+ "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
+ "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
+ "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+ "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.
+ "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
+ },
+ "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
+ "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.
+ "userBannedDetails": {
+ "banType": "A String", # The type of ban.
+ "bannedUserDetails": { # The details of the user that was banned.
+ "profileImageUrl": "A String", # The channels's avatar URL.
+ "displayName": "A String", # The channel's display name.
+ "channelUrl": "A String", # The channel's URL.
+ "channelId": "A String", # The YouTube channel ID.
+ },
+ "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
+ },
+ "messageRetractedDetails": {
+ "retractedMessageId": "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
+ "messageDeletedDetails": {
+ "deletedMessageId": "A String",
+ },
+ "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
+ "superStickerMetadata": { # Information about the Super Sticker.
+ "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.
+ "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
+ },
+ "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
+ "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
+ "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.
+ },
+ "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
+ "messageText": "A String", # The user's message.
+ },
+ "liveChatId": "A String",
+ "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
+ "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+ "userComment": "A String", # The comment added by the user to this fan funding event.
+ "amountMicros": "A String", # The amount of the fund.
+ "currency": "A String", # The currency in which the fund was made.
+ },
+ "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 format.
+ "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.
+ },
+ "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
+ "profileImageUrl": "A String", # The channels's avatar URL.
+ "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
+ "channelUrl": "A String", # The channel's URL.
+ "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
+ "isChatOwner": True or False, # Whether the author is the owner of the live chat.
+ "displayName": "A String", # The channel's display name.
+ "channelId": "A String", # The YouTube channel ID.
+ "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
+ },
+ "etag": "A String", # Etag of this resource.
+ },
+ ],
+ "visitorId": "A String", # The visitorId identifies the visitor.
+ "nextPageToken": "A String",
+ "etag": "A String", # Etag of this resource.
"pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information.
"totalResults": 42, # The total number of results in the result set.
"resultsPerPage": 42, # The number of results included in the API response.
},
- "eventId": "A String", # Serialized EventId of the request which produced this response.
- "nextPageToken": "A String",
- "items": [
- { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat.
- "snippet": { # The snippet object contains basic details about the message.
- "messageDeletedDetails": {
- "deletedMessageId": "A String",
- },
- "superStickerDetails": { # Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
- "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
- "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
- "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.
- },
- "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
- "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.
- "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 ISO 8601 format.
- "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.
- "liveChatId": "A String",
- "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
- "messageText": "A String", # The user's message.
- },
- "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.
- "currency": "A String", # The currency in which the fund was made.
- "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
- "amountMicros": "A String", # The amount of the fund.
- },
- "userBannedDetails": {
- "banType": "A String", # The type of ban.
- "bannedUserDetails": { # The details of the user that was banned.
- "channelId": "A String", # The YouTube channel ID.
- "displayName": "A String", # The channel's display name.
- "profileImageUrl": "A String", # The channels's avatar URL.
- "channelUrl": "A String", # The channel's URL.
- },
- "banDurationSeconds": "A String", # The duration of the ban. This property is only present if the banType is temporary.
- },
- "messageRetractedDetails": {
- "retractedMessageId": "A String",
- },
- "superChatDetails": { # Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
- "tier": 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
- "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.
- "amountMicros": "A String", # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
- },
- },
- "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
- "displayName": "A String", # The channel's display name.
- "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
- "channelUrl": "A String", # The channel's URL.
- "profileImageUrl": "A String", # The channels's avatar URL.
- "channelId": "A String", # The YouTube channel ID.
- "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
- "isChatOwner": True or False, # Whether the author is the owner of the live chat.
- "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
- },
- "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
- "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
- "etag": "A String", # Etag of this resource.
- },
- ],
+ "tokenPagination": { # Stub token pagination template to suppress results.
+ },
}</pre>
</div>