Update Metadata Async

Updates the reseller metadata attached to a batch of devices

12 variables
11 variables

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

Input

This building block consumes 12 input parameters

  = Parameter name
  = Format

partnerId INTEGER Required

Required. The reseller partner ID

updates[] OBJECT

Identifies metdata updates to one device

updates[].deviceIdentifier OBJECT

Encapsulates hardware and product IDs to identify a manufactured device. To understand requirements on identifier sets, read Identifiers

updates[].deviceIdentifier.meid STRING

The device’s MEID number

updates[].deviceIdentifier.manufacturer 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

updates[].deviceIdentifier.serialNumber STRING

The manufacturer's serial number for the device. This value might not be unique across different device models

updates[].deviceIdentifier.model 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

updates[].deviceIdentifier.imei STRING

The device’s IMEI number. Validated on input

updates[].deviceMetadata OBJECT

Metadata entries that can be attached to a Device. To learn more, read Device metadata

updates[].deviceMetadata.entries OBJECT

Metadata entries recorded as key-value pairs

updates[].deviceMetadata.entries.customKey.value STRING Required

Metadata entries recorded as key-value pairs

updates[].deviceId INTEGER

Device ID of the device

Output

This building block provides 11 output parameters

  = Parameter name
  = Format

response OBJECT

This field will contain a DevicesLongRunningOperationResponse object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync

response.customKey.value ANY

This field will contain a DevicesLongRunningOperationResponse object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync

name 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}

error OBJECT

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. 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

error.code INTEGER

The status code, which should be an enum value of google.rpc.Code

error.message 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

error.details[] OBJECT

error.details[].customKey.value ANY

metadata OBJECT

This field will contain a DevicesLongRunningOperationMetadata object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync

metadata.customKey.value ANY

This field will contain a DevicesLongRunningOperationMetadata object if the operation is created by claimAsync, unclaimAsync, or updateMetadataAsync

done BOOLEAN

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