Skip to content

Commit

Permalink
feat(youtube): update the api
Browse files Browse the repository at this point in the history 
#### youtube:v3

The following keys were added:
- schemas.ChannelSettings.properties.moderateComments.deprecated (Total Keys: 1)
- schemas.LiveChatMessageListResponse.properties.activePollItem.$ref (Total Keys: 1)
  • Loading branch information
@yoshi-automation
yoshi-automation committed Mar 12, 2024
1 parent 0f96cc7 commit 9779256
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 1 deletion.
96 changes: 96 additions & 0 deletions docs/dyn/youtube_v3.liveChatMessages.html
View file
Expand Up @@ -340,6 +340,102 @@ <h3>Method Details</h3>
An object of the form:

{
&quot;activePollItem&quot;: { # A *liveChatMessage* resource represents a chat message in a YouTube Live Chat. # Set when there is an active poll.
&quot;authorDetails&quot;: { # The authorDetails object contains basic details about the user that posted this message.
&quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
&quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
&quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
&quot;isChatModerator&quot;: True or False, # Whether the author is a moderator of the live chat.
&quot;isChatOwner&quot;: True or False, # Whether the author is the owner of the live chat.
&quot;isChatSponsor&quot;: True or False, # Whether the author is a sponsor of the live chat.
&quot;isVerified&quot;: True or False, # Whether the author&#x27;s identity has been verified by YouTube.
&quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
},
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
&quot;id&quot;: &quot;A String&quot;, # The ID that YouTube assigns to uniquely identify the message.
&quot;kind&quot;: &quot;youtube#liveChatMessage&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;youtube#liveChatMessage&quot;.
&quot;snippet&quot;: { # Next ID: 34 # The snippet object contains basic details about the message.
&quot;authorChannelId&quot;: &quot;A String&quot;, # 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 memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership 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 superStickerEvent - the user that made the purchase pollEvent - the user that created the poll
&quot;displayMessage&quot;: &quot;A String&quot;, # 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.
&quot;fanFundingEventDetails&quot;: { # Details about the funding event, this is only set if the type is &#x27;fanFundingEvent&#x27;.
&quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
&quot;amountMicros&quot;: &quot;A String&quot;, # The amount of the fund.
&quot;currency&quot;: &quot;A String&quot;, # The currency in which the fund was made.
&quot;userComment&quot;: &quot;A String&quot;, # The comment added by the user to this fan funding event.
},
&quot;giftMembershipReceivedDetails&quot;: { # Details about the Gift Membership Received event, this is only set if the type is &#x27;giftMembershipReceivedEvent&#x27;.
&quot;associatedMembershipGiftingMessageId&quot;: &quot;A String&quot;, # The ID of the membership gifting message that is related to this gift membership. This ID will always refer to a message whose type is &#x27;membershipGiftingEvent&#x27;.
&quot;gifterChannelId&quot;: &quot;A String&quot;, # The ID of the user that made the membership gifting purchase. This matches the `snippet.authorChannelId` of the associated membership gifting message.
&quot;memberLevelName&quot;: &quot;A String&quot;, # The name of the Level at which the viewer is a member. This matches the `snippet.membershipGiftingDetails.giftMembershipsLevelName` of the associated membership gifting message. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn&#x27;t filled.
},
&quot;hasDisplayContent&quot;: True or False, # Whether the message has display content that should be displayed to users.
&quot;liveChatId&quot;: &quot;A String&quot;,
&quot;memberMilestoneChatDetails&quot;: { # Details about the Member Milestone Chat event, this is only set if the type is &#x27;memberMilestoneChatEvent&#x27;.
&quot;memberLevelName&quot;: &quot;A String&quot;, # The name of the Level at which the viever is a member. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn&#x27;t filled.
&quot;memberMonth&quot;: 42, # The total amount of months (rounded up) the viewer has been a member that granted them this Member Milestone Chat. This is the same number of months as is being displayed to YouTube users.
&quot;userComment&quot;: &quot;A String&quot;, # The comment added by the member to this Member Milestone Chat. This field is empty for messages without a comment from the member.
},
&quot;membershipGiftingDetails&quot;: { # Details about the Membership Gifting event, this is only set if the type is &#x27;membershipGiftingEvent&#x27;.
&quot;giftMembershipsCount&quot;: 42, # The number of gift memberships purchased by the user.
&quot;giftMembershipsLevelName&quot;: &quot;A String&quot;, # The name of the level of the gift memberships purchased by the user. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn&#x27;t filled.
},
&quot;messageDeletedDetails&quot;: {
&quot;deletedMessageId&quot;: &quot;A String&quot;,
},
&quot;messageRetractedDetails&quot;: {
&quot;retractedMessageId&quot;: &quot;A String&quot;,
},
&quot;newSponsorDetails&quot;: { # Details about the New Member Announcement event, this is only set if the type is &#x27;newSponsorEvent&#x27;. Please note that &quot;member&quot; is the new term for &quot;sponsor&quot;.
&quot;isUpgrade&quot;: True or False, # If the viewer just had upgraded from a lower level. For viewers that were not members at the time of purchase, this field is false.
&quot;memberLevelName&quot;: &quot;A String&quot;, # The name of the Level that the viewer just had joined. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn&#x27;t filled.
},
&quot;pollDetails&quot;: { # Details about the poll event, this is only set if the type is &#x27;pollEvent&#x27;.
&quot;metadata&quot;: {
&quot;options&quot;: [ # The options will be returned in the order that is displayed in 1P
{
&quot;optionText&quot;: &quot;A String&quot;,
&quot;tally&quot;: &quot;A String&quot;,
},
],
&quot;questionText&quot;: &quot;A String&quot;,
},
&quot;status&quot;: &quot;A String&quot;,
},
&quot;publishedAt&quot;: &quot;A String&quot;, # The date and time when the message was orignally published.
&quot;superChatDetails&quot;: { # Details about the Super Chat event, this is only set if the type is &#x27;superChatEvent&#x27;.
&quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
&quot;amountMicros&quot;: &quot;A String&quot;, # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
&quot;currency&quot;: &quot;A String&quot;, # The currency in which the purchase was made.
&quot;tier&quot;: 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
&quot;userComment&quot;: &quot;A String&quot;, # The comment added by the user to this Super Chat event.
},
&quot;superStickerDetails&quot;: { # Details about the Super Sticker event, this is only set if the type is &#x27;superStickerEvent&#x27;.
&quot;amountDisplayString&quot;: &quot;A String&quot;, # A rendered string that displays the fund amount and currency to the user.
&quot;amountMicros&quot;: &quot;A String&quot;, # The amount purchased by the user, in micros (1,750,000 micros = 1.75).
&quot;currency&quot;: &quot;A String&quot;, # The currency in which the purchase was made.
&quot;superStickerMetadata&quot;: { # Information about the Super Sticker.
&quot;altText&quot;: &quot;A String&quot;, # Internationalized alt text that describes the sticker image and any animation associated with it.
&quot;altTextLanguage&quot;: &quot;A String&quot;, # Specifies the localization language in which the alt text is returned.
&quot;stickerId&quot;: &quot;A String&quot;, # 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.
},
&quot;tier&quot;: 42, # The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
},
&quot;textMessageDetails&quot;: { # Details about the text message, this is only set if the type is &#x27;textMessageEvent&#x27;.
&quot;messageText&quot;: &quot;A String&quot;, # The user&#x27;s message.
},
&quot;type&quot;: &quot;A String&quot;, # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
&quot;userBannedDetails&quot;: {
&quot;banDurationSeconds&quot;: &quot;A String&quot;, # The duration of the ban. This property is only present if the banType is temporary.
&quot;banType&quot;: &quot;A String&quot;, # The type of ban.
&quot;bannedUserDetails&quot;: { # The details of the user that was banned.
&quot;channelId&quot;: &quot;A String&quot;, # The YouTube channel ID.
&quot;channelUrl&quot;: &quot;A String&quot;, # The channel&#x27;s URL.
&quot;displayName&quot;: &quot;A String&quot;, # The channel&#x27;s display name.
&quot;profileImageUrl&quot;: &quot;A String&quot;, # The channels&#x27;s avatar URL.
},
},
},
},
&quot;etag&quot;: &quot;A String&quot;, # Etag of this resource.
&quot;eventId&quot;: &quot;A String&quot;, # Serialized EventId of the request which produced this response.
&quot;items&quot;: [
Expand Down
7 changes: 6 additions & 1 deletion googleapiclient/discovery_cache/documents/youtube.v3.json
View file
Expand Up @@ -4037,7 +4037,7 @@
}
}
},
"revision": "20240303",
"revision": "20240310",
"rootUrl": "https://youtube.googleapis.com/",
"schemas": {
"AbuseReport": {
Expand Down Expand Up @@ -5356,6 +5356,7 @@ false
"type": "string"
},
"moderateComments": {
"deprecated": true,
"description": "Whether user-submitted comments left on the channel page need to be approved by the channel owner to be publicly visible.",
"type": "boolean"
},
Expand Down Expand Up @@ -8744,6 +8745,10 @@ true
"LiveChatMessageListResponse": {
"id": "LiveChatMessageListResponse",
"properties": {
"activePollItem": {
"$ref": "LiveChatMessage",
"description": "Set when there is an active poll."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
Expand Down

0 comments on commit 9779256

Please sign in to comment.