Cuando los usuarios interactúan con Google Assistant to query the current
state of a device, your fulfillment receives an
action.devices.QUERY intent containing a
list of device IDs (as provided by your SYNC response).
Your fulfillment receives an
action.devices.EXECUTE intent
when users send commands to Assistant to control your
device.
Controla los intents QUERY
Tu respuesta de QUERY incluye un conjunto completo de estados para cada una de las características compatibles con los dispositivos solicitados.
{
"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"inputs": [{
"intent": "action.devices.QUERY",
"payload": {
"devices": [{
"id": "123",
"customData": {
"fooValue": 74,
"barValue": true,
"bazValue": "foo"
}
}, {
"id": "456",
"customData": {
"fooValue": 12,
"barValue": false,
"bazValue": "bar"
}
}]
}
}]
}
JSON
{
"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"payload": {
"devices": {
"123": {
"on": true,
"online": true
},
"456": {
"on": true,
"online": true,
"brightness": 80,
"color": {
"name": "cerulean",
"spectrumRGB": 31655
}
}
}
}
}
Node.js
const {smarthome} = require('actions-on-google');
const app = smarthome();
// ...
app.onQuery((body, headers) => {
// TODO Get device state
return {
requestId: body.requestId,
payload: {
devices: {
123: {
on: true,
online: true
},
456: {
on: true,
online: true,
brightness: 80,
color: {
name: "cerulean",
spectrumRGB: 31655
}
}
}
}
};
});
Java
@NotNull
@Override
public QueryResponse onQuery(@NotNull QueryRequest queryRequest, @Nullable Map<?, ?> map) {
QueryResponse.Payload payload = new QueryResponse.Payload();
payload.setDevices(
new HashMap<String, Map<String, Object>>() {
{
put(
"123",
new HashMap<String, Object>() {
{
put("on", true);
put("online", true);
}
});
put(
"456",
new HashMap<String, Object>() {
{
put("on", true);
put("online", true);
put("brightness", 80);
put(
"color",
new HashMap<String, Object>() {
{
put("name", "cerulean");
put("spectrumRGB", 31655);
}
});
}
});
}
});
return new QueryResponse(queryRequest.getRequestId(), payload);
}
Para obtener más información, consulta la documentación de referencia del intent QUERY.
Controla los intents EXECUTE
Al igual que QUERY, un solo intent puede orientarse a varios ID de dispositivo. Un solo intent EXECUTE también puede contener varios comandos diferentes proporcionados a un grupo de dispositivos. Por ejemplo, un intent activado puede establecer el brillo y el color de un grupo de luces, o establecer varias luces cada una con un color diferente. Tu respuesta EXECUTE debería mostrar el estado nuevo del dispositivo después de la ejecución.
Usa Report State cuando cambie el estado del dispositivo de los usuarios. Por ejemplo, debido a un intent EXECUTE o un cambio de estado local (como activar un interruptor de luz de forma manual).
Esto mantiene Google Home Graph synchronized with your cloud service.
{
"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"inputs": [{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [{
"devices": [{
"id": "123",
"customData": {
"fooValue": 74,
"barValue": true,
"bazValue": "sheepdip"
}
}, {
"id": "456",
"customData": {
"fooValue": 36,
"barValue": false,
"bazValue": "moarsheep"
}
}],
"execution": [{
"command": "action.devices.commands.OnOff",
"params": {
"on": true
}
}]
}]
}
}]
}
JSON
{
"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"on": true,
"online": true
}
},
{
"ids": [
"456"
],
"status": "ERROR",
"errorCode": "deviceTurnedOff"
}
]
}
}
Node.js
const {smarthome} = require('actions-on-google');
const app = smarthome();
// ...
app.onExecute((body, headers) => {
// TODO Send command to device
return {
requestId: body.requestId,
payload: {
commands: [{
ids: ["123"],
status: "SUCCESS",
states: {
on: true,
online: true
}
}, {
ids: ["456"],
status: "ERROR",
errorCode: "deviceTurnedOff"
}]
}
};
});
Java
@NotNull
@Override
public ExecuteResponse onExecute(
@NotNull ExecuteRequest executeRequest, @Nullable Map<?, ?> map) {
ExecuteResponse.Payload payload = new ExecuteResponse.Payload();
payload.setCommands(
new Commands[] {
new Commands(
new String[] {"123"},
"SUCCESS",
new HashMap<String, Object>() {
{
put("on", true);
put("online", true);
}
},
null,
null),
new Commands(new String[] {"456"}, "ERROR", null, "deviceTurnedOff", null)
});
return new ExecuteResponse(executeRequest.getRequestId(), payload);
}
Para obtener más información, consulta la documentación de referencia del intent EXECUTE.
Respuestas de estado
Las respuestas QUERY y EXECUTE incluyen un campo status para informar el resultado de la solicitud. Cada respuesta de estado puede proporcionar uno de los siguientes valores:
SUCCESS: La solicitud se realizó correctamente.OFFLINE: El dispositivo de destino no tiene conexión o es inaccesible.EXCEPTIONS: Hay un problema o una alerta asociados con la solicitud.ERROR: La solicitud falló con elerrorCodecorrespondiente.
Para ERROR y EXCEPTIONS, consulta Cómo solucionar errores y excepciones y Errores y excepciones para obtener más detalles.