Retrieves a data transfer request by its resource ID.
insert(body=None, x__xgafv=None)
Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.
+Inserts a data transfer request. See the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference for specific application requirements.
Lists the transfers for a customer by source user, destination user, or status.
@@ -113,7 +113,7 @@insert(body=None, x__xgafv=None)
- Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements. +Inserts a data transfer request. See the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference for specific application requirements. Args: body: object, The request body. @@ -146,7 +146,7 @@Method Details
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation. { # Template to map fields of ApplicationDataTransfer resource. "applicationId": "A String", # The application's ID. - "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference. + "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference. { # Template for application transfer parameters. "key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`. "value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`. @@ -178,7 +178,7 @@Method Details
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation. { # Template to map fields of ApplicationDataTransfer resource. "applicationId": "A String", # The application's ID. - "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference. + "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference. { # Template for application transfer parameters. "key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`. "value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`. @@ -224,7 +224,7 @@Method Details
"applicationDataTransfers": [ # The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation. { # Template to map fields of ApplicationDataTransfer resource. "applicationId": "A String", # The application's ID. - "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference. + "applicationTransferParams": [ # The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters) reference. { # Template for application transfer parameters. "key": "A String", # The type of the transfer parameter, such as `PRIVACY_LEVEL`. "value": [ # The value of the transfer parameter, such as `PRIVATE` or `SHARED`. diff --git a/docs/dyn/admin_directory_v1.chromeosdevices.html b/docs/dyn/admin_directory_v1.chromeosdevices.html index b9096291e09..ec15a294b6f 100644 --- a/docs/dyn/admin_directory_v1.chromeosdevices.html +++ b/docs/dyn/admin_directory_v1.chromeosdevices.html @@ -76,7 +76,7 @@Admin SDK API .
action(customerId, resourceId, body=None, x__xgafv=None)-Use [BatchChangeChromeOsDeviceStatus](/admin-sdk/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus) instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).
+Use [BatchChangeChromeOsDeviceStatus](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus) instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).
Close httplib2 connections.
@@ -94,18 +94,18 @@Instance Methods
Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.
-
patch(customerId, deviceId, body=None, projection=None, x__xgafv=None)Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
+Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
update(customerId, deviceId, body=None, projection=None, x__xgafv=None)Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.
Method Details
@@ -304,7 +304,7 @@action(customerId, resourceId, body=None, x__xgafv=None)-Use [BatchChangeChromeOsDeviceStatus](/admin-sdk/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus) instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633). +Use [BatchChangeChromeOsDeviceStatus](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus) instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633). Args: - customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required) - resourceId: string, The unique ID of the device. The `resourceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method. (required) + customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required) + resourceId: string, The unique ID of the device. The `resourceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method. (required) body: object, The request body. The object takes the form of: @@ -131,8 +131,8 @@Method Details
Retrieves a Chrome OS device's properties. Args: - customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required) - deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method. (required) + customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required) + deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method. (required) projection: string, Determines whether the response contains the full list of properties or only a subset. Allowed values BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user) @@ -145,7 +145,7 @@Method Details
Returns: An object of the form: - { # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices). + { # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices). "activeTimeRanges": [ # A list of active time ranges (Read-only). { "activeTime": 42, # Duration of usage in milliseconds. @@ -252,12 +252,12 @@Method Details
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) "macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response. "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. - "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid). + "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid). "model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. - "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. + "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. - "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). - "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device. "rebootTime": "A String", # Date and time of the last reboot. "state": "A String", # The update state of an OS update. @@ -311,7 +311,7 @@Method Details
Retrieves a paginated list of Chrome OS devices within an account. Args: - customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required) + customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required) includeChildOrgunits: boolean, Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided. maxResults: integer, Maximum number of results to return. Value should not exceed 300. orderBy: string, Device property to use for sorting results. @@ -321,14 +321,14 @@Method Details
lastSync - The date and time the Chrome device was last synchronized with the policy settings in the Admin console. notes - Chrome device notes as annotated by the administrator. serialNumber - The Chrome device serial number entered when the device was enabled. - status - Chrome device status. For more information, see the <a [chromeosdevices](/admin-sdk/directory/v1/reference/chromeosdevices.html). + status - Chrome device status. For more information, see the <a [chromeosdevices](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices.html). orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. pageToken: string, The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response. projection: string, Determines whether the response contains the full list of properties or only a subset. Allowed values BASIC - Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user) FULL - Includes all metadata fields - query: string, Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/list-query-operators + query: string, Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/list-query-operators sortOrder: string, Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter. Allowed values ASCENDING - Ascending order. @@ -343,7 +343,7 @@Method Details
{ "chromeosdevices": [ # A list of Chrome OS Device objects. - { # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices). + { # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices). "activeTimeRanges": [ # A list of active time ranges (Read-only). { "activeTime": 42, # Duration of usage in milliseconds. @@ -450,12 +450,12 @@Method Details
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) "macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response. "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. - "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid). + "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid). "model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. - "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. + "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. - "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). - "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device. "rebootTime": "A String", # Date and time of the last reboot. "state": "A String", # The update state of an OS update. @@ -548,15 +548,15 @@Method Details
@@ -279,7 +279,7 @@patch(customerId, deviceId, body=None, projection=None, x__xgafv=None)-Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch). +Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch). Args: - customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required) - deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method. (required) + customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required) + deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method. (required) body: object, The request body. The object takes the form of: -{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices). +{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices). "activeTimeRanges": [ # A list of active time ranges (Read-only). { "activeTime": 42, # Duration of usage in milliseconds. @@ -663,12 +663,12 @@Method Details
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) "macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response. "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. - "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid). + "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid). "model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. - "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. + "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. - "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). - "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device. "rebootTime": "A String", # Date and time of the last reboot. "state": "A String", # The update state of an OS update. @@ -728,7 +728,7 @@Method Details
Returns: An object of the form: - { # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices). + { # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices). "activeTimeRanges": [ # A list of active time ranges (Read-only). { "activeTime": 42, # Duration of usage in milliseconds. @@ -835,12 +835,12 @@Method Details
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) "macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response. "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. - "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid). + "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid). "model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. - "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. + "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. - "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). - "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device. "rebootTime": "A String", # Date and time of the last reboot. "state": "A String", # The update state of an OS update. @@ -894,12 +894,12 @@Method Details
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. Args: - customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required) - deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method. (required) + customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required) + deviceId: string, The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method. (required) body: object, The request body. The object takes the form of: -{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices). +{ # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices). "activeTimeRanges": [ # A list of active time ranges (Read-only). { "activeTime": 42, # Duration of usage in milliseconds. @@ -1006,12 +1006,12 @@Method Details
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) "macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response. "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. - "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid). + "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid). "model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. - "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. + "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. - "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). - "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device. "rebootTime": "A String", # Date and time of the last reboot. "state": "A String", # The update state of an OS update. @@ -1071,7 +1071,7 @@Method Details
Returns: An object of the form: - { # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices). + { # Google Chrome devices run on the [Chrome OS](https://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices). "activeTimeRanges": [ # A list of active time ranges (Read-only). { "activeTime": 42, # Duration of usage in milliseconds. @@ -1178,12 +1178,12 @@Method Details
"lastSync": "A String", # Date and time the device was last synchronized with the policy settings in the G Suite administrator control panel (Read-only) "macAddress": "A String", # The device's wireless MAC address. If the device does not have this information, it is not included in the response. "manufactureDate": "A String", # (Read-only) The date the device was manufactured in yyyy-mm-dd format. - "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid). + "meid": "A String", # The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid). "model": "A String", # The device's model information. If the device does not have this information, this property is not included in the response. - "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. + "notes": "A String", # Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. "orderNumber": "A String", # The device's order number. Only devices directly purchased from Google have an order number. - "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). - "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitId": "A String", # The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). + "orgUnitPath": "A String", # The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). "osUpdateStatus": { # Contains information regarding the current OS update status. # The status of the OS updates for the device. "rebootTime": "A String", # Date and time of the last reboot. "state": "A String", # The update state of an OS update. diff --git a/docs/dyn/admin_directory_v1.customers.chrome.printServers.html b/docs/dyn/admin_directory_v1.customers.chrome.printServers.html index b7e914ee908..7eba3bcd0b9 100644 --- a/docs/dyn/admin_directory_v1.customers.chrome.printServers.html +++ b/docs/dyn/admin_directory_v1.customers.chrome.printServers.html @@ -107,21 +107,21 @@Method Details
Creates multiple print servers. Args: - parent: string, Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required) + parent: string, Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required) body: object, The request body. The object takes the form of: { # Request to add multiple new print servers in a batch. "requests": [ # Required. A list of `PrintServer` resources to be created (max `50` per batch). { # Request for adding a new print server. - "parent": "A String", # Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` - "printServer": { # Configuration for a print server. # Required. A print server to create. If you want to place the print server under a specific organizational unit (OU), then populate the `org_unit_id`. Otherwise the print server is created under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/admin-sdk/directory/v1/guides/manage-org-units). + "parent": "A String", # Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` + "printServer": { # Configuration for a print server. # Required. A print server to create. If you want to place the print server under a specific organizational unit (OU), then populate the `org_unit_id`. Otherwise the print server is created under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units). "createTime": "A String", # Output only. Time when the print server was created. "description": "A String", # Editable. Description of the print server (as shown in the Admin console). "displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console). "id": "A String", # Immutable. ID of the print server. Leave empty when creating. "name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` - "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits). + "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). "uri": "A String", # Editable. Print server URI. }, }, @@ -147,7 +147,7 @@Method Details
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console). "id": "A String", # Immutable. ID of the print server. Leave empty when creating. "name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` - "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits). + "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). "uri": "A String", # Editable. Print server URI. }, "printServerId": "A String", # ID of a failed print server. @@ -160,7 +160,7 @@Method Details
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console). "id": "A String", # Immutable. ID of the print server. Leave empty when creating. "name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` - "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits). + "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). "uri": "A String", # Editable. Print server URI. }, ], @@ -172,7 +172,7 @@Method Details
Deletes multiple print servers. Args: - parent: string, Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{customer.id}` (required) + parent: string, Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{customer.id}` (required) body: object, The request body. The object takes the form of: @@ -201,7 +201,7 @@Method Details
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console). "id": "A String", # Immutable. ID of the print server. Leave empty when creating. "name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` - "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits). + "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). "uri": "A String", # Editable. Print server URI. }, "printServerId": "A String", # ID of a failed print server. @@ -223,7 +223,7 @@Method Details
Creates a print server. Args: - parent: string, Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required) + parent: string, Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required) body: object, The request body. The object takes the form of: @@ -233,7 +233,7 @@Method Details
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console). "id": "A String", # Immutable. ID of the print server. Leave empty when creating. "name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` - "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits). + "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). "uri": "A String", # Editable. Print server URI. } @@ -251,7 +251,7 @@Method Details
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console). "id": "A String", # Immutable. ID of the print server. Leave empty when creating. "name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` - "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits). + "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). "uri": "A String", # Editable. Print server URI. }Method Details
Returns a print server's configuration. Args: - name: string, Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required) + name: string, Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -294,7 +294,7 @@Method Details
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console). "id": "A String", # Immutable. ID of the print server. Leave empty when creating. "name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` - "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits). + "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). "uri": "A String", # Editable. Print server URI. }Method Details
Lists print server configurations. Args: - parent: string, Required. The [unique ID](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required) + parent: string, Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` (required) filter: string, Search query in [Common Expression Language syntax](https://github.com/google/cel-spec). Supported filters are `display_name`, `description`, and `uri`. Example: `printServer.displayName=='marketing-queue'`. orderBy: string, Sort order for results. Supported values are `display_name`, `description`, or `create_time`. Default order is ascending, but descending order can be returned by appending "desc" to the `order_by` field. For instance, `orderBy=='description desc'` returns the print servers sorted by description in descending order. orgUnitId: string, If `org_unit_id` is present in the request, only print servers owned or inherited by the organizational unit (OU) are returned. If the `PrintServer` resource's `org_unit_id` matches the one in the request, the OU owns the server. If `org_unit_id` is not specified in the request, all print servers are returned or filtered against. @@ -327,7 +327,7 @@Method Details
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console). "id": "A String", # Immutable. ID of the print server. Leave empty when creating. "name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` - "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits). + "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). "uri": "A String", # Editable. Print server URI. }, ], @@ -363,7 +363,7 @@Method Details
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console). "id": "A String", # Immutable. ID of the print server. Leave empty when creating. "name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` - "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits). + "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). "uri": "A String", # Editable. Print server URI. } @@ -382,7 +382,7 @@Method Details
"displayName": "A String", # Editable. Display name of the print server (as shown in the Admin console). "id": "A String", # Immutable. ID of the print server. Leave empty when creating. "name": "A String", # Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` - "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin-sdk/directory/reference/rest/v1/orgunits). + "orgUnitId": "A String", # ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). "uri": "A String", # Editable. Print server URI. }
Retrieves a domain alias of the customer.
Args:
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
domainAliasName: string, Name of domain alias to be retrieved. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -175,7 +175,7 @@ Method Details
Lists the domain aliases of the customer.
Args:
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
parentDomainName: string, Name of the parent domain for which domain aliases are to be fetched.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/admin_directory_v1.domains.html b/docs/dyn/admin_directory_v1.domains.html
index 259ef93fddb..1a653169218 100644
--- a/docs/dyn/admin_directory_v1.domains.html
+++ b/docs/dyn/admin_directory_v1.domains.html
@@ -114,7 +114,7 @@ Method Details
Retrieves a domain of the customer.
Args:
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
domainName: string, Name of domain to be retrieved (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -205,7 +205,7 @@ Method Details
Lists the domains of the customer.
Args:
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/admin_directory_v1.groups.html b/docs/dyn/admin_directory_v1.groups.html
index 5d8eb0a33c0..6bbba94b019 100644
--- a/docs/dyn/admin_directory_v1.groups.html
+++ b/docs/dyn/admin_directory_v1.groups.html
@@ -99,7 +99,7 @@ Instance Methods
Retrieves the next page of results.
patch(groupKey, body=None, x__xgafv=None)
-Updates a group's properties. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
+Updates a group's properties. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
update(groupKey, body=None, x__xgafv=None)
Updates a group's properties.
@@ -136,7 +136,7 @@ Method Details
Returns:
An object of the form:
- { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/admin-sdk/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
+ { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
"adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored.
"A String",
@@ -162,7 +162,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/admin-sdk/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
+{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
"adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored.
"A String",
@@ -187,7 +187,7 @@ Method Details
Returns:
An object of the form:
- { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/admin-sdk/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
+ { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
"adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored.
"A String",
@@ -210,7 +210,7 @@ Method Details
Retrieves all groups of a domain or of a user given a userKey (paginated).
Args:
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.
domain: string, The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.
maxResults: integer, Maximum number of results to return. Max allowed value is 200.
orderBy: string, Column to use for sorting results
@@ -234,7 +234,7 @@ Method Details
{
"etag": "A String", # ETag of the resource.
"groups": [ # A list of group objects.
- { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/admin-sdk/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
+ { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
"adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored.
"A String",
@@ -272,14 +272,14 @@ Method Details
patch(groupKey, body=None, x__xgafv=None)
- Updates a group's properties. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
+ Updates a group's properties. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
Args:
groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
body: object, The request body.
The object takes the form of:
-{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/admin-sdk/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
+{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
"adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored.
"A String",
@@ -304,7 +304,7 @@ Method Details
Returns:
An object of the form:
- { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/admin-sdk/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
+ { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
"adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored.
"A String",
@@ -331,7 +331,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/admin-sdk/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
+{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
"adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored.
"A String",
@@ -356,7 +356,7 @@ Method Details
Returns:
An object of the form:
- { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/admin-sdk/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
+ { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups). For information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups). Note: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.
"adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
"aliases": [ # Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored.
"A String",
diff --git a/docs/dyn/admin_directory_v1.members.html b/docs/dyn/admin_directory_v1.members.html
index 99539c15cbb..a443d09b2ac 100644
--- a/docs/dyn/admin_directory_v1.members.html
+++ b/docs/dyn/admin_directory_v1.members.html
@@ -91,13 +91,13 @@ Instance Methods
Adds a user to the specified group.
-Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/admin-sdk/directory/v1/guides/troubleshoot-error-codes).
+Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).
Retrieves the next page of results.
patch(groupKey, memberKey, body=None, x__xgafv=None)
-Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
+Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
update(groupKey, memberKey, body=None, x__xgafv=None)
Updates the membership of a user in the specified group.
@@ -136,7 +136,7 @@ Method Details
Returns:
An object of the form:
- { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
+ { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
"delivery_settings": "A String", # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
"email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
"etag": "A String", # ETag of the resource.
@@ -177,7 +177,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
+{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
"delivery_settings": "A String", # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
"email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
"etag": "A String", # ETag of the resource.
@@ -196,7 +196,7 @@ Method Details
Returns:
An object of the form:
- { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
+ { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
"delivery_settings": "A String", # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
"email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
"etag": "A String", # ETag of the resource.
@@ -210,7 +210,7 @@ Method Details
list(groupKey, includeDerivedMembership=None, maxResults=None, pageToken=None, roles=None, x__xgafv=None)
- Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/admin-sdk/directory/v1/guides/troubleshoot-error-codes).
+ Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).
Args:
groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
@@ -230,7 +230,7 @@ Method Details
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#members", # Kind of resource this is.
"members": [ # A list of member objects.
- { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
+ { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
"delivery_settings": "A String", # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
"email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
"etag": "A String", # ETag of the resource.
@@ -261,7 +261,7 @@ Method Details
patch(groupKey, memberKey, body=None, x__xgafv=None)
- Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
+ Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
Args:
groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
@@ -269,7 +269,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
+{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
"delivery_settings": "A String", # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
"email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
"etag": "A String", # ETag of the resource.
@@ -288,7 +288,7 @@ Method Details
Returns:
An object of the form:
- { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
+ { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
"delivery_settings": "A String", # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
"email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
"etag": "A String", # ETag of the resource.
@@ -310,7 +310,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
+{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
"delivery_settings": "A String", # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
"email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
"etag": "A String", # ETag of the resource.
@@ -329,7 +329,7 @@ Method Details
Returns:
An object of the form:
- { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
+ { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
"delivery_settings": "A String", # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
"email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
"etag": "A String", # ETag of the resource.
diff --git a/docs/dyn/admin_directory_v1.mobiledevices.html b/docs/dyn/admin_directory_v1.mobiledevices.html
index 2c557844eb9..2cf8451a18d 100644
--- a/docs/dyn/admin_directory_v1.mobiledevices.html
+++ b/docs/dyn/admin_directory_v1.mobiledevices.html
@@ -88,7 +88,7 @@ Instance Methods
Retrieves a mobile device's properties.
-Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/admin-sdk/directory/v1/guides/troubleshoot-error-codes).
+Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).
Retrieves the next page of results.
@@ -98,7 +98,7 @@ Method Details
Takes an action that affects a mobile device. For example, remotely wiping a device.
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
resourceId: string, The unique ID the API service uses to identify the mobile device. (required)
body: object, The request body.
The object takes the form of:
@@ -124,7 +124,7 @@ Method Details
Removes a mobile device.
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
resourceId: string, The unique ID the API service uses to identify the mobile device. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -138,7 +138,7 @@ Method Details
Retrieves a mobile device's properties.
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
resourceId: string, The unique ID the API service uses to identify the mobile device. (required)
projection: string, Restrict information returned to a set of selected fields.
Allowed values
@@ -152,7 +152,7 @@ Method Details
Returns:
An object of the form:
- { # Google Workspace Mobile Management includes Android, [Google Sync](https://support.google.com/a/answer/135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices.html).
+ { # Google Workspace Mobile Management includes Android, [Google Sync](https://support.google.com/a/answer/135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices.html).
"adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
"applications": [ # The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data. When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications.
{
@@ -174,7 +174,7 @@ Method Details
"deviceCompromisedStatus": "A String", # The compromised device status.
"deviceId": "A String", # The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.
"devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
- "email": [ # The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](/admin-sdk/directory/v1/guides/manage-users#get_user) method.
+ "email": [ # The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user) method.
"A String",
],
"encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
@@ -189,12 +189,12 @@ Method Details
"managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not.
"manufacturer": "A String", # Mobile Device manufacturer (Read-only)
"meid": "A String", # The device's MEID number.
- "model": "A String", # The mobile device's model name, for example Nexus S. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile=devices#update_mobile_device).
- "name": [ # The list of the owner's user names. If your application needs the current list of device owner names, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-users#get_user).
+ "model": "A String", # The mobile device's model name, for example Nexus S. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile=devices#update_mobile_device).
+ "name": [ # The list of the owner's user names. If your application needs the current list of device owner names, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user).
"A String",
],
"networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
- "os": "A String", # The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices#update_mobile_device).
+ "os": "A String", # The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).
"otherAccountsInfo": [ # The list of accounts added on device (Read-only)
"A String",
],
@@ -207,17 +207,17 @@ Method Details
"supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
"type": "A String", # The type of mobile device.
"unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
- "userAgent": "A String", # Gives information about the device such as `os` version. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices#update_mobile_device).
+ "userAgent": "A String", # Gives information about the device such as `os` version. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).
"wifiMacAddress": "A String", # The device's MAC address on Wi-Fi networks.
}
list(customerId, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, sortOrder=None, x__xgafv=None)
- Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/admin-sdk/directory/v1/guides/troubleshoot-error-codes).
+ Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
maxResults: integer, Maximum number of results to return. Max allowed value is 100.
orderBy: string, Device property to use for sorting results.
Allowed values
@@ -234,7 +234,7 @@ Method Details
Allowed values
BASIC - Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)
FULL - Includes all metadata fields
- query: string, Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/search-operators
+ query: string, Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/search-operators
sortOrder: string, Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.
Allowed values
ASCENDING - Ascending order.
@@ -251,7 +251,7 @@ Method Details
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#mobiledevices", # Kind of resource this is.
"mobiledevices": [ # A list of Mobile Device objects.
- { # Google Workspace Mobile Management includes Android, [Google Sync](https://support.google.com/a/answer/135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices.html).
+ { # Google Workspace Mobile Management includes Android, [Google Sync](https://support.google.com/a/answer/135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices.html).
"adbStatus": True or False, # Adb (USB debugging) enabled or disabled on device (Read-only)
"applications": [ # The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data. When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications.
{
@@ -273,7 +273,7 @@ Method Details
"deviceCompromisedStatus": "A String", # The compromised device status.
"deviceId": "A String", # The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.
"devicePasswordStatus": "A String", # DevicePasswordStatus (Read-only)
- "email": [ # The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](/admin-sdk/directory/v1/guides/manage-users#get_user) method.
+ "email": [ # The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user) method.
"A String",
],
"encryptionStatus": "A String", # Mobile Device Encryption Status (Read-only)
@@ -288,12 +288,12 @@ Method Details
"managedAccountIsOnOwnerProfile": True or False, # Boolean indicating if this account is on owner/primary profile or not.
"manufacturer": "A String", # Mobile Device manufacturer (Read-only)
"meid": "A String", # The device's MEID number.
- "model": "A String", # The mobile device's model name, for example Nexus S. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile=devices#update_mobile_device).
- "name": [ # The list of the owner's user names. If your application needs the current list of device owner names, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-users#get_user).
+ "model": "A String", # The mobile device's model name, for example Nexus S. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile=devices#update_mobile_device).
+ "name": [ # The list of the owner's user names. If your application needs the current list of device owner names, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user).
"A String",
],
"networkOperator": "A String", # Mobile Device mobile or network operator (if available) (Read-only)
- "os": "A String", # The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices#update_mobile_device).
+ "os": "A String", # The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).
"otherAccountsInfo": [ # The list of accounts added on device (Read-only)
"A String",
],
@@ -306,7 +306,7 @@ Method Details
"supportsWorkProfile": True or False, # Work profile supported on device (Read-only)
"type": "A String", # The type of mobile device.
"unknownSourcesStatus": True or False, # Unknown sources enabled or disabled on device (Read-only)
- "userAgent": "A String", # Gives information about the device such as `os` version. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices#update_mobile_device).
+ "userAgent": "A String", # Gives information about the device such as `os` version. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device).
"wifiMacAddress": "A String", # The device's MAC address on Wi-Fi networks.
},
],
diff --git a/docs/dyn/admin_directory_v1.orgunits.html b/docs/dyn/admin_directory_v1.orgunits.html
index 318c685619f..e20bea97bc4 100644
--- a/docs/dyn/admin_directory_v1.orgunits.html
+++ b/docs/dyn/admin_directory_v1.orgunits.html
@@ -91,7 +91,7 @@ Instance Methods
Retrieves a list of all organizational units for an account.
patch(customerId, orgUnitPath, body=None, x__xgafv=None)
-Updates an organizational unit. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch)
+Updates an organizational unit. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch)
update(customerId, orgUnitPath, body=None, x__xgafv=None)
Updates an organizational unit.
@@ -106,7 +106,7 @@ Method Details
Removes an organizational unit.
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -120,7 +120,7 @@ Method Details
Retrieves an organizational unit.
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -130,14 +130,14 @@ Method Details
Returns:
An object of the form:
- { # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
+ { # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
"blockInheritance": True or False, # This field is deprecated and setting its value has no effect.
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
- "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
+ "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}
@@ -148,18 +148,18 @@ Method Details
Adds an organizational unit.
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
body: object, The request body.
The object takes the form of:
-{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
+{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
"blockInheritance": True or False, # This field is deprecated and setting its value has no effect.
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
- "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
+ "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}
@@ -172,14 +172,14 @@ Method Details
Returns:
An object of the form:
- { # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
+ { # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
"blockInheritance": True or False, # This field is deprecated and setting its value has no effect.
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
- "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
+ "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}
@@ -190,7 +190,7 @@ Method Details
Retrieves a list of all organizational units for an account.
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
orgUnitPath: string, The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit.
type: string, Whether to return all sub-organizations or just immediate children.
Allowed values
@@ -209,14 +209,14 @@ Method Details
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnits", # The type of the API resource. For Org Unit resources, the type is `admin#directory#orgUnits`.
"organizationUnits": [ # A list of organizational unit objects.
- { # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
+ { # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
"blockInheritance": True or False, # This field is deprecated and setting its value has no effect.
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
- "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
+ "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
},
@@ -226,22 +226,22 @@ Method Details
patch(customerId, orgUnitPath, body=None, x__xgafv=None)
- Updates an organizational unit. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch)
+ Updates an organizational unit. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch)
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required)
body: object, The request body.
The object takes the form of:
-{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
+{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
"blockInheritance": True or False, # This field is deprecated and setting its value has no effect.
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
- "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
+ "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}
@@ -254,14 +254,14 @@ Method Details
Returns:
An object of the form:
- { # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
+ { # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
"blockInheritance": True or False, # This field is deprecated and setting its value has no effect.
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
- "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
+ "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}
@@ -272,19 +272,19 @@ Method Details
Updates an organizational unit.
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required)
body: object, The request body.
The object takes the form of:
-{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
+{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
"blockInheritance": True or False, # This field is deprecated and setting its value has no effect.
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
- "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
+ "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}
@@ -297,14 +297,14 @@ Method Details
Returns:
An object of the form:
- { # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
+ { # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.
"blockInheritance": True or False, # This field is deprecated and setting its value has no effect.
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
- "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
+ "orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}
diff --git a/docs/dyn/admin_directory_v1.privileges.html b/docs/dyn/admin_directory_v1.privileges.html
index 69c0e348381..4a8e016ea75 100644
--- a/docs/dyn/admin_directory_v1.privileges.html
+++ b/docs/dyn/admin_directory_v1.privileges.html
@@ -91,7 +91,7 @@ Method Details
Retrieves a paginated list of all privileges for a customer.
Args:
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -111,7 +111,7 @@ Method Details
"isOuScopable": True or False, # If the privilege can be restricted to an organization unit.
"kind": "admin#directory#privilege", # The type of the API resource. This is always `admin#directory#privilege`.
"privilegeName": "A String", # The name of the privilege.
- "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).
"serviceName": "A String", # The name of the service this privilege is for.
},
],
diff --git a/docs/dyn/admin_directory_v1.roleAssignments.html b/docs/dyn/admin_directory_v1.roleAssignments.html
index 586b26ce857..c5ee3cbe4f6 100644
--- a/docs/dyn/admin_directory_v1.roleAssignments.html
+++ b/docs/dyn/admin_directory_v1.roleAssignments.html
@@ -117,7 +117,7 @@ Method Details
Retrieves a role assignment.
Args:
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
roleAssignmentId: string, Immutable ID of the role assignment. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -130,7 +130,7 @@ Method Details
{ # Defines an assignment of a role.
"assignedTo": "A String", # The unique ID of the entity this role is assigned to—either the `user_id` of a user, the `group_id` of a group, or the `uniqueId` of a service account as defined in [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts).
"assigneeType": "A String", # Output only. The type of the assignee (`USER` or `GROUP`).
- "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). Additional conditions related to Locked Groups are available under Open Beta. - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition.
+ "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`.
"orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
@@ -152,7 +152,7 @@ Method Details
{ # Defines an assignment of a role.
"assignedTo": "A String", # The unique ID of the entity this role is assigned to—either the `user_id` of a user, the `group_id` of a group, or the `uniqueId` of a service account as defined in [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts).
"assigneeType": "A String", # Output only. The type of the assignee (`USER` or `GROUP`).
- "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). Additional conditions related to Locked Groups are available under Open Beta. - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition.
+ "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`.
"orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
@@ -172,7 +172,7 @@ Method Details
{ # Defines an assignment of a role.
"assignedTo": "A String", # The unique ID of the entity this role is assigned to—either the `user_id` of a user, the `group_id` of a group, or the `uniqueId` of a service account as defined in [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts).
"assigneeType": "A String", # Output only. The type of the assignee (`USER` or `GROUP`).
- "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). Additional conditions related to Locked Groups are available under Open Beta. - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition.
+ "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`.
"orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
@@ -187,7 +187,7 @@ Method Details
Retrieves a paginated list of all roleAssignments.
Args:
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
includeIndirectRoleAssignments: boolean, When set to `true`, fetches indirect role assignments (i.e. role assignment via a group) as well as direct ones. Defaults to `false`. You must specify `user_key` or the indirect role assignments will not be included.
maxResults: integer, Maximum number of results to return.
pageToken: string, Token to specify the next page in the list.
@@ -207,7 +207,7 @@ Method Details
{ # Defines an assignment of a role.
"assignedTo": "A String", # The unique ID of the entity this role is assigned to—either the `user_id` of a user, the `group_id` of a group, or the `uniqueId` of a service account as defined in [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts).
"assigneeType": "A String", # Output only. The type of the assignee (`USER` or `GROUP`).
- "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). Additional conditions related to Locked Groups are available under Open Beta. - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition.
+ "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`.
"orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
diff --git a/docs/dyn/admin_directory_v1.roles.html b/docs/dyn/admin_directory_v1.roles.html
index 1fb20b5d4bd..0f8acea98e5 100644
--- a/docs/dyn/admin_directory_v1.roles.html
+++ b/docs/dyn/admin_directory_v1.roles.html
@@ -123,7 +123,7 @@ Method Details
Retrieves a role.
Args:
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
roleId: string, Immutable ID of the role. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -144,7 +144,7 @@ Method Details
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"privilegeName": "A String", # The name of the privilege.
- "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).
},
],
}
@@ -170,7 +170,7 @@ Method Details
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"privilegeName": "A String", # The name of the privilege.
- "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).
},
],
}
@@ -194,7 +194,7 @@ Method Details
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"privilegeName": "A String", # The name of the privilege.
- "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).
},
],
}
@@ -205,7 +205,7 @@ Method Details
Retrieves a paginated list of all the roles in a domain.
Args:
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
maxResults: integer, Maximum number of results to return.
pageToken: string, Token to specify the next page in the list.
x__xgafv: string, V1 error format.
@@ -230,7 +230,7 @@ Method Details
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"privilegeName": "A String", # The name of the privilege.
- "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).
},
],
},
@@ -275,7 +275,7 @@ Method Details
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"privilegeName": "A String", # The name of the privilege.
- "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).
},
],
}
@@ -299,7 +299,7 @@ Method Details
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"privilegeName": "A String", # The name of the privilege.
- "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).
},
],
}
@@ -326,7 +326,7 @@ Method Details
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"privilegeName": "A String", # The name of the privilege.
- "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).
},
],
}
@@ -350,7 +350,7 @@ Method Details
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"privilegeName": "A String", # The name of the privilege.
- "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).
+ "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list).
},
],
}
diff --git a/docs/dyn/admin_directory_v1.schemas.html b/docs/dyn/admin_directory_v1.schemas.html
index 4818886525b..4e7b600cf6d 100644
--- a/docs/dyn/admin_directory_v1.schemas.html
+++ b/docs/dyn/admin_directory_v1.schemas.html
@@ -120,7 +120,7 @@ Method Details
Retrieves a schema.
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
schemaKey: string, Name or immutable ID of the schema. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -134,7 +134,7 @@ Method Details
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
- { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).
+ { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
@@ -147,7 +147,7 @@ Method Details
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
- "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
+ "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
@@ -169,7 +169,7 @@ Method Details
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
- { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).
+ { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
@@ -182,7 +182,7 @@ Method Details
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
- "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
+ "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
@@ -202,7 +202,7 @@ Method Details
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
- { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).
+ { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
@@ -215,7 +215,7 @@ Method Details
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
- "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
+ "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
@@ -229,7 +229,7 @@ Method Details
Retrieves all schemas for a customer.
Args:
- customerId: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
+ customerId: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -246,7 +246,7 @@ Method Details
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
- { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).
+ { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
@@ -259,7 +259,7 @@ Method Details
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
- "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
+ "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
@@ -284,7 +284,7 @@ Method Details
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
- { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).
+ { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
@@ -297,7 +297,7 @@ Method Details
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
- "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
+ "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
@@ -317,7 +317,7 @@ Method Details
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
- { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).
+ { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
@@ -330,7 +330,7 @@ Method Details
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
- "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
+ "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
@@ -353,7 +353,7 @@ Method Details
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
- { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).
+ { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
@@ -366,7 +366,7 @@ Method Details
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
- "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
+ "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
@@ -386,7 +386,7 @@ Method Details
"displayName": "A String", # Display name for the schema.
"etag": "A String", # The ETag of the resource.
"fields": [ # A list of fields in the schema.
- { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).
+ { # You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](https://developers.google.com/workspace/admin/directory/v1/guides/manage-schemas).
"displayName": "A String", # Display Name of the field.
"etag": "A String", # The ETag of the field.
"fieldId": "A String", # The unique identifier of the field (Read-only)
@@ -399,7 +399,7 @@ Method Details
"maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
"minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.
},
- "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
+ "readAccessType": "ALL_DOMAIN_USERS", # Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.
},
],
"kind": "admin#directory#schema", # Kind of resource this is.
diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html
index 0a0e8ed759e..62dd8f2b755 100644
--- a/docs/dyn/admin_directory_v1.users.html
+++ b/docs/dyn/admin_directory_v1.users.html
@@ -107,7 +107,7 @@ Instance Methods
Makes a user a super administrator.
patch(userKey, body=None, x__xgafv=None)
-Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/admin-sdk/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.
+Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/workspace/admin/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.
signOut(userKey, x__xgafv=None)
Signs a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again.
@@ -116,7 +116,7 @@ Instance Methods
Undeletes a deleted user.
update(userKey, body=None, x__xgafv=None)
-Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-users#update_user) for more information.
+Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#update_user) for more information.
Watches for changes in users list.
@@ -151,7 +151,7 @@ Method Details
basic - Do not include any custom fields for the user.
custom - Include custom fields from schemas requested in `customFieldMask`.
full - Include all fields associated with this user.
- viewType: string, Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin).
+ viewType: string, Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).
Allowed values
admin_view - Results include both administrator-only and domain-public fields for the user.
domain_public - Results only include fields for the user that are publicly visible to other users in the domain.
@@ -163,7 +163,7 @@ Method Details
Returns:
An object of the form:
- { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).
+ { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.
"aliases": [ # Output only. The list of the user's alias email addresses.
@@ -177,7 +177,7 @@ Method Details
"a_key": "",
},
},
- "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
+ "customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
@@ -188,7 +188,7 @@ Method Details
"ims": "", # The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB.
"includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
- "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
+ "isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
@@ -234,7 +234,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).
+{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.
"aliases": [ # Output only. The list of the user's alias email addresses.
@@ -248,7 +248,7 @@ Method Details
"a_key": "",
},
},
- "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
+ "customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
@@ -259,7 +259,7 @@ Method Details
"ims": "", # The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB.
"includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
- "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
+ "isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
@@ -305,7 +305,7 @@ Method Details
Returns:
An object of the form:
- { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).
+ { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.
"aliases": [ # Output only. The list of the user's alias email addresses.
@@ -319,7 +319,7 @@ Method Details
"a_key": "",
},
},
- "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
+ "customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
@@ -330,7 +330,7 @@ Method Details
"ims": "", # The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB.
"includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
- "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
+ "isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
@@ -374,7 +374,7 @@ Method Details
Args:
customFieldMask: string, A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.
- customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.
+ customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.
domain: string, The domain name. Use this field to get users from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. Either the `customer` or the `domain` parameter must be provided.
event: string, Event on which subscription is intended (if subscribing)
Allowed values
@@ -395,13 +395,13 @@ Method Details
basic - Do not include any custom fields for the user.
custom - Include custom fields from schemas requested in `customFieldMask`.
full - Include all fields associated with this user.
- query: string, Query string for searching user fields. For more information on constructing user queries, see [Search for Users](/admin-sdk/directory/v1/guides/search-users).
+ query: string, Query string for searching user fields. For more information on constructing user queries, see [Search for Users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users).
showDeleted: string, If set to `true`, retrieves the list of deleted users. (Default: `false`)
sortOrder: string, Whether to return results in ascending or descending order, ignoring case.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
- viewType: string, Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin).
+ viewType: string, Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).
Allowed values
admin_view - Results include both administrator-only and domain-public fields for the user.
domain_public - Results only include fields for the user that are publicly visible to other users in the domain.
@@ -419,7 +419,7 @@ Method Details
"nextPageToken": "A String", # Token used to access next page of this result. The page token is only valid for three days.
"trigger_event": "A String", # Event that triggered this response (only used in case of Push Response)
"users": [ # A list of user objects.
- { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).
+ { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.
"aliases": [ # Output only. The list of the user's alias email addresses.
@@ -433,7 +433,7 @@ Method Details
"a_key": "",
},
},
- "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
+ "customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
@@ -444,7 +444,7 @@ Method Details
"ims": "", # The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB.
"includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
- "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
+ "isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
@@ -520,14 +520,14 @@ Method Details
patch(userKey, body=None, x__xgafv=None)
- Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/admin-sdk/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.
+ Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/workspace/admin/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
body: object, The request body.
The object takes the form of:
-{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).
+{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.
"aliases": [ # Output only. The list of the user's alias email addresses.
@@ -541,7 +541,7 @@ Method Details
"a_key": "",
},
},
- "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
+ "customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
@@ -552,7 +552,7 @@ Method Details
"ims": "", # The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB.
"includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
- "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
+ "isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
@@ -597,7 +597,7 @@ Method Details
Returns:
An object of the form:
- { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).
+ { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.
"aliases": [ # Output only. The list of the user's alias email addresses.
@@ -611,7 +611,7 @@ Method Details
"a_key": "",
},
},
- "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
+ "customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
@@ -622,7 +622,7 @@ Method Details
"ims": "", # The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB.
"includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
- "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
+ "isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
@@ -695,14 +695,14 @@ Method Details
update(userKey, body=None, x__xgafv=None)
- Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/admin-sdk/directory/v1/guides/manage-users#update_user) for more information.
+ Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#update_user) for more information.
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
body: object, The request body.
The object takes the form of:
-{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).
+{ # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.
"aliases": [ # Output only. The list of the user's alias email addresses.
@@ -716,7 +716,7 @@ Method Details
"a_key": "",
},
},
- "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
+ "customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
@@ -727,7 +727,7 @@ Method Details
"ims": "", # The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB.
"includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
- "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
+ "isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
@@ -772,7 +772,7 @@ Method Details
Returns:
An object of the form:
- { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).
+ { # The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-user-aliases.html).
"addresses": "", # The list of the user's addresses. The maximum allowed data size for this field is 10KB.
"agreedToTerms": True or False, # Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.
"aliases": [ # Output only. The list of the user's alias email addresses.
@@ -786,7 +786,7 @@ Method Details
"a_key": "",
},
},
- "customerId": "A String", # Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.
+ "customerId": "A String", # Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request.
"deletionTime": "A String",
"emails": "", # The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.
"etag": "A String", # Output only. ETag of the resource.
@@ -797,7 +797,7 @@ Method Details
"ims": "", # The list of the user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2KB.
"includeInGlobalAddressList": True or False, # Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](https://support.google.com/a/answer/1285988).
"ipWhitelisted": True or False, # If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration.
- "isAdmin": True or False, # Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
+ "isAdmin": True or False, # Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.
"isDelegatedAdmin": True or False, # Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325).
"isEnforcedIn2Sv": True or False, # Output only. Is 2-step verification enforced (Read-only)
"isEnrolledIn2Sv": True or False, # Output only. Is enrolled in 2-step verification (Read-only)
@@ -886,7 +886,7 @@ Method Details
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
- viewType: string, Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin).
+ viewType: string, Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin).
Allowed values
admin_view - Results include both administrator-only and domain-public fields.
domain_public - Results only include fields for the user that are publicly visible to other users in the domain.
diff --git a/docs/dyn/admin_directory_v1.users.photos.html b/docs/dyn/admin_directory_v1.users.photos.html
index c375669d894..aa61e6126f0 100644
--- a/docs/dyn/admin_directory_v1.users.photos.html
+++ b/docs/dyn/admin_directory_v1.users.photos.html
@@ -85,7 +85,7 @@ Instance Methods
Retrieves the user's photo.
patch(userKey, body=None, x__xgafv=None)
-Adds a photo for the user. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
+Adds a photo for the user. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
update(userKey, body=None, x__xgafv=None)
Adds a photo for the user.
@@ -136,7 +136,7 @@ Method Details
patch(userKey, body=None, x__xgafv=None)
- Adds a photo for the user. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
+ Adds a photo for the user. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
Args:
userKey: string, Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. (required)
diff --git a/docs/dyn/admin_reports_v1.activities.html b/docs/dyn/admin_reports_v1.activities.html
index 3b863804b06..14b1387472e 100644
--- a/docs/dyn/admin_reports_v1.activities.html
+++ b/docs/dyn/admin_reports_v1.activities.html
@@ -228,6 +228,13 @@ Method Details
},
"ipAddress": "A String", # IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into Google Workspace, which may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.
"kind": "admin#reports#activity", # The type of API resource. For an activity report, the value is `audit#activity`.
+ "networkInfo": { # Network information of the user doing the action. # Network information of the user doing the action.
+ "ipAsn": [ # IP Address of the user doing the action.
+ 42,
+ ],
+ "regionCode": "A String", # ISO 3166-1 alpha-2 region code of the user doing the action.
+ "subdivisionCode": "A String", # ISO 3166-2 region code (states and provinces) for countries of the user doing the action.
+ },
"ownerDomain": "A String", # This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner.
"resourceDetails": [ # Details of the resource on which the action was performed.
{ # Details of the resource on which the action was performed.
@@ -367,7 +374,7 @@ Method Details
endTime: string, Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past.
eventName: string, The name of the event being queried by the API. Each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.
filters: string, The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An empty report is returned if the request's parameter doesn't belong to the `eventName`. For more information about the available `eventName` fields for each application and their associated parameters, go to the [ApplicationName](#applicationname) table, then click through to the Activity Events page in the Appendix for the application you want. In the following Drive activity examples, the returned list consists of all `edit` events where the `doc_id` parameter value matches the conditions defined by the relational operator. In the first example, the request returns all edited documents with a `doc_id` value equal to `12345`. In the second example, the report returns any edited documents where the `doc_id` value is not equal to `98765`. The `<>` operator is URL-encoded in the request's query string (`%3C%3E`): ``` GET...&eventName=edit&filters=doc_id==12345 GET...&eventName=edit&filters=doc_id%3C%3E98765 ``` A `filters` query supports these relational operators: * `==`—'equal to'. * `<>`—'not equal to'. Must be URL-encoded (%3C%3E). * `<`—'less than'. Must be URL-encoded (%3C). * `<=`—'less than or equal to'. Must be URL-encoded (%3C=). * `>`—'greater than'. Must be URL-encoded (%3E). * `>=`—'greater than or equal to'. Must be URL-encoded (%3E=). **Note:** The API doesn't accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned.
- groupIdFilter: string, Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175)
+ groupIdFilter: string, `Deprecated`. This field is deprecated and is no longer supported. Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456" *Important:* To filter by groups, you must explicitly add the groups to your filtering groups allowlist. For more information about adding groups to filtering groups allowlist, see [Filter results by Google Group](https://support.google.com/a/answer/11482175)
maxResults: integer, Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.
orgUnitID: string, `Deprecated`. This field is deprecated and is no longer supported. ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.
pageToken: string, The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.
diff --git a/docs/dyn/admin_reports_v1.customerUsageReports.html b/docs/dyn/admin_reports_v1.customerUsageReports.html
index a4f9d0a3984..edb27f3e8c1 100644
--- a/docs/dyn/admin_reports_v1.customerUsageReports.html
+++ b/docs/dyn/admin_reports_v1.customerUsageReports.html
@@ -122,7 +122,7 @@ Method Details
},
"etag": "A String", # ETag of the resource.
"kind": "admin#reports#usageReport", # The type of API resource. For a usage report, the value is `admin#reports#usageReport`.
- "parameters": [ # Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).
+ "parameters": [ # Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](https://developers.google.com/workspace/admin/reports/v1/reference/usage-ref-appendix-a/entities).
{
"boolValue": True or False, # Output only. Boolean value of the parameter.
"datetimeValue": "A String", # The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z.
diff --git a/docs/dyn/admin_reports_v1.entityUsageReports.html b/docs/dyn/admin_reports_v1.entityUsageReports.html
index feb780d8da2..bf07bf1107c 100644
--- a/docs/dyn/admin_reports_v1.entityUsageReports.html
+++ b/docs/dyn/admin_reports_v1.entityUsageReports.html
@@ -128,7 +128,7 @@ Method Details
},
"etag": "A String", # ETag of the resource.
"kind": "admin#reports#usageReport", # The type of API resource. For a usage report, the value is `admin#reports#usageReport`.
- "parameters": [ # Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).
+ "parameters": [ # Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](https://developers.google.com/workspace/admin/reports/v1/reference/usage-ref-appendix-a/entities).
{
"boolValue": True or False, # Output only. Boolean value of the parameter.
"datetimeValue": "A String", # The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z.
diff --git a/docs/dyn/admin_reports_v1.userUsageReport.html b/docs/dyn/admin_reports_v1.userUsageReport.html
index 80d7340089b..8b9417d480b 100644
--- a/docs/dyn/admin_reports_v1.userUsageReport.html
+++ b/docs/dyn/admin_reports_v1.userUsageReport.html
@@ -127,7 +127,7 @@ Method Details
},
"etag": "A String", # ETag of the resource.
"kind": "admin#reports#usageReport", # The type of API resource. For a usage report, the value is `admin#reports#usageReport`.
- "parameters": [ # Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).
+ "parameters": [ # Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](https://developers.google.com/workspace/admin/reports/v1/reference/usage-ref-appendix-a/entities).
{
"boolValue": True or False, # Output only. Boolean value of the parameter.
"datetimeValue": "A String", # The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z.
diff --git a/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html b/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html
index 000352b88bb..2d973837809 100644
--- a/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html
+++ b/docs/dyn/adsenseplatform_v1alpha.accounts.platforms.groups.html
@@ -110,9 +110,9 @@ Method Details
An object of the form:
{ # Representation of a Transparent Platform Group.
- "description": "A String", # Output only. Description of the PlatformGroup.
+ "description": "A String", # Required. Description of the PlatformGroup.
"name": "A String", # Identifier. Format: accounts/{account}/platforms/{platform}/groups/{platform_group}
- "revshareMillipercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%).
+ "revshareMillipercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # Output only. The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%).
"value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
},
}
@@ -138,9 +138,9 @@ Method Details
"nextPageToken": "A String", # Continuation token used to page through platforms. To retrieve the next page of the results, set the next request's "page_token" value to this.
"platformGroups": [ # The platform groups returned in this list response.
{ # Representation of a Transparent Platform Group.
- "description": "A String", # Output only. Description of the PlatformGroup.
+ "description": "A String", # Required. Description of the PlatformGroup.
"name": "A String", # Identifier. Format: accounts/{account}/platforms/{platform}/groups/{platform_group}
- "revshareMillipercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%).
+ "revshareMillipercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # Output only. The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%).
"value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
},
},
@@ -172,9 +172,9 @@ Method Details
The object takes the form of:
{ # Representation of a Transparent Platform Group.
- "description": "A String", # Output only. Description of the PlatformGroup.
+ "description": "A String", # Required. Description of the PlatformGroup.
"name": "A String", # Identifier. Format: accounts/{account}/platforms/{platform}/groups/{platform_group}
- "revshareMillipercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%).
+ "revshareMillipercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # Output only. The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%).
"value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
},
}
@@ -189,9 +189,9 @@ Method Details
An object of the form:
{ # Representation of a Transparent Platform Group.
- "description": "A String", # Output only. Description of the PlatformGroup.
+ "description": "A String", # Required. Description of the PlatformGroup.
"name": "A String", # Identifier. Format: accounts/{account}/platforms/{platform}/groups/{platform_group}
- "revshareMillipercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%).
+ "revshareMillipercent": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html). # Output only. The revenue share of the PlatformGroup, in millipercent (e.g. 15000 = 15%).
"value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
},
}
diff --git a/docs/dyn/androidpublisher_v3.orders.html b/docs/dyn/androidpublisher_v3.orders.html
index c33547abfaf..d04339caba6 100644
--- a/docs/dyn/androidpublisher_v3.orders.html
+++ b/docs/dyn/androidpublisher_v3.orders.html
@@ -126,7 +126,10 @@ Method Details
},
"oneTimePurchaseDetails": { # Details of a one-time purchase. # Details of a one-time purchase.
"offerId": "A String", # The offer ID of the one-time purchase offer.
+ "purchaseOptionId": "A String", # ID of the purchase option. This field is set for both purchase options and variant offers. For purchase options, this ID identifies the purchase option itself. For variant offers, this ID refers to the associated purchase option, and in conjunction with offer_id it identifies the variant offer.
"quantity": 42, # The number of items purchased (for multi-quantity item purchases).
+ "rentalDetails": { # Details of a rental purchase. # The details of a rent purchase. Only set if it is a rent purchase.
+ },
},
"paidAppDetails": { # Details of a paid app purchase. # Details of a paid app purchase.
},
@@ -267,7 +270,10 @@ Method Details
},
"oneTimePurchaseDetails": { # Details of a one-time purchase. # Details of a one-time purchase.
"offerId": "A String", # The offer ID of the one-time purchase offer.
+ "purchaseOptionId": "A String", # ID of the purchase option. This field is set for both purchase options and variant offers. For purchase options, this ID identifies the purchase option itself. For variant offers, this ID refers to the associated purchase option, and in conjunction with offer_id it identifies the variant offer.
"quantity": 42, # The number of items purchased (for multi-quantity item purchases).
+ "rentalDetails": { # Details of a rental purchase. # The details of a rent purchase. Only set if it is a rent purchase.
+ },
},
"paidAppDetails": { # Details of a paid app purchase. # Details of a paid app purchase.
},
diff --git a/docs/dyn/apphub_v1alpha.projects.locations.html b/docs/dyn/apphub_v1alpha.projects.locations.html
index 6fe63a04651..77fbc59fa9b 100644
--- a/docs/dyn/apphub_v1alpha.projects.locations.html
+++ b/docs/dyn/apphub_v1alpha.projects.locations.html
@@ -108,9 +108,6 @@ Instance Methods
Gets information about a location.
-
- getPerimeter(name, x__xgafv=None)
-Gets a perimeter
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service.
@@ -177,29 +174,6 @@ Method Details
}
-
- getPerimeter(name, x__xgafv=None)
- Gets a perimeter
-
-Args:
- name: string, Required. Fully qualified name of the Perimeter Expected format: `projects/{project}/locations/{location}/perimeter`. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Perimeter is a boundary that describes application management on a `perimeter_node` (currently limited to an app-enabled folder).
- "createTime": "A String", # Output only. Create time.
- "name": "A String", # Identifier. Name of the Perimeter resource.
- "perimeterNode": "A String", # Immutable. Cloud Resource Manager node that determines the perimeter. Only `folders/{folder_number}` is currently supported.
- "state": "A String", # Output only. Perimeter state.
- "updateTime": "A String", # Output only. Update time.
-}
-
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service.
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.dockerImages.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.dockerImages.html
index 1dc73c65579..c6b5083cf84 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.dockerImages.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.dockerImages.html
@@ -110,7 +110,7 @@ Method Details
"buildTime": "A String", # The time this image was built. This field is returned as the 'metadata.buildTime' field in the Version resource. The build time is returned to the client as an RFC 3339 string, which can be easily used with the JavaScript Date constructor.
"imageSizeBytes": "A String", # Calculated size of the image. This field is returned as the 'metadata.imageSizeBytes' field in the Version resource.
"mediaType": "A String", # Media type of this image, e.g. "application/vnd.docker.distribution.manifest.v2+json". This field is returned as the 'metadata.mediaType' field in the Version resource.
- "name": "A String", # Required. registry_location, project_id, repository_name and image id forms a unique image name:`projects//locations//repository//dockerImages/`. For example, "projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/ nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and "nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf" is the image's digest.
+ "name": "A String", # Required. registry_location, project_id, repository_name and image id forms a unique image name:`projects//locations//repositories//dockerImages/`. For example, "projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/ nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and "nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf" is the image's digest.
"tags": [ # Tags attached to this image.
"A String",
],
@@ -143,7 +143,7 @@ Method Details
"buildTime": "A String", # The time this image was built. This field is returned as the 'metadata.buildTime' field in the Version resource. The build time is returned to the client as an RFC 3339 string, which can be easily used with the JavaScript Date constructor.
"imageSizeBytes": "A String", # Calculated size of the image. This field is returned as the 'metadata.imageSizeBytes' field in the Version resource.
"mediaType": "A String", # Media type of this image, e.g. "application/vnd.docker.distribution.manifest.v2+json". This field is returned as the 'metadata.mediaType' field in the Version resource.
- "name": "A String", # Required. registry_location, project_id, repository_name and image id forms a unique image name:`projects//locations//repository//dockerImages/`. For example, "projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/ nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and "nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf" is the image's digest.
+ "name": "A String", # Required. registry_location, project_id, repository_name and image id forms a unique image name:`projects//locations//repositories//dockerImages/`. For example, "projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/ nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and "nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf" is the image's digest.
"tags": [ # Tags attached to this image.
"A String",
],
diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html
index 28b6a3fcfd0..fd3955ac318 100644
--- a/docs/dyn/chat_v1.spaces.messages.html
+++ b/docs/dyn/chat_v1.spaces.messages.html
@@ -409,6 +409,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -665,6 +666,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -1066,6 +1068,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -1322,6 +1325,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -1927,6 +1931,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -2183,6 +2188,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -2713,6 +2719,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -2969,6 +2976,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -3370,6 +3378,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -3626,6 +3635,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -4231,6 +4241,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -4487,6 +4498,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -5035,6 +5047,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -5291,6 +5304,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -5692,6 +5706,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -5948,6 +5963,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -6553,6 +6569,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -6809,6 +6826,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -7345,6 +7363,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -7601,6 +7620,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -8002,6 +8022,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -8258,6 +8279,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -8863,6 +8885,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -9119,6 +9142,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -9660,6 +9684,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -9916,6 +9941,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -10317,6 +10343,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -10573,6 +10600,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -11178,6 +11206,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -11434,6 +11463,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -11958,6 +11988,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -12214,6 +12245,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -12615,6 +12647,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -12871,6 +12904,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -13476,6 +13510,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -13732,6 +13767,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -14256,6 +14292,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -14512,6 +14549,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -14913,6 +14951,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -15169,6 +15208,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -15774,6 +15814,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -16030,6 +16071,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -16554,6 +16596,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -16810,6 +16853,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -17211,6 +17255,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -17467,6 +17512,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -18072,6 +18118,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -18328,6 +18375,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html
index 3f04cbff686..912a1caca16 100644
--- a/docs/dyn/chat_v1.spaces.spaceEvents.html
+++ b/docs/dyn/chat_v1.spaces.spaceEvents.html
@@ -524,6 +524,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -780,6 +781,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -1181,6 +1183,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -1437,6 +1440,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -2042,6 +2046,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -2298,6 +2303,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -2817,6 +2823,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -3073,6 +3080,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -3474,6 +3482,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -3730,6 +3739,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -4335,6 +4345,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -4591,6 +4602,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -5110,6 +5122,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -5366,6 +5379,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -5767,6 +5781,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -6023,6 +6038,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -6628,6 +6644,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -6884,6 +6901,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -7401,6 +7419,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -7657,6 +7676,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -8058,6 +8078,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -8314,6 +8335,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -8919,6 +8941,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -9175,6 +9198,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -9690,6 +9714,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -9946,6 +9971,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -10347,6 +10373,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -10603,6 +10630,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -11208,6 +11236,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -11464,6 +11493,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -11979,6 +12009,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -12235,6 +12266,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -12636,6 +12668,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -12892,6 +12925,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -13497,6 +13531,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -13753,6 +13788,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -14667,6 +14703,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -14923,6 +14960,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -15324,6 +15362,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -15580,6 +15619,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -16185,6 +16225,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -16441,6 +16482,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -16960,6 +17002,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -17216,6 +17259,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -17617,6 +17661,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -17873,6 +17918,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -18478,6 +18524,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -18734,6 +18781,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -19253,6 +19301,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -19509,6 +19558,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -19910,6 +19960,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -20166,6 +20217,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -20771,6 +20823,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -21027,6 +21080,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -21544,6 +21598,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -21800,6 +21855,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -22201,6 +22257,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -22457,6 +22514,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -23062,6 +23120,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -23318,6 +23377,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -23833,6 +23893,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -24089,6 +24150,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -24490,6 +24552,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -24746,6 +24809,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -25351,6 +25415,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -25607,6 +25672,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -26122,6 +26188,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -26378,6 +26445,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -26779,6 +26847,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -27035,6 +27104,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -27640,6 +27710,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
@@ -27896,6 +27967,7 @@ Method Details
"A String",
],
},
+ "hintText": "A String", # Optional. Text that appears below the selection input field meant to assist users by prompting them to enter a certain value. This text is always visible. Only supported by Google Workspace Workflows, but not Google Chat API or Google Workspace Add-ons.
"items": [ # An array of selectable items. For example, an array of radio buttons or checkboxes. Supports up to 100 items.
{ # An item that users can select in a selection input, such as a checkbox or switch. Supports up to 100 items. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend):
"bottomText": "A String", # For multiselect menus, a text description or label that's displayed below the item's `text` field.
diff --git a/docs/dyn/chromemanagement_v1.customers.apps.android.html b/docs/dyn/chromemanagement_v1.customers.apps.android.html
index da2d9400237..15cb7564586 100644
--- a/docs/dyn/chromemanagement_v1.customers.apps.android.html
+++ b/docs/dyn/chromemanagement_v1.customers.apps.android.html
@@ -116,6 +116,7 @@ Method Details
"isKioskOnly": True or False, # Output only. Whether the app is only for Kiosk mode on ChromeOS 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 ChromeOS devices
+ "manifestVersion": "A String", # Output only. The version of this extension's manifest.
"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 bfb45cfbc41..bec8228a7d2 100644
--- a/docs/dyn/chromemanagement_v1.customers.apps.chrome.html
+++ b/docs/dyn/chromemanagement_v1.customers.apps.chrome.html
@@ -116,6 +116,7 @@ Method Details
"isKioskOnly": True or False, # Output only. Whether the app is only for Kiosk mode on ChromeOS 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 ChromeOS devices
+ "manifestVersion": "A String", # Output only. The version of this extension's manifest.
"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 ac6b2846abd..e825bef0e15 100644
--- a/docs/dyn/chromemanagement_v1.customers.apps.web.html
+++ b/docs/dyn/chromemanagement_v1.customers.apps.web.html
@@ -116,6 +116,7 @@ Method Details
"isKioskOnly": True or False, # Output only. Whether the app is only for Kiosk mode on ChromeOS 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 ChromeOS devices
+ "manifestVersion": "A String", # Output only. The version of this extension's manifest.
"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.profiles.commands.html b/docs/dyn/chromemanagement_v1.customers.profiles.commands.html
new file mode 100644
index 00000000000..3aa2039e45a
--- /dev/null
+++ b/docs/dyn/chromemanagement_v1.customers.profiles.commands.html
@@ -0,0 +1,232 @@
+
+
+
+Chrome Management API . customers . profiles . commands
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
+Creates a Chrome browser profile remote command.
+
+Gets a Chrome browser profile remote command.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+Lists remote commands of a Chrome browser profile.
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, x__xgafv=None)
+ Creates a Chrome browser profile remote command.
+
+Args:
+ parent: string, Required. Format: customers/{customer_id}/profiles/{profile_permanent_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A representation of a remote command for a Chrome browser profile.
+ "commandResult": { # Result of the execution of a command. # Output only. Result of the remote command.
+ "clientExecutionTime": "A String", # Output only. Timestamp of the client execution of the remote command.
+ "resultCode": "A String", # Output only. Result code that indicates the type of error or success of the command.
+ "resultType": "A String", # Output only. Result type of the remote command.
+ },
+ "commandState": "A String", # Output only. State of the remote command.
+ "commandType": "A String", # Required. Type of the remote command. The only supported command_type is "clearBrowsingData".
+ "issueTime": "A String", # Output only. Timestamp of the issurance of the remote command.
+ "name": "A String", # Identifier. Format: customers/{customer_id}/profiles/{profile_permanent_id}/commands/{command_id}
+ "payload": { # Required. Payload of the remote command. The payload for "clearBrowsingData" command supports: - fields "clearCache" and "clearCookies" - values of boolean type.
+ "a_key": "", # Properties of the object.
+ },
+ "validDuration": "A String", # Output only. Valid duration of the remote command.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A representation of a remote command for a Chrome browser profile.
+ "commandResult": { # Result of the execution of a command. # Output only. Result of the remote command.
+ "clientExecutionTime": "A String", # Output only. Timestamp of the client execution of the remote command.
+ "resultCode": "A String", # Output only. Result code that indicates the type of error or success of the command.
+ "resultType": "A String", # Output only. Result type of the remote command.
+ },
+ "commandState": "A String", # Output only. State of the remote command.
+ "commandType": "A String", # Required. Type of the remote command. The only supported command_type is "clearBrowsingData".
+ "issueTime": "A String", # Output only. Timestamp of the issurance of the remote command.
+ "name": "A String", # Identifier. Format: customers/{customer_id}/profiles/{profile_permanent_id}/commands/{command_id}
+ "payload": { # Required. Payload of the remote command. The payload for "clearBrowsingData" command supports: - fields "clearCache" and "clearCookies" - values of boolean type.
+ "a_key": "", # Properties of the object.
+ },
+ "validDuration": "A String", # Output only. Valid duration of the remote command.
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets a Chrome browser profile remote command.
+
+Args:
+ name: string, Required. Format: customers/{customer_id}/profiles/{profile_permanent_id}/commands/{command_id} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A representation of a remote command for a Chrome browser profile.
+ "commandResult": { # Result of the execution of a command. # Output only. Result of the remote command.
+ "clientExecutionTime": "A String", # Output only. Timestamp of the client execution of the remote command.
+ "resultCode": "A String", # Output only. Result code that indicates the type of error or success of the command.
+ "resultType": "A String", # Output only. Result type of the remote command.
+ },
+ "commandState": "A String", # Output only. State of the remote command.
+ "commandType": "A String", # Required. Type of the remote command. The only supported command_type is "clearBrowsingData".
+ "issueTime": "A String", # Output only. Timestamp of the issurance of the remote command.
+ "name": "A String", # Identifier. Format: customers/{customer_id}/profiles/{profile_permanent_id}/commands/{command_id}
+ "payload": { # Required. Payload of the remote command. The payload for "clearBrowsingData" command supports: - fields "clearCache" and "clearCookies" - values of boolean type.
+ "a_key": "", # Properties of the object.
+ },
+ "validDuration": "A String", # Output only. Valid duration of the remote command.
+}
+
+
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists remote commands of a Chrome browser profile.
+
+Args:
+ parent: string, Required. Format: customers/{customer_id}/profiles/{profile_permanent_id} (required)
+ pageSize: integer, Optional. The maximum number of commands to return. The default page size is 100 if page_size is unspecified, and the maximum page size allowed is 100.
+ pageToken: string, Optional. The page token used to retrieve a specific page of the listing request.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to ListChromeBrowserProfileCommands method.
+ "chromeBrowserProfileCommands": [ # The list of commands returned.
+ { # A representation of a remote command for a Chrome browser profile.
+ "commandResult": { # Result of the execution of a command. # Output only. Result of the remote command.
+ "clientExecutionTime": "A String", # Output only. Timestamp of the client execution of the remote command.
+ "resultCode": "A String", # Output only. Result code that indicates the type of error or success of the command.
+ "resultType": "A String", # Output only. Result type of the remote command.
+ },
+ "commandState": "A String", # Output only. State of the remote command.
+ "commandType": "A String", # Required. Type of the remote command. The only supported command_type is "clearBrowsingData".
+ "issueTime": "A String", # Output only. Timestamp of the issurance of the remote command.
+ "name": "A String", # Identifier. Format: customers/{customer_id}/profiles/{profile_permanent_id}/commands/{command_id}
+ "payload": { # Required. Payload of the remote command. The payload for "clearBrowsingData" command supports: - fields "clearCache" and "clearCookies" - values of boolean type.
+ "a_key": "", # Properties of the object.
+ },
+ "validDuration": "A String", # Output only. Valid duration of the remote command.
+ },
+ ],
+ "nextPageToken": "A String", # The pagination token that can be used to list the next page.
+ "totalSize": "A String", # Total size represents an estimated number of resources returned.
+}
+
+
+
+ list_next()
+ 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.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/chromemanagement_v1.customers.profiles.html b/docs/dyn/chromemanagement_v1.customers.profiles.html
index 5f29a17bd4f..5565b92ab7c 100644
--- a/docs/dyn/chromemanagement_v1.customers.profiles.html
+++ b/docs/dyn/chromemanagement_v1.customers.profiles.html
@@ -74,6 +74,11 @@
Chrome Management API . customers . profiles
Instance Methods
+
+ commands()
+
+Returns the commands Resource.
+
Close httplib2 connections.
diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html b/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html
index 680cdc4f1e5..354e1b5f772 100644
--- a/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html
+++ b/docs/dyn/chromemanagement_v1.customers.telemetry.devices.html
@@ -212,10 +212,12 @@ Method Details
"displayHeightMm": 42, # Output only. Display height in millimeters.
"displayName": "A String", # Output only. Display device name.
"displayWidthMm": 42, # Output only. Display width in millimeters.
+ "edidVersion": "A String", # Output only. EDID version.
"internal": True or False, # Output only. Is display internal or not.
"manufactureYear": 42, # Output only. Year of manufacture.
"manufacturerId": "A String", # Output only. Three letter manufacturer ID.
"modelId": 42, # Output only. Manufacturer product code.
+ "serialNumber": 42, # Output only. Serial number.
},
],
"eprivacySupported": True or False, # Output only. Is ePrivacy screen supported or not.
@@ -236,10 +238,12 @@ Method Details
{ # Information for a display.
"deviceId": "A String", # Output only. Represents the graphics card device id.
"displayName": "A String", # Output only. Display device name.
+ "edidVersion": "A String", # Output only. EDID version.
"isInternal": True or False, # Output only. Indicates if display is internal or not.
"refreshRate": 42, # Output only. Refresh rate in Hz.
"resolutionHeight": 42, # Output only. Resolution height in pixels.
"resolutionWidth": 42, # Output only. Resolution width in pixels.
+ "serialNumber": 42, # Output only. Serial number.
},
],
"reportTime": "A String", # Output only. Time at which the graphics data was reported.
@@ -530,10 +534,12 @@ Method Details
"displayHeightMm": 42, # Output only. Display height in millimeters.
"displayName": "A String", # Output only. Display device name.
"displayWidthMm": 42, # Output only. Display width in millimeters.
+ "edidVersion": "A String", # Output only. EDID version.
"internal": True or False, # Output only. Is display internal or not.
"manufactureYear": 42, # Output only. Year of manufacture.
"manufacturerId": "A String", # Output only. Three letter manufacturer ID.
"modelId": 42, # Output only. Manufacturer product code.
+ "serialNumber": 42, # Output only. Serial number.
},
],
"eprivacySupported": True or False, # Output only. Is ePrivacy screen supported or not.
@@ -554,10 +560,12 @@ Method Details
{ # Information for a display.
"deviceId": "A String", # Output only. Represents the graphics card device id.
"displayName": "A String", # Output only. Display device name.
+ "edidVersion": "A String", # Output only. EDID version.
"isInternal": True or False, # Output only. Indicates if display is internal or not.
"refreshRate": 42, # Output only. Refresh rate in Hz.
"resolutionHeight": 42, # Output only. Resolution height in pixels.
"resolutionWidth": 42, # Output only. Resolution width in pixels.
+ "serialNumber": 42, # Output only. Serial number.
},
],
"reportTime": "A String", # Output only. Time at which the graphics data was reported.
diff --git a/docs/dyn/civicinfo_v2.divisions.html b/docs/dyn/civicinfo_v2.divisions.html
index d9f1e5d87fd..d62f0caa0c2 100644
--- a/docs/dyn/civicinfo_v2.divisions.html
+++ b/docs/dyn/civicinfo_v2.divisions.html
@@ -116,6 +116,9 @@ Method Details
},
},
"normalizedInput": { # A simple representation of an address. # The normalized version of the requested address.
+ "addressLine": [
+ "A String",
+ ],
"city": "A String", # The city or town for the address.
"line1": "A String", # The street name and number of this address.
"line2": "A String", # The second line the address, if needed.
diff --git a/docs/dyn/civicinfo_v2.elections.html b/docs/dyn/civicinfo_v2.elections.html
index 501d537f8c6..481a0276175 100644
--- a/docs/dyn/civicinfo_v2.elections.html
+++ b/docs/dyn/civicinfo_v2.elections.html
@@ -200,6 +200,9 @@ Method Details
"dropOffLocations": [ # Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.
{ # A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.
"address": { # A simple representation of an address. # The address of the location.
+ "addressLine": [
+ "A String",
+ ],
"city": "A String", # The city or town for the address.
"line1": "A String", # The street name and number of this address.
"line2": "A String", # The second line the address, if needed.
@@ -227,6 +230,9 @@ Method Details
"earlyVoteSites": [ # Locations where the voter is eligible to vote early, prior to election day.
{ # A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.
"address": { # A simple representation of an address. # The address of the location.
+ "addressLine": [
+ "A String",
+ ],
"city": "A String", # The city or town for the address.
"line1": "A String", # The street name and number of this address.
"line2": "A String", # The second line the address, if needed.
@@ -261,6 +267,9 @@ Method Details
"kind": "civicinfo#voterInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".
"mailOnly": True or False, # Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well).
"normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
+ "addressLine": [
+ "A String",
+ ],
"city": "A String", # The city or town for the address.
"line1": "A String", # The street name and number of this address.
"line2": "A String", # The second line the address, if needed.
@@ -281,6 +290,9 @@ Method Details
"pollingLocations": [ # Locations where the voter is eligible to vote on election day.
{ # A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.
"address": { # A simple representation of an address. # The address of the location.
+ "addressLine": [
+ "A String",
+ ],
"city": "A String", # The city or town for the address.
"line1": "A String", # The street name and number of this address.
"line2": "A String", # The second line the address, if needed.
@@ -342,6 +354,9 @@ Method Details
"absenteeVotingInfoUrl": "A String", # A URL provided by this administrative body for information on absentee voting.
"ballotInfoUrl": "A String", # A URL provided by this administrative body to give contest information to the voter.
"correspondenceAddress": { # A simple representation of an address. # The mailing address of this administrative body.
+ "addressLine": [
+ "A String",
+ ],
"city": "A String", # The city or town for the address.
"line1": "A String", # The street name and number of this address.
"line2": "A String", # The second line the address, if needed.
@@ -368,6 +383,9 @@ Method Details
"hoursOfOperation": "A String", # A description of the hours of operation for this administrative body.
"name": "A String", # The name of this election administrative body.
"physicalAddress": { # A simple representation of an address. # The physical address of this administrative body.
+ "addressLine": [
+ "A String",
+ ],
"city": "A String", # The city or town for the address.
"line1": "A String", # The street name and number of this address.
"line2": "A String", # The second line the address, if needed.
diff --git a/docs/dyn/cloudbilling_v1beta.billingAccounts.html b/docs/dyn/cloudbilling_v1beta.billingAccounts.html
index 09190cb1349..72013e838eb 100644
--- a/docs/dyn/cloudbilling_v1beta.billingAccounts.html
+++ b/docs/dyn/cloudbilling_v1beta.billingAccounts.html
@@ -92,555 +92,10 @@ Instance Methods
Close httplib2 connections.
-
- estimateCostScenario(billingAccount, body=None, x__xgafv=None)
-Use custom pricing in the estimate, using a `CostScenario` with a defined `billingAccount`.
Method Details
close()
Close httplib2 connections.
-
- estimateCostScenario(billingAccount, body=None, x__xgafv=None)
- Use custom pricing in the estimate, using a `CostScenario` with a defined `billingAccount`.
-
-Args:
- billingAccount: string, Resource name of the billing account for the cost estimate. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` is the resource name for billing account `012345-567890-ABCDEF`. Must be specified. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Request for EstimateCostScenarioForBillingAccount.
- "costScenario": { # Encapsulates all the information needed to perform a cost estimate. It includes a specification of the Google Cloud usage whose costs are estimated, and configuration options. # The scenario to estimate costs for.
- "commitments": [ # New commitments to estimate the costs for. The cost of the commitments will be included in the estimate result and discounts the commitment entitles will be included in the workload cost estimates. A maximum of 100 workloads can be provided.
- { # Commitments give you the ability to pay a recurring fee in exchange for a benefit, such as a discount for your use. For example, this object might contain details of a [spend-based committed use discount (CUD)](https://cloud.google.com/docs/cuds#spend_based_commitments). Within a CostScenario, adding a commitment includes the cost of the commitment and any discounts.
- "name": "A String", # Required. A name for this commitment. All commitments in a CostScenario must have unique names. Each name may be at most 128 characters long.
- "vmResourceBasedCud": { # Specifies a resource-based committed use discount (CUD). # A resource-based committed use discount (CUD).
- "guestAccelerator": { # Specification of a set of guest accelerators attached to a machine. # Guest accelerator, known as GPU.
- "acceleratorCount": "A String", # The number of the guest accelerator cards exposed to each instance.
- "acceleratorType": "A String", # The type of the guest accelerator cards. For example: "nvidia-tesla-t4".
- },
- "machineSeries": "A String", # The machine series for CUD. For example: "n1" for general purpose N1 machine type commitments. "n2" for general purpose N2 machine type commitments. "e2" for general purpose E2 machine type commitments. "n2d" for general purpose N2D machine type commitments. "t2d" for general purpose T2D machine type commitments. "c2"/"c2d" for compute-optimized commitments. "m1"/"m2" for the memory-optimized commitments. "a2' for the accelerator-optimized commitments.
- "memorySizeGb": 3.14, # Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB).
- "plan": "A String", # Commitment usage plan.
- "region": "A String", # The region where the VM runs. For example: "us-central1"
- "virtualCpuCount": "A String", # The number of vCPUs. The number of vCPUs must be an integer of 0 or more and can be even or odd.
- },
- },
- ],
- "scenarioConfig": { # Configuration for a CostScenario. Specifies how costs are calculated. # Configuration for the scenario.
- "estimateDuration": "A String", # Time frame for the estimate. Workloads must specify usage for this duration. Duration must be at least 1 hour (3,600 seconds) and at most 10 years (315,360,000 seconds). The calculations for years and months are based on a 730-hour (2,628,000-second) month. For durations longer than one month (2,628,000 seconds), the duration is rounded up to the next month, so the estimate shows you the costs for full months. For example, a duration of 3,232,800 seconds (roughly 5 weeks) is rounded up to 2 months.
- },
- "workloads": [ # The Google Cloud usage whose costs are estimated. A maximum of 100 workloads can be provided.
- { # Specifies usage on a single Google Cloud product over a time frame. Each Google Cloud product has its own message, containing specific product configuration parameters of the product usage amounts along each dimension in which the product is billed.
- "cloudCdnEgressWorkload": { # Specifies usage for Cloud CDN Data Transfer. # Usage on Google Cloud CDN Data Transfer.
- "cacheEgressDestination": "A String", # The destination for the cache data transfer.
- "cacheEgressRate": { # An amount of usage over a time frame. # Cache data transfer usage. The rate of data cache transferred to the destination. Use units such as GiBy/s or TiBy/mo, based on [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- },
- "cloudCdnWorkload": { # Specifies usage for Cloud CDN resources. # Usage on Google Cloud CDN.
- "cacheFillOriginService": "A String", # The source service for the cache fill.
- "cacheFillRate": { # An amount of usage over a time frame. # Cache fill usage. The rate of data transferred between cache fill regions. For example: units such as "GiBy/s" or "TBy/mo".
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "cacheFillRegions": { # Specifies the regions for Cache Fill. # The regions where data is transferred from Google data locations into Google global cache servers. The SKU prices for cache fill across services are the same.
- "destinationRegion": "A String", # The destination region for cache fill.
- "sourceRegion": "A String", # The source region for cache fill.
- },
- "cacheLookUpRate": { # An amount of usage over a time frame. # Cache look up requests. This is specified to indicate the number of requests. For example: units such as "1/s".
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- },
- "cloudInterconnectEgressWorkload": { # Includes the estimate for Interconnect Data Transfer only. To specify usage for data transfer between VMs and internet end-points, use the Standard Tier Internet Data Transfer interface. # Usage on Google Cloud Interconnect Data Transfer.
- "egressRate": { # An amount of usage over a time frame. # Outbound data transfer usage. This usage applies when you move or copy data from one Google Cloud service to another service. The units are GiBy/s, By/s, and so on, based on [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "interconnectConnectionLocation": "A String", # Locations in the [Interconnect connection location table](https://cloud.google.com/vpc/network-pricing#interconnect-pricing). These are the Interconnect Data Transfer charges.
- },
- "cloudInterconnectWorkload": { # Specifies usage for Cloud Interconnect resources. # Usage on Google Cloud Interconnect.
- "interconnectAttachments": [ # VLAN attachment used for interconnect.
- { # VLAN attachment for Cloud Interconnect.
- "bandwidth": "A String", # Capacities in the [pricing table](https://cloud.google.com/vpc/network-pricing#interconnect-pricing) Examples of capacity are: 50/100/200/300/400/500-Mbps, 1/2/5/10/20/50-Gbps.
- "vlanCount": { # An amount of usage over a time frame. # VLAN usage. This is specified as a unitless quantity which indicates the number of VLAN attachment used in interconnect.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- },
- ],
- "interconnectType": "A String", # VLAN attachment type
- "linkType": "A String", # Interconnect circuit link type.
- "provisionedLinkCount": { # An amount of usage over a time frame. # Interconnect usage. This is specified as a unitless quantity which indicates the number of circuit provisioned in interconnect.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- },
- "cloudStorageEgressWorkload": { # Specification of a network type. Network data transfer within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network data transfer within Google Cloud and the general network usage. * If transferring data between two regions, the source and destination fields are set to different values. For example: `source_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC", `destination_continent` = "SOURCE_CONTINENT_SOUTH_AMERICA". * If transferring data within one region, the source and destination fields are set to the same value. For example: `source_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC", `destination_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC". Some examples for the Network data transfer traffic type on the pricing page. * Data moves between different locations on the same continent. `source_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC", `destination_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC". * Data moves between different continents and neither is Australia. `source_continent` = "SOURCE_CONTINENT_NORTH_AMERICA", `destination_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC". * Data moves between different continents and one is Australia. `source_continent` = "SOURCE_CONTINENT_NORTH_AMERICA", `destination_continent` = "SOURCE_CONTINENT_AUSTRALIA". # Usage on Cloud Storage Data Transfer.
- "destinationContinent": "A String", # Where the data is sent to.
- "egressRate": { # An amount of usage over a time frame. # Data transfer usage rate. This usage applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket. The expected units are GiBy/s, By/s, and so on, based on [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "sourceContinent": "A String", # Where the data comes from.
- },
- "cloudStorageWorkload": { # Specifies usage of Cloud Storage resources. # Usage on Google Cloud Storage.
- "dataRetrieval": { # An amount of usage over a time frame. # Data retrieval usage. A retrieval cost applies when data or metadata is read, copied, or rewritten . For example: units such as "GiB/s" or "B/s".
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "dataStored": { # An amount of usage over a time frame. # Data storage usage. The amount of data stored in buckets. For example: units such as GiBy/s or TiBy/mo, based on [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "dualRegion": { # Area contains dual locations. # Specify dual regions.
- "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: "asia1" for dual region.
- },
- "multiRegion": { # Area contains multiple locations. # Specify multi regions.
- "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: "us" for multi-region.
- },
- "operationA": { # An amount of usage over a time frame. # Class A operation usage in Cloud Storage, such as listing the objects in buckets. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as "1/s".
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "operationB": { # An amount of usage over a time frame. # Class B operation usage in Cloud Storage, such as `getIamPolicy`. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as "1/s".
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "region": { # Area contains only one location. # Specify a single region.
- "name": "A String", # The [location name](https://cloud.google.com/storage/docs/locations#available-locations). For example: "us-central1" for region.
- },
- "storageClass": "A String", # The [storage class](https://cloud.google.com/storage/docs/storage-classes#classes) of the data and operation. For example: "standard" and "nearline".
- },
- "computeVmWorkload": { # Specificies usage of a set of identical compute VM instances. # Usage of a Google Compute Engine Virtual Machine.
- "enableConfidentialCompute": True or False, # Defines whether each instance has confidential compute enabled.
- "guestAccelerator": { # Specification of a set of guest accelerators attached to a machine. # Guest accelerators attached to each machine.
- "acceleratorCount": "A String", # The number of the guest accelerator cards exposed to each instance.
- "acceleratorType": "A String", # The type of the guest accelerator cards. For example: "nvidia-tesla-t4".
- },
- "instancesRunning": { # An amount of usage over a time frame. # VM usage. This is specified as a unitless quantity which indicates the number of instances running.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "licenses": [ # Premium image licenses used by each instance.
- "A String",
- ],
- "machineType": { # Specification of machine series, memory, and number of vCPUs. # The machine type.
- "customMachineType": { # Specification of a custom machine type.
- "machineSeries": "A String", # Required. The machine series. Only certain [machine series](https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types) support custom configurations. For example: "n1".
- "memorySizeGb": 3.14, # Required. Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB). Each [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison) has limitations on allowed values for the ratio of memory-to-vCPU count.
- "virtualCpuCount": "A String", # Required. The number of vCPUs. The allowed values depend on the [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison).
- },
- "predefinedMachineType": { # Specification of a predefined machine type.
- "machineType": "A String", # The [machine type](https://cloud.google.com/compute/docs/machine-types). For example: "n1-standard1".
- },
- },
- "persistentDisks": [ # Persistent disks attached to each instance. Must include a boot disk.
- { # Specification of a persistent disk attached to a VM.
- "diskSize": { # An amount of usage over a time frame. # Specifies the size of disk. Must be at least 10 GB.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "diskType": "A String", # The [disk type](https://cloud.google.com/compute/docs/disks#disk-types). For example: "pd-standard".
- "provisionedIops": { # An amount of usage over a time frame. # Indicates how many IOPS to provision for the disk for extreme persistent disks. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "scope": "A String", # The geographic scope of the disk. Defaults to `SCOPE_ZONAL` if not specified.
- },
- ],
- "preemptible": True or False, # Defines whether each instance is preemptible.
- "region": "A String", # The [region](https://cloud.google.com/compute/docs/regions-zones) where the VMs run. For example: "us-central1".
- },
- "name": "A String", # Required. A name for this workload. All workloads in a `CostScenario` must have a unique `name`. Each `name` may be at most 128 characters long.
- "premiumTierEgressWorkload": { # Specify a Premium Tier Internet Data Transfer networking workload. # Usage on Premium Tier Internet Data Transfer.
- "destinationContinent": "A String", # Where the data is sent to.
- "egressRate": { # An amount of usage over a time frame. # Premium Tier Data Transfer usage. The expected units are GiBy/s, By/s, and so on, based on [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data comes from.
- },
- "standardTierEgressWorkload": { # Specify Standard Tier Internet Data Transfer. # Usage on Standard Tier Internet Data Transfer.
- "egressRate": { # An amount of usage over a time frame. # Standard Tier Data Transfer usage. The expected units are GiBy/s, By/s, and so on, based on the [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred from.
- },
- "vmToVmEgressWorkload": { # Specify VM to VM data transfer. # Usage on VM to VM Data Transfer.
- "interRegionEgress": { # Data transfer between two regions.
- "destinationRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred to.
- "egressRate": { # An amount of usage over a time frame. # VM to VM data transfer usage. The expected units such are GiBy/s, By/s, and so on.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- "sourceRegion": "A String", # Which [region](https://cloud.google.com/compute/docs/regions-zones) the data is transferred from.
- },
- "intraRegionEgress": { # Data transfer within the same region. When the source region and destination region are in the same zone, using internal IP addresses, there isn't any charge for data transfer.
- "egressRate": { # An amount of usage over a time frame. # VM to VM data transfer usage. The expected are GiBy/s, By/s, and so on.
- "usageRateTimeline": { # A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours. # A timeline of usage rates over the estimate interval.
- "unit": "A String", # The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = "{" NAME "}" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`
- "usageRateTimelineEntries": [ # The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.
- { # A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.
- "effectiveTime": { # Represents a point in time. # The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "usageRate": 3.14, # The usage rate.
- },
- ],
- },
- },
- },
- },
- },
- ],
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Response for EstimateCostScenarioForBillingAccount
- "costEstimationResult": { # The result of a estimating the costs of a `CostScenario`. # The result of the cost estimation.
- "currencyCode": "A String", # Required. The ISO 4217 currency code for the cost estimate.
- "segmentCostEstimates": [ # Required. Estimated costs for each idealized month of a `CostScenario`.
- { # Workload cost estimates for a single time segment.
- "commitmentCostEstimates": [ # Estimated costs for each commitment.
- { # Estimated cost for a commitment.
- "commitmentTotalCostEstimate": { # An estimated cost. # Total estimated costs for the commitment.
- "creditEstimates": [ # The estimated credits applied.
- { # An estimated credit applied to the costs on a SKU.
- "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "creditDescription": "A String", # The credit description.
- "creditType": "A String", # The credit type.
- },
- ],
- "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- },
- "name": "A String", # The name of the commitment, as specified in the `CostScenario`.
- "skuCostEstimates": [ # Estimated costs for each SKU in the commitment.
- { # Estimated cost for usage on a SKU.
- "costEstimate": { # An estimated cost. # The estimated cost for the usage on this SKU.
- "creditEstimates": [ # The estimated credits applied.
- { # An estimated credit applied to the costs on a SKU.
- "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "creditDescription": "A String", # The credit description.
- "creditType": "A String", # The credit type.
- },
- ],
- "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- },
- "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" More information about the SKU can be found in the `skus` field of the `CostEstimationResult`.
- "usageAmount": 3.14, # The amount of usage on this SKU.
- "usageUnit": "A String", # The unit for the usage on this SKU.
- },
- ],
- },
- ],
- "segmentStartTime": { # Represents a point in time. # Timestamp for the start of the segment.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "segmentTotalCostEstimate": { # An estimated cost. # Total estimated costs for the time segment.
- "creditEstimates": [ # The estimated credits applied.
- { # An estimated credit applied to the costs on a SKU.
- "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "creditDescription": "A String", # The credit description.
- "creditType": "A String", # The credit type.
- },
- ],
- "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- },
- "workloadCostEstimates": [ # Estimated costs for each workload.
- { # Estimated cost for a workload.
- "name": "A String", # The name of the workload, as specified in the `CostScenario`.
- "skuCostEstimates": [ # Estimated costs for each SKU in the workload.
- { # Estimated cost for usage on a SKU.
- "costEstimate": { # An estimated cost. # The estimated cost for the usage on this SKU.
- "creditEstimates": [ # The estimated credits applied.
- { # An estimated credit applied to the costs on a SKU.
- "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "creditDescription": "A String", # The credit description.
- "creditType": "A String", # The credit type.
- },
- ],
- "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- },
- "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" More information about the SKU can be found in the `skus` field of the `CostEstimationResult`.
- "usageAmount": 3.14, # The amount of usage on this SKU.
- "usageUnit": "A String", # The unit for the usage on this SKU.
- },
- ],
- "workloadTotalCostEstimate": { # An estimated cost. # Total estimated costs for the workload.
- "creditEstimates": [ # The estimated credits applied.
- { # An estimated credit applied to the costs on a SKU.
- "creditAmount": { # Represents an amount of money with its currency type. # The estimated credit amount.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "creditDescription": "A String", # The credit description.
- "creditType": "A String", # The credit type.
- },
- ],
- "netCostEstimate": { # Represents an amount of money with its currency type. # The estimated net cost after applying credits.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "preCreditCostEstimate": { # Represents an amount of money with its currency type. # The estimated cost prior to applying credits.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- },
- },
- ],
- },
- ],
- "skus": [ # Required. Information about SKUs used in the estimate.
- { # Information about SKUs appearing in the cost estimate.
- "displayName": "A String", # The display name for the SKU. Example: A2 Instance Core running in Americas
- "prices": [ # A timeline of prices for a SKU in chronological order. Note: The API currently only supports using a constant price for the entire estimation time frame so this list will contain a single value.
- { # The price of a SKU at a point int time.
- "effectiveTime": { # Represents a point in time. # The timestamp within the estimation time frame when the price was set.
- "estimationTimeFrameOffset": "A String", # The point in time, relative to the start of the time frame covered by the cost estimate.
- },
- "priceType": "A String", # The type of price. Possible values: "RATE"
- "rate": { # A SKU price consisting of tiered rates. # A set of tiered rates.
- "tiers": [ # The service tiers.
- { # Pricing details for a service tier.
- "price": { # Represents an amount of money with its currency type. # The price for this tier.
- "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
- "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
- "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
- },
- "startAmount": 3.14, # The magnitude of usage in which the tier interval begins. Example: "From 100 GiBi the price is $1 per byte" implies `start_amount` = 100
- },
- ],
- "unit": "A String", # The SKU's pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this field will show 'By'. The `start_amount` field in each tier will be in this unit.
- "unitCount": 3.14, # The SKU's count for the pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this column will show 1000000.
- },
- },
- ],
- "sku": "A String", # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE"
- },
- ],
- },
-}
-
-