Glossary

Access token

Part of user authorization, your product will use an access token to make API calls to the Nest service. This access token serves as proof that a user has authorized your product to make calls on their behalf. Learn more about access tokens.

Authentication

Authentication is the process of proving that a user is who they claim to be. Before granting an access token, the Nest service authenticates a user, granting an access token for that specific account.

Authorization

Permission, given by users, for your product or service to access their Nest device. These permissions are represented by an access token. Users can revoke authorization at any time. Learn more about authorization.

Authorization mode

Web-based or PIN-based authorization modes are available. When you create a client in the Nest Developer program, we will ask that you choose the authorization mode. We use OAuth 2.0 to authorize your apps with the Nest service.

Client

OAuth Client. An integration of your product or service with Nest devices that uses OAuth 2.0 for authorization. When you create a Nest Account and sign up for the Developer Program, you can add up to 10 clients to the account.

Client credentials

The Client ID and Client Secret values assigned to your OAuth Client. These credentials are used to authorize a user's Works with Nest connection with your product.

Client name

The public name of your product. Client name is created at registration and is displayed to users in:

Client name must be unique, and cannot include "Nest" or "Works with Nest".

As a best practice, we recommend that you include the client name when you write permission descriptions.

Client version

As you add features to your products, you'll update your client with new permissions for the data you want to access. Your users will be prompted to accept these new permissions before they can use your updated product. We use client version to track user authentication of these updated clients. Client version is the last user-authorized version of a Works with Nest product, and is associated with an access token. Learn more about client version.

Company name

The name of your organization. Company name is displayed to users when they authorize your Works with Nest product, or in the Works with Nest Store.

Data location

Every piece of data is addressable by URL. The URLs that point to a data value is known as a data location. Data locations can store strings, numbers, booleans, parent/child objects, or arrays. Learn more about data structure.

Destination data path

Part of the Resource use API, the destination data path is a storage location for electricity, gas, or water usage. The path is unique to each company and includes $company and $product_type. We'll assign a destination data path when you request company verification.

Developer

A person or organization who participates in the Nest Developer program, and integrates their software/hardware/service with the Nest service via the Nest API.

Device

A Nest Learning Thermostat, Nest Protect, Nest Cam Indoor, or Nest Cam Outdoor. Multiple devices can be associated with a single structure.

Device linking (pairing)

When a user pairs a Nest device to their Nest Account, they get secure remote device access from the Nest app or via a web browser.

Energy rush hours

Times when demand for energy is high, generally during extreme weather events.

Home/Away Assist

A feature that combines existing activity sensor data from any Nest product with mobile device location to determine if anyone is home. That means our Works with Nest partners can get information about home occupancy from any Nest device. Learn more about Home/Away Assist.

Integration

The combined product and related application(s) that provides third-party devices or applications access to Nest devices. The integration can be delivered via web, phone, or other technology interface.

Nest Account

An account created at home.nest.com that grants the account owner (user) control of the Nest device via web/mobile applications.

Nest Sense

A collection of intelligence services that use sensor data and algorithms from our products to build services and determine events. Learn more about Nest Sense.

OAuth Client

See Client.

Owner

An owner is a person who owns a Nest device, has a Nest Account, has installed a Nest device in a structure, and has connected their device with the Nest service. Learn more about Nest Account Owners.

Payload

Information you send to Nest when you use the Resource use API. It's JSON-formatted data that contains company identification and the resource use data.

Permission

Permissions provide access to categories of data values (examples: Thermostat, Smoke + CO, Camera, Away, ETA, etc.). When you create a client, we will ask that you choose applicable permissions, and describe how your customers might use your product with Nest. These permissions and descriptions are presented to your users when your product or service requests access to the user's device data.

Permission descriptions

Permission descriptions are user-facing. They appear in the Works with Nest user authorization page and the permissions view in the Nest app. Permission descriptions explain what your product does with user data and how this benefits users. Learn to write permission descriptions.

Product

The tangible third-party device or service that the customer integrates with their Nest products. A product is linked to an OAuth Client for authorization and use of the Nest API.

Product type

Part of the Resource use API, $product_type is a string provided by Nest, and makes up part of the destination data path. It defines the type of product, device, or appliance you manufacture, and can be an object or an array, depending on the storage location.

Product variants

Different versions of a product that are tied to a single client. For example, multiple colors of the same product as displayed on the Works with Nest Store.

Real-time

How updates from the Nest service are received when using REST Streaming or Multiplex. In this documentation, it is analogous to the concept of "near real-time," which accounts for factors such as server processing and network latency, as well as perceived lag by the end user.

Rush Hour Rewards

Program that a user can enroll in with their energy company. Enrolled users can receive rebates or other monetary rewards.

Structure

A physical entity (house, apartment, condo), where the Nest device is installed.

User

A user is a person with a Nest Account. The user may be an Owner, but may also be a person invited to share access to a Nest home. Learn more about Family Accounts.