docs: update generated docs (#981)
diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html
index 5c77218..45a8ce7 100644
--- a/docs/dyn/chat_v1.spaces.messages.html
+++ b/docs/dyn/chat_v1.spaces.messages.html
@@ -75,6 +75,11 @@
<h1><a href="chat_v1.html">Hangouts Chat API</a> . <a href="chat_v1.spaces.html">spaces</a> . <a href="chat_v1.spaces.messages.html">messages</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="chat_v1.spaces.messages.attachments.html">attachments()</a></code>
+</p>
+<p class="firstline">Returns the attachments Resource.</p>
+
+<p class="toc_element">
<code><a href="#create">create(parent, body=None, threadKey=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a message.</p>
<p class="toc_element">
@@ -98,586 +103,9 @@
The object takes the form of:
{ # A message in Hangouts Chat.
- "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.
- "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards
- # cannot be displayed (e.g. mobile notifications).
- "actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is
- # posted.
- "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
- "type": "A String", # The type of bot response.
- },
- "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
- # server.
- "sender": { # A user in Hangouts Chat. # The user who created the message.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- },
- "cards": [ # Rich, formatted and interactive cards that can be used to display UI
- # elements such as: formatted texts, buttons, clickable images. Cards are
- # normally displayed below the plain-text body of the message.
- { # A card is a UI element that can contain UI widgets such as texts, images.
- "name": "A String", # Name of the card.
- "sections": [ # Sections are separated by a line divider.
- { # A section contains a collection of widgets that are rendered
- # (vertically) in the order that they are specified. Across all platforms,
- # cards have a narrow fixed width, so
- # there is currently no need for layout properties (e.g. float).
- "header": "A String", # The header of the section, text formatted supported.
- "widgets": [ # A section must contain at least 1 widget.
- { # A widget is a UI element that presents texts, images, etc.
- "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.
- "text": "A String",
- },
- "keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.
- # element may also contain some actions such as onclick button.
- "topLabel": "A String", # The text of the top label. Formatted text supported.
- "iconUrl": "A String", # The icon specified by a URL.
- "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
- "textButton": { # A button with text and onclick action. # A button with text and onclick action.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "text": "A String", # The text of the button.
- },
- "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
- "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
- # API.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "iconUrl": "A String", # The icon specified by a URL.
- "name": "A String", # The name of this image_button which will be used for accessibility.
- # Default value will be provided if developers don't specify.
- },
- },
- "content": "A String", # The text of the content. Formatted text supported and always required.
- "bottomLabel": "A String", # The text of the bottom label. Formatted text supported.
- "icon": "A String", # An enum value that will be replaced by the Chat API with the
- # corresponding icon image.
- "contentMultiline": True or False, # If the content should be multiline.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region
- # are clickable.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- },
- "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "aspectRatio": 3.14, # The aspect ratio of this image (width/height). This field allows clients
- # to reserve the right height for the image while waiting for it to load.
- # It's not meant to override the native aspect ratio of the image.
- # If unset, the server fills it by prefetching the image.
- "imageUrl": "A String", # The URL of the image.
- },
- "buttons": [ # A list of buttons. Buttons is also oneof data and only one of these
- # fields should be set.
- { # A button. Can be a text button or an image button.
- "textButton": { # A button with text and onclick action. # A button with text and onclick action.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "text": "A String", # The text of the button.
- },
- "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
- "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
- # API.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "iconUrl": "A String", # The icon specified by a URL.
- "name": "A String", # The name of this image_button which will be used for accessibility.
- # Default value will be provided if developers don't specify.
- },
- },
- ],
- },
- ],
- },
- ],
- "cardActions": [ # The actions of this card.
- { # A card action is
- # the action associated with the card. For an invoice card, a
- # typical action would be: delete invoice, email invoice or open the
- # invoice in browser.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "actionLabel": "A String", # The label used to be displayed in the action menu item.
- },
- ],
- "header": { # The header of the card. A header usually contains a title and an image.
- "imageStyle": "A String", # The image's type (e.g. square border or circular border).
- "title": "A String", # The title must be specified. The header has a fixed height: if both a
- # title and subtitle is specified, each will take up 1 line. If only the
- # title is specified, it will take up both lines.
- "subtitle": "A String", # The subtitle of the card header.
- "imageUrl": "A String", # The URL of the image in the card header.
- },
- },
- ],
- "thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
- "name": "A String", # Resource name, in the form "spaces/*/threads/*".
- #
- # Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
- },
- "annotations": [ # Output only. Annotations associated with the text in this message.
- { # Annotations associated with the plain-text body of the message.
- #
- # Example plain-text message body:
- # ```
- # Hello @FooBot how are you!"
- # ```
- #
- # The corresponding annotations metadata:
- # ```
- # "annotations":[{
- # "type":"USER_MENTION",
- # "startIndex":6,
- # "length":7,
- # "userMention": {
- # "user": {
- # "name":"users/107946847022116401880",
- # "displayName":"FooBot",
- # "avatarUrl":"https://goo.gl/aeDtrS",
- # "type":"BOT"
- # },
- # "type":"MENTION"
- # }
- # }]
- # ```
- "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
- "user": { # A user in Hangouts Chat. # The user mentioned.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- },
- "type": "A String", # The type of user mention.
- },
- "type": "A String", # The type of this annotation.
- "length": 42, # Length of the substring in the plain-text message body this annotation
- # corresponds to.
- "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this
- # annotation corresponds to.
- },
- ],
- "name": "A String", # Resource name, in the form "spaces/*/messages/*".
- #
- # Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
- "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the
- # user, but any links to images, web pages, videos, etc. included here will
- # generate preview chips.
- "text": "A String", # Plain-text body of the message.
- "space": { # A room or DM in Hangouts Chat. # The space the message belongs to.
- "name": "A String", # Resource name of the space, in the form "spaces/*".
- #
- # Example: spaces/AAAAMpdlehYs
- "threaded": True or False, # Whether the messages are threaded in this space.
- "displayName": "A String", # Output only. The display name (only if the space is a room).
- "type": "A String", # Output only. The type of a space.
- # This is deprecated. Use `single_user_bot_dm` instead.
- "singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human.
- },
-}
-
- threadKey: string, Opaque thread identifier string that can be specified to group messages
-into a single thread. If this is the first message with a given thread
-identifier, a new thread is created. Subsequent messages with the same
-thread identifier will be posted into the same thread. This relieves bots
-and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post
-further updates to it.
-
-Has no effect if thread field,
-corresponding to an existing thread, is set in message.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # A message in Hangouts Chat.
- "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.
- "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards
- # cannot be displayed (e.g. mobile notifications).
- "actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is
- # posted.
- "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
- "type": "A String", # The type of bot response.
- },
- "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
- # server.
- "sender": { # A user in Hangouts Chat. # The user who created the message.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- },
- "cards": [ # Rich, formatted and interactive cards that can be used to display UI
- # elements such as: formatted texts, buttons, clickable images. Cards are
- # normally displayed below the plain-text body of the message.
- { # A card is a UI element that can contain UI widgets such as texts, images.
- "name": "A String", # Name of the card.
- "sections": [ # Sections are separated by a line divider.
- { # A section contains a collection of widgets that are rendered
- # (vertically) in the order that they are specified. Across all platforms,
- # cards have a narrow fixed width, so
- # there is currently no need for layout properties (e.g. float).
- "header": "A String", # The header of the section, text formatted supported.
- "widgets": [ # A section must contain at least 1 widget.
- { # A widget is a UI element that presents texts, images, etc.
- "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.
- "text": "A String",
- },
- "keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.
- # element may also contain some actions such as onclick button.
- "topLabel": "A String", # The text of the top label. Formatted text supported.
- "iconUrl": "A String", # The icon specified by a URL.
- "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
- "textButton": { # A button with text and onclick action. # A button with text and onclick action.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "text": "A String", # The text of the button.
- },
- "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
- "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
- # API.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "iconUrl": "A String", # The icon specified by a URL.
- "name": "A String", # The name of this image_button which will be used for accessibility.
- # Default value will be provided if developers don't specify.
- },
- },
- "content": "A String", # The text of the content. Formatted text supported and always required.
- "bottomLabel": "A String", # The text of the bottom label. Formatted text supported.
- "icon": "A String", # An enum value that will be replaced by the Chat API with the
- # corresponding icon image.
- "contentMultiline": True or False, # If the content should be multiline.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region
- # are clickable.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- },
- "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "aspectRatio": 3.14, # The aspect ratio of this image (width/height). This field allows clients
- # to reserve the right height for the image while waiting for it to load.
- # It's not meant to override the native aspect ratio of the image.
- # If unset, the server fills it by prefetching the image.
- "imageUrl": "A String", # The URL of the image.
- },
- "buttons": [ # A list of buttons. Buttons is also oneof data and only one of these
- # fields should be set.
- { # A button. Can be a text button or an image button.
- "textButton": { # A button with text and onclick action. # A button with text and onclick action.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "text": "A String", # The text of the button.
- },
- "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
- "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
- # API.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "iconUrl": "A String", # The icon specified by a URL.
- "name": "A String", # The name of this image_button which will be used for accessibility.
- # Default value will be provided if developers don't specify.
- },
- },
- ],
- },
- ],
- },
- ],
- "cardActions": [ # The actions of this card.
- { # A card action is
- # the action associated with the card. For an invoice card, a
- # typical action would be: delete invoice, email invoice or open the
- # invoice in browser.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "actionLabel": "A String", # The label used to be displayed in the action menu item.
- },
- ],
- "header": { # The header of the card. A header usually contains a title and an image.
- "imageStyle": "A String", # The image's type (e.g. square border or circular border).
- "title": "A String", # The title must be specified. The header has a fixed height: if both a
- # title and subtitle is specified, each will take up 1 line. If only the
- # title is specified, it will take up both lines.
- "subtitle": "A String", # The subtitle of the card header.
- "imageUrl": "A String", # The URL of the image in the card header.
- },
- },
- ],
- "thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
- "name": "A String", # Resource name, in the form "spaces/*/threads/*".
- #
- # Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
- },
+ "name": "A String", # Resource name, in the form "spaces/*/messages/*".
+ #
+ # Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
"annotations": [ # Output only. Annotations associated with the text in this message.
{ # Annotations associated with the plain-text body of the message.
#
@@ -703,40 +131,667 @@
# }
# }]
# ```
+ "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this
+ # annotation corresponds to.
+ "type": "A String", # The type of this annotation.
+ "length": 42, # Length of the substring in the plain-text message body this annotation
+ # corresponds to.
"userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
"user": { # A user in Hangouts Chat. # The user mentioned.
"name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
"type": "A String", # User type.
+ "displayName": "A String", # The user's display name.
"domainId": "A String", # Obfuscated domain information.
},
"type": "A String", # The type of user mention.
},
- "type": "A String", # The type of this annotation.
- "length": 42, # Length of the substring in the plain-text message body this annotation
- # corresponds to.
- "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this
- # annotation corresponds to.
},
],
- "name": "A String", # Resource name, in the form "spaces/*/messages/*".
- #
- # Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
+ "actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is
+ # posted.
+ "type": "A String", # The type of bot response.
+ "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
+ },
+ "sender": { # A user in Hangouts Chat. # The user who created the message.
+ "name": "A String", # Resource name, in the format "users/*".
+ "type": "A String", # User type.
+ "displayName": "A String", # The user's display name.
+ "domainId": "A String", # Obfuscated domain information.
+ },
+ "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
+ # server.
+ "text": "A String", # Plain-text body of the message.
"previewText": "A String", # Text for generating preview chips. This text will not be displayed to the
# user, but any links to images, web pages, videos, etc. included here will
# generate preview chips.
- "text": "A String", # Plain-text body of the message.
+ "attachment": [ # User uploaded attachment.
+ { # An attachment in Hangouts Chat.
+ "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the
+ # attachment to a human user. Bots should not use this URL to download
+ # attachment content.
+ "driveDataRef": { # A reference to the data of a drive attachment. # A reference to the drive attachment. This is used with the Drive API.
+ "driveFileId": "A String", # The id for the drive file, for use with the Drive API.
+ },
+ "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to
+ # download the attachment. Bots should not use this URL to download
+ # attachment content.
+ "contentType": "A String", # The content type (MIME type) of the file.
+ "name": "A String", # Resource name of the attachment, in the form
+ # "spaces/*/messages/*/attachments/*".
+ "source": "A String", # The source of the attachment.
+ "attachmentDataRef": { # A reference to the data of an attachment. # A reference to the attachment data. This is used with the media API to
+ # download the attachment data.
+ "resourceName": "A String", # The resource name of the attachment data. This is used with the media API
+ # to download the attachment data.
+ },
+ "contentName": "A String", # The original file name for the content, not the full path.
+ },
+ ],
+ "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.
+ "cards": [ # Rich, formatted and interactive cards that can be used to display UI
+ # elements such as: formatted texts, buttons, clickable images. Cards are
+ # normally displayed below the plain-text body of the message.
+ { # A card is a UI element that can contain UI widgets such as texts, images.
+ "name": "A String", # Name of the card.
+ "cardActions": [ # The actions of this card.
+ { # A card action is
+ # the action associated with the card. For an invoice card, a
+ # typical action would be: delete invoice, email invoice or open the
+ # invoice in browser.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "actionLabel": "A String", # The label used to be displayed in the action menu item.
+ },
+ ],
+ "sections": [ # Sections are separated by a line divider.
+ { # A section contains a collection of widgets that are rendered
+ # (vertically) in the order that they are specified. Across all platforms,
+ # cards have a narrow fixed width, so
+ # there is currently no need for layout properties (e.g. float).
+ "widgets": [ # A section must contain at least 1 widget.
+ { # A widget is a UI element that presents texts, images, etc.
+ "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.
+ "text": "A String",
+ },
+ "buttons": [ # A list of buttons. Buttons is also oneof data and only one of these
+ # fields should be set.
+ { # A button. Can be a text button or an image button.
+ "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
+ "iconUrl": "A String", # The icon specified by a URL.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "name": "A String", # The name of this image_button which will be used for accessibility.
+ # Default value will be provided if developers don't specify.
+ "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
+ # API.
+ },
+ "textButton": { # A button with text and onclick action. # A button with text and onclick action.
+ "text": "A String", # The text of the button.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ },
+ },
+ ],
+ "keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.
+ # element may also contain some actions such as onclick button.
+ "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
+ "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
+ "iconUrl": "A String", # The icon specified by a URL.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "name": "A String", # The name of this image_button which will be used for accessibility.
+ # Default value will be provided if developers don't specify.
+ "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
+ # API.
+ },
+ "textButton": { # A button with text and onclick action. # A button with text and onclick action.
+ "text": "A String", # The text of the button.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ },
+ },
+ "icon": "A String", # An enum value that will be replaced by the Chat API with the
+ # corresponding icon image.
+ "bottomLabel": "A String", # The text of the bottom label. Formatted text supported.
+ "contentMultiline": True or False, # If the content should be multiline.
+ "topLabel": "A String", # The text of the top label. Formatted text supported.
+ "content": "A String", # The text of the content. Formatted text supported and always required.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region
+ # are clickable.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "iconUrl": "A String", # The icon specified by a URL.
+ },
+ "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "aspectRatio": 3.14, # The aspect ratio of this image (width/height). This field allows clients
+ # to reserve the right height for the image while waiting for it to load.
+ # It's not meant to override the native aspect ratio of the image.
+ # If unset, the server fills it by prefetching the image.
+ "imageUrl": "A String", # The URL of the image.
+ },
+ },
+ ],
+ "header": "A String", # The header of the section, text formatted supported.
+ },
+ ],
+ "header": { # The header of the card. A header usually contains a title and an image.
+ "imageUrl": "A String", # The URL of the image in the card header.
+ "imageStyle": "A String", # The image's type (e.g. square border or circular border).
+ "title": "A String", # The title must be specified. The header has a fixed height: if both a
+ # title and subtitle is specified, each will take up 1 line. If only the
+ # title is specified, it will take up both lines.
+ "subtitle": "A String", # The subtitle of the card header.
+ },
+ },
+ ],
"space": { # A room or DM in Hangouts Chat. # The space the message belongs to.
+ "displayName": "A String", # Output only. The display name (only if the space is a room).
+ # Please note that this field might not be populated in direct messages
+ # between humans.
+ "threaded": True or False, # Whether the messages are threaded in this space.
"name": "A String", # Resource name of the space, in the form "spaces/*".
#
# Example: spaces/AAAAMpdlehYs
- "threaded": True or False, # Whether the messages are threaded in this space.
- "displayName": "A String", # Output only. The display name (only if the space is a room).
"type": "A String", # Output only. The type of a space.
# This is deprecated. Use `single_user_bot_dm` instead.
"singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human.
},
- }</pre>
+ "thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
+ "name": "A String", # Resource name, in the form "spaces/*/threads/*".
+ #
+ # Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
+ },
+ "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards
+ # cannot be displayed (e.g. mobile notifications).
+ }
+
+ threadKey: string, Opaque thread identifier string that can be specified to group messages
+into a single thread. If this is the first message with a given thread
+identifier, a new thread is created. Subsequent messages with the same
+thread identifier will be posted into the same thread. This relieves bots
+and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post
+further updates to it.
+
+Has no effect if thread field,
+corresponding to an existing thread, is set in message.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A message in Hangouts Chat.
+ "name": "A String", # Resource name, in the form "spaces/*/messages/*".
+ #
+ # Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
+ "annotations": [ # Output only. Annotations associated with the text in this message.
+ { # Annotations associated with the plain-text body of the message.
+ #
+ # Example plain-text message body:
+ # ```
+ # Hello @FooBot how are you!"
+ # ```
+ #
+ # The corresponding annotations metadata:
+ # ```
+ # "annotations":[{
+ # "type":"USER_MENTION",
+ # "startIndex":6,
+ # "length":7,
+ # "userMention": {
+ # "user": {
+ # "name":"users/107946847022116401880",
+ # "displayName":"FooBot",
+ # "avatarUrl":"https://goo.gl/aeDtrS",
+ # "type":"BOT"
+ # },
+ # "type":"MENTION"
+ # }
+ # }]
+ # ```
+ "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this
+ # annotation corresponds to.
+ "type": "A String", # The type of this annotation.
+ "length": 42, # Length of the substring in the plain-text message body this annotation
+ # corresponds to.
+ "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
+ "user": { # A user in Hangouts Chat. # The user mentioned.
+ "name": "A String", # Resource name, in the format "users/*".
+ "type": "A String", # User type.
+ "displayName": "A String", # The user's display name.
+ "domainId": "A String", # Obfuscated domain information.
+ },
+ "type": "A String", # The type of user mention.
+ },
+ },
+ ],
+ "actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is
+ # posted.
+ "type": "A String", # The type of bot response.
+ "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
+ },
+ "sender": { # A user in Hangouts Chat. # The user who created the message.
+ "name": "A String", # Resource name, in the format "users/*".
+ "type": "A String", # User type.
+ "displayName": "A String", # The user's display name.
+ "domainId": "A String", # Obfuscated domain information.
+ },
+ "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
+ # server.
+ "text": "A String", # Plain-text body of the message.
+ "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the
+ # user, but any links to images, web pages, videos, etc. included here will
+ # generate preview chips.
+ "attachment": [ # User uploaded attachment.
+ { # An attachment in Hangouts Chat.
+ "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the
+ # attachment to a human user. Bots should not use this URL to download
+ # attachment content.
+ "driveDataRef": { # A reference to the data of a drive attachment. # A reference to the drive attachment. This is used with the Drive API.
+ "driveFileId": "A String", # The id for the drive file, for use with the Drive API.
+ },
+ "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to
+ # download the attachment. Bots should not use this URL to download
+ # attachment content.
+ "contentType": "A String", # The content type (MIME type) of the file.
+ "name": "A String", # Resource name of the attachment, in the form
+ # "spaces/*/messages/*/attachments/*".
+ "source": "A String", # The source of the attachment.
+ "attachmentDataRef": { # A reference to the data of an attachment. # A reference to the attachment data. This is used with the media API to
+ # download the attachment data.
+ "resourceName": "A String", # The resource name of the attachment data. This is used with the media API
+ # to download the attachment data.
+ },
+ "contentName": "A String", # The original file name for the content, not the full path.
+ },
+ ],
+ "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.
+ "cards": [ # Rich, formatted and interactive cards that can be used to display UI
+ # elements such as: formatted texts, buttons, clickable images. Cards are
+ # normally displayed below the plain-text body of the message.
+ { # A card is a UI element that can contain UI widgets such as texts, images.
+ "name": "A String", # Name of the card.
+ "cardActions": [ # The actions of this card.
+ { # A card action is
+ # the action associated with the card. For an invoice card, a
+ # typical action would be: delete invoice, email invoice or open the
+ # invoice in browser.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "actionLabel": "A String", # The label used to be displayed in the action menu item.
+ },
+ ],
+ "sections": [ # Sections are separated by a line divider.
+ { # A section contains a collection of widgets that are rendered
+ # (vertically) in the order that they are specified. Across all platforms,
+ # cards have a narrow fixed width, so
+ # there is currently no need for layout properties (e.g. float).
+ "widgets": [ # A section must contain at least 1 widget.
+ { # A widget is a UI element that presents texts, images, etc.
+ "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.
+ "text": "A String",
+ },
+ "buttons": [ # A list of buttons. Buttons is also oneof data and only one of these
+ # fields should be set.
+ { # A button. Can be a text button or an image button.
+ "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
+ "iconUrl": "A String", # The icon specified by a URL.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "name": "A String", # The name of this image_button which will be used for accessibility.
+ # Default value will be provided if developers don't specify.
+ "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
+ # API.
+ },
+ "textButton": { # A button with text and onclick action. # A button with text and onclick action.
+ "text": "A String", # The text of the button.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ },
+ },
+ ],
+ "keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.
+ # element may also contain some actions such as onclick button.
+ "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
+ "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
+ "iconUrl": "A String", # The icon specified by a URL.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "name": "A String", # The name of this image_button which will be used for accessibility.
+ # Default value will be provided if developers don't specify.
+ "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
+ # API.
+ },
+ "textButton": { # A button with text and onclick action. # A button with text and onclick action.
+ "text": "A String", # The text of the button.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ },
+ },
+ "icon": "A String", # An enum value that will be replaced by the Chat API with the
+ # corresponding icon image.
+ "bottomLabel": "A String", # The text of the bottom label. Formatted text supported.
+ "contentMultiline": True or False, # If the content should be multiline.
+ "topLabel": "A String", # The text of the top label. Formatted text supported.
+ "content": "A String", # The text of the content. Formatted text supported and always required.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region
+ # are clickable.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "iconUrl": "A String", # The icon specified by a URL.
+ },
+ "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "aspectRatio": 3.14, # The aspect ratio of this image (width/height). This field allows clients
+ # to reserve the right height for the image while waiting for it to load.
+ # It's not meant to override the native aspect ratio of the image.
+ # If unset, the server fills it by prefetching the image.
+ "imageUrl": "A String", # The URL of the image.
+ },
+ },
+ ],
+ "header": "A String", # The header of the section, text formatted supported.
+ },
+ ],
+ "header": { # The header of the card. A header usually contains a title and an image.
+ "imageUrl": "A String", # The URL of the image in the card header.
+ "imageStyle": "A String", # The image's type (e.g. square border or circular border).
+ "title": "A String", # The title must be specified. The header has a fixed height: if both a
+ # title and subtitle is specified, each will take up 1 line. If only the
+ # title is specified, it will take up both lines.
+ "subtitle": "A String", # The subtitle of the card header.
+ },
+ },
+ ],
+ "space": { # A room or DM in Hangouts Chat. # The space the message belongs to.
+ "displayName": "A String", # Output only. The display name (only if the space is a room).
+ # Please note that this field might not be populated in direct messages
+ # between humans.
+ "threaded": True or False, # Whether the messages are threaded in this space.
+ "name": "A String", # Resource name of the space, in the form "spaces/*".
+ #
+ # Example: spaces/AAAAMpdlehYs
+ "type": "A String", # Output only. The type of a space.
+ # This is deprecated. Use `single_user_bot_dm` instead.
+ "singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human.
+ },
+ "thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
+ "name": "A String", # Resource name, in the form "spaces/*/threads/*".
+ #
+ # Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
+ },
+ "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards
+ # cannot be displayed (e.g. mobile notifications).
+ }</pre>
</div>
<div class="method">
@@ -786,257 +841,358 @@
An object of the form:
{ # A message in Hangouts Chat.
- "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.
- "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards
- # cannot be displayed (e.g. mobile notifications).
- "actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is
- # posted.
- "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
- "type": "A String", # The type of bot response.
- },
- "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
- # server.
- "sender": { # A user in Hangouts Chat. # The user who created the message.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- },
- "cards": [ # Rich, formatted and interactive cards that can be used to display UI
- # elements such as: formatted texts, buttons, clickable images. Cards are
- # normally displayed below the plain-text body of the message.
- { # A card is a UI element that can contain UI widgets such as texts, images.
- "name": "A String", # Name of the card.
- "sections": [ # Sections are separated by a line divider.
- { # A section contains a collection of widgets that are rendered
- # (vertically) in the order that they are specified. Across all platforms,
- # cards have a narrow fixed width, so
- # there is currently no need for layout properties (e.g. float).
- "header": "A String", # The header of the section, text formatted supported.
- "widgets": [ # A section must contain at least 1 widget.
- { # A widget is a UI element that presents texts, images, etc.
- "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.
- "text": "A String",
- },
- "keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.
- # element may also contain some actions such as onclick button.
- "topLabel": "A String", # The text of the top label. Formatted text supported.
- "iconUrl": "A String", # The icon specified by a URL.
- "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
- "textButton": { # A button with text and onclick action. # A button with text and onclick action.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "text": "A String", # The text of the button.
- },
- "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
- "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
- # API.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "iconUrl": "A String", # The icon specified by a URL.
- "name": "A String", # The name of this image_button which will be used for accessibility.
- # Default value will be provided if developers don't specify.
- },
- },
- "content": "A String", # The text of the content. Formatted text supported and always required.
- "bottomLabel": "A String", # The text of the bottom label. Formatted text supported.
- "icon": "A String", # An enum value that will be replaced by the Chat API with the
- # corresponding icon image.
- "contentMultiline": True or False, # If the content should be multiline.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region
- # are clickable.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- },
- "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "aspectRatio": 3.14, # The aspect ratio of this image (width/height). This field allows clients
- # to reserve the right height for the image while waiting for it to load.
- # It's not meant to override the native aspect ratio of the image.
- # If unset, the server fills it by prefetching the image.
- "imageUrl": "A String", # The URL of the image.
- },
- "buttons": [ # A list of buttons. Buttons is also oneof data and only one of these
- # fields should be set.
- { # A button. Can be a text button or an image button.
- "textButton": { # A button with text and onclick action. # A button with text and onclick action.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "text": "A String", # The text of the button.
- },
- "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
- "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
- # API.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "iconUrl": "A String", # The icon specified by a URL.
- "name": "A String", # The name of this image_button which will be used for accessibility.
- # Default value will be provided if developers don't specify.
- },
- },
- ],
- },
- ],
- },
- ],
- "cardActions": [ # The actions of this card.
- { # A card action is
- # the action associated with the card. For an invoice card, a
- # typical action would be: delete invoice, email invoice or open the
- # invoice in browser.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "actionLabel": "A String", # The label used to be displayed in the action menu item.
- },
- ],
- "header": { # The header of the card. A header usually contains a title and an image.
- "imageStyle": "A String", # The image's type (e.g. square border or circular border).
- "title": "A String", # The title must be specified. The header has a fixed height: if both a
- # title and subtitle is specified, each will take up 1 line. If only the
- # title is specified, it will take up both lines.
- "subtitle": "A String", # The subtitle of the card header.
- "imageUrl": "A String", # The URL of the image in the card header.
- },
- },
- ],
- "thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
- "name": "A String", # Resource name, in the form "spaces/*/threads/*".
+ "name": "A String", # Resource name, in the form "spaces/*/messages/*".
#
- # Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
- },
+ # Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
+ "annotations": [ # Output only. Annotations associated with the text in this message.
+ { # Annotations associated with the plain-text body of the message.
+ #
+ # Example plain-text message body:
+ # ```
+ # Hello @FooBot how are you!"
+ # ```
+ #
+ # The corresponding annotations metadata:
+ # ```
+ # "annotations":[{
+ # "type":"USER_MENTION",
+ # "startIndex":6,
+ # "length":7,
+ # "userMention": {
+ # "user": {
+ # "name":"users/107946847022116401880",
+ # "displayName":"FooBot",
+ # "avatarUrl":"https://goo.gl/aeDtrS",
+ # "type":"BOT"
+ # },
+ # "type":"MENTION"
+ # }
+ # }]
+ # ```
+ "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this
+ # annotation corresponds to.
+ "type": "A String", # The type of this annotation.
+ "length": 42, # Length of the substring in the plain-text message body this annotation
+ # corresponds to.
+ "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
+ "user": { # A user in Hangouts Chat. # The user mentioned.
+ "name": "A String", # Resource name, in the format "users/*".
+ "type": "A String", # User type.
+ "displayName": "A String", # The user's display name.
+ "domainId": "A String", # Obfuscated domain information.
+ },
+ "type": "A String", # The type of user mention.
+ },
+ },
+ ],
+ "actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is
+ # posted.
+ "type": "A String", # The type of bot response.
+ "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
+ },
+ "sender": { # A user in Hangouts Chat. # The user who created the message.
+ "name": "A String", # Resource name, in the format "users/*".
+ "type": "A String", # User type.
+ "displayName": "A String", # The user's display name.
+ "domainId": "A String", # Obfuscated domain information.
+ },
+ "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
+ # server.
+ "text": "A String", # Plain-text body of the message.
+ "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the
+ # user, but any links to images, web pages, videos, etc. included here will
+ # generate preview chips.
+ "attachment": [ # User uploaded attachment.
+ { # An attachment in Hangouts Chat.
+ "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the
+ # attachment to a human user. Bots should not use this URL to download
+ # attachment content.
+ "driveDataRef": { # A reference to the data of a drive attachment. # A reference to the drive attachment. This is used with the Drive API.
+ "driveFileId": "A String", # The id for the drive file, for use with the Drive API.
+ },
+ "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to
+ # download the attachment. Bots should not use this URL to download
+ # attachment content.
+ "contentType": "A String", # The content type (MIME type) of the file.
+ "name": "A String", # Resource name of the attachment, in the form
+ # "spaces/*/messages/*/attachments/*".
+ "source": "A String", # The source of the attachment.
+ "attachmentDataRef": { # A reference to the data of an attachment. # A reference to the attachment data. This is used with the media API to
+ # download the attachment data.
+ "resourceName": "A String", # The resource name of the attachment data. This is used with the media API
+ # to download the attachment data.
+ },
+ "contentName": "A String", # The original file name for the content, not the full path.
+ },
+ ],
+ "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.
+ "cards": [ # Rich, formatted and interactive cards that can be used to display UI
+ # elements such as: formatted texts, buttons, clickable images. Cards are
+ # normally displayed below the plain-text body of the message.
+ { # A card is a UI element that can contain UI widgets such as texts, images.
+ "name": "A String", # Name of the card.
+ "cardActions": [ # The actions of this card.
+ { # A card action is
+ # the action associated with the card. For an invoice card, a
+ # typical action would be: delete invoice, email invoice or open the
+ # invoice in browser.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "actionLabel": "A String", # The label used to be displayed in the action menu item.
+ },
+ ],
+ "sections": [ # Sections are separated by a line divider.
+ { # A section contains a collection of widgets that are rendered
+ # (vertically) in the order that they are specified. Across all platforms,
+ # cards have a narrow fixed width, so
+ # there is currently no need for layout properties (e.g. float).
+ "widgets": [ # A section must contain at least 1 widget.
+ { # A widget is a UI element that presents texts, images, etc.
+ "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.
+ "text": "A String",
+ },
+ "buttons": [ # A list of buttons. Buttons is also oneof data and only one of these
+ # fields should be set.
+ { # A button. Can be a text button or an image button.
+ "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
+ "iconUrl": "A String", # The icon specified by a URL.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "name": "A String", # The name of this image_button which will be used for accessibility.
+ # Default value will be provided if developers don't specify.
+ "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
+ # API.
+ },
+ "textButton": { # A button with text and onclick action. # A button with text and onclick action.
+ "text": "A String", # The text of the button.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ },
+ },
+ ],
+ "keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.
+ # element may also contain some actions such as onclick button.
+ "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
+ "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
+ "iconUrl": "A String", # The icon specified by a URL.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "name": "A String", # The name of this image_button which will be used for accessibility.
+ # Default value will be provided if developers don't specify.
+ "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
+ # API.
+ },
+ "textButton": { # A button with text and onclick action. # A button with text and onclick action.
+ "text": "A String", # The text of the button.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ },
+ },
+ "icon": "A String", # An enum value that will be replaced by the Chat API with the
+ # corresponding icon image.
+ "bottomLabel": "A String", # The text of the bottom label. Formatted text supported.
+ "contentMultiline": True or False, # If the content should be multiline.
+ "topLabel": "A String", # The text of the top label. Formatted text supported.
+ "content": "A String", # The text of the content. Formatted text supported and always required.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region
+ # are clickable.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "iconUrl": "A String", # The icon specified by a URL.
+ },
+ "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "aspectRatio": 3.14, # The aspect ratio of this image (width/height). This field allows clients
+ # to reserve the right height for the image while waiting for it to load.
+ # It's not meant to override the native aspect ratio of the image.
+ # If unset, the server fills it by prefetching the image.
+ "imageUrl": "A String", # The URL of the image.
+ },
+ },
+ ],
+ "header": "A String", # The header of the section, text formatted supported.
+ },
+ ],
+ "header": { # The header of the card. A header usually contains a title and an image.
+ "imageUrl": "A String", # The URL of the image in the card header.
+ "imageStyle": "A String", # The image's type (e.g. square border or circular border).
+ "title": "A String", # The title must be specified. The header has a fixed height: if both a
+ # title and subtitle is specified, each will take up 1 line. If only the
+ # title is specified, it will take up both lines.
+ "subtitle": "A String", # The subtitle of the card header.
+ },
+ },
+ ],
+ "space": { # A room or DM in Hangouts Chat. # The space the message belongs to.
+ "displayName": "A String", # Output only. The display name (only if the space is a room).
+ # Please note that this field might not be populated in direct messages
+ # between humans.
+ "threaded": True or False, # Whether the messages are threaded in this space.
+ "name": "A String", # Resource name of the space, in the form "spaces/*".
+ #
+ # Example: spaces/AAAAMpdlehYs
+ "type": "A String", # Output only. The type of a space.
+ # This is deprecated. Use `single_user_bot_dm` instead.
+ "singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human.
+ },
+ "thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
+ "name": "A String", # Resource name, in the form "spaces/*/threads/*".
+ #
+ # Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
+ },
+ "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards
+ # cannot be displayed (e.g. mobile notifications).
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="update">update(name, body=None, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates a message.
+
+Args:
+ name: string, Resource name, in the form "spaces/*/messages/*".
+
+Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A message in Hangouts Chat.
+ "name": "A String", # Resource name, in the form "spaces/*/messages/*".
+ #
+ # Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
"annotations": [ # Output only. Annotations associated with the text in this message.
{ # Annotations associated with the plain-text body of the message.
#
@@ -1062,364 +1218,313 @@
# }
# }]
# ```
+ "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this
+ # annotation corresponds to.
+ "type": "A String", # The type of this annotation.
+ "length": 42, # Length of the substring in the plain-text message body this annotation
+ # corresponds to.
"userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
"user": { # A user in Hangouts Chat. # The user mentioned.
"name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
"type": "A String", # User type.
+ "displayName": "A String", # The user's display name.
"domainId": "A String", # Obfuscated domain information.
},
"type": "A String", # The type of user mention.
},
- "type": "A String", # The type of this annotation.
- "length": 42, # Length of the substring in the plain-text message body this annotation
- # corresponds to.
- "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this
- # annotation corresponds to.
},
],
- "name": "A String", # Resource name, in the form "spaces/*/messages/*".
- #
- # Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
+ "actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is
+ # posted.
+ "type": "A String", # The type of bot response.
+ "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
+ },
+ "sender": { # A user in Hangouts Chat. # The user who created the message.
+ "name": "A String", # Resource name, in the format "users/*".
+ "type": "A String", # User type.
+ "displayName": "A String", # The user's display name.
+ "domainId": "A String", # Obfuscated domain information.
+ },
+ "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
+ # server.
+ "text": "A String", # Plain-text body of the message.
"previewText": "A String", # Text for generating preview chips. This text will not be displayed to the
# user, but any links to images, web pages, videos, etc. included here will
# generate preview chips.
- "text": "A String", # Plain-text body of the message.
+ "attachment": [ # User uploaded attachment.
+ { # An attachment in Hangouts Chat.
+ "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the
+ # attachment to a human user. Bots should not use this URL to download
+ # attachment content.
+ "driveDataRef": { # A reference to the data of a drive attachment. # A reference to the drive attachment. This is used with the Drive API.
+ "driveFileId": "A String", # The id for the drive file, for use with the Drive API.
+ },
+ "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to
+ # download the attachment. Bots should not use this URL to download
+ # attachment content.
+ "contentType": "A String", # The content type (MIME type) of the file.
+ "name": "A String", # Resource name of the attachment, in the form
+ # "spaces/*/messages/*/attachments/*".
+ "source": "A String", # The source of the attachment.
+ "attachmentDataRef": { # A reference to the data of an attachment. # A reference to the attachment data. This is used with the media API to
+ # download the attachment data.
+ "resourceName": "A String", # The resource name of the attachment data. This is used with the media API
+ # to download the attachment data.
+ },
+ "contentName": "A String", # The original file name for the content, not the full path.
+ },
+ ],
+ "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.
+ "cards": [ # Rich, formatted and interactive cards that can be used to display UI
+ # elements such as: formatted texts, buttons, clickable images. Cards are
+ # normally displayed below the plain-text body of the message.
+ { # A card is a UI element that can contain UI widgets such as texts, images.
+ "name": "A String", # Name of the card.
+ "cardActions": [ # The actions of this card.
+ { # A card action is
+ # the action associated with the card. For an invoice card, a
+ # typical action would be: delete invoice, email invoice or open the
+ # invoice in browser.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "actionLabel": "A String", # The label used to be displayed in the action menu item.
+ },
+ ],
+ "sections": [ # Sections are separated by a line divider.
+ { # A section contains a collection of widgets that are rendered
+ # (vertically) in the order that they are specified. Across all platforms,
+ # cards have a narrow fixed width, so
+ # there is currently no need for layout properties (e.g. float).
+ "widgets": [ # A section must contain at least 1 widget.
+ { # A widget is a UI element that presents texts, images, etc.
+ "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.
+ "text": "A String",
+ },
+ "buttons": [ # A list of buttons. Buttons is also oneof data and only one of these
+ # fields should be set.
+ { # A button. Can be a text button or an image button.
+ "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
+ "iconUrl": "A String", # The icon specified by a URL.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "name": "A String", # The name of this image_button which will be used for accessibility.
+ # Default value will be provided if developers don't specify.
+ "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
+ # API.
+ },
+ "textButton": { # A button with text and onclick action. # A button with text and onclick action.
+ "text": "A String", # The text of the button.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ },
+ },
+ ],
+ "keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.
+ # element may also contain some actions such as onclick button.
+ "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
+ "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
+ "iconUrl": "A String", # The icon specified by a URL.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "name": "A String", # The name of this image_button which will be used for accessibility.
+ # Default value will be provided if developers don't specify.
+ "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
+ # API.
+ },
+ "textButton": { # A button with text and onclick action. # A button with text and onclick action.
+ "text": "A String", # The text of the button.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ },
+ },
+ "icon": "A String", # An enum value that will be replaced by the Chat API with the
+ # corresponding icon image.
+ "bottomLabel": "A String", # The text of the bottom label. Formatted text supported.
+ "contentMultiline": True or False, # If the content should be multiline.
+ "topLabel": "A String", # The text of the top label. Formatted text supported.
+ "content": "A String", # The text of the content. Formatted text supported and always required.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region
+ # are clickable.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "iconUrl": "A String", # The icon specified by a URL.
+ },
+ "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "aspectRatio": 3.14, # The aspect ratio of this image (width/height). This field allows clients
+ # to reserve the right height for the image while waiting for it to load.
+ # It's not meant to override the native aspect ratio of the image.
+ # If unset, the server fills it by prefetching the image.
+ "imageUrl": "A String", # The URL of the image.
+ },
+ },
+ ],
+ "header": "A String", # The header of the section, text formatted supported.
+ },
+ ],
+ "header": { # The header of the card. A header usually contains a title and an image.
+ "imageUrl": "A String", # The URL of the image in the card header.
+ "imageStyle": "A String", # The image's type (e.g. square border or circular border).
+ "title": "A String", # The title must be specified. The header has a fixed height: if both a
+ # title and subtitle is specified, each will take up 1 line. If only the
+ # title is specified, it will take up both lines.
+ "subtitle": "A String", # The subtitle of the card header.
+ },
+ },
+ ],
"space": { # A room or DM in Hangouts Chat. # The space the message belongs to.
+ "displayName": "A String", # Output only. The display name (only if the space is a room).
+ # Please note that this field might not be populated in direct messages
+ # between humans.
+ "threaded": True or False, # Whether the messages are threaded in this space.
"name": "A String", # Resource name of the space, in the form "spaces/*".
#
# Example: spaces/AAAAMpdlehYs
- "threaded": True or False, # Whether the messages are threaded in this space.
- "displayName": "A String", # Output only. The display name (only if the space is a room).
"type": "A String", # Output only. The type of a space.
# This is deprecated. Use `single_user_bot_dm` instead.
"singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human.
},
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="update">update(name, body=None, updateMask=None, x__xgafv=None)</code>
- <pre>Updates a message.
-
-Args:
- name: string, Resource name, in the form "spaces/*/messages/*".
-
-Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4 (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # A message in Hangouts Chat.
- "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.
- "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards
- # cannot be displayed (e.g. mobile notifications).
- "actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is
- # posted.
- "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
- "type": "A String", # The type of bot response.
- },
- "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
- # server.
- "sender": { # A user in Hangouts Chat. # The user who created the message.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- },
- "cards": [ # Rich, formatted and interactive cards that can be used to display UI
- # elements such as: formatted texts, buttons, clickable images. Cards are
- # normally displayed below the plain-text body of the message.
- { # A card is a UI element that can contain UI widgets such as texts, images.
- "name": "A String", # Name of the card.
- "sections": [ # Sections are separated by a line divider.
- { # A section contains a collection of widgets that are rendered
- # (vertically) in the order that they are specified. Across all platforms,
- # cards have a narrow fixed width, so
- # there is currently no need for layout properties (e.g. float).
- "header": "A String", # The header of the section, text formatted supported.
- "widgets": [ # A section must contain at least 1 widget.
- { # A widget is a UI element that presents texts, images, etc.
- "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.
- "text": "A String",
- },
- "keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.
- # element may also contain some actions such as onclick button.
- "topLabel": "A String", # The text of the top label. Formatted text supported.
- "iconUrl": "A String", # The icon specified by a URL.
- "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
- "textButton": { # A button with text and onclick action. # A button with text and onclick action.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "text": "A String", # The text of the button.
- },
- "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
- "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
- # API.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "iconUrl": "A String", # The icon specified by a URL.
- "name": "A String", # The name of this image_button which will be used for accessibility.
- # Default value will be provided if developers don't specify.
- },
- },
- "content": "A String", # The text of the content. Formatted text supported and always required.
- "bottomLabel": "A String", # The text of the bottom label. Formatted text supported.
- "icon": "A String", # An enum value that will be replaced by the Chat API with the
- # corresponding icon image.
- "contentMultiline": True or False, # If the content should be multiline.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region
- # are clickable.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- },
- "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "aspectRatio": 3.14, # The aspect ratio of this image (width/height). This field allows clients
- # to reserve the right height for the image while waiting for it to load.
- # It's not meant to override the native aspect ratio of the image.
- # If unset, the server fills it by prefetching the image.
- "imageUrl": "A String", # The URL of the image.
- },
- "buttons": [ # A list of buttons. Buttons is also oneof data and only one of these
- # fields should be set.
- { # A button. Can be a text button or an image button.
- "textButton": { # A button with text and onclick action. # A button with text and onclick action.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "text": "A String", # The text of the button.
- },
- "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
- "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
- # API.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "iconUrl": "A String", # The icon specified by a URL.
- "name": "A String", # The name of this image_button which will be used for accessibility.
- # Default value will be provided if developers don't specify.
- },
- },
- ],
- },
- ],
- },
- ],
- "cardActions": [ # The actions of this card.
- { # A card action is
- # the action associated with the card. For an invoice card, a
- # typical action would be: delete invoice, email invoice or open the
- # invoice in browser.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "actionLabel": "A String", # The label used to be displayed in the action menu item.
- },
- ],
- "header": { # The header of the card. A header usually contains a title and an image.
- "imageStyle": "A String", # The image's type (e.g. square border or circular border).
- "title": "A String", # The title must be specified. The header has a fixed height: if both a
- # title and subtitle is specified, each will take up 1 line. If only the
- # title is specified, it will take up both lines.
- "subtitle": "A String", # The subtitle of the card header.
- "imageUrl": "A String", # The URL of the image in the card header.
- },
+ "thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
+ "name": "A String", # Resource name, in the form "spaces/*/threads/*".
+ #
+ # Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
},
- ],
- "thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
- "name": "A String", # Resource name, in the form "spaces/*/threads/*".
- #
- # Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
- },
- "annotations": [ # Output only. Annotations associated with the text in this message.
- { # Annotations associated with the plain-text body of the message.
- #
- # Example plain-text message body:
- # ```
- # Hello @FooBot how are you!"
- # ```
- #
- # The corresponding annotations metadata:
- # ```
- # "annotations":[{
- # "type":"USER_MENTION",
- # "startIndex":6,
- # "length":7,
- # "userMention": {
- # "user": {
- # "name":"users/107946847022116401880",
- # "displayName":"FooBot",
- # "avatarUrl":"https://goo.gl/aeDtrS",
- # "type":"BOT"
- # },
- # "type":"MENTION"
- # }
- # }]
- # ```
- "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
- "user": { # A user in Hangouts Chat. # The user mentioned.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- },
- "type": "A String", # The type of user mention.
- },
- "type": "A String", # The type of this annotation.
- "length": 42, # Length of the substring in the plain-text message body this annotation
- # corresponds to.
- "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this
- # annotation corresponds to.
- },
- ],
- "name": "A String", # Resource name, in the form "spaces/*/messages/*".
- #
- # Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
- "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the
- # user, but any links to images, web pages, videos, etc. included here will
- # generate preview chips.
- "text": "A String", # Plain-text body of the message.
- "space": { # A room or DM in Hangouts Chat. # The space the message belongs to.
- "name": "A String", # Resource name of the space, in the form "spaces/*".
- #
- # Example: spaces/AAAAMpdlehYs
- "threaded": True or False, # Whether the messages are threaded in this space.
- "displayName": "A String", # Output only. The display name (only if the space is a room).
- "type": "A String", # Output only. The type of a space.
- # This is deprecated. Use `single_user_bot_dm` instead.
- "singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human.
- },
-}
+ "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards
+ # cannot be displayed (e.g. mobile notifications).
+ }
updateMask: string, Required. The field paths to be updated, comma separated if there are
multiple.
@@ -1436,316 +1541,341 @@
An object of the form:
{ # A message in Hangouts Chat.
- "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.
- "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards
- # cannot be displayed (e.g. mobile notifications).
- "actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is
- # posted.
- "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
- "type": "A String", # The type of bot response.
- },
- "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
- # server.
- "sender": { # A user in Hangouts Chat. # The user who created the message.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- },
- "cards": [ # Rich, formatted and interactive cards that can be used to display UI
- # elements such as: formatted texts, buttons, clickable images. Cards are
- # normally displayed below the plain-text body of the message.
- { # A card is a UI element that can contain UI widgets such as texts, images.
- "name": "A String", # Name of the card.
- "sections": [ # Sections are separated by a line divider.
- { # A section contains a collection of widgets that are rendered
- # (vertically) in the order that they are specified. Across all platforms,
- # cards have a narrow fixed width, so
- # there is currently no need for layout properties (e.g. float).
- "header": "A String", # The header of the section, text formatted supported.
- "widgets": [ # A section must contain at least 1 widget.
- { # A widget is a UI element that presents texts, images, etc.
- "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.
- "text": "A String",
- },
- "keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.
- # element may also contain some actions such as onclick button.
- "topLabel": "A String", # The text of the top label. Formatted text supported.
- "iconUrl": "A String", # The icon specified by a URL.
- "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
- "textButton": { # A button with text and onclick action. # A button with text and onclick action.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "text": "A String", # The text of the button.
- },
- "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
- "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
- # API.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "iconUrl": "A String", # The icon specified by a URL.
- "name": "A String", # The name of this image_button which will be used for accessibility.
- # Default value will be provided if developers don't specify.
- },
- },
- "content": "A String", # The text of the content. Formatted text supported and always required.
- "bottomLabel": "A String", # The text of the bottom label. Formatted text supported.
- "icon": "A String", # An enum value that will be replaced by the Chat API with the
- # corresponding icon image.
- "contentMultiline": True or False, # If the content should be multiline.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region
- # are clickable.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- },
- "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "aspectRatio": 3.14, # The aspect ratio of this image (width/height). This field allows clients
- # to reserve the right height for the image while waiting for it to load.
- # It's not meant to override the native aspect ratio of the image.
- # If unset, the server fills it by prefetching the image.
- "imageUrl": "A String", # The URL of the image.
- },
- "buttons": [ # A list of buttons. Buttons is also oneof data and only one of these
- # fields should be set.
- { # A button. Can be a text button or an image button.
- "textButton": { # A button with text and onclick action. # A button with text and onclick action.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "text": "A String", # The text of the button.
- },
- "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
- "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
- # API.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
- },
- "iconUrl": "A String", # The icon specified by a URL.
- "name": "A String", # The name of this image_button which will be used for accessibility.
- # Default value will be provided if developers don't specify.
- },
- },
- ],
- },
- ],
- },
- ],
- "cardActions": [ # The actions of this card.
- { # A card action is
- # the action associated with the card. For an invoice card, a
- # typical action would be: delete invoice, email invoice or open the
- # invoice in browser.
- "onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.
- "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
- "url": "A String", # The URL to open.
- },
- "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
- # For example, an Apps Script can be invoked to handle the form.
- "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
- # form submission. This information is echoed back to the bot as part of
- # the card click event. The same method name can be used for several
- # elements that trigger a common behavior if desired.
- "parameters": [ # List of action parameters.
- { # List of string parameters to supply when the action method is invoked.
- # For example, consider three snooze buttons: snooze now, snooze 1 day,
- # snooze next week. You might use action method = snooze(), passing the
- # snooze type and snooze time in the list of string parameters.
- "value": "A String", # The value of the parameter.
- "key": "A String", # The name of the parameter for the action script.
- },
- ],
- },
+ "name": "A String", # Resource name, in the form "spaces/*/messages/*".
+ #
+ # Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
+ "annotations": [ # Output only. Annotations associated with the text in this message.
+ { # Annotations associated with the plain-text body of the message.
+ #
+ # Example plain-text message body:
+ # ```
+ # Hello @FooBot how are you!"
+ # ```
+ #
+ # The corresponding annotations metadata:
+ # ```
+ # "annotations":[{
+ # "type":"USER_MENTION",
+ # "startIndex":6,
+ # "length":7,
+ # "userMention": {
+ # "user": {
+ # "name":"users/107946847022116401880",
+ # "displayName":"FooBot",
+ # "avatarUrl":"https://goo.gl/aeDtrS",
+ # "type":"BOT"
+ # },
+ # "type":"MENTION"
+ # }
+ # }]
+ # ```
+ "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this
+ # annotation corresponds to.
+ "type": "A String", # The type of this annotation.
+ "length": 42, # Length of the substring in the plain-text message body this annotation
+ # corresponds to.
+ "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
+ "user": { # A user in Hangouts Chat. # The user mentioned.
+ "name": "A String", # Resource name, in the format "users/*".
+ "type": "A String", # User type.
+ "displayName": "A String", # The user's display name.
+ "domainId": "A String", # Obfuscated domain information.
},
- "actionLabel": "A String", # The label used to be displayed in the action menu item.
+ "type": "A String", # The type of user mention.
},
- ],
- "header": { # The header of the card. A header usually contains a title and an image.
- "imageStyle": "A String", # The image's type (e.g. square border or circular border).
- "title": "A String", # The title must be specified. The header has a fixed height: if both a
- # title and subtitle is specified, each will take up 1 line. If only the
- # title is specified, it will take up both lines.
- "subtitle": "A String", # The subtitle of the card header.
- "imageUrl": "A String", # The URL of the image in the card header.
},
+ ],
+ "actionResponse": { # Parameters that a bot can use to configure how it's response is posted. # Input only. Parameters that a bot can use to configure how its response is
+ # posted.
+ "type": "A String", # The type of bot response.
+ "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
},
- ],
- "thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
- "name": "A String", # Resource name, in the form "spaces/*/threads/*".
- #
- # Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
- },
- "annotations": [ # Output only. Annotations associated with the text in this message.
- { # Annotations associated with the plain-text body of the message.
- #
- # Example plain-text message body:
- # ```
- # Hello @FooBot how are you!"
- # ```
- #
- # The corresponding annotations metadata:
- # ```
- # "annotations":[{
- # "type":"USER_MENTION",
- # "startIndex":6,
- # "length":7,
- # "userMention": {
- # "user": {
- # "name":"users/107946847022116401880",
- # "displayName":"FooBot",
- # "avatarUrl":"https://goo.gl/aeDtrS",
- # "type":"BOT"
- # },
- # "type":"MENTION"
- # }
- # }]
- # ```
- "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
- "user": { # A user in Hangouts Chat. # The user mentioned.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
+ "sender": { # A user in Hangouts Chat. # The user who created the message.
+ "name": "A String", # Resource name, in the format "users/*".
+ "type": "A String", # User type.
+ "displayName": "A String", # The user's display name.
+ "domainId": "A String", # Obfuscated domain information.
+ },
+ "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
+ # server.
+ "text": "A String", # Plain-text body of the message.
+ "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the
+ # user, but any links to images, web pages, videos, etc. included here will
+ # generate preview chips.
+ "attachment": [ # User uploaded attachment.
+ { # An attachment in Hangouts Chat.
+ "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the
+ # attachment to a human user. Bots should not use this URL to download
+ # attachment content.
+ "driveDataRef": { # A reference to the data of a drive attachment. # A reference to the drive attachment. This is used with the Drive API.
+ "driveFileId": "A String", # The id for the drive file, for use with the Drive API.
},
- "type": "A String", # The type of user mention.
+ "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to
+ # download the attachment. Bots should not use this URL to download
+ # attachment content.
+ "contentType": "A String", # The content type (MIME type) of the file.
+ "name": "A String", # Resource name of the attachment, in the form
+ # "spaces/*/messages/*/attachments/*".
+ "source": "A String", # The source of the attachment.
+ "attachmentDataRef": { # A reference to the data of an attachment. # A reference to the attachment data. This is used with the media API to
+ # download the attachment data.
+ "resourceName": "A String", # The resource name of the attachment data. This is used with the media API
+ # to download the attachment data.
+ },
+ "contentName": "A String", # The original file name for the content, not the full path.
},
- "type": "A String", # The type of this annotation.
- "length": 42, # Length of the substring in the plain-text message body this annotation
- # corresponds to.
- "startIndex": 42, # Start index (0-based, inclusive) in the plain-text message body this
- # annotation corresponds to.
+ ],
+ "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out.
+ "cards": [ # Rich, formatted and interactive cards that can be used to display UI
+ # elements such as: formatted texts, buttons, clickable images. Cards are
+ # normally displayed below the plain-text body of the message.
+ { # A card is a UI element that can contain UI widgets such as texts, images.
+ "name": "A String", # Name of the card.
+ "cardActions": [ # The actions of this card.
+ { # A card action is
+ # the action associated with the card. For an invoice card, a
+ # typical action would be: delete invoice, email invoice or open the
+ # invoice in browser.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action for this action item.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "actionLabel": "A String", # The label used to be displayed in the action menu item.
+ },
+ ],
+ "sections": [ # Sections are separated by a line divider.
+ { # A section contains a collection of widgets that are rendered
+ # (vertically) in the order that they are specified. Across all platforms,
+ # cards have a narrow fixed width, so
+ # there is currently no need for layout properties (e.g. float).
+ "widgets": [ # A section must contain at least 1 widget.
+ { # A widget is a UI element that presents texts, images, etc.
+ "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget.
+ "text": "A String",
+ },
+ "buttons": [ # A list of buttons. Buttons is also oneof data and only one of these
+ # fields should be set.
+ { # A button. Can be a text button or an image button.
+ "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
+ "iconUrl": "A String", # The icon specified by a URL.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "name": "A String", # The name of this image_button which will be used for accessibility.
+ # Default value will be provided if developers don't specify.
+ "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
+ # API.
+ },
+ "textButton": { # A button with text and onclick action. # A button with text and onclick action.
+ "text": "A String", # The text of the button.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ },
+ },
+ ],
+ "keyValue": { # A UI element contains a key (label) and a value (content). And this # Display a key value item in this widget.
+ # element may also contain some actions such as onclick button.
+ "button": { # A button. Can be a text button or an image button. # A button that can be clicked to trigger an action.
+ "imageButton": { # An image button with an onclick action. # A button with image and onclick action.
+ "iconUrl": "A String", # The icon specified by a URL.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "name": "A String", # The name of this image_button which will be used for accessibility.
+ # Default value will be provided if developers don't specify.
+ "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat
+ # API.
+ },
+ "textButton": { # A button with text and onclick action. # A button with text and onclick action.
+ "text": "A String", # The text of the button.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action of the button.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ },
+ },
+ "icon": "A String", # An enum value that will be replaced by the Chat API with the
+ # corresponding icon image.
+ "bottomLabel": "A String", # The text of the bottom label. Formatted text supported.
+ "contentMultiline": True or False, # If the content should be multiline.
+ "topLabel": "A String", # The text of the top label. Formatted text supported.
+ "content": "A String", # The text of the content. Formatted text supported and always required.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action. Only the top label, bottom label and content region
+ # are clickable.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "iconUrl": "A String", # The icon specified by a URL.
+ },
+ "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget.
+ "onClick": { # An onclick action (e.g. open a link). # The onclick action.
+ "action": { # A form action describes the behavior when the form is submitted. # A form action will be trigger by this onclick if specified.
+ # For example, an Apps Script can be invoked to handle the form.
+ "actionMethodName": "A String", # The method name is used to identify which part of the form triggered the
+ # form submission. This information is echoed back to the bot as part of
+ # the card click event. The same method name can be used for several
+ # elements that trigger a common behavior if desired.
+ "parameters": [ # List of action parameters.
+ { # List of string parameters to supply when the action method is invoked.
+ # For example, consider three snooze buttons: snooze now, snooze 1 day,
+ # snooze next week. You might use action method = snooze(), passing the
+ # snooze type and snooze time in the list of string parameters.
+ "value": "A String", # The value of the parameter.
+ "key": "A String", # The name of the parameter for the action script.
+ },
+ ],
+ },
+ "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
+ "url": "A String", # The URL to open.
+ },
+ },
+ "aspectRatio": 3.14, # The aspect ratio of this image (width/height). This field allows clients
+ # to reserve the right height for the image while waiting for it to load.
+ # It's not meant to override the native aspect ratio of the image.
+ # If unset, the server fills it by prefetching the image.
+ "imageUrl": "A String", # The URL of the image.
+ },
+ },
+ ],
+ "header": "A String", # The header of the section, text formatted supported.
+ },
+ ],
+ "header": { # The header of the card. A header usually contains a title and an image.
+ "imageUrl": "A String", # The URL of the image in the card header.
+ "imageStyle": "A String", # The image's type (e.g. square border or circular border).
+ "title": "A String", # The title must be specified. The header has a fixed height: if both a
+ # title and subtitle is specified, each will take up 1 line. If only the
+ # title is specified, it will take up both lines.
+ "subtitle": "A String", # The subtitle of the card header.
+ },
+ },
+ ],
+ "space": { # A room or DM in Hangouts Chat. # The space the message belongs to.
+ "displayName": "A String", # Output only. The display name (only if the space is a room).
+ # Please note that this field might not be populated in direct messages
+ # between humans.
+ "threaded": True or False, # Whether the messages are threaded in this space.
+ "name": "A String", # Resource name of the space, in the form "spaces/*".
+ #
+ # Example: spaces/AAAAMpdlehYs
+ "type": "A String", # Output only. The type of a space.
+ # This is deprecated. Use `single_user_bot_dm` instead.
+ "singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human.
},
- ],
- "name": "A String", # Resource name, in the form "spaces/*/messages/*".
- #
- # Example: spaces/AAAAMpdlehY/messages/UMxbHmzDlr4.UMxbHmzDlr4
- "previewText": "A String", # Text for generating preview chips. This text will not be displayed to the
- # user, but any links to images, web pages, videos, etc. included here will
- # generate preview chips.
- "text": "A String", # Plain-text body of the message.
- "space": { # A room or DM in Hangouts Chat. # The space the message belongs to.
- "name": "A String", # Resource name of the space, in the form "spaces/*".
- #
- # Example: spaces/AAAAMpdlehYs
- "threaded": True or False, # Whether the messages are threaded in this space.
- "displayName": "A String", # Output only. The display name (only if the space is a room).
- "type": "A String", # Output only. The type of a space.
- # This is deprecated. Use `single_user_bot_dm` instead.
- "singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human.
- },
- }</pre>
+ "thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
+ "name": "A String", # Resource name, in the form "spaces/*/threads/*".
+ #
+ # Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4
+ },
+ "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards
+ # cannot be displayed (e.g. mobile notifications).
+ }</pre>
</div>
</body></html>
\ No newline at end of file