Notice: We're retiring Works with Nest. See the home page for more information.
Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
このページは Cloud Translation API によって翻訳されました。
Switch to English

NestAPIリファレンス

Nest APIは、物理的な家や建物を構造物としてモデル化し、Nest Learning Thermostats、Nest Protects、NestCamsを構造物のデバイスとして使用します。この構造には、家全体に関する情報(AwayまたはETAの状態、アクティブなラッシュアワーなど)も含まれます。

構造内のすべてのデータ要素は、共有JSONドキュメント内のリソースURL(「データの場所」と呼ばれます)によってアドレス指定できます。各データの場所には、文字列、数値、ブール値、親/子オブジェクト、または配列を格納できます。

このインタラクティブなAPIリファレンスを使用してデータモデルを調べてください。

APIから、データモデルの複数のレベルにある場所のデータを同期できます。次に例を示します。

  • すべてのデバイスを含む構造全体
  • 構造内の単一のデバイス
  • データ値のグループ(現在および周囲温度)
  • 単一のデータ値(バッテリーの状態)

製品は、次のようなイベントに慎重に対応する必要があります。

ただし、各デバイスベースのオブジェクトは実際の制約の下で機能していることに注意してください。たとえば、非常用熱が有効になっている場合、サーモスタットはエアコンを作動させないでください。私たちのAPIは、デバイスとユーザーの家の両方を保護するように設計されており、驚くべきまたは危険な特定のアクションを防止します。

権限と共有デバイスデータ

データの場所の読み取りまたは書き込みの機能は、権限によって制御されます。権限グループは、デバイスおよび構造内の選択されたデータ値への読み取り、書き込み、または読み取り/書き込みアクセスを提供します。

詳細については、権限の概要を参照してください。

データとプライバシー

家庭用製品に関連するデータは非常に個人的なものになる可能性があります。ホームセンサーデータには、人々が個人的な空間でどのように生活しているかに関する情報が含まれています。そのデータのセキュリティと処理は非常に重要であり、Nestでは重要な焦点となっています。私たちは、ユーザーがどのような種類のデータを持っているか、どのように使用されているか、どこで制御できるかを明確にします。

プライバシーに関する当社の見解の詳細をご覧ください。

メタデータ

メタデータは、ルートレベルのエンドポイントを呼び出すときに提供される追加情報です。

https://developer-api.nest.com/

アクセストークン

ユーザー認証後、製品はアクセストークンを使用してNestサービスへのAPI呼び出しを行います。このアクセストークンは、ユーザーが製品に代わって電話をかけることを許可したことの証明として機能します。

詳細
戻り値string
例:「c.FmDPkzyzaQe ...」

client_version

クライアントバージョンは、クライアントの最後のユーザー承認バージョンであり、 access_token関連付けられています。

クライアントのアクセス許可を更新すると、クライアントのバージョンがインクリメントされ、更新が利用可能であることがユーザーに通知されます。ユーザーは、更新された製品を使用する前に、このクライアントの更新を受け入れる必要があります。

詳細
戻り値number
例:1、17、42

ユーザーID

ユーザーIDを使用すると、API呼び出し全体でユーザーを識別できます。この識別子は、Works withNest製品とユーザーの組み合わせごとに異なります。

たとえば、ユーザー1がWorks withNest製品AとWorkswith Nest製品Bを許可している場合、製品Aにはユーザー1のuser_id値が1つあり、製品Bにはユーザー1のuser_id値が異なりuser_id

詳細
戻り値string
例:z.1.1.7DHps .. ..