Modelo de dispositivo y esquemas de instancia
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Modelo del dispositivo
Los campos de esta sección definen el modelo de dispositivo.
Los campos de modelo de dispositivo solo pueden contener letras, números y los siguientes elementos:
símbolos: punto (.), guion (-), guion bajo (_), espacio ( ) y signo más
(+). El primer carácter de un campo debe ser una letra o un número.
{
"project_id": "my-devices-project",
"device_model_id": "my-devices-project-prototype-light-v1",
"manifest": {
"manufacturer": "Assistant SDK developer",
"product_name": "Assistant SDK light",
"device_description": "Assistant SDK light device"
},
"device_type": "action.devices.types.LIGHT",
"traits": ["action.devices.traits.OnOff"]
}
.
.
{
"project_id": string,
"device_model_id": string,
"manifest": {
"manufacturer": string,
"product_name": string,
"device_description": string
},
"device_type": string,
"traits": [ string ]
}
project_id: (cadena) obligatoria. ID del proyecto de Google Cloud Platform
del proyecto de la Consola de Actions para asociarlo con este modelo de dispositivo.
Un proyecto puede contener varios modelos de dispositivos.device_model_id: (cadena) obligatoria. Identificador único a nivel global
para este modelo de dispositivo: usa el project_id como
un prefijo para ayudar a evitar colisiones en el rango de todos los proyectos. Usado
en las métricas y durante el registro de dispositivos.manifest: (objeto(manifiesto)): Obligatorio. Metadatos que describen
el modelo y el fabricante del dispositivo. Es posible que se muestre en el SDK (próximamente).
la consola de Cloud, los paneles de métricas
y otras interfaces visuales relacionadas.
manifest.manufacturer: (cadena) obligatoria. Nombre del dispositivo
fabricante.manifest.product_name: (cadena) obligatoria. Para el consumidor
Es el nombre del producto correspondiente a este modelo de dispositivo.manifest.device_description: (cadena) opcional. Descripción
de este modelo de dispositivo.
device_type: (cadena) obligatoria. Es el tipo de hardware del dispositivo. Seleccionar
de lo siguiente:
action.devices.types.CAMERAaction.devices.types.DISHWASHERaction.devices.types.DRYERaction.devices.types.LIGHTaction.devices.types.OUTLETaction.devices.types.PHONEaction.devices.types.REFRIGERATORaction.devices.types.SCENEaction.devices.types.SOUNDBARaction.devices.types.SPEAKERaction.devices.types.SWITCHaction.devices.types.THERMOSTATaction.devices.types.TVaction.devices.types.VACUUMaction.devices.types.WASHER
traits: (Array<String>) Opcional. Lista de rasgos del dispositivo
admite. Los rasgos incluyen los comandos, atributos y estados de la
dispositivo. No es necesario definir un paquete de acción
para usar
características integradas.
Instancia de dispositivo
La instancia del dispositivo se define en los campos de esta sección.
Los campos de instancias de dispositivos deben comenzar con una letra o un número. El ID de dispositivo
solo puede contener letras, números y los siguientes símbolos: punto (.),
guion (-), guion bajo (_) y signo más (+). El sobrenombre del dispositivo solo puede
contener números, letras y el símbolo de espacio ( ).
{
"id": "my_led_1",
"model_id": "my-devices-project-prototype-light-v1",
"nickname": "My Assistant Light",
"client_type": "SDK_LIBRARY"
}
.
.
{
"id": string,
"model_id": string,
"nickname": string,
"client_type": string
}
id: (cadena) obligatoria. Es el identificador del dispositivo de prueba. Debe ser
únicos en todos los dispositivos registrados bajo la misma cuenta de Google
Proyecto de desarrollador.model_id: (cadena) obligatoria. Identificador del modelo del dispositivo imprescindible
ser la misma que la device_model_id
asociado con este dispositivo de prueba. El modelo del dispositivo debe estar registrado
anteriormente.nickname: (cadena) opcional. Es el sobrenombre del dispositivo. Este nombre
para referirse al dispositivo en interfaces visuales como la
Configuración de Asistente.client_type: (cadena) obligatoria. El tipo de dispositivo del cliente. Debe ser
cualquiera de las siguientes: SDK_SERVICE o SDK_LIBRARY.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[[["\u003cp\u003eDevice models are defined with a unique ID, manufacturer details, device type, and supported traits, enabling the Google Assistant to understand and interact with the device.\u003c/p\u003e\n"],["\u003cp\u003eDevice instances represent individual devices, linking to a specific model with a unique ID, an optional nickname, and client type (SDK service or library).\u003c/p\u003e\n"],["\u003cp\u003eDevice model and instance IDs can contain letters, numbers, and specific symbols, ensuring proper formatting for identification within the Google ecosystem.\u003c/p\u003e\n"],["\u003cp\u003eA device model's \u003ccode\u003etraits\u003c/code\u003e field determines its functionalities and capabilities, allowing developers to define its behavior and interaction with the Google Assistant.\u003c/p\u003e\n"],["\u003cp\u003eDevice instances are registered using their unique ID and associated with a pre-registered device model, enabling them to be recognized and controlled by the Google Assistant.\u003c/p\u003e\n"]]],["Device models are defined by fields such as `project_id`, `device_model_id`, `manifest`, `device_type`, and `traits`. Fields can contain letters, numbers, and specific symbols. `Manifest` describes the device's manufacturer, product name, and description. Device instances have fields like `id`, `model_id`, `nickname`, and `client_type`, which specify unique identifiers, associated device models, nicknames, and client types. The device `id` and `model_id` are required.\n"],null,["# Device Model and Instance Schemas\n\nDevice model\n------------\n\nThe device model is defined by the fields in this section.\n\n\nDevice model fields can only contain letters, numbers, and the following\nsymbols: period (.), hyphen (-), underscore (_), space ( ) and plus\n(+). The first character of a field must be a letter or number.\nExample \n\n```carbon\n{\n \"project_id\": \"my-devices-project\",\n \"device_model_id\": \"my-devices-project-prototype-light-v1\",\n \"manifest\": {\n \"manufacturer\": \"Assistant SDK developer\",\n \"product_name\": \"Assistant SDK light\",\n \"device_description\": \"Assistant SDK light device\"\n },\n \"device_type\": \"action.devices.types.LIGHT\",\n \"traits\": [\"action.devices.traits.OnOff\"]\n}\n```\nSchema \n\n```carbon\n{\n \"project_id\": string,\n \"device_model_id\": string,\n \"manifest\": {\n \"manufacturer\": string,\n \"product_name\": string,\n \"device_description\": string\n },\n \"device_type\": string,\n \"traits\": [ string ]\n}\n```\n\n- **`project_id`:** (String) Required. Google Cloud Platform project [ID](https://support.google.com/cloud/answer/6158840) of the Actions Console project to associate with this device model. A project can contain multiple device models.\n- **`device_model_id`:** (String) Required. Globally-unique identifier for this device model; use the `project_id` as a prefix to help avoid collisions over the range of all projects. Used in metrics and during device registration.\n- **`manifest`:** (object(Manifest)) Required. Metadata that describes the device model and manufacturer. This may be shown in the (upcoming) SDK console, metrics dashboards, and other related visual interfaces.\n - **`manifest.manufacturer`:** (String) Required. Name of the device manufacturer.\n - **`manifest.product_name`:** (String) Required. Consumer-facing product name for this device model.\n - **`manifest.device_description`:** (String) Optional. Description of this device model.\n- **`device_type`:** (String) Required. The type of device hardware. Select from the following:\n - `action.devices.types.CAMERA`\n - `action.devices.types.DISHWASHER`\n - `action.devices.types.DRYER`\n - `action.devices.types.LIGHT`\n - `action.devices.types.OUTLET`\n - `action.devices.types.PHONE`\n - `action.devices.types.REFRIGERATOR`\n - `action.devices.types.SCENE`\n - `action.devices.types.SOUNDBAR`\n - `action.devices.types.SPEAKER`\n - `action.devices.types.SWITCH`\n - `action.devices.types.THERMOSTAT`\n - `action.devices.types.TV`\n - `action.devices.types.VACUUM`\n - `action.devices.types.WASHER`\n- **`traits`:** (Array\\\u003cString\\\u003e) Optional. List of traits the device supports. Traits include the commands, attributes, and states for the device. You do not need to define an [Action package](/assistant/conversational/action-package/reference/rest/Shared.Types/ActionPackage) to use [built-in traits](/assistant/sdk/reference/traits).\n\nDevice instance\n---------------\n\nThe device instance is defined by the fields in this section.\n\n\nDevice instance fields must start with a letter or number. The device ID\ncan only contain letters, numbers, and the following symbols: period (.),\nhyphen (-), underscore (_), and plus (+). The device nickname can only\ncontain numbers, letters, and the space ( ) symbol.\nExample \n\n```carbon\n {\n \"id\": \"my_led_1\",\n \"model_id\": \"my-devices-project-prototype-light-v1\",\n \"nickname\": \"My Assistant Light\",\n \"client_type\": \"SDK_LIBRARY\"\n }\n```\nSchema \n\n```carbon\n {\n \"id\": string,\n \"model_id\": string,\n \"nickname\": string,\n \"client_type\": string\n }\n```\n\n- **`id`:** (String) Required. Identifier for the test device. Must be unique within all of the devices registered under the same Google Developer project.\n- **`model_id`:** (String) Required. Identifier of the device model; must be the same as the [`device_model_id`](#device_model_json) associated with this test device. The device model must have been registered previously.\n- **`nickname`:** (String) Optional. Nickname for the device. This name will be used to refer to the device in visual interfaces like the Assistant settings.\n- **`client_type`:** (String) Required. The type of client device. Must be either of the following: `SDK_SERVICE` or `SDK_LIBRARY`."]]
