Метаданные устройства

Реселлер может связать с каждым устройством метаданные, например номер телефона или заказа на покупку. Вы можете связать метаданные, вызвав API или загрузив CSV-файл на портале автоматической настройки. В таблице 1 показано, кто может связывать и просматривать метаданные.

Таблица 1. Разрешения на доступ к метаданным

Задача	Реселлеры	Клиенты
Как связать метаданные с помощью вызова API
Как связать метаданные, загрузив CSV-файл на портал автоматической настройки
Просмотр метаданных устройств в результатах вызовов API
Как посмотреть метаданные устройства на портале автоматической настройки

Назначение метаданных

Чтобы связать метаданные с каждым устройством, вызовите метод partners.devices.metadata. Вы можете добавить номера телефонов и заказов для устройств Android, используя ключи из таблицы 2 ниже.

Таблица 2. Ключи метаданных для устройств Android

Данные	Ключ	Тип значения	Пример
Номер телефона	phonenumber	Строка	[phone]
Номер заказа	ordernumber	Строка	GOOG#123/ABC-123456

Оба значения метаданных представляют собой строки в свободной форме, поэтому вы можете использовать формат, который подходит для вашей организации.

Для устройств с ChromeOS можно использовать ключи из таблицы 3 ниже.

Таблица 3. Ключи метаданных для устройств с ChromeOS

Данные	Ключ	Тип значения	Пример
Номер заказа	ordernumber	Строка	GOOG#123/ABC-123456
Идентификатор объекта	annotatedassetid	Строка	CORP-001234
Местоположение	annotatedlocation	Строка	Нью-Йорк
Назначено пользователю	annotateduser	Строка	Иван Петров

Чтобы назначить метаданные при создании устройств, включите их при вызове 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...