Ambient API UX guidelines

These guidelines apply specifically to integrations using the Google Photos Ambient API. In addition to these requirements, you should also review the general Google Photos APIs UX guidelines, as many of those principles also apply to ambient experiences.

Device experience

  • Clear connection status: Users must always be able to determine if their Google Photos account is connected to the device. This status should be accessible, for example, within a device settings page or an information menu. This helps ensure user awareness and allows users to protect their privacy.
  • Account identification: The user should be able to confirm which account is connected. This can be done by displaying the user's email address, or by using the account avatar (profile picture or initial) in conjunction with the account name within a settings menu.
  • Easy disconnection: Provide a straightforward method for users to disconnect their Google Photos account directly from the device settings. This process should be intuitive and not require navigating through complex menus.
  • Naming devices: Encourage users to name their devices during the setup process, as outlined in Create and manage devices. This helps users identify the device within their Google Photos app settings when selecting media sources.

Authentication

  • Clear instructions: Provide clear, concise on-screen instructions during the authentication process, for example when guiding the user to scan a QR code with their mobile device.
  • Simplified sign-in: Minimize user friction with the streamlined authentication flow by including the state parameter during the OAuth process. This can reduce the number of QR codes the user needs to scan. Be prepared to display the settingsUri as a fallback QR code if the automatic redirection fails, or for users who want to change settings later.

Media display

  • Attribution: While not required on every photo or video, there should be an accessible way for the user to understand that the photos are from Google Photos (e.g., in the device settings or on a photo information overlay).
  • Content freshness: Keep content sources fresh. For example, with slideshow experiences, regularly poll for updates to the media items list as described in List and retrieve media items, respecting the pollInterval to verify the displayed content reflects the user's current selections.

Branding

  • Initial setup: When the user is connecting their Google Photos account, you may use the Google Photos logo and branding as described in the general UX guidelines.
  • Ambient display: Keep the user's photos and videos as the main focus. Avoid persistent Google Photos branding or logos on the screen while the photo slideshow is active. Branding should be limited to setup and settings menus.