+ close()
Close httplib2 connections.
+
+ create(packageName, allowUnknownDevices=None, body=None, x__xgafv=None)
Creates a new device tier config for an app.
+
+ get(packageName, deviceTierConfigId, x__xgafv=None)
Returns a particular device tier config.
+
+ list(packageName, pageSize=None, pageToken=None, x__xgafv=None)
Returns created device tier configs, ordered by descending creation time.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
create(packageName, allowUnknownDevices=None, body=None, x__xgafv=None)
+ Creates a new device tier config for an app.
+
+Args:
+ packageName: string, Package name of the app. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # LINT.IfChange Configuration describing device targeting criteria for the content of an app.
+ "deviceGroups": [ # Definition of device groups for the app.
+ { # LINT.IfChange A group of devices. A group is defined by a set of device selectors. A device belongs to the group if it matches any selector (logical OR).
+ "deviceSelectors": [ # Device selectors for this group. A device matching any of the selectors is included in this group.
+ { # Selector for a device group. A selector consists of a set of conditions on the device that should all match (logical AND) to determine a device group eligibility. For instance, if a selector specifies RAM conditions, device model inclusion and device model exclusion, a device is considered to match if: device matches RAM conditions AND device matches one of the included device models AND device doesn't match excluded device models
+ "deviceRam": { # Conditions about a device's RAM capabilities. # Conditions on the device's RAM.
+ "maxBytes": "A String", # Maximum RAM in bytes (bound excluded).
+ "minBytes": "A String", # Minimum RAM in bytes (bound included).
+ },
+ "excludedDeviceIds": [ # Device models excluded by this selector, even if they match all other conditions.
+ { # Identifier of a device.
+ "buildBrand": "A String", # Value of Build.BRAND.
+ "buildDevice": "A String", # Value of Build.DEVICE.
+ },
+ ],
+ "forbiddenSystemFeatures": [ # A device that has any of these system features is excluded by this selector, even if it matches all other conditions.
+ { # Representation of a system feature.
+ "name": "A String", # The name of the feature.
+ },
+ ],
+ "includedDeviceIds": [ # Device models included by this selector.
+ { # Identifier of a device.
+ "buildBrand": "A String", # Value of Build.BRAND.
+ "buildDevice": "A String", # Value of Build.DEVICE.
+ },
+ ],
+ "requiredSystemFeatures": [ # A device needs to have all these system features to be included by the selector.
+ { # Representation of a system feature.
+ "name": "A String", # The name of the feature.
+ },
+ ],
+ },
+ ],
+ "name": "A String", # The name of the group.
+ },
+ ],
+ "deviceTierConfigId": "A String", # Output only. The device tier config ID.
+ "deviceTierSet": { # A set of device tiers. A tier set determines what variation of app content gets served to a specific device, for device-targeted content. You should assign a priority level to each tier, which determines the ordering by which they are evaluated by Play. See the documentation of DeviceTier.level for more details. # Definition of the set of device tiers for the app.
+ "deviceTiers": [ # Device tiers belonging to the set.
+ { # A single device tier. Devices matching any of the device groups in device_group_names are considered to match the tier.
+ "deviceGroupNames": [ # Groups of devices included in this tier. These groups must be defined explicitly under device_groups in this configuration.
+ "A String",
+ ],
+ "level": 42, # The priority level of the tier. Tiers are evaluated in descending order of level: the highest level tier has the highest priority. The highest tier matching a given device is selected for that device. You should use a contiguous range of levels for your tiers in a tier set; tier levels in a tier set must be unique. For instance, if your tier set has 4 tiers (including the global fallback), you should define tiers 1, 2 and 3 in this configuration. Note: tier 0 is implicitly defined as a global fallback and selected for devices that don't match any of the tiers explicitly defined here. You mustn't define level 0 explicitly in this configuration.
+ },
+ ],
+ },
+}
+
+ allowUnknownDevices: boolean, Whether the service should accept device IDs that are unknown to Play's device catalog.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # LINT.IfChange Configuration describing device targeting criteria for the content of an app.
+ "deviceGroups": [ # Definition of device groups for the app.
+ { # LINT.IfChange A group of devices. A group is defined by a set of device selectors. A device belongs to the group if it matches any selector (logical OR).
+ "deviceSelectors": [ # Device selectors for this group. A device matching any of the selectors is included in this group.
+ { # Selector for a device group. A selector consists of a set of conditions on the device that should all match (logical AND) to determine a device group eligibility. For instance, if a selector specifies RAM conditions, device model inclusion and device model exclusion, a device is considered to match if: device matches RAM conditions AND device matches one of the included device models AND device doesn't match excluded device models
+ "deviceRam": { # Conditions about a device's RAM capabilities. # Conditions on the device's RAM.
+ "maxBytes": "A String", # Maximum RAM in bytes (bound excluded).
+ "minBytes": "A String", # Minimum RAM in bytes (bound included).
+ },
+ "excludedDeviceIds": [ # Device models excluded by this selector, even if they match all other conditions.
+ { # Identifier of a device.
+ "buildBrand": "A String", # Value of Build.BRAND.
+ "buildDevice": "A String", # Value of Build.DEVICE.
+ },
+ ],
+ "forbiddenSystemFeatures": [ # A device that has any of these system features is excluded by this selector, even if it matches all other conditions.
+ { # Representation of a system feature.
+ "name": "A String", # The name of the feature.
+ },
+ ],
+ "includedDeviceIds": [ # Device models included by this selector.
+ { # Identifier of a device.
+ "buildBrand": "A String", # Value of Build.BRAND.
+ "buildDevice": "A String", # Value of Build.DEVICE.
+ },
+ ],
+ "requiredSystemFeatures": [ # A device needs to have all these system features to be included by the selector.
+ { # Representation of a system feature.
+ "name": "A String", # The name of the feature.
+ },
+ ],
+ },
+ ],
+ "name": "A String", # The name of the group.
+ },
+ ],
+ "deviceTierConfigId": "A String", # Output only. The device tier config ID.
+ "deviceTierSet": { # A set of device tiers. A tier set determines what variation of app content gets served to a specific device, for device-targeted content. You should assign a priority level to each tier, which determines the ordering by which they are evaluated by Play. See the documentation of DeviceTier.level for more details. # Definition of the set of device tiers for the app.
+ "deviceTiers": [ # Device tiers belonging to the set.
+ { # A single device tier. Devices matching any of the device groups in device_group_names are considered to match the tier.
+ "deviceGroupNames": [ # Groups of devices included in this tier. These groups must be defined explicitly under device_groups in this configuration.
+ "A String",
+ ],
+ "level": 42, # The priority level of the tier. Tiers are evaluated in descending order of level: the highest level tier has the highest priority. The highest tier matching a given device is selected for that device. You should use a contiguous range of levels for your tiers in a tier set; tier levels in a tier set must be unique. For instance, if your tier set has 4 tiers (including the global fallback), you should define tiers 1, 2 and 3 in this configuration. Note: tier 0 is implicitly defined as a global fallback and selected for devices that don't match any of the tiers explicitly defined here. You mustn't define level 0 explicitly in this configuration.
+ },
+ ],
+ },
+}
+get(packageName, deviceTierConfigId, x__xgafv=None)
+ Returns a particular device tier config.
+
+Args:
+ packageName: string, Package name of the app. (required)
+ deviceTierConfigId: string, Required. Id of an existing device tier config. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # LINT.IfChange Configuration describing device targeting criteria for the content of an app.
+ "deviceGroups": [ # Definition of device groups for the app.
+ { # LINT.IfChange A group of devices. A group is defined by a set of device selectors. A device belongs to the group if it matches any selector (logical OR).
+ "deviceSelectors": [ # Device selectors for this group. A device matching any of the selectors is included in this group.
+ { # Selector for a device group. A selector consists of a set of conditions on the device that should all match (logical AND) to determine a device group eligibility. For instance, if a selector specifies RAM conditions, device model inclusion and device model exclusion, a device is considered to match if: device matches RAM conditions AND device matches one of the included device models AND device doesn't match excluded device models
+ "deviceRam": { # Conditions about a device's RAM capabilities. # Conditions on the device's RAM.
+ "maxBytes": "A String", # Maximum RAM in bytes (bound excluded).
+ "minBytes": "A String", # Minimum RAM in bytes (bound included).
+ },
+ "excludedDeviceIds": [ # Device models excluded by this selector, even if they match all other conditions.
+ { # Identifier of a device.
+ "buildBrand": "A String", # Value of Build.BRAND.
+ "buildDevice": "A String", # Value of Build.DEVICE.
+ },
+ ],
+ "forbiddenSystemFeatures": [ # A device that has any of these system features is excluded by this selector, even if it matches all other conditions.
+ { # Representation of a system feature.
+ "name": "A String", # The name of the feature.
+ },
+ ],
+ "includedDeviceIds": [ # Device models included by this selector.
+ { # Identifier of a device.
+ "buildBrand": "A String", # Value of Build.BRAND.
+ "buildDevice": "A String", # Value of Build.DEVICE.
+ },
+ ],
+ "requiredSystemFeatures": [ # A device needs to have all these system features to be included by the selector.
+ { # Representation of a system feature.
+ "name": "A String", # The name of the feature.
+ },
+ ],
+ },
+ ],
+ "name": "A String", # The name of the group.
+ },
+ ],
+ "deviceTierConfigId": "A String", # Output only. The device tier config ID.
+ "deviceTierSet": { # A set of device tiers. A tier set determines what variation of app content gets served to a specific device, for device-targeted content. You should assign a priority level to each tier, which determines the ordering by which they are evaluated by Play. See the documentation of DeviceTier.level for more details. # Definition of the set of device tiers for the app.
+ "deviceTiers": [ # Device tiers belonging to the set.
+ { # A single device tier. Devices matching any of the device groups in device_group_names are considered to match the tier.
+ "deviceGroupNames": [ # Groups of devices included in this tier. These groups must be defined explicitly under device_groups in this configuration.
+ "A String",
+ ],
+ "level": 42, # The priority level of the tier. Tiers are evaluated in descending order of level: the highest level tier has the highest priority. The highest tier matching a given device is selected for that device. You should use a contiguous range of levels for your tiers in a tier set; tier levels in a tier set must be unique. For instance, if your tier set has 4 tiers (including the global fallback), you should define tiers 1, 2 and 3 in this configuration. Note: tier 0 is implicitly defined as a global fallback and selected for devices that don't match any of the tiers explicitly defined here. You mustn't define level 0 explicitly in this configuration.
+ },
+ ],
+ },
+}
+list(packageName, pageSize=None, pageToken=None, x__xgafv=None)
+ Returns created device tier configs, ordered by descending creation time.
+
+Args:
+ packageName: string, Package name of the app. (required)
+ pageSize: integer, The maximum number of device tier configs to return. The service may return fewer than this value. If unspecified, at most 10 device tier configs will be returned. The maximum value for this field is 100; values above 100 will be coerced to 100. Device tier configs will be ordered by descending creation time.
+ pageToken: string, A page token, received from a previous `ListDeviceTierConfigs` call. Provide this to retrieve the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response listing existing device tier configs.
+ "deviceTierConfigs": [ # Device tier configs created by the developer.
+ { # LINT.IfChange Configuration describing device targeting criteria for the content of an app.
+ "deviceGroups": [ # Definition of device groups for the app.
+ { # LINT.IfChange A group of devices. A group is defined by a set of device selectors. A device belongs to the group if it matches any selector (logical OR).
+ "deviceSelectors": [ # Device selectors for this group. A device matching any of the selectors is included in this group.
+ { # Selector for a device group. A selector consists of a set of conditions on the device that should all match (logical AND) to determine a device group eligibility. For instance, if a selector specifies RAM conditions, device model inclusion and device model exclusion, a device is considered to match if: device matches RAM conditions AND device matches one of the included device models AND device doesn't match excluded device models
+ "deviceRam": { # Conditions about a device's RAM capabilities. # Conditions on the device's RAM.
+ "maxBytes": "A String", # Maximum RAM in bytes (bound excluded).
+ "minBytes": "A String", # Minimum RAM in bytes (bound included).
+ },
+ "excludedDeviceIds": [ # Device models excluded by this selector, even if they match all other conditions.
+ { # Identifier of a device.
+ "buildBrand": "A String", # Value of Build.BRAND.
+ "buildDevice": "A String", # Value of Build.DEVICE.
+ },
+ ],
+ "forbiddenSystemFeatures": [ # A device that has any of these system features is excluded by this selector, even if it matches all other conditions.
+ { # Representation of a system feature.
+ "name": "A String", # The name of the feature.
+ },
+ ],
+ "includedDeviceIds": [ # Device models included by this selector.
+ { # Identifier of a device.
+ "buildBrand": "A String", # Value of Build.BRAND.
+ "buildDevice": "A String", # Value of Build.DEVICE.
+ },
+ ],
+ "requiredSystemFeatures": [ # A device needs to have all these system features to be included by the selector.
+ { # Representation of a system feature.
+ "name": "A String", # The name of the feature.
+ },
+ ],
+ },
+ ],
+ "name": "A String", # The name of the group.
+ },
+ ],
+ "deviceTierConfigId": "A String", # Output only. The device tier config ID.
+ "deviceTierSet": { # A set of device tiers. A tier set determines what variation of app content gets served to a specific device, for device-targeted content. You should assign a priority level to each tier, which determines the ordering by which they are evaluated by Play. See the documentation of DeviceTier.level for more details. # Definition of the set of device tiers for the app.
+ "deviceTiers": [ # Device tiers belonging to the set.
+ { # A single device tier. Devices matching any of the device groups in device_group_names are considered to match the tier.
+ "deviceGroupNames": [ # Groups of devices included in this tier. These groups must be defined explicitly under device_groups in this configuration.
+ "A String",
+ ],
+ "level": 42, # The priority level of the tier. Tiers are evaluated in descending order of level: the highest level tier has the highest priority. The highest tier matching a given device is selected for that device. You should use a contiguous range of levels for your tiers in a tier set; tier levels in a tier set must be unique. For instance, if your tier set has 4 tiers (including the global fallback), you should define tiers 1, 2 and 3 in this configuration. Note: tier 0 is implicitly defined as a global fallback and selected for devices that don't match any of the tiers explicitly defined here. You mustn't define level 0 explicitly in this configuration.
+ },
+ ],
+ },
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+list_next(previous_request, previous_response)
+ 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. ++
- pricing()
+ deviceTierConfigs()
Returns the pricing Resource.
+Returns the deviceTierConfigs Resource.
diff --git a/docs/dyn/androidpublisher_v3.html b/docs/dyn/androidpublisher_v3.html index 02a78eed1e9..869302a3c08 100644 --- a/docs/dyn/androidpublisher_v3.html +++ b/docs/dyn/androidpublisher_v3.html @@ -74,6 +74,11 @@
+ applications()
+
Returns the applications Resource.
+ diff --git a/docs/dyn/apigateway_v1.projects.locations.operations.html b/docs/dyn/apigateway_v1.projects.locations.operations.html index e6b0722451e..efe326831c2 100644 --- a/docs/dyn/apigateway_v1.projects.locations.operations.html +++ b/docs/dyn/apigateway_v1.projects.locations.operations.html @@ -113,7 +113,7 @@Close httplib2 connections.
-Returns a space.
+Returns a space. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
list(pageSize=None, pageToken=None, x__xgafv=None)
Lists spaces the caller is a member of.
+Lists spaces the caller is a member of. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
list_next(previous_request, previous_response)
Retrieves the next page of results.
@@ -107,7 +107,7 @@get(name, x__xgafv=None)
- Returns a space. +Returns a space. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Args: name: string, Required. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA (required) @@ -119,10 +119,10 @@@@ -130,7 +130,7 @@Method Details
Returns: An object of the form: - { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. + { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "displayName": "A String", # The space's display name. For direct messages between humans, this field might be empty. "name": "A String", # Optional. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA - "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a bot and a single human. + "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a Chat app and a single human. "threaded": True or False, # Output only. Whether the messages are threaded in this space. "type": "A String", # Deprecated. Use `single_user_bot_dm` instead. Output only. The type of a space. }Method Details
diff --git a/docs/dyn/classroom_v1.courses.courseWorkMaterials.html b/docs/dyn/classroom_v1.courses.courseWorkMaterials.html index 6dfeeb3899f..3dc7be9f34e 100644 --- a/docs/dyn/classroom_v1.courses.courseWorkMaterials.html +++ b/docs/dyn/classroom_v1.courses.courseWorkMaterials.html @@ -234,7 +234,7 @@list(pageSize=None, pageToken=None, x__xgafv=None)-Lists spaces the caller is a member of. +Lists spaces the caller is a member of. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). 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. @@ -146,10 +146,10 @@Method Details
{ "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 space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. + { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "displayName": "A String", # The space's display name. For direct messages between humans, this field might be empty. "name": "A String", # Optional. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA - "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a bot and a single human. + "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a Chat app and a single human. "threaded": True or False, # Output only. Whether the messages are threaded in this space. "type": "A String", # Deprecated. Use `single_user_bot_dm` instead. Output only. The type of a space. }, @@ -181,13 +181,13 @@Method Details
The object takes the form of: { # A message in Google 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. - "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Must be accompanied by `ResponseType.Dialog`. - "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. + "actionResponse": { # Parameters that a Chat app can use to configure how it's response is posted. # Input only. Parameters that a Chat app can use to configure how its response is posted. + "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/dialogs). Must be accompanied by `ResponseType.Dialog`. + "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. "statusCode": "A String", # The status code. "userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, - "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/bot-dialogs) for the request. + "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/dialogs) for the request. "body": { # A card is a UI element that can contain UI widgets such as text and images. For more information, see Cards . For example, the following JSON creates a card that has a header with the name, position, icons, and link for a contact, followed by a section with contact information like email and phone number. ``` { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageStyle": "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "imageAltText": "Avatar for Sasha" }, "sections" : [ { "header": "Contact Info", "widgets": [ { "decorated_text": { "icon": { "knownIcon": "EMAIL" }, "content": "sasha@example.com" } }, { "decoratedText": { "icon": { "knownIcon": "PERSON" }, "content": "Online" } }, { "decoratedText": { "icon": { "knownIcon": "PHONE" }, "content": "+1 (555) 555-1234" } }, { "buttons": [ { "textButton": { "text": "Share", }, "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "textButton": { "text": "Edit", }, "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ], "loadIndicator": "LoadIndicator.SPINNER" } } } ] } ], "collapsible": true, "uncollapsibleWidgetsCount": 3 } ], "cardActions": [ { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ], "name": "contact-card-K3wB6arF2H9L" } ``` # Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's generated toolbar menu. For example, the following JSON constructs a card action menu with Settings and Send Feedback options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. @@ -707,17 +707,17 @@Method Details
}, }, }, - "type": "A String", # The type of bot response. + "type": "A String", # The type of Chat app 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. + "bot": { # A user in Google Chat. # The Chat app whose command was invoked. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, @@ -733,14 +733,14 @@Method Details
"user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, }, }, ], - "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out. + "argumentText": "A String", # Plain-text body of the message with all Chat app mentions stripped out. "attachment": [ # User uploaded attachment. { # An attachment in Google 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. @@ -748,13 +748,13 @@Method Details
}, "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. + "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps 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. + "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps 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. @@ -764,7 +764,7 @@Method Details
"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. + "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 Chat app 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. @@ -798,7 +798,7 @@Method Details
"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. + "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 Chat app 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. @@ -814,7 +814,7 @@Method Details
"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. + "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 Chat app 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. @@ -835,7 +835,7 @@Method Details
"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. + "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 Chat app 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. @@ -857,7 +857,7 @@Method Details
"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. + "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 Chat app 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. @@ -873,7 +873,7 @@Method Details
"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. + "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 Chat app 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. @@ -894,7 +894,7 @@Method Details
"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. + "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 Chat app 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. @@ -920,36 +920,35 @@Method Details
"createTime": "A String", # Output only. The time at which the message was created in Google 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). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. - "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "matchedUrl": { # A matched url in a Chat message. Chat apps can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). "url": "A String", # The url that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` - "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", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, "slashCommand": { # A [slash command](https://developers.google.com/chat/how-tos/slash-commands) in Google Chat. # Slash command information, if applicable. "commandId": "A String", # The id of the slash command invoked. }, - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. # The space the message belongs to. + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The space the message belongs to. "displayName": "A String", # The space's display name. For direct messages between humans, this field might be empty. "name": "A String", # Optional. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA - "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a bot and a single human. + "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a Chat app and a single human. "threaded": True or False, # Output only. Whether the messages are threaded in this space. "type": "A String", # Deprecated. Use `single_user_bot_dm` instead. Output only. The type of a space. }, - "text": "A String", # Plain-text body of the message. + "text": "A String", # Plain-text body of the message. The first link to an image, video, web page, or other preview-able item generates a preview chip. "thread": { # A thread in Google Chat. # The thread the message belongs to. "name": "A String", # Resource name, in the form "spaces/*/threads/*". Example: spaces/AAAAAAAAAAA/threads/TTTTTTTTTTT }, } requestId: string, Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message. - threadKey: string, Optional. 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 Google 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. + threadKey: string, Optional. 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 Chat apps and webhooks from having to store the Google 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 @@ -959,13 +958,13 @@Method Details
An object of the form: { # A message in Google 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. - "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Must be accompanied by `ResponseType.Dialog`. - "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. + "actionResponse": { # Parameters that a Chat app can use to configure how it's response is posted. # Input only. Parameters that a Chat app can use to configure how its response is posted. + "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/dialogs). Must be accompanied by `ResponseType.Dialog`. + "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. "statusCode": "A String", # The status code. "userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, - "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/bot-dialogs) for the request. + "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/dialogs) for the request. "body": { # A card is a UI element that can contain UI widgets such as text and images. For more information, see Cards . For example, the following JSON creates a card that has a header with the name, position, icons, and link for a contact, followed by a section with contact information like email and phone number. ``` { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageStyle": "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "imageAltText": "Avatar for Sasha" }, "sections" : [ { "header": "Contact Info", "widgets": [ { "decorated_text": { "icon": { "knownIcon": "EMAIL" }, "content": "sasha@example.com" } }, { "decoratedText": { "icon": { "knownIcon": "PERSON" }, "content": "Online" } }, { "decoratedText": { "icon": { "knownIcon": "PHONE" }, "content": "+1 (555) 555-1234" } }, { "buttons": [ { "textButton": { "text": "Share", }, "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "textButton": { "text": "Edit", }, "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ], "loadIndicator": "LoadIndicator.SPINNER" } } } ] } ], "collapsible": true, "uncollapsibleWidgetsCount": 3 } ], "cardActions": [ { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ], "name": "contact-card-K3wB6arF2H9L" } ``` # Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's generated toolbar menu. For example, the following JSON constructs a card action menu with Settings and Send Feedback options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. @@ -1485,17 +1484,17 @@Method Details
}, }, }, - "type": "A String", # The type of bot response. + "type": "A String", # The type of Chat app 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. + "bot": { # A user in Google Chat. # The Chat app whose command was invoked. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, @@ -1511,14 +1510,14 @@Method Details
"user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, }, }, ], - "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out. + "argumentText": "A String", # Plain-text body of the message with all Chat app mentions stripped out. "attachment": [ # User uploaded attachment. { # An attachment in Google 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. @@ -1526,13 +1525,13 @@Method Details
}, "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. + "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps 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. + "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps 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. @@ -1542,7 +1541,7 @@Method Details
"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. + "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 Chat app 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. @@ -1576,7 +1575,7 @@Method Details
"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. + "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 Chat app 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. @@ -1592,7 +1591,7 @@Method Details
"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. + "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 Chat app 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. @@ -1613,7 +1612,7 @@Method Details
"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. + "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 Chat app 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. @@ -1635,7 +1634,7 @@Method Details
"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. + "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 Chat app 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. @@ -1651,7 +1650,7 @@Method Details
"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. + "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 Chat app 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. @@ -1672,7 +1671,7 @@Method Details
"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. + "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 Chat app 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. @@ -1698,29 +1697,28 @@Method Details
"createTime": "A String", # Output only. The time at which the message was created in Google 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). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. - "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "matchedUrl": { # A matched url in a Chat message. Chat apps can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). "url": "A String", # The url that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` - "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", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, "slashCommand": { # A [slash command](https://developers.google.com/chat/how-tos/slash-commands) in Google Chat. # Slash command information, if applicable. "commandId": "A String", # The id of the slash command invoked. }, - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. # The space the message belongs to. + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The space the message belongs to. "displayName": "A String", # The space's display name. For direct messages between humans, this field might be empty. "name": "A String", # Optional. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA - "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a bot and a single human. + "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a Chat app and a single human. "threaded": True or False, # Output only. Whether the messages are threaded in this space. "type": "A String", # Deprecated. Use `single_user_bot_dm` instead. Output only. The type of a space. }, - "text": "A String", # Plain-text body of the message. + "text": "A String", # Plain-text body of the message. The first link to an image, video, web page, or other preview-able item generates a preview chip. "thread": { # A thread in Google Chat. # The thread the message belongs to. "name": "A String", # Resource name, in the form "spaces/*/threads/*". Example: spaces/AAAAAAAAAAA/threads/TTTTTTTTTTT }, diff --git a/docs/dyn/chat_v1.spaces.members.html b/docs/dyn/chat_v1.spaces.members.html index 3f9aa26d493..29fc08bb230 100644 --- a/docs/dyn/chat_v1.spaces.members.html +++ b/docs/dyn/chat_v1.spaces.members.html @@ -79,10 +79,10 @@Instance Methods
Close httplib2 connections.
-Returns a membership.
+Returns a membership. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists human memberships in a space.
+Lists human memberships in a space. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
list_next(previous_request, previous_response)Retrieves the next page of results.
@@ -94,7 +94,7 @@Method Details
@@ -655,7 +655,7 @@get(name, x__xgafv=None)-Returns a membership. +Returns a membership. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Args: name: string, Required. Resource name of the membership to be retrieved, in the form "spaces/*/members/*". Example: spaces/AAAAAAAAAAAA/members/111111111111111111111 (required) @@ -111,7 +111,7 @@Method Details
"member": { # A user in Google Chat. # A user in Google Chat. Represents a [person](https://developers.google.com/people/api/rest/v1/people) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Format: `users/{user}` "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, @@ -122,7 +122,7 @@Method Details
@@ -629,7 +629,7 @@list(parent, pageSize=None, pageToken=None, x__xgafv=None)-Lists human memberships in a space. +Lists human memberships in a space. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Args: parent: string, Required. The resource name of the space for which membership list is to be fetched, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA (required) @@ -143,7 +143,7 @@Method Details
"member": { # A user in Google Chat. # A user in Google Chat. Represents a [person](https://developers.google.com/people/api/rest/v1/people) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Format: `users/{user}` "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, diff --git a/docs/dyn/chat_v1.spaces.messages.attachments.html b/docs/dyn/chat_v1.spaces.messages.attachments.html index 2d783622baa..85ba2bff3a5 100644 --- a/docs/dyn/chat_v1.spaces.messages.attachments.html +++ b/docs/dyn/chat_v1.spaces.messages.attachments.html @@ -79,7 +79,7 @@Instance Methods
Close httplib2 connections.
-Gets the metadata of a message attachment. The attachment data is fetched using the media API.
+Gets the metadata of a message attachment. The attachment data is fetched using the media API. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
Method Details
diff --git a/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html b/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html index ed88a9c6dec..6e67e249235 100644 --- a/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html +++ b/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html @@ -603,7 +603,7 @@close()@@ -88,7 +88,7 @@Method Details
diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 1debd5ba74a..ed42ce4b532 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -84,16 +84,16 @@get(name, x__xgafv=None)-Gets the metadata of a message attachment. The attachment data is fetched using the media API. +Gets the metadata of a message attachment. The attachment data is fetched using the media API. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Args: name: string, Required. Resource name of the attachment, in the form "spaces/*/messages/*/attachments/*". (required) @@ -106,13 +106,13 @@Method Details
}, "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. + "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps 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. + "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps should not use this URL to download attachment content. }Instance Methods
Close httplib2 connections.
-
create(parent, body=None, requestId=None, threadKey=None, x__xgafv=None)Creates a message.
+Creates a message. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
-Deletes a message.
+Deletes a message. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
-Returns a message.
+Returns a message. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
-
update(name, body=None, updateMask=None, x__xgafv=None)Updates a message.
+Updates a message. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts).
Method Details
diff --git a/docs/dyn/classroom_v1.courses.courseWork.html b/docs/dyn/classroom_v1.courses.courseWork.html index 30858cc545e..b593a14af4c 100644 --- a/docs/dyn/classroom_v1.courses.courseWork.html +++ b/docs/dyn/classroom_v1.courses.courseWork.html @@ -308,7 +308,7 @@close()@@ -102,7 +102,7 @@Method Details
diff --git a/docs/dyn/classroom_v1.courses.announcements.html b/docs/dyn/classroom_v1.courses.announcements.html index 9f9955e9444..9ae9c46358e 100644 --- a/docs/dyn/classroom_v1.courses.announcements.html +++ b/docs/dyn/classroom_v1.courses.announcements.html @@ -233,7 +233,7 @@create(parent, body=None, requestId=None, threadKey=None, x__xgafv=None)-Creates a message. +Creates a message. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Args: parent: string, Required. Space resource name, in the form "spaces/*". Example: spaces/AAAAAAAAAAA (required) @@ -110,13 +110,13 @@Method Details
The object takes the form of: { # A message in Google 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. - "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Must be accompanied by `ResponseType.Dialog`. - "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. + "actionResponse": { # Parameters that a Chat app can use to configure how it's response is posted. # Input only. Parameters that a Chat app can use to configure how its response is posted. + "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/dialogs). Must be accompanied by `ResponseType.Dialog`. + "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. "statusCode": "A String", # The status code. "userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, - "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/bot-dialogs) for the request. + "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/dialogs) for the request. "body": { # A card is a UI element that can contain UI widgets such as text and images. For more information, see Cards . For example, the following JSON creates a card that has a header with the name, position, icons, and link for a contact, followed by a section with contact information like email and phone number. ``` { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageStyle": "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "imageAltText": "Avatar for Sasha" }, "sections" : [ { "header": "Contact Info", "widgets": [ { "decorated_text": { "icon": { "knownIcon": "EMAIL" }, "content": "sasha@example.com" } }, { "decoratedText": { "icon": { "knownIcon": "PERSON" }, "content": "Online" } }, { "decoratedText": { "icon": { "knownIcon": "PHONE" }, "content": "+1 (555) 555-1234" } }, { "buttons": [ { "textButton": { "text": "Share", }, "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "textButton": { "text": "Edit", }, "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ], "loadIndicator": "LoadIndicator.SPINNER" } } } ] } ], "collapsible": true, "uncollapsibleWidgetsCount": 3 } ], "cardActions": [ { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ], "name": "contact-card-K3wB6arF2H9L" } ``` # Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's generated toolbar menu. For example, the following JSON constructs a card action menu with Settings and Send Feedback options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. @@ -636,17 +636,17 @@Method Details
}, }, }, - "type": "A String", # The type of bot response. + "type": "A String", # The type of Chat app 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. + "bot": { # A user in Google Chat. # The Chat app whose command was invoked. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, @@ -662,14 +662,14 @@Method Details
"user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, }, }, ], - "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out. + "argumentText": "A String", # Plain-text body of the message with all Chat app mentions stripped out. "attachment": [ # User uploaded attachment. { # An attachment in Google 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. @@ -677,13 +677,13 @@Method Details
}, "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. + "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps 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. + "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps 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. @@ -693,7 +693,7 @@Method Details
"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. + "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 Chat app 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. @@ -727,7 +727,7 @@Method Details
"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. + "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 Chat app 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. @@ -743,7 +743,7 @@Method Details
"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. + "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 Chat app 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. @@ -764,7 +764,7 @@Method Details
"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. + "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 Chat app 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. @@ -786,7 +786,7 @@Method Details
"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. + "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 Chat app 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. @@ -802,7 +802,7 @@Method Details
"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. + "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 Chat app 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. @@ -823,7 +823,7 @@Method Details
"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. + "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 Chat app 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. @@ -849,36 +849,35 @@Method Details
"createTime": "A String", # Output only. The time at which the message was created in Google 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). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. - "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "matchedUrl": { # A matched url in a Chat message. Chat apps can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). "url": "A String", # The url that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` - "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", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, "slashCommand": { # A [slash command](https://developers.google.com/chat/how-tos/slash-commands) in Google Chat. # Slash command information, if applicable. "commandId": "A String", # The id of the slash command invoked. }, - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. # The space the message belongs to. + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The space the message belongs to. "displayName": "A String", # The space's display name. For direct messages between humans, this field might be empty. "name": "A String", # Optional. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA - "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a bot and a single human. + "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a Chat app and a single human. "threaded": True or False, # Output only. Whether the messages are threaded in this space. "type": "A String", # Deprecated. Use `single_user_bot_dm` instead. Output only. The type of a space. }, - "text": "A String", # Plain-text body of the message. + "text": "A String", # Plain-text body of the message. The first link to an image, video, web page, or other preview-able item generates a preview chip. "thread": { # A thread in Google Chat. # The thread the message belongs to. "name": "A String", # Resource name, in the form "spaces/*/threads/*". Example: spaces/AAAAAAAAAAA/threads/TTTTTTTTTTT }, } requestId: string, Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message. - threadKey: string, Optional. 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 Google 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. + threadKey: string, Optional. 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 Chat apps and webhooks from having to store the Google 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 @@ -888,13 +887,13 @@Method Details
An object of the form: { # A message in Google 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. - "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Must be accompanied by `ResponseType.Dialog`. - "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. + "actionResponse": { # Parameters that a Chat app can use to configure how it's response is posted. # Input only. Parameters that a Chat app can use to configure how its response is posted. + "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/dialogs). Must be accompanied by `ResponseType.Dialog`. + "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. "statusCode": "A String", # The status code. "userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, - "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/bot-dialogs) for the request. + "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/dialogs) for the request. "body": { # A card is a UI element that can contain UI widgets such as text and images. For more information, see Cards . For example, the following JSON creates a card that has a header with the name, position, icons, and link for a contact, followed by a section with contact information like email and phone number. ``` { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageStyle": "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "imageAltText": "Avatar for Sasha" }, "sections" : [ { "header": "Contact Info", "widgets": [ { "decorated_text": { "icon": { "knownIcon": "EMAIL" }, "content": "sasha@example.com" } }, { "decoratedText": { "icon": { "knownIcon": "PERSON" }, "content": "Online" } }, { "decoratedText": { "icon": { "knownIcon": "PHONE" }, "content": "+1 (555) 555-1234" } }, { "buttons": [ { "textButton": { "text": "Share", }, "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "textButton": { "text": "Edit", }, "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ], "loadIndicator": "LoadIndicator.SPINNER" } } } ] } ], "collapsible": true, "uncollapsibleWidgetsCount": 3 } ], "cardActions": [ { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ], "name": "contact-card-K3wB6arF2H9L" } ``` # Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's generated toolbar menu. For example, the following JSON constructs a card action menu with Settings and Send Feedback options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. @@ -1414,17 +1413,17 @@Method Details
}, }, }, - "type": "A String", # The type of bot response. + "type": "A String", # The type of Chat app 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. + "bot": { # A user in Google Chat. # The Chat app whose command was invoked. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, @@ -1440,14 +1439,14 @@Method Details
"user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, }, }, ], - "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out. + "argumentText": "A String", # Plain-text body of the message with all Chat app mentions stripped out. "attachment": [ # User uploaded attachment. { # An attachment in Google 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. @@ -1455,13 +1454,13 @@Method Details
}, "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. + "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps 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. + "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps 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. @@ -1471,7 +1470,7 @@Method Details
"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. + "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 Chat app 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. @@ -1505,7 +1504,7 @@Method Details
"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. + "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 Chat app 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. @@ -1521,7 +1520,7 @@Method Details
"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. + "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 Chat app 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. @@ -1542,7 +1541,7 @@Method Details
"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. + "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 Chat app 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. @@ -1564,7 +1563,7 @@Method Details
"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. + "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 Chat app 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. @@ -1580,7 +1579,7 @@Method Details
"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. + "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 Chat app 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. @@ -1601,7 +1600,7 @@Method Details
"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. + "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 Chat app 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. @@ -1627,29 +1626,28 @@Method Details
"createTime": "A String", # Output only. The time at which the message was created in Google 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). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. - "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "matchedUrl": { # A matched url in a Chat message. Chat apps can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). "url": "A String", # The url that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` - "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", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, "slashCommand": { # A [slash command](https://developers.google.com/chat/how-tos/slash-commands) in Google Chat. # Slash command information, if applicable. "commandId": "A String", # The id of the slash command invoked. }, - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. # The space the message belongs to. + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The space the message belongs to. "displayName": "A String", # The space's display name. For direct messages between humans, this field might be empty. "name": "A String", # Optional. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA - "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a bot and a single human. + "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a Chat app and a single human. "threaded": True or False, # Output only. Whether the messages are threaded in this space. "type": "A String", # Deprecated. Use `single_user_bot_dm` instead. Output only. The type of a space. }, - "text": "A String", # Plain-text body of the message. + "text": "A String", # Plain-text body of the message. The first link to an image, video, web page, or other preview-able item generates a preview chip. "thread": { # A thread in Google Chat. # The thread the message belongs to. "name": "A String", # Resource name, in the form "spaces/*/threads/*". Example: spaces/AAAAAAAAAAA/threads/TTTTTTTTTTT }, @@ -1658,7 +1656,7 @@Method Details
delete(name, x__xgafv=None)-Deletes a message. +Deletes a message. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Args: name: string, Required. Resource name of the message to be deleted, in the form "spaces/*/messages/*" Example: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB (required) @@ -1670,13 +1668,13 @@Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }diff --git a/docs/dyn/chromepolicy_v1.customers.policySchemas.html b/docs/dyn/chromepolicy_v1.customers.policySchemas.html index 74d43450070..30bf848e03f 100644 --- a/docs/dyn/chromepolicy_v1.customers.policySchemas.html +++ b/docs/dyn/chromepolicy_v1.customers.policySchemas.html @@ -189,6 +189,16 @@get(name, x__xgafv=None)-Returns a message. +Returns a message. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Args: name: string, Required. Resource name of the message to be retrieved, in the form "spaces/*/messages/*". Example: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB (required) @@ -1689,13 +1687,13 @@Method Details
An object of the form: { # A message in Google 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. - "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Must be accompanied by `ResponseType.Dialog`. - "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. + "actionResponse": { # Parameters that a Chat app can use to configure how it's response is posted. # Input only. Parameters that a Chat app can use to configure how its response is posted. + "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/dialogs). Must be accompanied by `ResponseType.Dialog`. + "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. "statusCode": "A String", # The status code. "userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, - "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/bot-dialogs) for the request. + "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/dialogs) for the request. "body": { # A card is a UI element that can contain UI widgets such as text and images. For more information, see Cards . For example, the following JSON creates a card that has a header with the name, position, icons, and link for a contact, followed by a section with contact information like email and phone number. ``` { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageStyle": "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "imageAltText": "Avatar for Sasha" }, "sections" : [ { "header": "Contact Info", "widgets": [ { "decorated_text": { "icon": { "knownIcon": "EMAIL" }, "content": "sasha@example.com" } }, { "decoratedText": { "icon": { "knownIcon": "PERSON" }, "content": "Online" } }, { "decoratedText": { "icon": { "knownIcon": "PHONE" }, "content": "+1 (555) 555-1234" } }, { "buttons": [ { "textButton": { "text": "Share", }, "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "textButton": { "text": "Edit", }, "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ], "loadIndicator": "LoadIndicator.SPINNER" } } } ] } ], "collapsible": true, "uncollapsibleWidgetsCount": 3 } ], "cardActions": [ { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ], "name": "contact-card-K3wB6arF2H9L" } ``` # Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's generated toolbar menu. For example, the following JSON constructs a card action menu with Settings and Send Feedback options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. @@ -2215,17 +2213,17 @@Method Details
}, }, }, - "type": "A String", # The type of bot response. + "type": "A String", # The type of Chat app 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. + "bot": { # A user in Google Chat. # The Chat app whose command was invoked. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, @@ -2241,14 +2239,14 @@Method Details
"user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, }, }, ], - "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out. + "argumentText": "A String", # Plain-text body of the message with all Chat app mentions stripped out. "attachment": [ # User uploaded attachment. { # An attachment in Google 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. @@ -2256,13 +2254,13 @@Method Details
}, "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. + "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps 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. + "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps 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. @@ -2272,7 +2270,7 @@Method Details
"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. + "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 Chat app 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. @@ -2306,7 +2304,7 @@Method Details
"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. + "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 Chat app 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. @@ -2322,7 +2320,7 @@Method Details
"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. + "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 Chat app 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. @@ -2343,7 +2341,7 @@Method Details
"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. + "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 Chat app 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. @@ -2365,7 +2363,7 @@Method Details
"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. + "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 Chat app 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. @@ -2381,7 +2379,7 @@Method Details
"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. + "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 Chat app 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. @@ -2402,7 +2400,7 @@Method Details
"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. + "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 Chat app 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. @@ -2428,29 +2426,28 @@Method Details
"createTime": "A String", # Output only. The time at which the message was created in Google 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). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. - "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "matchedUrl": { # A matched url in a Chat message. Chat apps can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). "url": "A String", # The url that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` - "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", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, "slashCommand": { # A [slash command](https://developers.google.com/chat/how-tos/slash-commands) in Google Chat. # Slash command information, if applicable. "commandId": "A String", # The id of the slash command invoked. }, - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. # The space the message belongs to. + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The space the message belongs to. "displayName": "A String", # The space's display name. For direct messages between humans, this field might be empty. "name": "A String", # Optional. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA - "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a bot and a single human. + "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a Chat app and a single human. "threaded": True or False, # Output only. Whether the messages are threaded in this space. "type": "A String", # Deprecated. Use `single_user_bot_dm` instead. Output only. The type of a space. }, - "text": "A String", # Plain-text body of the message. + "text": "A String", # Plain-text body of the message. The first link to an image, video, web page, or other preview-able item generates a preview chip. "thread": { # A thread in Google Chat. # The thread the message belongs to. "name": "A String", # Resource name, in the form "spaces/*/threads/*". Example: spaces/AAAAAAAAAAA/threads/TTTTTTTTTTT }, @@ -2459,7 +2456,7 @@Method Details
@@ -156,7 +156,7 @@update(name, body=None, updateMask=None, x__xgafv=None)-Updates a message. +Updates a message. Requires [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Args: name: string, Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` (required) @@ -2467,13 +2464,13 @@Method Details
The object takes the form of: { # A message in Google 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. - "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Must be accompanied by `ResponseType.Dialog`. - "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. + "actionResponse": { # Parameters that a Chat app can use to configure how it's response is posted. # Input only. Parameters that a Chat app can use to configure how its response is posted. + "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/dialogs). Must be accompanied by `ResponseType.Dialog`. + "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. "statusCode": "A String", # The status code. "userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, - "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/bot-dialogs) for the request. + "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/dialogs) for the request. "body": { # A card is a UI element that can contain UI widgets such as text and images. For more information, see Cards . For example, the following JSON creates a card that has a header with the name, position, icons, and link for a contact, followed by a section with contact information like email and phone number. ``` { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageStyle": "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "imageAltText": "Avatar for Sasha" }, "sections" : [ { "header": "Contact Info", "widgets": [ { "decorated_text": { "icon": { "knownIcon": "EMAIL" }, "content": "sasha@example.com" } }, { "decoratedText": { "icon": { "knownIcon": "PERSON" }, "content": "Online" } }, { "decoratedText": { "icon": { "knownIcon": "PHONE" }, "content": "+1 (555) 555-1234" } }, { "buttons": [ { "textButton": { "text": "Share", }, "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "textButton": { "text": "Edit", }, "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ], "loadIndicator": "LoadIndicator.SPINNER" } } } ] } ], "collapsible": true, "uncollapsibleWidgetsCount": 3 } ], "cardActions": [ { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ], "name": "contact-card-K3wB6arF2H9L" } ``` # Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's generated toolbar menu. For example, the following JSON constructs a card action menu with Settings and Send Feedback options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. @@ -2993,17 +2990,17 @@Method Details
}, }, }, - "type": "A String", # The type of bot response. + "type": "A String", # The type of Chat app 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. + "bot": { # A user in Google Chat. # The Chat app whose command was invoked. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, @@ -3019,14 +3016,14 @@Method Details
"user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, }, }, ], - "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out. + "argumentText": "A String", # Plain-text body of the message with all Chat app mentions stripped out. "attachment": [ # User uploaded attachment. { # An attachment in Google 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. @@ -3034,13 +3031,13 @@Method Details
}, "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. + "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps 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. + "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps 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. @@ -3050,7 +3047,7 @@Method Details
"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. + "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 Chat app 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. @@ -3084,7 +3081,7 @@Method Details
"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. + "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 Chat app 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. @@ -3100,7 +3097,7 @@Method Details
"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. + "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 Chat app 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. @@ -3121,7 +3118,7 @@Method Details
"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. + "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 Chat app 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. @@ -3143,7 +3140,7 @@Method Details
"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. + "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 Chat app 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. @@ -3159,7 +3156,7 @@Method Details
"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. + "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 Chat app 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. @@ -3180,7 +3177,7 @@Method Details
"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. + "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 Chat app 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. @@ -3206,29 +3203,28 @@Method Details
"createTime": "A String", # Output only. The time at which the message was created in Google 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). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. - "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "matchedUrl": { # A matched url in a Chat message. Chat apps can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). "url": "A String", # The url that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` - "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", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, "slashCommand": { # A [slash command](https://developers.google.com/chat/how-tos/slash-commands) in Google Chat. # Slash command information, if applicable. "commandId": "A String", # The id of the slash command invoked. }, - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. # The space the message belongs to. + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The space the message belongs to. "displayName": "A String", # The space's display name. For direct messages between humans, this field might be empty. "name": "A String", # Optional. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA - "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a bot and a single human. + "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a Chat app and a single human. "threaded": True or False, # Output only. Whether the messages are threaded in this space. "type": "A String", # Deprecated. Use `single_user_bot_dm` instead. Output only. The type of a space. }, - "text": "A String", # Plain-text body of the message. + "text": "A String", # Plain-text body of the message. The first link to an image, video, web page, or other preview-able item generates a preview chip. "thread": { # A thread in Google Chat. # The thread the message belongs to. "name": "A String", # Resource name, in the form "spaces/*/threads/*". Example: spaces/AAAAAAAAAAA/threads/TTTTTTTTTTT }, @@ -3244,13 +3240,13 @@Method Details
An object of the form: { # A message in Google 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. - "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Must be accompanied by `ResponseType.Dialog`. - "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. + "actionResponse": { # Parameters that a Chat app can use to configure how it's response is posted. # Input only. Parameters that a Chat app can use to configure how its response is posted. + "dialogAction": { # Contains a [dialog](https://developers.google.com/chat/how-tos/dialogs) and request status code. # A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/dialogs). Must be accompanied by `ResponseType.Dialog`. + "actionStatus": { # Represents the status of a request. # Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success. "statusCode": "A String", # The status code. "userFacingMessage": "A String", # The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent. }, - "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/bot-dialogs) for the request. + "dialog": { # Wrapper around the card body of the dialog. # [Dialog](https://developers.google.com/chat/how-tos/dialogs) for the request. "body": { # A card is a UI element that can contain UI widgets such as text and images. For more information, see Cards . For example, the following JSON creates a card that has a header with the name, position, icons, and link for a contact, followed by a section with contact information like email and phone number. ``` { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageStyle": "ImageStyle.AVATAR", "imageUrl": "https://example.com/sasha.png", "imageAltText": "Avatar for Sasha" }, "sections" : [ { "header": "Contact Info", "widgets": [ { "decorated_text": { "icon": { "knownIcon": "EMAIL" }, "content": "sasha@example.com" } }, { "decoratedText": { "icon": { "knownIcon": "PERSON" }, "content": "Online" } }, { "decoratedText": { "icon": { "knownIcon": "PHONE" }, "content": "+1 (555) 555-1234" } }, { "buttons": [ { "textButton": { "text": "Share", }, "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "textButton": { "text": "Edit", }, "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ], "loadIndicator": "LoadIndicator.SPINNER" } } } ] } ], "collapsible": true, "uncollapsibleWidgetsCount": 3 } ], "cardActions": [ { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ], "name": "contact-card-K3wB6arF2H9L" } ``` # Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`. "cardActions": [ # The card's actions. Actions are added to the card's generated toolbar menu. For example, the following JSON constructs a card action menu with Settings and Send Feedback options: ``` "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": { "functionName": "goToView", "parameters": [ { "key": "viewType", "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { "url": "https://example.com/feedback" } } } ] ``` { # A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser. @@ -3770,17 +3766,17 @@Method Details
}, }, }, - "type": "A String", # The type of bot response. + "type": "A String", # The type of Chat app 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. + "bot": { # A user in Google Chat. # The Chat app whose command was invoked. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, @@ -3796,14 +3792,14 @@Method Details
"user": { # A user in Google Chat. # The user mentioned. "displayName": "A String", # The user's display name. "domainId": "A String", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, }, }, ], - "argumentText": "A String", # Plain-text body of the message with all bot mentions stripped out. + "argumentText": "A String", # Plain-text body of the message with all Chat app mentions stripped out. "attachment": [ # User uploaded attachment. { # An attachment in Google 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. @@ -3811,13 +3807,13 @@Method Details
}, "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. + "downloadUri": "A String", # Output only. The download URL which should be used to allow a human user to download the attachment. Chat apps 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. + "thumbnailUri": "A String", # Output only. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps 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. @@ -3827,7 +3823,7 @@Method Details
"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. + "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 Chat app 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. @@ -3861,7 +3857,7 @@Method Details
"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. + "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 Chat app 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. @@ -3877,7 +3873,7 @@Method Details
"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. + "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 Chat app 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. @@ -3898,7 +3894,7 @@Method Details
"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. + "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 Chat app 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. @@ -3920,7 +3916,7 @@Method Details
"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. + "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 Chat app 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. @@ -3936,7 +3932,7 @@Method Details
"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. + "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 Chat app 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. @@ -3957,7 +3953,7 @@Method Details
"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. + "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 Chat app 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. @@ -3983,29 +3979,28 @@Method Details
"createTime": "A String", # Output only. The time at which the message was created in Google 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). "lastUpdateTime": "A String", # Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. - "matchedUrl": { # A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). + "matchedUrl": { # A matched url in a Chat message. Chat apps can unfurl matched URLs. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). # A URL in `spaces.messages.text` that matches a link unfurling pattern. For more information, refer to [Unfurl links](/chat/how-tos/link-unfurling). "url": "A String", # The url that was matched. }, "name": "A String", # Resource name in the form `spaces/*/messages/*`. Example: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` - "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", # Unique identifier of the user's Google Workspace domain. - "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible. + "isAnonymous": True or False, # When `true`, the user is deleted or their profile is not visible. "name": "A String", # Resource name for a Google Chat user. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API or a [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Admin SDK Directory API. Formatted as: `users/{user}` "type": "A String", # User type. }, "slashCommand": { # A [slash command](https://developers.google.com/chat/how-tos/slash-commands) in Google Chat. # Slash command information, if applicable. "commandId": "A String", # The id of the slash command invoked. }, - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. # The space the message belongs to. + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The space the message belongs to. "displayName": "A String", # The space's display name. For direct messages between humans, this field might be empty. "name": "A String", # Optional. Resource name of the space, in the form "spaces/*". Example: spaces/AAAAAAAAAAAA - "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a bot and a single human. + "singleUserBotDm": True or False, # Output only. Whether the space is a DM between a Chat app and a single human. "threaded": True or False, # Output only. Whether the messages are threaded in this space. "type": "A String", # Deprecated. Use `single_user_bot_dm` instead. Output only. The type of a space. }, - "text": "A String", # Plain-text body of the message. + "text": "A String", # Plain-text body of the message. The first link to an image, video, web page, or other preview-able item generates a preview chip. "thread": { # A thread in Google Chat. # The thread the message belongs to. "name": "A String", # Resource name, in the form "spaces/*/threads/*". Example: spaces/AAAAAAAAAAA/threads/TTTTTTTTTTT }, diff --git a/docs/dyn/chromemanagement_v1.customers.apps.android.html b/docs/dyn/chromemanagement_v1.customers.apps.android.html index 5a591b90c58..388d76e3c89 100644 --- a/docs/dyn/chromemanagement_v1.customers.apps.android.html +++ b/docs/dyn/chromemanagement_v1.customers.apps.android.html @@ -112,7 +112,9 @@Method Details
"chromeAppInfo": { # Chrome Web Store app information. # Output only. Chrome Web Store app information. "googleOwned": True or False, # Output only. Whether the app or extension is built and maintained by Google. Version-specific field that will only be set when the requested app version is found. "isCwsHosted": True or False, # Output only. Whether the app or extension is in a published state in the Chrome Web Store. + "isKioskOnly": True or False, # Output only. Whether the app is only for Kiosk mode on Chrome OS devices "isTheme": True or False, # Output only. Whether the app or extension is a theme. + "kioskEnabled": True or False, # Output only. Whether this app is enabled for Kiosk mode on Chrome OS devices "minUserCount": 42, # Output only. The minimum number of users using this app. "permissions": [ # Output only. Every custom permission requested by the app. Version-specific field that will only be set when the requested app version is found. { # Permission requested by a Chrome app or extension. diff --git a/docs/dyn/chromemanagement_v1.customers.apps.chrome.html b/docs/dyn/chromemanagement_v1.customers.apps.chrome.html index acc42c502a8..337c3dc6e6a 100644 --- a/docs/dyn/chromemanagement_v1.customers.apps.chrome.html +++ b/docs/dyn/chromemanagement_v1.customers.apps.chrome.html @@ -112,7 +112,9 @@Method Details
"chromeAppInfo": { # Chrome Web Store app information. # Output only. Chrome Web Store app information. "googleOwned": True or False, # Output only. Whether the app or extension is built and maintained by Google. Version-specific field that will only be set when the requested app version is found. "isCwsHosted": True or False, # Output only. Whether the app or extension is in a published state in the Chrome Web Store. + "isKioskOnly": True or False, # Output only. Whether the app is only for Kiosk mode on Chrome OS devices "isTheme": True or False, # Output only. Whether the app or extension is a theme. + "kioskEnabled": True or False, # Output only. Whether this app is enabled for Kiosk mode on Chrome OS devices "minUserCount": 42, # Output only. The minimum number of users using this app. "permissions": [ # Output only. Every custom permission requested by the app. Version-specific field that will only be set when the requested app version is found. { # Permission requested by a Chrome app or extension. diff --git a/docs/dyn/chromemanagement_v1.customers.apps.web.html b/docs/dyn/chromemanagement_v1.customers.apps.web.html index adb6cd125cf..9a62ca7a878 100644 --- a/docs/dyn/chromemanagement_v1.customers.apps.web.html +++ b/docs/dyn/chromemanagement_v1.customers.apps.web.html @@ -112,7 +112,9 @@Method Details
"chromeAppInfo": { # Chrome Web Store app information. # Output only. Chrome Web Store app information. "googleOwned": True or False, # Output only. Whether the app or extension is built and maintained by Google. Version-specific field that will only be set when the requested app version is found. "isCwsHosted": True or False, # Output only. Whether the app or extension is in a published state in the Chrome Web Store. + "isKioskOnly": True or False, # Output only. Whether the app is only for Kiosk mode on Chrome OS devices "isTheme": True or False, # Output only. Whether the app or extension is a theme. + "kioskEnabled": True or False, # Output only. Whether this app is enabled for Kiosk mode on Chrome OS devices "minUserCount": 42, # Output only. The minimum number of users using this app. "permissions": [ # Output only. Every custom permission requested by the app. Version-specific field that will only be set when the requested app version is found. { # Permission requested by a Chrome app or extension. diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html b/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html index 4d615ecc6b8..6808d7f6a4a 100644 --- a/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html +++ b/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html @@ -95,7 +95,7 @@Method Details
Args: parent: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) - filter: string, Optional. Only include resources that match the filter. Supported filter fields: - org_unit_id - serial_number + filter: string, Optional. Only include resources that match the filter. Supported filter fields: - org_unit_id - serial_number - device_id pageSize: integer, Maximum number of results to return. Default value is 100. Maximum value is 200. pageToken: string, Token to specify next page in the list. readMask: string, Required. Read mask to specify which fields to return. @@ -110,6 +110,17 @@Method Details
{ "devices": [ # Telemetry devices returned in the response. { # Telemetry data collected from a managed device. + "audioStatusReport": [ # Output only. Audio reports collected periodically. + { # Audio report. + "inputDevice": "A String", # Output only. Active input device's name. + "inputGain": 42, # Output only. Active input device's gain in [0, 100]. + "inputMute": True or False, # Output only. Is active input device mute or not. + "outputDevice": "A String", # Output only. Active output device's name. + "outputMute": True or False, # Output only. Is active output device mute or not. + "outputVolume": 42, # Output only. Active output device's volume in [0, 100]. + "reportTime": "A String", # Output only. Timestamp of when the sample was collected on device. + }, + ], "batteryInfo": [ # Output only. Information on battery specs for the device. { # Battery info "designCapacity": "A String", # Output only. Design capacity (mAmpere-hours). diff --git a/docs/dyn/chromepolicy_v1.customers.policies.orgunits.html b/docs/dyn/chromepolicy_v1.customers.policies.orgunits.html index 17469c8643f..7423f965d62 100644 --- a/docs/dyn/chromepolicy_v1.customers.policies.orgunits.html +++ b/docs/dyn/chromepolicy_v1.customers.policies.orgunits.html @@ -115,7 +115,7 @@Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }Method Details
"nestedFieldDescriptions": [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields. # Object with schema name: GoogleChromePolicyV1PolicySchemaFieldDescription ], + "requiredItems": [ # Output only. Provides a list of fields that are required to be set if this field has a certain value. + { # The fields that will become required based on the value of this field. + "fieldConditions": [ # The value(s) of the field that provoke required field enforcement. An empty field_conditions implies that any value assigned to this field will provoke required field enforcement. + "A String", + ], + "requiredFields": [ # The fields that are required as a consequence of the field conditions. + "A String", + ], + }, + ], }, ], "name": "A String", # Format: name=customers/{customer}/policySchemas/{schema_namespace} @@ -321,6 +331,16 @@Method Details
"nestedFieldDescriptions": [ # Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields. # Object with schema name: GoogleChromePolicyV1PolicySchemaFieldDescription ], + "requiredItems": [ # Output only. Provides a list of fields that are required to be set if this field has a certain value. + { # The fields that will become required based on the value of this field. + "fieldConditions": [ # The value(s) of the field that provoke required field enforcement. An empty field_conditions implies that any value assigned to this field will provoke required field enforcement. + "A String", + ], + "requiredFields": [ # The fields that are required as a consequence of the field conditions. + "A String", + ], + }, + ], }, ], "name": "A String", # Format: name=customers/{customer}/policySchemas/{schema_namespace} diff --git a/docs/dyn/chromeuxreport_v1.records.html b/docs/dyn/chromeuxreport_v1.records.html index 64ce37b536c..a59d0bb2b18 100644 --- a/docs/dyn/chromeuxreport_v1.records.html +++ b/docs/dyn/chromeuxreport_v1.records.html @@ -97,7 +97,7 @@Method Details
{ # Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience record. "effectiveConnectionType": "A String", # The effective connection type is a query dimension that specifies the effective network class that the record's data should belong to. This field uses the values ["offline", "slow-2G", "2G", "3G", "4G"] as specified in: https://wicg.github.io/netinfo/#effective-connection-types Note: If no effective connection type is specified, then a special record with aggregated data over all effective connection types will be returned. "formFactor": "A String", # The form factor is a query dimension that specifies the device class that the record's data should belong to. Note: If no form factor is specified, then a special record with aggregated data over all form factors will be returned. - "metrics": [ # The metrics that should be included in the response. If none are specified then any metrics found will be returned. Allowed values: ["first_contentful_paint", "first_input_delay", "largest_contentful_paint", "cumulative_layout_shift", "experimental_uncapped_cumulative_layout_shift"] + "metrics": [ # The metrics that should be included in the response. If none are specified then any metrics found will be returned. Allowed values: ["first_contentful_paint", "first_input_delay", "largest_contentful_paint", "cumulative_layout_shift"] "A String", ], "origin": "A String", # The url pattern "origin" refers to a url pattern that is the origin of a website. Examples: "https://example.com", "https://cloud.google.com" diff --git a/docs/dyn/classroom_v1.courses.aliases.html b/docs/dyn/classroom_v1.courses.aliases.html index 24e535b4075..a3fd8abefd6 100644 --- a/docs/dyn/classroom_v1.courses.aliases.html +++ b/docs/dyn/classroom_v1.courses.aliases.html @@ -136,7 +136,7 @@Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }
Retrieves the next page of results.
patch(id, body=None, updateMask=None, x__xgafv=None)
Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
+Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * InactiveCourseOwner
update(id, body=None, x__xgafv=None)
Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
@@ -306,7 +306,7 @@patch(id, body=None, updateMask=None, x__xgafv=None)
- Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable +Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable * InactiveCourseOwner Args: id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required) diff --git a/docs/dyn/classroom_v1.courses.students.html b/docs/dyn/classroom_v1.courses.students.html index 1957aa24485..abad1ff01e5 100644 --- a/docs/dyn/classroom_v1.courses.students.html +++ b/docs/dyn/classroom_v1.courses.students.html @@ -79,7 +79,7 @@Instance Methods
Close httplib2 connections.
-
create(courseId, body=None, enrollmentCode=None, x__xgafv=None)Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.
+Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course.
delete(courseId, userId, x__xgafv=None)Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
@@ -100,7 +100,7 @@Method Details
diff --git a/docs/dyn/classroom_v1.courses.teachers.html b/docs/dyn/classroom_v1.courses.teachers.html index e91858ee65c..97999770e30 100644 --- a/docs/dyn/classroom_v1.courses.teachers.html +++ b/docs/dyn/classroom_v1.courses.teachers.html @@ -79,7 +79,7 @@create(courseId, body=None, enrollmentCode=None, x__xgafv=None)-Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course. +Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course. Args: courseId: string, Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. (required) @@ -184,7 +184,7 @@Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }Instance Methods
Close httplib2 connections.
-
create(courseId, body=None, x__xgafv=None)Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.
+Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a teacher or student in the course.
delete(courseId, userId, x__xgafv=None)Removes the specified teacher from the specified course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner.
@@ -100,7 +100,7 @@Method Details
diff --git a/docs/dyn/classroom_v1.courses.topics.html b/docs/dyn/classroom_v1.courses.topics.html index a46f8c85f18..04b6aef33fe 100644 --- a/docs/dyn/classroom_v1.courses.topics.html +++ b/docs/dyn/classroom_v1.courses.topics.html @@ -148,7 +148,7 @@create(courseId, body=None, x__xgafv=None)-Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course. +Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a teacher or student in the course. Args: courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) @@ -173,7 +173,7 @@Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }Method Details
Returns: An object of the form: - { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }
Returns the repos Resource.
-
- addBitbucketServerConnectedRepository(config, body=None, x__xgafv=None)
Add a Bitbucket Server repository to a given BitbucketServerConfig's connected repositories. This API is experimental.
Close httplib2 connections.
@@ -112,41 +109,6 @@removeBitbucketServerConnectedRepository(config, body=None, x__xgafv=None)
Remove a Bitbucket Server repository from an given BitbucketServerConfig’s connected repositories. This API is experimental.
addBitbucketServerConnectedRepository(config, body=None, x__xgafv=None)
- Add a Bitbucket Server repository to a given BitbucketServerConfig's connected repositories. This API is experimental.
-
-Args:
- config: string, Required. The name of the `BitbucketServerConfig` to add a connected repository. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}` (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # RPC request object accepted by the AddBitbucketServerConnectedRepository RPC method.
- "connectedRepository": { # BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server. # The connected repository to add.
- "projectKey": "A String", # Required. Identifier for the project storing the repository.
- "repoSlug": "A String", # Required. Identifier for the repository.
- "webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # RPC request object returned by the AddBitbucketServerConnectedRepository RPC method.
- "config": "A String", # The name of the `BitbucketServerConfig` that added connected repository. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`
- "connectedRepository": { # BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server. # The connected repository.
- "projectKey": "A String", # Required. Identifier for the project storing the repository.
- "repoSlug": "A String", # Required. Identifier for the repository.
- "webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
- },
-}
-close()
Close httplib2 connections.@@ -433,7 +395,7 @@
list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ loadSnapshot(environment, body=None, x__xgafv=None)
Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment.
patch(name, body=None, updateMask=None, x__xgafv=None)
Update an environment.
restartWebServer(name, body=None, x__xgafv=None)
Restart Airflow web server.
+
+ saveSnapshot(environment, body=None, x__xgafv=None)
Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.
checkUpgrade(environment, body=None, x__xgafv=None)
@@ -112,7 +118,7 @@ loadSnapshot(environment, body=None, x__xgafv=None)
+ Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment.
+
+Args:
+ environment: string, The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to load a snapshot into a Cloud Composer environment.
+ "skipPypiPackagesInstallation": True or False, # Whether or not to skip installing Pypi packages when loading the environment's state.
+ "snapshotPath": "A String", # A Cloud Storage path to a snapshot to load, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp".
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+patch(name, body=None, updateMask=None, x__xgafv=None)
Update an environment. @@ -672,7 +721,7 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "nodeConfig": { # The configuration information for the Kubernetes Engine nodes running the Apache Airflow software. # The configuration used for the Kubernetes Engine cluster. - "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. + "diskSizeGb": 42, # Optional. The disk size in GB used for node VMs. Minimum size is 30GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. "enableIpMasqAgent": True or False, # Optional. Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the GKE cluster. # Optional. The IPAllocationPolicy fields for the GKE cluster. "clusterIpv4CidrBlock": "A String", # Optional. The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*, this field is applicable only when `use_ip_aliases` is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. Specify `cluster_secondary_range_name` or `cluster_ipv4_cidr_block` but not both. @@ -717,7 +766,7 @@Method Details
"envVariables": { # Optional. Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression `a-zA-Z_*`. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression `AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+`), and they cannot match any of the following reserved names: * `AIRFLOW_HOME` * `C_FORCE_ROOT` * `CONTAINER_NAME` * `DAGS_FOLDER` * `GCP_PROJECT` * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER` "a_key": "A String", }, - "imageVersion": "A String", # The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+\.[0-9]+(\.[0-9]+)?)`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full [semantic version](https://semver.org), or an alias in the form of major version number or `latest`. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major and minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and [versioning overview](/composer/docs/concepts/versioning/composer-versioning-overview). + "imageVersion": "A String", # The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full [semantic version](https://semver.org), or an alias in the form of major version number or `latest`. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and [versioning overview](/composer/docs/concepts/versioning/composer-versioning-overview). "pypiPackages": { # Optional. Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name such as "numpy" and values are the lowercase extras and version specifier such as "==1.12.0", "[devel,gcp_api]", or "[devel]>=1.8.2, <1.9.2". To specify a package without pinning it to a version specifier, use the empty string as the value. "a_key": "A String", }, @@ -837,4 +886,46 @@Method Details
}
saveSnapshot(environment, body=None, x__xgafv=None)
+ Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.
+
+Args:
+ environment: string, The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to create a snapshot of a Cloud Composer environment.
+ "snapshotLocation": "A String", # Location in a Cloud Storage where the snapshot is going to be stored, e.g.: "gs://my-bucket/snapshots".
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+