裝置中繼資料

經銷商可以將中繼資料 (例如電話號碼或訂購單號碼) 與每部裝置建立關聯。您可以呼叫 API 或在零接觸入口網站中上傳 CSV 檔案，藉此與中繼資料建立關聯。表 1 顯示可以建立關聯及查看中繼資料的人員：

表 1. 中繼資料權限

工作	經銷商	客戶
呼叫 API 以連結中繼資料
將 CSV 檔案上傳至零接觸入口網站，為中繼資料建立關聯
查看 API 呼叫結果中的裝置中繼資料
前往零接觸入口網站查看裝置中繼資料

指派中繼資料

如要將中繼資料與每部裝置建立關聯，請呼叫 partners.devices.metadata 方法。您可以使用下表 2 中的金鑰，為 Android 裝置新增電話和訂單號碼：

表 2. Android 裝置的中繼資料金鑰

資料	鍵	值類型	範例
電話號碼	phonenumber	字串	[phone]
訂單號碼	ordernumber	字串	GOOG#123/ABC-123456

這兩個中繼資料值都是任意形式的字串，因此您可以使用適合貴機構的格式。

針對 ChromeOS 裝置，您可以使用下表 3 中的金鑰：

表 3. ChromeOS 裝置的中繼資料金鑰

資料	鍵	值類型	範例
訂單號碼	ordernumber	字串	GOOG#123/ABC-123456

如要在建立裝置時指派中繼資料，請在呼叫 claimAsync 時加入中繼資料。以下範例顯示如何為現有裝置 TARGET_DEVICE_ID 設定電話號碼和訂單號碼：

Java

// Allowed metadata dictionary keys.
private static String METADATA_KEY_PHONE_NUMBER = "phonenumber";
private static String METADATA_KEY_ORDER_NUMBER = "ordernumber";

// ...
// Create the metadata record with the values.
DeviceMetadata metadata = new DeviceMetadata();
Map<String,String> entries = new HashMap<String, String>();
entries.put(METADATA_KEY_ORDER_NUMBER, "GOOG123/ABC-#123456");
entries.put(METADATA_KEY_PHONE_NUMBER, "[phone]");
metadata.setEntries(entries);

// Set the metadata values on the target device.
UpdateDeviceMetadataRequest body = new UpdateDeviceMetadataRequest();
body.setDeviceMetadata(metadata);

DeviceMetadata response = service
        .partners()
        .devices()
        .metadata(PARTNER_ID, targetDeviceId, body)
        .execute();

.NET

// Allowed metadata dictionary keys.
private static string MetadataKeyPhoneNumber = "phonenumber";
private static string MetadataKeyOrderNumber = "ordernumber";

// ...
// Create the metadata record with the values.
DeviceMetadata metadata = new DeviceMetadata
{
    Entries = new Dictionary<string, string> {
        {MetadataKeyOrderNumber, "GOOG123/ABC-#123456"},
        {MetadataKeyPhoneNumber, "[phone]"}
    }
};

// Set the metadata values on the target device.
UpdateDeviceMetadataRequest body = new UpdateDeviceMetadataRequest
{
    DeviceMetadata = metadata
};
var request = service.Partners.Devices.Metadata(body, PartnerId, targetDeviceId);
var results = request.Execute();

Python

# Allowed metadata dictionary keys.
METADATA_KEY_ENTRIES = "entries";
METADATA_KEY_PHONE_NUMBER = "phonenumber";
METADATA_KEY_ORDER_NUMBER = "ordernumber";

# ...
# Create the record with values.
new_metadata = {METADATA_KEY_ENTRIES:{ \
    METADATA_KEY_PHONE_NUMBER:'[phone]', \
    METADATA_KEY_ORDER_NUMBER:'GOOG123/ABC-#123456'}}

# Set the metadata values on the target device.
response = service.partners().devices().metadata(
    metadataOwnerId=PARTNER_ID,
    deviceId=target_device_id,
    body={'deviceMetadata':new_metadata}).execute()

中繼資料引數會取代相同鍵的現有中繼資料值。

刪除中繼資料

您可以將中繼資料從裝置中刪除。針對要刪除的中繼資料值傳遞空白字串。以下範例說明如何刪除電話號碼：

Java

// Create the metadata record with the values.
DeviceMetadata metadata = new DeviceMetadata();
Map<String,String> entries = new HashMap<String, String>();
entries.put(METADATA_KEY_PHONE_NUMBER, "");
metadata.setEntries(entries);

// Call partners().devices().metadata() to remove the phone metadata from the device...

.NET

// Create the metadata record with empty values.
DeviceMetadata metadata = new DeviceMetadata
{
    Entries = new Dictionary<string, string> {
        {MetadataKeyPhoneNumber, ""}
    }
};

// Call Partners.Devices.Metadata to remove the phone metadata from the device...

Python

# Create the metadata record with empty values.
metadata_to_remove = {METADATA_KEY_ENTRIES: {METADATA_KEY_PHONE_NUMBER:''}}

# Call partners().devices().metadata() to remove the phone number
# metadata from the device...