當使用者與
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.互動
處理 QUERY 意圖
您的 QUERY 回應包含所要求裝置支援的每個特徵的一組完整狀態。
{
"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);
}
詳情請參閱 QUERY 意圖參考說明文件。
處理 EXECUTE 意圖
與 QUERY 類似，單一意圖可以指定多個裝置 ID。單一 EXECUTE 意圖也可能包含一組給不同裝置的指令。例如，已觸發的意圖可以設定一組燈光上的亮度和顏色，或將多個光源設為不同顏色。執行後，EXECUTE 回應應會傳回裝置的新狀態。
使用者裝置的狀態變更時，請使用
Report State
。例如，由於 EXECUTE 意圖或本機狀態變更 (例如手動翻轉燈具開關)。這樣可以維持
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);
}
詳情請參閱 EXECUTE 意圖參考說明文件。
狀態回應
您的 QUERY 和 EXECUTE 回應包含一個 status 欄位，用於回報要求的結果。每個狀態回應都可以提供下列其中一個值：
SUCCESS：要求已順利完成。OFFLINE：目標裝置處於離線狀態或無法連上。EXCEPTIONS：與要求相關的問題或快訊。ERROR：相應的errorCode要求失敗。