Edit a Client

You can edit a client at any time to manage the information in any of these areas:

Edit overview

To edit client metadata, select the Overview tab of the OAuth Clients page, and then select [Edit] in the upper right corner.

Edit

Edit any of the following metadata, as needed:

  1. Client name. Remember that client name:
    • Is analogous to the product name
    • Is visible to users
    • Must be unique
    • Cannot include "Nest" or "Works with Nest"
  2. Product description
  3. Product info
    • Select the target number of users
    • Select one or two categories where you expect to market your product
      • We use market categories for discovery of products in the Works with Nest Store, so be thoughtful in your selection
  4. URLs
    • Edit your support site URL
      • When users have questions about your product, they'll visit this site
    • OAuth redirect URI
      • To use PIN-based authorization, the redirect URI fields must be empty
      • To use web-based authorization, enter a redirect URI (HTTPS is required)
        • If you have a personal/local development environment, you can use a non-secure HTTP with a localhost domain and an optional port number or path:
          • http://localhost
          • http://localhost:port
          • http://localhost:port/path

Select [Update] to save your changes.

Edit permissions

You have the option to edit existing permission descriptions, or to change permissions entirely (add or remove).

Edit permission descriptions

Edit permissions
  1. Select the Permissions tab on the OAuth Clients page. Permissions are grouped into five product categories: Thermostat, Camera, Smoke+CO Alarm, Security, Other Permissions. The number of currently active permissions within each category is displayed.
  2. Open the product category containing the permission you wish to edit.
  3. Select [Edit] for the target permission.
  4. Edit the permission description(s). If multiple locales are active for the product, the description for each locale is also available for editing.
    Save edited permissions
  5. Select [Done] to close the permission description window. Note that this does not save your changes.
  6. Continue editing other permissions, or select [Update Permissions] at the bottom of the page to save your changes.

Add permissions

  1. Select the Permissions tab on the OAuth Clients page.
  2. Open the product category for the permission you wish to add.
  3. Select the target permission from the list. Selecting a tiered permission will disable others in the same tier. For example, selecting the "Thermostat read" permission disables the "Thermostat read/write" permission—you cannot have both permissions active at the same time.
  4. Update the permission description for your selected permission and select [Done]. Note that this does not save your changes.
  5. Select [Update Permissions] at the bottom of the page to save your changes.

Remove permissions

  1. Select the Permissions tab on the OAuth Clients page.
  2. Open the product category for the permission you wish to remove.
  3. Deselect the target permission from the list. Select [OK] to confirm the removal. Note that this does not save your changes.
  4. Select [Update Permissions] at the bottom of the page to save your changes.

Edit platforms

Supported platforms

Your product must be supported by at least one platform app to be visible in the Works with Nest Store. Supported platforms are displayed on the product's individual Store page for customer reference. All other information is used in our product review process. Add all platforms that your product supports.

The Minimum Supported Version is required for iOS and Android, as are the App Store ID for iOS and the Google Play package name for Android.

All fields are required for Web and Other.

Edit localizations

Localizations

We use locales to display localized product information in the Works with Nest page in the Nest app or on the web at home.nest.com. Localization is highly recommended if you plan to market your product in other countries. International customers are more likely to engage with a company and their products when content is localized and respectful of their language and culture.

When you create a client, the US English (en_US) locale is added automatically. If you plan to localize your product and related apps beyond that, make sure to add those additional locales here, so that there's a consistent user experience between your product and Nest.

Localized product information includes these values:

  • Product name
  • Support URL
  • Permission descriptions

Tips for localization

Before adding additional locales, consider the following guidelines for your own product documentation or app:

  • Decide which locales you want to support as early in the design process as possible.
  • Separate functionality from content that must be localized.
  • Design your app with a neutral tone that doesn't focus on a specific culture or language.
  • Allow your user interface to adjust to different lengths of localized content (for example, English is typically more concise than German).
  • Avoid unnecessary complexity in text or strings.
  • Ensure that values such as dates or numbers can be handled appropriately for other locales.

Add a new locale

Add a Nest app locale for each localization you want available in the Store. Then add localized product information.

To add a new locale:

  1. Select the Localizations tab on the OAuth Clients page
  2. Select [+ Add locale]
    • Alternatively, you can clone an existing locale by selecting the [Clone] option, next to [Edit]
  3. Select your desired locale from the list of Available locales
  4. Add or edit localized content then select [Save]

Default locale

When you create a client, the US English (en_US) locale is added automatically. When you edit your client and add multiple locales, en-US becomes the default locale, but you have the option to specify a different default locale. The default locale defines the product information your users will see in the Works with Nest page in the Nest app or on the web at home.nest.com.

Auto-translate

When you choose a non-English locale, you get the option to auto-translate the permission descriptions during creation or editing of the locale.

To use the auto-translation option:

Translate locale
  1. On the Localizations tab, select [Edit] for a non-English locale that is not the default
  2. Select the Auto-translate option
  3. Select OK to confirm you want to use Google Translate to auto-translate the permission description
  4. Review the translated copy and make any necessary adjustments
  5. Select [Save]

Preview auto-translate

Use preview to see what the permission might look like in the app:

Translate preview

Troubleshooting auto-translate

If you don't see the Auto-translate option, check if:

  • You're editing an English locale
  • The locale is set as the default

To work around the default locale case:

  1. Assign a different locale as the default (en-US, for example)
  2. Select the preferred locale (fr, for example) and use the Auto-translate option
  3. Edit permissions and product information as needed
  4. Use the Make default locale option to set the preferred locale (fr) as the default
  5. Select [SAVE]