Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.

Unclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again.

Method Details

applyConfiguration(parent, body=None, x__xgafv=None)

Args:
parent: string, Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for customer to assign a configuration to device.
"configuration": "A String", # Required. The configuration applied to the device in the format `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
"device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device the configuration is applied to. There are custom validations in ApplyConfigurationRequestValidator
"deviceId": "A String", # The 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). # The hardware IDs 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 [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. 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:

{ # 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); }
}

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets the details of a device.

Args:
  name: string, Required. The device to get. An API resource name in the format `customers/[CUSTOMER_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.
    "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. 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.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists a customer's devices.

Args:
  parent: string, Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`. (required)
  pageSize: string, The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
  pageToken: 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 message of customer's liting 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.
        "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. 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.
}

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.

removeConfiguration(parent, body=None, x__xgafv=None)

Removes a configuration from device.

Args:
parent: string, Required. The customer managing the device in the format `customers/[CUSTOMER_ID]`. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for customer to remove the configuration from device.
"device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device to remove the configuration from. There are custom validations in RemoveConfigurationRequestValidator
"deviceId": "A String", # The 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). # The hardware IDs 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 [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. 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:

unclaim(parent, body=None, x__xgafv=None)

Unclaims a device from a customer and removes it from zero-touch enrollment. After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again.

Args:
  parent: string, Required. The customer managing the device. An API resource name in the format `customers/[CUSTOMER_ID]`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for customer to unclaim a device.
  "device": { # A `DeviceReference` is an API abstraction that lets you supply a _device_ argument to a method using one of the following identifier types: * A numeric API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to the manufactured device. Methods that operate on devices take a `DeviceReference` as a parameter type because it's more flexible for the caller. To learn more about device identifiers, read [Identifiers](https://developers.google.com/zero-touch/guides/identifiers). # Required. The device to unclaim. There are custom validations in UnclaimDeviceRequestValidator.
    "deviceId": "A String", # The 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). # The hardware IDs 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 [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. 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:

    { # 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); }
}

Android Device Provisioning Partner API . customers . devices

Instance Methods

Method Details