पहचानें और सिंक करें

smart home ऐक्शन बनाने के बाद, अगला चरण अपने फ़ुलफ़िलमेंट में फ़ंक्शनलिटी जोड़ना है, ताकि स्मार्ट होम इंटेंट को प्रोसेस किया जा सके और Google Assistant को जवाब दिए जा सकें.

उपयोगकर्ता की पहचान करना

Assistant, Authorization हेडर में आपके OAuth 2.0 सर्वर से मिले ऐक्सेस टोकन की मदद से, आपकी smart home कार्रवाई को पूरा करने के लिए अनुरोध करता है.

POST /fulfillment HTTP/1.1
Host: smarthome.example.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN

किसी भी अनुरोध का जवाब देने से पहले, आपके फ़ुलफ़िलमेंट लॉजिक को यह पुष्टि करनी चाहिए कि यह टोकन क्रेडेंशियल मान्य है या नहीं. साथ ही, उससे जुड़े उपयोगकर्ता खाते का पता लगाना चाहिए. अगर ऐक्सेस टोकन अमान्य है, तो आपके फ़ुलफ़िलमेंट को एचटीटीपी 401 Unauthorized गड़बड़ी का मैसेज दिखाना चाहिए.

डिवाइसों और उनकी क्षमताओं की सूची बनाएं

इस टास्क के लिए सुझाए गए टूल

Assistant, उपयोगकर्ता और उसकी क्षमताओं से जुड़े डिवाइसों की सूची का अनुरोध करने के लिए, आपके फ़ुलफ़िलमेंट को action.devices.SYNC इंटेंट भेजता है. आपके फ़ुलफ़िलमेंट को SYNC रिस्पॉन्स के agentUserId फ़ील्ड में, हर उपयोगकर्ता के लिए एक यूनीक आईडी दिखाना चाहिए. यह आईडी, उपयोगकर्ता को आपकी क्लाउड सेवा पर दिखाने के लिए, बदली नहीं जा सकने वाली वैल्यू होना चाहिए. हमारा सुझाव है कि ऐसी सेटिंग के आधार पर ईमेल पते या अन्य एट्रिब्यूट न दें जिन्हें उपयोगकर्ता बदल सकता है.

आपके SYNC रिस्पॉन्स के devices फ़ील्ड में, वे सभी डिवाइस शामिल होते हैं जिन्हें उपयोगकर्ता ने Assistant को ऐक्सेस करने की अनुमति दी है. इसमें वे टाइप और विशेषताएं शामिल हैं जिनका इस्तेमाल वह करता है. साथ ही, इस डिवाइस के लिए Trait के व्यवहार को कॉन्फ़िगर करने के लिए ज़रूरी एट्रिब्यूट.

SYNC इंटेंट, खाता लिंक करने के दौरान या तब ट्रिगर होता है, जब कोई उपयोगकर्ता अपने डिवाइसों को मैन्युअल तरीके से फिर से सिंक करता है. अगर उपयोगकर्ताओं के डिवाइसों की सूची, काम करने वाली विशेषताओं या एट्रिब्यूट की वैल्यू में बदलाव होता है, तो नया SYNC इंटेंट ट्रिगर करने के लिए, सिंक करने का अनुरोध करें का इस्तेमाल करें. साथ ही, Google को अपडेट की रिपोर्ट दें.

अनुरोध
{
    "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
    "inputs": [{
      "intent": "action.devices.SYNC"
    }]
}
JSON
{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "1836.15267389",
    "devices": [
      {
        "id": "123",
        "type": "action.devices.types.OUTLET",
        "traits": [
          "action.devices.traits.OnOff"
        ],
        "name": {
          "defaultNames": [
            "My Outlet 1234"
          ],
          "name": "Night light",
          "nicknames": [
            "wall plug"
          ]
        },
        "willReportState": false,
        "roomHint": "kitchen",
        "deviceInfo": {
          "manufacturer": "lights-out-inc",
          "model": "hs1234",
          "hwVersion": "3.2",
          "swVersion": "11.4"
        },
        "otherDeviceIds": [
          {
            "deviceId": "local-device-id"
          }
        ],
        "customData": {
          "fooValue": 74,
          "barValue": true,
          "bazValue": "foo"
        }
      },
      {
        "id": "456",
        "type": "action.devices.types.LIGHT",
        "traits": [
          "action.devices.traits.OnOff",
          "action.devices.traits.Brightness",
          "action.devices.traits.ColorSetting"
        ],
        "name": {
          "defaultNames": [
            "lights out inc. bulb A19 color hyperglow"
          ],
          "name": "lamp1",
          "nicknames": [
            "reading lamp"
          ]
        },
        "willReportState": false,
        "roomHint": "office",
        "attributes": {
          "colorModel": "rgb",
          "colorTemperatureRange": {
            "temperatureMinK": 2000,
            "temperatureMaxK": 9000
          },
          "commandOnlyColorSetting": false
        },
        "deviceInfo": {
          "manufacturer": "lights out inc.",
          "model": "hg11",
          "hwVersion": "1.2",
          "swVersion": "5.4"
        },
        "customData": {
          "fooValue": 12,
          "barValue": false,
          "bazValue": "bar"
        }
      }
    ]
  }
}
Node.js
const {smarthome} = require('actions-on-google');
const app = smarthome();
// ...
app.onSync((body, headers) => {
  // TODO Get devices for user
  return {
    requestId: body.requestId,
    payload: {
      agentUserId: "1836.15267389",
      devices: [{
        id: "123",
        type: "action.devices.types.OUTLET",
        traits: [
          "action.devices.traits.OnOff"
        ],
        name: {
          defaultNames: ["My Outlet 1234"],
          name: "Night light",
          nicknames: ["wall plug"]
        },
        willReportState: false,
        roomHint: "kitchen",
        deviceInfo: {
          manufacturer: "lights-out-inc",
          model: "hs1234",
          hwVersion: "3.2",
          swVersion: "11.4"
        },
        otherDeviceIds: [{
          deviceId: "local-device-id"
        }],
        customData: {
          fooValue: 74,
          barValue: true,
          bazValue: "foo"
        }
      }, {
        id: "456",
        type: "action.devices.types.LIGHT",
        traits: [
          "action.devices.traits.OnOff",
          "action.devices.traits.Brightness",
          "action.devices.traits.ColorSetting"
        ],
        name: {
          defaultNames: ["lights out inc. bulb A19 color hyperglow"],
          name: "lamp1",
          nicknames: ["reading lamp"]
        },
        willReportState: false,
        roomHint: "office",
        attributes: {
          colorModel: 'rgb',
          colorTemperatureRange: {
            temperatureMinK: 2000,
            temperatureMaxK: 9000
          },
          commandOnlyColorSetting: false
        },
        deviceInfo: {
          manufacturer: "lights out inc.",
          model: "hg11",
          hwVersion: "1.2",
          swVersion: "5.4"
        },
        customData: {
          fooValue: 12,
          barValue: false,
          bazValue: "bar"
        }
      }]
    }
  };
});
Java
@NotNull
@Override
public SyncResponse onSync(@NotNull SyncRequest syncRequest, @Nullable Map<?, ?> map) {
  Payload payload = new Payload();
  payload.setAgentUserId("1836.15267389");
  payload.setDevices(
      new Device[] {
        new Device.Builder()
            .setId("123")
            .setType("action.devices.types.OUTLET")
            .addTrait("action.devices.traits.OnOff")
            .setName(
                Collections.singletonList("My Outlet 1234"),
                "Night light",
                Collections.singletonList("Wall plug"))
            .setWillReportState(true)
            .setDeviceInfo("lights-out-inc", "hs1234", "3.2", "11.4")
            .setCustomData(
                new JSONObject()
                    .put("fooValue", 74)
                    .put("barValue", true)
                    .put("bazValue", "foo"))
            .build(),
        new Device.Builder()
            .setId("456")
            .setType("action.devices.types.LIGHT")
            .addTrait("action.devices.traits.OnOff")
            .addTrait("action.devices.traits.Brightness")
            .addTrait("action.devices.traits.ColorTemperature")
            .addTrait("action.devices.traits.ColorSpectrum")
            .setName(
                Collections.singletonList("Lights Out Inc. bulb A19 color hyperglow"),
                "Lamp",
                Collections.singletonList("Reading lamp"))
            .setWillReportState(true)
            .setDeviceInfo("Lights Out Inc.", "hg11", "1.2", "5.4")
            .setCustomData(
                new JSONObject()
                    .put("fooValue", 12)
                    .put("barValue", false)
                    .put("bazValue", "bar"))
            .build(),
      });
  return new SyncResponse(syncRequest.getRequestId(), payload);
}

ज़्यादा जानकारी के लिए, SYNC इंटेंट के रेफ़रंस दस्तावेज़ देखें.