docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html
index 4ab60cc..5c77218 100644
--- a/docs/dyn/chat_v1.spaces.messages.html
+++ b/docs/dyn/chat_v1.spaces.messages.html
@@ -98,10 +98,27 @@
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,
@@ -117,10 +134,8 @@
# 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.
- "content": "A String", # The text of the content. Formatted text supported and always required.
"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.
- "text": "A String", # The text of the button.
"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.
@@ -136,12 +151,13 @@
# 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.
+ "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
@@ -161,8 +177,8 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
@@ -172,9 +188,11 @@
# 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.
@@ -191,20 +209,14 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
},
- "contentMultiline": True or False, # If the content should be multiline.
},
"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.
"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
"url": "A String", # The URL to open.
@@ -220,18 +232,22 @@
# 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.
+ "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.
- "text": "A String", # The text of the button.
"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.
@@ -247,12 +263,13 @@
# 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.
+ "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
@@ -272,8 +289,8 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
@@ -293,7 +310,6 @@
# 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.
"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
"url": "A String", # The URL to open.
@@ -309,31 +325,25 @@
# 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.
+ "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.
- "subtitle": "A String", # The subtitle of the card header.
- "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.
+ "imageUrl": "A String", # The URL of the image in the card header.
},
- "name": "A String", # Name of the card.
},
],
- "sender": { # A user in Hangouts Chat. # The user who created the message.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- },
"thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
"name": "A String", # Resource name, in the form "spaces/*/threads/*".
#
@@ -364,20 +374,20 @@
# }
# }]
# ```
+ "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.
- "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
- "type": "A String", # The type of user mention.
- "user": { # A user in Hangouts Chat. # The user mentioned.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- },
- },
},
],
"name": "A String", # Resource name, in the form "spaces/*/messages/*".
@@ -386,27 +396,17 @@
"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.
- "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 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.
},
- "text": "A String", # Plain-text body of the message.
- "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.
- "type": "A String", # The type of bot response.
- "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
- },
- "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
- # server.
}
threadKey: string, Opaque thread identifier string that can be specified to group messages
@@ -427,10 +427,27 @@
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,
@@ -446,10 +463,8 @@
# 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.
- "content": "A String", # The text of the content. Formatted text supported and always required.
"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.
- "text": "A String", # The text of the button.
"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.
@@ -465,12 +480,13 @@
# 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.
+ "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
@@ -490,8 +506,8 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
@@ -501,9 +517,11 @@
# 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.
@@ -520,20 +538,14 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
},
- "contentMultiline": True or False, # If the content should be multiline.
},
"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.
"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
"url": "A String", # The URL to open.
@@ -549,18 +561,22 @@
# 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.
+ "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.
- "text": "A String", # The text of the button.
"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.
@@ -576,12 +592,13 @@
# 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.
+ "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
@@ -601,8 +618,8 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
@@ -622,7 +639,6 @@
# 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.
"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
"url": "A String", # The URL to open.
@@ -638,31 +654,25 @@
# 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.
+ "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.
- "subtitle": "A String", # The subtitle of the card header.
- "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.
+ "imageUrl": "A String", # The URL of the image in the card header.
},
- "name": "A String", # Name of the card.
},
],
- "sender": { # A user in Hangouts Chat. # The user who created the message.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- },
"thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
"name": "A String", # Resource name, in the form "spaces/*/threads/*".
#
@@ -693,20 +703,20 @@
# }
# }]
# ```
+ "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.
- "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
- "type": "A String", # The type of user mention.
- "user": { # A user in Hangouts Chat. # The user mentioned.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- },
- },
},
],
"name": "A String", # Resource name, in the form "spaces/*/messages/*".
@@ -715,27 +725,17 @@
"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.
- "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 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.
},
- "text": "A String", # Plain-text body of the message.
- "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.
- "type": "A String", # The type of bot response.
- "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
- },
- "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
- # server.
}</pre>
</div>
@@ -786,10 +786,27 @@
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,
@@ -805,10 +822,8 @@
# 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.
- "content": "A String", # The text of the content. Formatted text supported and always required.
"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.
- "text": "A String", # The text of the button.
"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.
@@ -824,12 +839,13 @@
# 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.
+ "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
@@ -849,8 +865,8 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
@@ -860,9 +876,11 @@
# 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.
@@ -879,20 +897,14 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
},
- "contentMultiline": True or False, # If the content should be multiline.
},
"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.
"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
"url": "A String", # The URL to open.
@@ -908,18 +920,22 @@
# 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.
+ "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.
- "text": "A String", # The text of the button.
"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.
@@ -935,12 +951,13 @@
# 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.
+ "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
@@ -960,8 +977,8 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
@@ -981,7 +998,6 @@
# 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.
"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
"url": "A String", # The URL to open.
@@ -997,31 +1013,25 @@
# 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.
+ "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.
- "subtitle": "A String", # The subtitle of the card header.
- "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.
+ "imageUrl": "A String", # The URL of the image in the card header.
},
- "name": "A String", # Name of the card.
},
],
- "sender": { # A user in Hangouts Chat. # The user who created the message.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- },
"thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
"name": "A String", # Resource name, in the form "spaces/*/threads/*".
#
@@ -1052,20 +1062,20 @@
# }
# }]
# ```
+ "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.
- "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
- "type": "A String", # The type of user mention.
- "user": { # A user in Hangouts Chat. # The user mentioned.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- },
- },
},
],
"name": "A String", # Resource name, in the form "spaces/*/messages/*".
@@ -1074,27 +1084,17 @@
"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.
- "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 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.
},
- "text": "A String", # Plain-text body of the message.
- "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.
- "type": "A String", # The type of bot response.
- "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
- },
- "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
- # server.
}</pre>
</div>
@@ -1110,10 +1110,27 @@
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,
@@ -1129,10 +1146,8 @@
# 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.
- "content": "A String", # The text of the content. Formatted text supported and always required.
"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.
- "text": "A String", # The text of the button.
"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.
@@ -1148,12 +1163,13 @@
# 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.
+ "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
@@ -1173,8 +1189,8 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
@@ -1184,9 +1200,11 @@
# 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.
@@ -1203,20 +1221,14 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
},
- "contentMultiline": True or False, # If the content should be multiline.
},
"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.
"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
"url": "A String", # The URL to open.
@@ -1232,18 +1244,22 @@
# 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.
+ "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.
- "text": "A String", # The text of the button.
"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.
@@ -1259,12 +1275,13 @@
# 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.
+ "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
@@ -1284,8 +1301,8 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
@@ -1305,7 +1322,6 @@
# 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.
"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
"url": "A String", # The URL to open.
@@ -1321,31 +1337,25 @@
# 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.
+ "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.
- "subtitle": "A String", # The subtitle of the card header.
- "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.
+ "imageUrl": "A String", # The URL of the image in the card header.
},
- "name": "A String", # Name of the card.
},
],
- "sender": { # A user in Hangouts Chat. # The user who created the message.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- },
"thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
"name": "A String", # Resource name, in the form "spaces/*/threads/*".
#
@@ -1376,20 +1386,20 @@
# }
# }]
# ```
+ "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.
- "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
- "type": "A String", # The type of user mention.
- "user": { # A user in Hangouts Chat. # The user mentioned.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- },
- },
},
],
"name": "A String", # Resource name, in the form "spaces/*/messages/*".
@@ -1398,27 +1408,17 @@
"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.
- "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 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.
},
- "text": "A String", # Plain-text body of the message.
- "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.
- "type": "A String", # The type of bot response.
- "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
- },
- "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
- # server.
}
updateMask: string, Required. The field paths to be updated, comma separated if there are
@@ -1436,10 +1436,27 @@
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,
@@ -1455,10 +1472,8 @@
# 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.
- "content": "A String", # The text of the content. Formatted text supported and always required.
"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.
- "text": "A String", # The text of the button.
"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.
@@ -1474,12 +1489,13 @@
# 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.
+ "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
@@ -1499,8 +1515,8 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
@@ -1510,9 +1526,11 @@
# 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.
@@ -1529,20 +1547,14 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
},
- "contentMultiline": True or False, # If the content should be multiline.
},
"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.
"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
"url": "A String", # The URL to open.
@@ -1558,18 +1570,22 @@
# 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.
+ "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.
- "text": "A String", # The text of the button.
"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.
@@ -1585,12 +1601,13 @@
# 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.
+ "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
@@ -1610,8 +1627,8 @@
# 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.
+ "key": "A String", # The name of the parameter for the action script.
},
],
},
@@ -1631,7 +1648,6 @@
# 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.
"openLink": { # A link that opens a new window. # This onclick triggers an open link action if specified.
"url": "A String", # The URL to open.
@@ -1647,31 +1663,25 @@
# 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.
+ "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.
- "subtitle": "A String", # The subtitle of the card header.
- "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.
+ "imageUrl": "A String", # The URL of the image in the card header.
},
- "name": "A String", # Name of the card.
},
],
- "sender": { # A user in Hangouts Chat. # The user who created the message.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- },
"thread": { # A thread in Hangouts Chat. # The thread the message belongs to.
"name": "A String", # Resource name, in the form "spaces/*/threads/*".
#
@@ -1702,20 +1712,20 @@
# }
# }]
# ```
+ "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.
- "userMention": { # Annotation metadata for user mentions (@). # The metadata of user mention.
- "type": "A String", # The type of user mention.
- "user": { # A user in Hangouts Chat. # The user mentioned.
- "type": "A String", # User type.
- "domainId": "A String", # Obfuscated domain information.
- "name": "A String", # Resource name, in the format "users/*".
- "displayName": "A String", # The user's display name.
- },
- },
},
],
"name": "A String", # Resource name, in the form "spaces/*/messages/*".
@@ -1724,27 +1734,17 @@
"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.
- "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 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.
},
- "text": "A String", # Plain-text body of the message.
- "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.
- "type": "A String", # The type of bot response.
- "url": "A String", # URL for users to auth or config. (Only for REQUEST_CONFIG response types.)
- },
- "createTime": "A String", # Output only. The time at which the message was created in Hangouts Chat
- # server.
}</pre>
</div>