diff --git a/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html b/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html index c38bbd4f4fe..2f08fc9aa18 100644 --- a/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html +++ b/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html @@ -110,10 +110,12 @@
Gets a device.
metadata(metadataOwnerId, deviceId, body=None, x__xgafv=None)
Updates reseller metadata associated with the device.
+Updates reseller metadata associated with the device. Android devices only.
unclaim(partnerId, body=None, x__xgafv=None)
Unclaims a device from a customer and removes it from zero-touch enrollment.
@@ -109,7 +109,7 @@Unclaims a batch of devices for a customer asynchronously. Removes the devices from zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
updateMetadataAsync(partnerId, body=None, x__xgafv=None)
Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
+Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). Android Devices only.
claim(partnerId, body=None, x__xgafv=None)
@@ -121,12 +121,14 @@ metadata(metadataOwnerId, deviceId, body=None, x__xgafv=None)
- Updates reseller metadata associated with the device. +Updates reseller metadata associated with the device. Android devices only. Args: metadataOwnerId: string, Required. The owner of the newly set metadata. Set this to the partner ID. (required) @@ -456,10 +478,12 @@Method Details
{ # Request message to unclaim a device. "deviceId": "A String", # Required. The device ID returned by `ClaimDevice`. "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device identifier you used when you claimed this device. + "chromeOsAttestedDeviceId": "A String", # An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices. + "deviceType": "A String", # The type of the device "imei": "A String", # The device’s IMEI number. Validated on input. - "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). + "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). "meid": "A String", # The device’s MEID number. - "model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names). + "model": "A String", # The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175?hl=en#identify_compatible). "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models. }, "sectionType": "A String", # Required. The section type of the device's provisioning record. @@ -493,10 +517,12 @@Method Details
{ # Identifies one unclaim request. "deviceId": "A String", # Required. Device ID of the device. "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. Device identifier of the device. + "chromeOsAttestedDeviceId": "A String", # An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices. + "deviceType": "A String", # The type of the device "imei": "A String", # The device’s IMEI number. Validated on input. - "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). + "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). "meid": "A String", # The device’s MEID number. - "model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names). + "model": "A String", # The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175?hl=en#identify_compatible). "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models. }, "sectionType": "A String", # Required. The section type of the device's provisioning record. @@ -537,7 +563,7 @@Method Details
updateMetadataAsync(partnerId, body=None, x__xgafv=None)
-Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). +Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations). Android Devices only. Args: partnerId: string, Required. The reseller partner ID. (required) @@ -549,10 +575,12 @@Method Details
{ # Identifies metadata updates to one device. "deviceId": "A String", # Required. Device ID of the device. "deviceIdentifier": { # Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. Device identifier. + "chromeOsAttestedDeviceId": "A String", # An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices. + "deviceType": "A String", # The type of the device "imei": "A String", # The device’s IMEI number. Validated on input. - "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). + "manufacturer": "A String", # The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). "meid": "A String", # The device’s MEID number. - "model": "A String", # The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names). + "model": "A String", # The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175?hl=en#identify_compatible). "serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models. }, "deviceMetadata": { # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata). # Required. The metadata to update. diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.customers.html b/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.customers.html index edceed84947..701720ecd79 100644 --- a/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.customers.html +++ b/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.customers.html @@ -113,6 +113,12 @@Method Details
], "companyId": "A String", # Output only. The ID of the company. Assigned by the server. "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal. + "googleWorkspaceAccount": { # A Google Workspace customer. # Output only. The Google Workspace account associated with this customer. Only used for customer Companies. + "customerId": "A String", # Required. The customer ID. + "preProvisioningTokens": [ # Output only. The pre-provisioning tokens previously used to claim devices. + "A String", + ], + }, "languageCode": "A String", # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi) "name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. "ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.html b/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.html index 8a9e9cc68ea..681eeb30c88 100644 --- a/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.html +++ b/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.html @@ -120,6 +120,12 @@Method Details
], "companyId": "A String", # Output only. The ID of the company. Assigned by the server. "companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal. + "googleWorkspaceAccount": { # A Google Workspace customer. # Output only. The Google Workspace account associated with this customer. Only used for customer Companies. + "customerId": "A String", # Required. The customer ID. + "preProvisioningTokens": [ # Output only. The pre-provisioning tokens previously used to claim devices. + "A String", + ], + }, "languageCode": "A String", # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi) "name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. "ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json index c619c8567b5..e48f5cc5a13 100644 --- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json @@ -632,7 +632,7 @@ } }, "metadata": { - "description": "Updates reseller metadata associated with the device.", + "description": "Updates reseller metadata associated with the device. Android devices only.", "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata", "httpMethod": "POST", "id": "androiddeviceprovisioning.partners.devices.metadata", @@ -719,7 +719,7 @@ } }, "updateMetadataAsync": { - "description": "Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long\u2011running batch operations](/zero-touch/guides/how-it-works#operations).", + "description": "Updates the reseller metadata attached to a batch of devices. This method updates devices asynchronously and returns an `Operation` that can be used to track progress. Read [Long\u2011running batch operations](/zero-touch/guides/how-it-works#operations). Android Devices only.", "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync", "httpMethod": "POST", "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync", @@ -825,7 +825,7 @@ } } }, - "revision": "20221012", + "revision": "20221023", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { @@ -833,7 +833,7 @@ "id": "ClaimDeviceRequest", "properties": { "customerId": { - "description": "Required. The ID of the customer for whom the device is being claimed.", + "description": "The ID of the customer for whom the device is being claimed.", "format": "int64", "type": "string" }, @@ -845,6 +845,14 @@ "$ref": "DeviceMetadata", "description": "Optional. The metadata to attach to the device." }, + "googleWorkspaceCustomerId": { + "description": "The Google Workspace customer ID.", + "type": "string" + }, + "preProvisioningToken": { + "description": "Optional. Must and can only be set for Chrome OS devices.", + "type": "string" + }, "sectionType": { "description": "Required. The section type of the device's provisioning record.", "enum": [ @@ -913,6 +921,11 @@ "description": "Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.", "type": "string" }, + "googleWorkspaceAccount": { + "$ref": "GoogleWorkspaceAccount", + "description": "Output only. The Google Workspace account associated with this customer. Only used for customer Companies.", + "readOnly": true + }, "languageCode": { "description": "Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)", "type": "string" @@ -1116,7 +1129,7 @@ "type": "object" }, "Device": { - "description": "An Android device registered for zero-touch enrollment.", + "description": "An Android or Chrome OS device registered for zero-touch enrollment.", "id": "Device", "properties": { "claims": { @@ -1169,8 +1182,12 @@ ], "type": "string" }, + "googleWorkspaceCustomerId": { + "description": "The ID of the Google Workspace account that owns the Chrome OS device.", + "type": "string" + }, "ownerCompanyId": { - "description": "The ID of the Customer that purchased the device.", + "description": "The ID of the Customer that purchased the Android device.", "format": "int64", "type": "string" }, @@ -1211,12 +1228,30 @@ "description": "Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).", "id": "DeviceIdentifier", "properties": { + "chromeOsAttestedDeviceId": { + "description": "An identifier provided by OEMs, carried through the production and sales process. Only applicable to Chrome OS devices.", + "type": "string" + }, + "deviceType": { + "description": "The type of the device", + "enum": [ + "DEVICE_TYPE_UNSPECIFIED", + "DEVICE_TYPE_ANDROID", + "DEVICE_TYPE_CHROME_OS" + ], + "enumDescriptions": [ + "Device type is not specified.", + "Android device", + "Chrome OS device" + ], + "type": "string" + }, "imei": { "description": "The device\u2019s IMEI number. Validated on input.", "type": "string" }, "manufacturer": { - "description": "The device manufacturer\u2019s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).", + "description": "The device manufacturer\u2019s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).", "type": "string" }, "meid": { @@ -1224,7 +1259,7 @@ "type": "string" }, "model": { - "description": "The device model's name. Matches the device's built-in value returned from `android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/resources/manufacturer-names#model-names).", + "description": "The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175?hl=en#identify_compatible).", "type": "string" }, "serialNumber": { @@ -1290,7 +1325,7 @@ "type": "string" }, "progress": { - "description": "The processing progress of the operation. Measured as a number from 0 to 100. A value of 10O doesnt always mean the operation completed\u2014check for the inclusion of a `done` field.", + "description": "The processing progress of the operation. Measured as a number from 0 to 100. A value of 10O doesn't always mean the operation completed\u2014check for the inclusion of a `done` field.", "format": "int32", "type": "integer" } @@ -1392,13 +1427,20 @@ "id": "FindDevicesByOwnerRequest", "properties": { "customerId": { - "description": "Required. The list of customer IDs to search for.", + "description": "The list of customer IDs to search for.", "items": { "format": "int64", "type": "string" }, "type": "array" }, + "googleWorkspaceCustomerId": { + "description": "The list of IDs of Google Workspace accounts to search for.", + "items": { + "type": "string" + }, + "type": "array" + }, "limit": { "description": "Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.", "format": "int64", @@ -1448,6 +1490,25 @@ }, "type": "object" }, + "GoogleWorkspaceAccount": { + "description": "A Google Workspace customer.", + "id": "GoogleWorkspaceAccount", + "properties": { + "customerId": { + "description": "Required. The customer ID.", + "type": "string" + }, + "preProvisioningTokens": { + "description": "Output only. The pre-provisioning tokens previously used to claim devices.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "ListCustomersResponse": { "description": "Response message of all customers related to this partner.", "id": "ListCustomersResponse", @@ -1580,7 +1641,7 @@ "id": "PartnerClaim", "properties": { "customerId": { - "description": "Required. The ID of the customer for whom the device is being claimed.", + "description": "The ID of the customer for whom the device is being claimed.", "format": "int64", "type": "string" }, @@ -1592,6 +1653,14 @@ "$ref": "DeviceMetadata", "description": "Required. The metadata to attach to the device at claim." }, + "googleWorkspaceCustomerId": { + "description": "The Google Workspace customer ID.", + "type": "string" + }, + "preProvisioningToken": { + "description": "Optional. Must and can only be set for Chrome OS devices.", + "type": "string" + }, "sectionType": { "description": "Required. The section type of the device's provisioning record.", "enum": [ @@ -1654,7 +1723,7 @@ "id": "PerDeviceStatusInBatch", "properties": { "deviceId": { - "description": "If processing succeeds, the device ID of the device.", + "description": "If processing succeeds, the device ID of the Android device.", "format": "int64", "type": "string" }, @@ -1676,7 +1745,9 @@ "SINGLE_DEVICE_STATUS_PERMISSION_DENIED", "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER", "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE", - "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS" + "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS", + "SINGLE_DEVICE_STATUS_INVALID_TOKEN", + "SINGLE_DEVICE_STATUS_REVOKED_TOKEN" ], "enumDescriptions": [ "Invalid code. Shouldn't be used.", @@ -1686,7 +1757,9 @@ "Permission denied.", "Invalid device identifier.", "Invalid section type.", - "This section is claimed by another company." + "This section is claimed by another company.", + "Invalid pre-provisioning token.", + "Revoked pre-provisioning token." ], "type": "string" }