Zapytanie i wykonanie

Gdy użytkownicy wchodzą w interakcję z Google Assistant, aby sprawdzić bieżący stan urządzenia, Twoja realizacja otrzymuje intencję action.devices.QUERY zawierającą listę identyfikatorów urządzeń (podanych w odpowiedzi SYNC). Gdy użytkownicy wysyłają polecenia do Assistant, aby sterować urządzeniem, Twoja usługa realizacji otrzymuje intencję action.devices.EXECUTE.

Obsługa intencji QUERY

Odpowiedź QUERY zawiera pełny zestaw stanów dla każdej cechy obsługiwanej przez urządzenia, których dotyczy żądanie.

Poproś o
{
    "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,
        "status": "SUCCESS"
      },
      "456": {
        "on": true,
        "online": true,
        "status": "SUCCESS",
        "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,
          status: "SUCCESS"
        },
        456: {
          on: true,
          online: true,
          status: "SUCCESS",
          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("status", "SUCCESS");
                }
              });
          put(
              "456",
              new HashMap<String, Object>() {
                {
                  put("on", true);
                  put("online", true);
                  put("status", "SUCCESS");
                  put("brightness", 80);
                  put(
                      "color",
                      new HashMap<String, Object>() {
                        {
                          put("name", "cerulean");
                          put("spectrumRGB", 31655);
                        }
                      });
                }
              });
        }
      });

  return new QueryResponse(queryRequest.getRequestId(), payload);
}

Więcej informacji znajdziesz w dokumentacji referencyjnej intencji QUERY.

Obsługa intencji EXECUTE

Podobnie jak w przypadku QUERY, pojedyncza intencja może być kierowana na wiele identyfikatorów urządzeń. Jedna intencja EXECUTE może też zawierać wiele różnych poleceń wydawanych grupie urządzeń. Na przykład wywołana intencja może ustawić zarówno jasność, jak i kolor grupy świateł, lub ustawić różne kolory dla wielu świateł. Odpowiedź EXECUTE powinna zwracać nowy stan urządzenia po wykonaniu polecenia.

Użyj Report State, gdy zmieni się stan urządzenia użytkownika. Na przykład z powodu intencji EXECUTE lub zmiany stanu lokalnego (np. ręcznego przełączenia przełącznika światła). Dzięki temu Google Home Graph będzie zsynchronizowany z Twoją usługą w chmurze.

Poproś o
{
    "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);
}

Więcej informacji znajdziesz w dokumentacji referencyjnej intencji EXECUTE.

Odpowiedzi dotyczące stanu

Odpowiedzi QUERY i EXECUTE zawierają pole status, które informuje o wyniku żądania. Każda odpowiedź dotycząca stanu może zawierać jedną z tych wartości:

  • SUCCESS: żądanie zostało zrealizowane.
  • OFFLINE: urządzenie docelowe jest offline lub jest nieosiągalne z innego powodu.
  • EXCEPTIONS: z prośbą jest powiązany problem lub alert.
  • ERROR: żądanie nie powiodło się i zwróciło odpowiedni błąd errorCode.

Więcej informacji o ERROR i EXCEPTIONS znajdziesz w artykułach Obsługa błędów i wyjątków oraz Błędy i wyjątki.

Wstecz
Identyfikacja i synchronizacja
Dalej
Odłącz