claim(partnerId, body=None, x__xgafv=None)
Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.
claimAsync(partnerId, body=None, x__xgafv=None)
Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
Close httplib2 connections.
findByIdentifier(partnerId, body=None, x__xgafv=None)
Finds devices by hardware identifiers, such as IMEI.
Retrieves the next page of results.
findByOwner(partnerId, body=None, x__xgafv=None)
Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from other resellers don't appear in the results.
Retrieves the next page of results.
Gets a device.
getSimLockState(partnerId, body=None, x__xgafv=None)
Gets a device's SIM lock state.
metadata(metadataOwnerId, deviceId, body=None, x__xgafv=None)
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.
unclaimAsync(partnerId, body=None, x__xgafv=None)
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). Android Devices only.
claim(partnerId, body=None, x__xgafv=None)
Claims a device for a customer and adds it to zero-touch enrollment. If the device is already claimed by another customer, the call returns an error.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
body: object, The request body.
The object takes the form of:
{ # Request message to claim a device on behalf of a customer.
"configurationId": "A String", # Optional. The ID of the configuration applied to the device section.
"customerId": "A String", # The ID of the customer for whom the device is being claimed.
"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. Required. The device identifier of the device to claim.
"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.
"imei2": "A String", # The device’s second IMEI number.
"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.
"meid2": "A String", # The device’s second MEID number.
"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#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). # Optional. The metadata to attach to the device.
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
"googleWorkspaceCustomerId": "A String", # The Google Workspace customer ID.
"preProvisioningToken": "A String", # Optional. Must and can only be set for Chrome OS devices.
"sectionType": "A String", # Required. The section type of the device's provisioning record.
"simlockProfileId": "A String", # Optional. Must and can only be set when DeviceProvisioningSectionType is SECTION_TYPE_SIM_LOCK. The unique identifier of the SimLock profile.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message containing device id of the claim.
"deviceId": "A String", # The device ID of the claimed device.
"deviceName": "A String", # The resource name of the device in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
}
claimAsync(partnerId, body=None, x__xgafv=None)
Claims a batch of devices for a customer asynchronously. Adds the devices to zero-touch enrollment. To learn more, read [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
body: object, The request body.
The object takes the form of:
{ # Request to claim devices asynchronously in batch. Claiming a device adds the device to zero-touch enrollment and shows the device in the customer's view of the portal.
"claims": [ # Required. A list of device claims.
{ # Identifies one claim request.
"configurationId": "A String", # Optional. The ID of the configuration applied to the device section.
"customerId": "A String", # The ID of the customer for whom the device is being claimed.
"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. 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.
"imei2": "A String", # The device’s second IMEI number.
"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.
"meid2": "A String", # The device’s second MEID number.
"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#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 attach to the device at claim.
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
"googleWorkspaceCustomerId": "A String", # The Google Workspace customer ID.
"preProvisioningToken": "A String", # Optional. Must and can only be set for Chrome OS devices.
"sectionType": "A String", # Required. The section type of the device's provisioning record.
"simlockProfileId": "A String", # Optional. Must and can only be set when DeviceProvisioningSectionType is SECTION_TYPE_SIM_LOCK. The unique identifier of the SimLock profile.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
close()
Close httplib2 connections.
findByIdentifier(partnerId, body=None, x__xgafv=None)
Finds devices by hardware identifiers, such as IMEI.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
body: object, The request body.
The object takes the form of:
{ # Request to find devices.
"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. Required. The device identifier to search for.
"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.
"imei2": "A String", # The device’s second IMEI number.
"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.
"meid2": "A String", # The device’s second MEID number.
"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#identify_compatible).
"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
"limit": "A String", # Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
"pageToken": "A String", # A token specifying which result page to return.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing found devices.
"devices": [ # Found devices.
{ # An Android or Chrome OS device registered for zero-touch enrollment.
"claims": [ # Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
{ # A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
"additionalService": "A String", # The Additional service registered for the device.
"googleWorkspaceCustomerId": "A String", # The ID of the Google Workspace account that owns the Chrome OS device.
"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
"resellerId": "A String", # The ID of the reseller that claimed the device.
"sectionType": "A String", # Output only. The type of claim made on the device.
"vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
"vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
},
],
"configuration": "A String", # Not available to resellers.
"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
"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). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
"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.
"imei2": "A String", # The device’s second IMEI number.
"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.
"meid2": "A String", # The device’s second MEID number.
"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#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). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
"name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
},
],
"nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further results are available.
"totalSize": 42, # The total count of items in the list irrespective of pagination.
}
findByIdentifier_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.
findByOwner(partnerId, body=None, x__xgafv=None)
Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from other resellers don't appear in the results.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
body: object, The request body.
The object takes the form of:
{ # Request to find devices by customers.
"customerId": [ # The list of customer IDs to search for.
"A String",
],
"googleWorkspaceCustomerId": [ # The list of IDs of Google Workspace accounts to search for.
"A String",
],
"limit": "A String", # Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
"pageToken": "A String", # A token specifying which result page to return.
"sectionType": "A String", # Required. The section type of the device's provisioning record.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing found devices.
"devices": [ # The customer's devices.
{ # An Android or Chrome OS device registered for zero-touch enrollment.
"claims": [ # Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
{ # A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
"additionalService": "A String", # The Additional service registered for the device.
"googleWorkspaceCustomerId": "A String", # The ID of the Google Workspace account that owns the Chrome OS device.
"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
"resellerId": "A String", # The ID of the reseller that claimed the device.
"sectionType": "A String", # Output only. The type of claim made on the device.
"vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
"vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
},
],
"configuration": "A String", # Not available to resellers.
"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
"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). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
"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.
"imei2": "A String", # The device’s second IMEI number.
"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.
"meid2": "A String", # The device’s second MEID number.
"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#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). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
"name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
},
],
"nextPageToken": "A String", # A token used to access the next page of results. Omitted if no further results are available.
"totalSize": 42, # The total count of items in the list irrespective of pagination.
}
findByOwner_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.
get(name, x__xgafv=None)
Gets a device.
Args:
name: string, Required. The device API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Android or Chrome OS device registered for zero-touch enrollment.
"claims": [ # Output only. The provisioning claims for a device. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the device from zero-touch enrollment.
{ # A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
"additionalService": "A String", # The Additional service registered for the device.
"googleWorkspaceCustomerId": "A String", # The ID of the Google Workspace account that owns the Chrome OS device.
"ownerCompanyId": "A String", # The ID of the Customer that purchased the device.
"resellerId": "A String", # The ID of the reseller that claimed the device.
"sectionType": "A String", # Output only. The type of claim made on the device.
"vacationModeExpireTime": "A String", # The timestamp when the device will exit ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
"vacationModeStartTime": "A String", # The timestamp when the device was put into ‘vacation mode’. This value is present iff the device is in 'vacation mode'.
},
],
"configuration": "A String", # Not available to resellers.
"deviceId": "A String", # Output only. The ID of the device. Assigned by the server.
"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). # The hardware IDs that identify a manufactured device. To learn more, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
"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.
"imei2": "A String", # The device’s second IMEI number.
"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.
"meid2": "A String", # The device’s second MEID number.
"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#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). # The metadata attached to the device. Structured as key-value pairs. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
"name": "A String", # Output only. The API resource name in the format `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
}
getSimLockState(partnerId, body=None, x__xgafv=None)
Gets a device's SIM lock state.
Args:
partnerId: string, Required. The ID of the partner. (required)
body: object, The request body.
The object takes the form of:
{ # Request to get a device's SIM lock status.
"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. Required. The device identifier to search for.
"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.
"imei2": "A String", # The device’s second IMEI number.
"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.
"meid2": "A String", # The device’s second MEID number.
"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#identify_compatible).
"serialNumber": "A String", # The manufacturer's serial number for the device. This value might not be unique across different device models.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing a device's SimLock state.
"simLockState": "A String",
}
metadata(metadataOwnerId, deviceId, body=None, x__xgafv=None)
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)
deviceId: string, Required. The ID of the device. (required)
body: object, The request body.
The object takes the form of:
{ # Request to set metadata for a device.
"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 attach to the device.
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata entries that can be attached to a `Device`. To learn more, read [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
}
unclaim(partnerId, body=None, x__xgafv=None)
Unclaims a device from a customer and removes it from zero-touch enrollment.
Args:
partnerId: string, Required. The ID of the reseller partner. (required)
body: object, The request body.
The object takes the form of:
{ # 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.
"imei2": "A String", # The device’s second IMEI number.
"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.
"meid2": "A String", # The device’s second MEID number.
"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#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.
"vacationModeDays": 42, # The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
"vacationModeExpireTime": "A String", # The expiration time of the vacation unlock.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
unclaimAsync(partnerId, body=None, x__xgafv=None)
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).
Args:
partnerId: string, Required. The reseller partner ID. (required)
body: object, The request body.
The object takes the form of:
{ # Request to unclaim devices asynchronously in batch.
"unclaims": [ # Required. The list of devices to unclaim.
{ # 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.
"imei2": "A String", # The device’s second IMEI number.
"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.
"meid2": "A String", # The device’s second MEID number.
"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#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.
"vacationModeDays": 42, # Optional. The duration of the vacation unlock starting from when the request is processed. (1 day is treated as 24 hours)
"vacationModeExpireTime": "A String", # Optional. The expiration time of the vacation unlock.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
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). Android Devices only.
Args:
partnerId: string, Required. The reseller partner ID. (required)
body: object, The request body.
The object takes the form of:
{ # Request to update device metadata in batch.
"updates": [ # Required. The list of metadata updates.
{ # 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.
"imei2": "A String", # The device’s second IMEI number.
"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.
"meid2": "A String", # The device’s second MEID number.
"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#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.
"entries": { # Metadata entries recorded as key-value pairs.
"a_key": "A String",
},
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}