Notice: We're retiring Works with Nest. See the home page for more information.
Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

API de structure

Les utilisateurs peuvent ajouter au maximum trois structures , avec plusieurs appareils par structure.

Toutes les valeurs ci-dessous se trouvent sous chaque structures/ structure_id dans le document JSON.

structure_id

Numéro d'identification de la structure. Lorsque vous appelez cet emplacement de données, vous pouvez accéder aux valeurs de données de cette structure.

Détails
https://developer-api.nest.com/structures/ structure_id /structure_id
Retour string
Exemple: "VqFabWH21nw ..."
Accès lecture seulement
Disponible en Lecture du thermostat / v1-v6
Thermostat lecture / écriture / v1-v6
Fumée + CO lecture / v1-v5
Lecture en extérieur / v1-v2
Lecture / écriture en absence / v1-v2
Ecriture ETA / v1-v2
Code postal lu / v2
Lecture de la caméra / v1-v3
Lecture caméra + images / v1-v4
Lecture / écriture de la caméra / v1-v3
Caméra lecture / écriture + images / v1-v4
Énergie lue / v2

thermostats

Liste des thermostats dans la structure, par identifiant unique de l'appareil. Il s'agit d'un tableau d'objets JSON qui comprend tous les thermostats de la structure.

Détails
https://developer-api.nest.com/structures/ structure_id /thermostats
Retour array
Exemple: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
Accès lecture seulement
Disponible en Lecture du thermostat / v1-v6
Thermostat lecture / écriture / v1-v6
Fumée + CO lecture / v1-v5
Lecture en extérieur / v1-v2
Lecture / écriture en absence / v1-v2
Ecriture ETA / v1-v2
Lecture de la caméra / v2-v3
Lecture caméra + images / v2-v4
Lecture / écriture de la caméra / v2-v3
Caméra lecture / écriture + images / v2-v4

smoke_co_alarms

Liste des alarmes fumée + CO dans la structure, par identifiant unique d'appareil. Il s'agit d'un tableau d'objets JSON qui comprend toutes les alarmes de fumée + CO de la structure.

Détails
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms
Retour array
Exemple: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
Accès lecture seulement
Disponible en Lecture du thermostat / v1-v6
Thermostat lecture / écriture / v1-v6
Fumée + CO lecture / v1-v5
Lecture en extérieur / v1-v2
Lecture / écriture en absence / v1-v2
Ecriture ETA / v1-v2
Lecture de la caméra / v2-v3
Lecture caméra + images / v2-v4
Lecture / écriture de la caméra / v2-v3
Caméra lecture / écriture + images / v2-v4

appareils photo

Liste des caméras de la structure, par identifiant unique de l'appareil. Il s'agit d'un tableau d'objets JSON qui comprend toutes les caméras de la structure.

Détails
https://developer-api.nest.com/structures/ structure_id /cameras
Retour array
Exemple: [ "awJo6rH...",... ]
Accès lecture seulement
Disponible en Lecture du thermostat / v4-v6
Thermostat lecture / écriture / v4-v6
Fumée + CO lecture / v4-v5
Lecture à l'extérieur / v2
Lecture / écriture / v2 absent
Ecriture ETA / v2
Lecture de la caméra / v1-v3
Lecture caméra + images / v1-v4
Lecture / écriture de la caméra / v1-v3
Caméra lecture / écriture + images / v1-v4

une façon

Indique l'état d'occupation de la structure.

Les structures ont deux états liés à la présence: à la home ou à l' away . En l' absence de mouvement est détecté dans la maison, la structure passe de la home à l' away .

Détails
https://developer-api.nest.com/structures/ structure_id /away
Retour string
Valeurs: "à la maison", "à l'extérieur"
Accès lire écrire
Disponible en Lis:
Lecture du thermostat / v1-v6
Thermostat lecture / écriture / v1-v6
Fumée + CO lecture / v1-v5
Lecture en extérieur / v1-v2
Lecture / écriture en absence / v1-v2
Ecriture ETA / v1-v2
Écrire:
Lecture / écriture en absence / v1-v2

Nom

Nom d'affichage de la structure défini par l'utilisateur.

Détails
https://developer-api.nest.com/structures/ structure_id /name
Retour string
Exemples: "Chez moi", "Beach House", "Mountain House"
Accès lire écrire
Disponible en Lis:
Lecture du thermostat / v1-v6
Thermostat lecture / écriture / v1-v6
Fumée + CO lecture / v1-v5
Lecture en extérieur / v1-v2
Lecture / écriture en absence / v1-v2
Ecriture ETA / v1-v2
Code postal lu / v2
Lecture de la caméra / v1-v3
Lecture caméra + images / v1-v4
Lecture / écriture de la caméra / v1-v3
Caméra lecture / écriture + images / v1-v4
Énergie lue / v2
Structure lecture / écriture / v1
Écrire:
Structure lecture / écriture / v1

code postal

Code de pays, au format ISO 3166 alpha-2 .

Détails
https://developer-api.nest.com/structures/ structure_id /country_code
Retour string
Exemples: "US", "CA", "UK"
Accès lecture seulement
Disponible en Lecture du thermostat / v1-v6
Thermostat lecture / écriture / v1-v6
Fumée + CO lecture / v1-v5
Lecture en extérieur / v1-v2
Lecture / écriture en absence / v1-v2
Ecriture ETA / v1-v2

code postal

Code postal ou postal, selon le pays.

Détails
https://developer-api.nest.com/structures/ structure_id /postal_code
Retour string
Exemples: "94304", "94304-1027", "EC1A 1BB"
Accès lecture seulement
Disponible en Code postal lu / v1-v2

peak_period_start_time

Heure de début de l'événement heure de pointe de l' énergie , au format ISO 8601 .

Détails
https://developer-api.nest.com/structures/ structure_id /peak_period_start_time
Retour string
Exemple: "2016-12-31T23: 59: 59.000Z"
Accès lecture seulement
Disponible en Lecture du thermostat / v1-v6
Thermostat lecture / écriture / v1-v6
Lecture d'énergie / v1-v2

peak_period_end_time

Heure de fin de l'événement heure de pointe de l' énergie , au format ISO 8601 .

Détails
https://developer-api.nest.com/structures/ structure_id /peak_period_end_time
Retour string
Exemple: "2016-12-31T23: 59: 59.000Z"
Accès lecture seulement
Disponible en Lecture du thermostat / v1-v6
Thermostat lecture / écriture / v1-v6
Lecture d'énergie / v1-v2

fuseau horaire

Fuseau horaire au niveau de la structure, au format de fuseau horaire IANA .

Détails
https://developer-api.nest.com/structures/ structure_id /time_zone
Retour string
Exemple: "America / Los_Angeles"
Accès lecture seulement
Disponible en Lecture du thermostat / v1-v6
Thermostat lecture / écriture / v1-v6
Fumée + CO lecture / v1-v5
Lecture en extérieur / v1-v2
Lecture / écriture / v2 absent
Ecriture ETA / v1-v2

eta

ETA (heure d'arrivée estimée) est un objet qui peut être placé sur une structure. Il est utilisé pour informer Nest qu’un utilisateur doit rentrer chez lui à une heure précise. Pour plus d'informations sur la façon de passer un appel ETA, consultez le guide Away .

Détails
https://developer-api.nest.com/structures/ structure_id /eta
Retour object
Exemple: "myTripID1024", "2014-10-31T22: 42: 00.000Z", "2016-12-31T23: 59: 59.000Z"
Paramètres
trip_id Une chaîne définie par l'utilisateur identifiant le trajet
estimated_arrival_window_begin Un horodatage au format ISO 8601 .
Doit être supérieur à NOW .
estimated_arrival_window_end Un horodatage au format ISO 8601 .
Doit être supérieur à estimated_arrival_window_begin .
Accès écriture seule
Disponible en Ecriture ETA / v1-v2

eta_begin

Horodatage de la première heure d'arrivée prévue au format ISO 8601 . Utilisé pour déclencher des actions ou des événements.

Détails
https://developer-api.nest.com/structures/ structure_id /eta_begin
Retour string
Exemple: "2016-12-31T23: 59: 59.000Z"
Accès lecture seulement
Disponible en ETA lecture / v1

rhr_enrollment

Statut d'inscription au programme Rush Hour Rewards .

Détails
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment
Retour boolean
Valeurs: vrai, faux
Accès lecture seulement
Disponible en Lecture d'énergie / v1-v2

wwn_security_state

État de sécurité de la structure.

Détails
https://developer-api.nest.com/structures/ structure_id /wwn_security_state
Type string enum
Valeurs: "ok", "dissuader"
Accès lecture seulement
Disponible en État de sécurité lu / v1

Un objet contenant des identificateurs where_id ( where_id et name ) pour les périphériques de la structure. name est le nom d'affichage de l'appareil. Il peut s'agir de n'importe quel nom de pièce d'une liste que nous fournissons ou d'un nom personnalisé.

Pour plus d'informations sur les wheres , consultez le Guide de la structure .

En savoir plus sur les noms des thermostats Nest , des Nest Protect et des Nest Cam .

Détails
https://developer-api.nest.com/structures/ structure_id /wheres
Retour object
Accès lecture seulement
Disponible en Lis:
Lecture du thermostat / v3-v6
Thermostat lecture / écriture / v3-v6
Fumée + CO lecture / v3-v5
Lecture de la caméra / v1-v3
Lecture caméra + images / v1-v4
Lecture / écriture de la caméra / v1-v3
Caméra lecture / écriture + images / v1-v4

where_id

Identificateur unique généré par Nest qui représente le name .

where_id est automatiquement créé et renvoyé lors de l'appel de création de name .

Détails
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id
Retour string
Exemple: "Fqp6wJI ..."
Accès lecture seulement
Disponible en Lis:
Lecture du thermostat / v3-v6
Thermostat lecture / écriture / v3-v6
Fumée + CO lecture / v3-v5
Lecture de la caméra / v1-v3
Lecture caméra + images / v1-v4
Lecture / écriture de la caméra / v1-v3
Caméra lecture / écriture + images / v1-v4

Nom

Le nom d'affichage de l'appareil.

Détails
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name
Retour string
Exemple: "Chambre"
Accès lire écrire
Disponible en Lis:
Lecture du thermostat / v3-v6
Thermostat lecture / écriture / v3-v6
Fumée + CO lecture / v3-v5
Lecture de la caméra / v1-v3
Lecture caméra + images / v1-v4
Lecture / écriture de la caméra / v1-v3
Caméra lecture / écriture + images / v1-v4

co_alarm_state

État de l'alarme CO.

Détails
https://developer-api.nest.com/structures/ structure_id /co_alarm_state
Retour string enum
Valeurs: "ok", "warning", "Emergency"
Accès lecture seulement
Disponible en Fumée + CO lecture / v5

smoke_alarm_state

État du détecteur de fumée.

Détails
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
Retour string enum
Valeurs: "ok", "warning", "Emergency"
Accès lecture seulement
Disponible en Fumée + CO lecture / v5