| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="chat_v1.html">Google Chat API</a> . <a href="chat_v1.spaces.html">spaces</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="chat_v1.spaces.members.html">members()</a></code> |
| </p> |
| <p class="firstline">Returns the members Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="chat_v1.spaces.messages.html">messages()</a></code> |
| </p> |
| <p class="firstline">Returns the messages Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns a space.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists spaces the caller is a member of.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#webhooks">webhooks(parent, body=None, threadKey=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Legacy path for creating message. Calling these will result in a BadRequest response.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Returns a space. |
| |
| Args: |
| name: string, Required. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAMpdlehY (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A room or DM in Hangouts Chat. |
| "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. |
| "name": "A String", # Resource name of the space, in the form "spaces/*". Example: spaces/AAAAMpdlehYs |
| "singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human. |
| "threaded": True or False, # Whether the messages are threaded in this space. |
| "type": "A String", # Output only. The type of a space. This is deprecated. Use `single_user_bot_dm` instead. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists spaces the caller is a member of. |
| |
| Args: |
| pageSize: integer, Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100. |
| pageToken: string, A token identifying a page of results the server should return. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "nextPageToken": "A String", # Continuation token to retrieve the next page of results. It will be empty for the last page of results. Tokens expire in an hour. An error is thrown if an expired token is passed. |
| "spaces": [ # List of spaces in the requested (or first) page. |
| { # A room or DM in Hangouts Chat. |
| "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. |
| "name": "A String", # Resource name of the space, in the form "spaces/*". Example: spaces/AAAAMpdlehYs |
| "singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human. |
| "threaded": True or False, # Whether the messages are threaded in this space. |
| "type": "A String", # Output only. The type of a space. This is deprecated. Use `single_user_bot_dm` instead. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="webhooks">webhooks(parent, body=None, threadKey=None, x__xgafv=None)</code> |
| <pre>Legacy path for creating message. Calling these will result in a BadRequest response. |
| |
| Args: |
| parent: string, Required. Space resource name, in the form "spaces/*". Example: spaces/AAAAMpdlehY (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A message in Hangouts Chat. |
| "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.) |
| }, |
| "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" } }] ``` |
| "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. |
| "slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. |
| "bot": { # A user in Google Chat. # The bot whose command was invoked. |
| "displayName": "A String", # The user's display name. |
| "domainId": "A String", # Obfuscated domain information. |
| "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. |
| "name": "A String", # Resource name, in the format "users/*". |
| "type": "A String", # User type. |
| }, |
| "commandId": "A String", # The command id of the invoked slash command. |
| "commandName": "A String", # The name of the invoked slash command. |
| "triggersDialog": True or False, # Indicating whether the slash command is for a dialog. |
| "type": "A String", # The type of slash command. |
| }, |
| "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. |
| "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention. |
| "type": "A String", # The type of user mention. |
| "user": { # A user in Google Chat. # The user mentioned. |
| "displayName": "A String", # The user's display name. |
| "domainId": "A String", # Obfuscated domain information. |
| "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. |
| "name": "A String", # Resource name, in the format "users/*". |
| "type": "A String", # User type. |
| }, |
| }, |
| }, |
| ], |
| "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out. |
| "attachment": [ # User uploaded attachment. |
| { # An attachment in Hangouts Chat. |
| "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. |
| "contentType": "A String", # The content type (MIME type) of the file. |
| "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. |
| "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. |
| }, |
| "name": "A String", # Resource name of the attachment, in the form "spaces/*/messages/*/attachments/*". |
| "source": "A String", # The source of the attachment. |
| "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. |
| }, |
| ], |
| "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. |
| "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. |
| "actionLabel": "A String", # The label used to be displayed in the action menu item. |
| "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. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| }, |
| ], |
| "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). |
| "imageUrl": "A String", # The URL of the image in the card header. |
| "subtitle": "A String", # The subtitle of the card header. |
| "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. |
| }, |
| "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. |
| "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. |
| "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat API. |
| "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. |
| "onClick": { # An onclick action (e.g. open a link). # The onclick action. |
| "action": { # A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| }, |
| "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. |
| "action": { # A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| "text": "A String", # The text of the button. |
| }, |
| }, |
| ], |
| "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget. |
| "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. |
| "onClick": { # An onclick action (e.g. open a link). # The onclick action. |
| "action": { # A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "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 element may also contain some actions such as onclick button. # Display a key value item in this widget. |
| "bottomLabel": "A String", # The text of the bottom label. Formatted text supported. |
| "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. |
| "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat API. |
| "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. |
| "onClick": { # An onclick action (e.g. open a link). # The onclick action. |
| "action": { # A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| }, |
| "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. |
| "action": { # A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| "text": "A String", # The text of the button. |
| }, |
| }, |
| "content": "A String", # The text of the content. Formatted text supported and always required. |
| "contentMultiline": True or False, # If the content should be multiline. |
| "icon": "A String", # An enum value that will be replaced by the Chat API with the corresponding icon image. |
| "iconUrl": "A String", # The icon specified by a URL. |
| "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. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| "topLabel": "A String", # The text of the top label. Formatted text supported. |
| }, |
| "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget. |
| "text": "A String", |
| }, |
| }, |
| ], |
| }, |
| ], |
| }, |
| ], |
| "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat server. |
| "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). |
| "name": "A String", |
| "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. |
| "sender": { # A user in Google Chat. # The user who created the message. |
| "displayName": "A String", # The user's display name. |
| "domainId": "A String", # Obfuscated domain information. |
| "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. |
| "name": "A String", # Resource name, in the format "users/*". |
| "type": "A String", # User type. |
| }, |
| "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. |
| "commandId": "A String", # The id of the slash command invoked. |
| }, |
| "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. |
| "name": "A String", # Resource name of the space, in the form "spaces/*". Example: spaces/AAAAMpdlehYs |
| "singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human. |
| "threaded": True or False, # Whether the messages are threaded in this space. |
| "type": "A String", # Output only. The type of a space. This is deprecated. Use `single_user_bot_dm` instead. |
| }, |
| "text": "A String", # Plain-text body of the message. |
| "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 |
| }, |
| } |
| |
| 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. |
| "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.) |
| }, |
| "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" } }] ``` |
| "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. |
| "slashCommand": { # Annotation metadata for slash commands (/). # The metadata for a slash command. |
| "bot": { # A user in Google Chat. # The bot whose command was invoked. |
| "displayName": "A String", # The user's display name. |
| "domainId": "A String", # Obfuscated domain information. |
| "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. |
| "name": "A String", # Resource name, in the format "users/*". |
| "type": "A String", # User type. |
| }, |
| "commandId": "A String", # The command id of the invoked slash command. |
| "commandName": "A String", # The name of the invoked slash command. |
| "triggersDialog": True or False, # Indicating whether the slash command is for a dialog. |
| "type": "A String", # The type of slash command. |
| }, |
| "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. |
| "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention. |
| "type": "A String", # The type of user mention. |
| "user": { # A user in Google Chat. # The user mentioned. |
| "displayName": "A String", # The user's display name. |
| "domainId": "A String", # Obfuscated domain information. |
| "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. |
| "name": "A String", # Resource name, in the format "users/*". |
| "type": "A String", # User type. |
| }, |
| }, |
| }, |
| ], |
| "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out. |
| "attachment": [ # User uploaded attachment. |
| { # An attachment in Hangouts Chat. |
| "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. |
| "contentType": "A String", # The content type (MIME type) of the file. |
| "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. |
| "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. |
| }, |
| "name": "A String", # Resource name of the attachment, in the form "spaces/*/messages/*/attachments/*". |
| "source": "A String", # The source of the attachment. |
| "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. |
| }, |
| ], |
| "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. |
| "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. |
| "actionLabel": "A String", # The label used to be displayed in the action menu item. |
| "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. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| }, |
| ], |
| "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). |
| "imageUrl": "A String", # The URL of the image in the card header. |
| "subtitle": "A String", # The subtitle of the card header. |
| "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. |
| }, |
| "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. |
| "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. |
| "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat API. |
| "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. |
| "onClick": { # An onclick action (e.g. open a link). # The onclick action. |
| "action": { # A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| }, |
| "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. |
| "action": { # A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| "text": "A String", # The text of the button. |
| }, |
| }, |
| ], |
| "image": { # An image that is specified by a URL and can have an onclick action. # Display an image in this widget. |
| "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. |
| "onClick": { # An onclick action (e.g. open a link). # The onclick action. |
| "action": { # A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "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 element may also contain some actions such as onclick button. # Display a key value item in this widget. |
| "bottomLabel": "A String", # The text of the bottom label. Formatted text supported. |
| "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. |
| "icon": "A String", # The icon specified by an enum that indices to an icon provided by Chat API. |
| "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. |
| "onClick": { # An onclick action (e.g. open a link). # The onclick action. |
| "action": { # A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| }, |
| "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. |
| "action": { # A form action describes the behavior when the form is submitted. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| "text": "A String", # The text of the button. |
| }, |
| }, |
| "content": "A String", # The text of the content. Formatted text supported and always required. |
| "contentMultiline": True or False, # If the content should be multiline. |
| "icon": "A String", # An enum value that will be replaced by the Chat API with the corresponding icon image. |
| "iconUrl": "A String", # The icon specified by a URL. |
| "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. For example, an Apps Script can be invoked to handle the form. # A form action will be triggered by this onclick if specified. |
| "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. |
| "key": "A String", # The name of the parameter for the action script. |
| "value": "A String", # The value of the parameter. |
| }, |
| ], |
| }, |
| "openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified. |
| "url": "A String", # The URL to open. |
| }, |
| }, |
| "topLabel": "A String", # The text of the top label. Formatted text supported. |
| }, |
| "textParagraph": { # A paragraph of text. Formatted text supported. # Display a text paragraph in this widget. |
| "text": "A String", |
| }, |
| }, |
| ], |
| }, |
| ], |
| }, |
| ], |
| "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat server. |
| "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). |
| "name": "A String", |
| "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. |
| "sender": { # A user in Google Chat. # The user who created the message. |
| "displayName": "A String", # The user's display name. |
| "domainId": "A String", # Obfuscated domain information. |
| "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. |
| "name": "A String", # Resource name, in the format "users/*". |
| "type": "A String", # User type. |
| }, |
| "slashCommand": { # A Slash Command in Chat. # Slash command information, if applicable. |
| "commandId": "A String", # The id of the slash command invoked. |
| }, |
| "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. |
| "name": "A String", # Resource name of the space, in the form "spaces/*". Example: spaces/AAAAMpdlehYs |
| "singleUserBotDm": True or False, # Whether the space is a DM between a bot and a single human. |
| "threaded": True or False, # Whether the messages are threaded in this space. |
| "type": "A String", # Output only. The type of a space. This is deprecated. Use `single_user_bot_dm` instead. |
| }, |
| "text": "A String", # Plain-text body of the message. |
| "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 |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |