Autoriser un compte

Une fois vos projets Google Cloud et Device Access créés, vous pouvez autoriser un compte Google avec un appareil Google Nest compatible pour l'API SDM.

Associer votre compte

Pour afficher les structures et les appareils, vous devez associer un compte Google à votre projetDevice Access à l'aide du PCM. PCM permet à user d'accorder l'autorisation à developerd'accéder à leurs structures et aux données de leurs appareils.

Dans ce guide, vous jouez le rôle de user et de developer.

Ouvrez le lien suivant dans un navigateur Web, en remplaçant :

project-id par votre ID Device Access Project
oauth2-client-id avec l'ID client OAuth2 de vos identifiants Google Cloud

https://nestservices.google.com/partnerconnections/project-id/auth?redirect_uri=https://www.google.com&access_type=offline&prompt=consent&client_id=oauth2-client-id&response_type=code&scope=https://www.googleapis.com/auth/sdm.service

Si vous vous êtes récemment connecté à Google avec plusieurs comptes, un écran initial Choisir un compte peut s'afficher avec la liste de vos comptes Google. Si c'est le cas, sélectionnez le compte Google associé aux appareils pour lesquels vous souhaitez autoriser Device Access.
L'écran Autorisations Google Nest est le PCM lui-même. Vous pouvez y accorder des autorisations pour la structure et les appareils. Activez les autorisations pour votre maison (étape 1) et pour tous les appareils de cette maison compatibles avec l'API SDM (étape 2), puis cliquez sur Suivant.
Sur l'écran Choisir un compte pour continuer vers Nom du projet, où Nom du projet correspond au nom de votre projet Google Cloud, sélectionnez le compte Google que vous souhaitez autoriser pour l'API SDM. Utilisez le même compte Google qu'auparavant.
Après avoir choisi un compte, un écran d'avertissement peut s'afficher, indiquant Google n'a pas validé cette application. Si c'est le cas, cliquez sur l'option Avancé, puis sur Accéder à Nom du projet (non sécurisé) pour continuer. Pour en savoir plus, consultez Google n'a pas validé cette application.
Sur l'écran Accorder l'autorisation Nom du projet, cliquez sur Autoriser pour accorder au projet l'autorisation d'accéder à votre compte Google.
Sur l'écran Confirmer vos choix, assurez-vous que les autorisations que vous souhaitez accorder sont cochées, puis cliquez sur Autoriser pour confirmer.
Vous devriez être redirigé vers https://www.google.com. Le code d'autorisation est renvoyé en tant que paramètre code dans l'URL, qui doit être au format suivant :
```
https://www.google.com?code=authorization-code&scope=https://www.googleapis.com/auth/sdm.service
```
Copiez le code d'autorisation.

Obtenir un jeton d'accès

Utilisez le code d'autorisation pour récupérer un jeton d'accès que vous pourrez utiliser pour appeler l'API SDM.

Ouvrez un terminal et exécutez la commande curl suivante, en remplaçant :
1. oauth2-client-id et oauth2-client-secret avec l'ID client et le code secret du client OAuth2 de vos identifiants Google Cloud.
2. authorization-code par le code que vous avez reçu à l'étape précédente.
```
curl -L -X POST 'https://www.googleapis.com/oauth2/v4/token?client_id=oauth2-client-id&client_secret=oauth2-client-secret&code=authorization-code&grant_type=authorization_code&redirect_uri=https://www.google.com'
```
Google OAuth renvoie deux jetons : un jeton d'accès et un jeton d'actualisation.
```
{
  "access_token": "access-token",
  "expires_in": 3599,
  "refresh_token": "refresh-token",
  "scope": "https://www.googleapis.com/auth/sdm.service",
  "token_type": "Bearer"
}
```
Copiez ces deux valeurs. Le jeton d'accès permet d'appeler l'API SDM, et le jeton d'actualisation permet d'obtenir un nouveau jeton d'accès.

Effectuer un appel de liste d'appareils

L'autorisation n'est pas complète tant que vous n'avez pas effectué votre premier appel devices.list avec votre nouveau jeton d'accès. Cet appel initial termine le processus d'autorisation et active les événements si vous avez déjà configuré un abonnement Pub/Sub.

Utilisez curl pour effectuer cet appel pour le point de terminaison devices :

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

Un appel réussi renvoie la liste des appareils associés à votre projet Device Access. Chaque appareil possède sa propre liste de caractéristiques disponibles :

{
  "devices": [
    {
      "name": "enterprises/project-id/devices/device-id",
      "type": "sdm.devices.types.device-type",
      "traits": { ... },
      "parentRelations": [
        {
          "parent": "enterprises/project-id/structures/structure-id/rooms/room-id",
          "displayName": "device-room-name"
        }
      ]
    }
  ]
}

Utiliser un jeton d'actualisation

Les jetons d'accès pour l'API SDM ne sont valides que pendant une heure, comme indiqué dans le paramètre expires_in renvoyé par Google OAuth. Si votre jeton d'accès expire, utilisez le jeton d'actualisation pour en obtenir un nouveau.

Cette commande est semblable à celle du jeton d'accès, sauf que vous utilisez un grant_type différent.

Ouvrez un terminal et exécutez la commande curl suivante, en remplaçant :
1. oauth2-client-id et oauth2-client-secret avec l'ID client et le code secret du client OAuth2 de vos identifiants Google Cloud.
2. refresh-token avec le code que vous avez reçu lorsque vous avez obtenu le jeton d'accès.
```
curl -L -X POST 'https://www.googleapis.com/oauth2/v4/token?client_id=oauth2-client-id&client_secret=oauth2-client-secret&refresh_token=refresh-token&grant_type=refresh_token'
```

Google OAuth renvoie un nouveau jeton d'accès.

{
  "access_token": "new-access-token",
  "expires_in": 3599,
  "scope": "https://www.googleapis.com/auth/sdm.service",
  "token_type": "Bearer"
}

Dépannage

Pour en savoir plus sur Google OAuth, consultez Utiliser OAuth 2.0 pour accéder aux API Google.

Le jeton d'actualisation expire sans cesse

Les jetons d'actualisation peuvent cesser de fonctionner au bout de sept jours si l'ID client n'est pas approuvé. L'expiration du jeton au bout de sept jours n'est pas liée aux approbations commerciales ou sandbox. Un compte de service ou d'utilisateur doit faire approuver son ID client OAuth 2.0 et le mettre en production pour obtenir des jetons avec une durée de vie plus longue. Pour en savoir plus, consultez Expiration du jeton d'actualisation.

Accès refusé

Si vous avez configuré votre écran de consentement OAuth dans Google Cloud et que le type d'utilisateur est défini sur Externe, vous recevrez un message d'erreur "Accès refusé" si vous tentez d'associer un compte Google qui n'est pas répertorié en tant qu'utilisateur test pour votre application. Veillez à ajouter le compte Google à la section Utilisateurs test de votre écran de consentement OAuth.

Erreur du Gestionnaire des connexions partenaires (PCM)

Pour obtenir de l'aide sur les erreurs rencontrées lors de l'accès au PCM, consultez la documentation de référence sur les erreurs du Partner Connections Manager (PCM).

Google n'a pas validé cette application

L'API SDM utilise un champ d'application restreint, ce qui signifie que toutes les applications qui utilisent ce champ d'application lors de l'autorisation seront "non validées" tant que la validation de l'API OAuth n'aura pas été effectuée. Lorsque vous utilisez Device Access pour un usage personnel, la validation de l'API OAuth n'est pas requise.

Il est possible que l'écran "Google n'a pas validé cette application" s'affiche pendant le processus d'autorisation. Cela se produit si le champ d'application sdm.service n'est pas configuré sur votre écran de consentement OAuth dans Google Cloud. Vous pouvez ignorer cet écran en cliquant sur l'option Avancé, puis sur Accéder à Nom du projet (non sécurisé).

Pour en savoir plus, consultez la section Écran d'application non validée.

Client non valide

Lorsque vous tentez d'obtenir un jeton d'accès ou d'actualisation, vous recevez une erreur "Client non valide" si vous fournissez un secret client OAuth 2.0 incorrect. Assurez-vous que la valeur client_secret que vous utilisez dans les appels de jetons d'accès et d'actualisation est celle de l'ID client OAuth 2.0 utilisé, comme indiqué sur la page Identifiants Google Cloud.

Requête non valide, champ d'application obligatoire manquant

Après avoir accordé des autorisations dans PCM, vous pouvez rencontrer une erreur "Requête non valide" de type "Paramètre requis manquant : scope". Assurez-vous que la valeur scope que vous utilisez dans les appels d'autorisation est la même que celle que vous avez définie pour le client OAuth 2.0, comme indiqué sur la page Identifiants Google Cloud.

Incohérence de l'URI de redirection

Lors de l'autorisation, vous pouvez rencontrer une erreur "Redirect uri mismatch" (URI de redirection non concordante). Assurez-vous que la valeur redirect_uri que vous utilisez dans les appels d'autorisation est la même que celle que vous avez définie pour le client OAuth 2.0, comme indiqué sur la page Identifiants Google Cloud.

Modifier les autorisations du compte

Pour modifier les autorisations accordées à un projet Device Access ou le dissocier complètement, accédez à PCM :

https://nestservices.google.com/partnerconnections

Cette page affiche tous les services de développeurs tiers (projetsDevice Access ) associés à votre compte. Sélectionnez le projet Device Access que vous souhaitez modifier. Sur l'écran suivant, modifiez les autorisations comme vous le souhaitez.

Pour révoquer uniquement certaines autorisations pour un service autorisé, activez/désactivez les autorisations que vous souhaitez révoquer, puis cliquez sur la flèche "Retour" pour enregistrer.

Pour dissocier complètement un service autorisé, cliquez sur Dissocier votre compte Google afin de révoquer toutes les autorisations et tous les jetons d'accès accordés au projet pour le compte.

Si PCM n'affiche pas le service souhaité, vous devrez peut-être d'abord appeler la liste des appareils.

Référence rapide

Utilisez cette référence pour implémenter rapidement les étapes permettant d'autoriser unuser et d'associer son compte Google.

Pour utiliser cette référence rapide, modifiez chaque variable d'espace réservé dans les exemples de code avec les valeurs de votre intégration spécifique, puis copiez et collez selon vos besoins :

1 PCM

Ouvrez le lien suivant dans un navigateur Web, en remplaçant :

project-id par votre ID Device Access Project
oauth2-client-id avec l'ID client OAuth2 de vos identifiants Google Cloud

https://nestservices.google.com/partnerconnections/project-id/auth?redirect_uri=https://www.google.com&access_type=offline&prompt=consent&client_id=oauth2-client-id&response_type=code&scope=https://www.googleapis.com/auth/sdm.service

2 Code d'authentification

Vous devriez être redirigé vers https://www.google.com. Le code d'autorisation est renvoyé en tant que paramètre code dans l'URL, qui doit être au format suivant :

https://www.google.com?code=authorization-code&scope=https://www.googleapis.com/auth/sdm.service

3. Jeton d'accès

Utilisez le code d'autorisation pour récupérer un jeton d'accès que vous pourrez utiliser pour appeler l'API SDM.

Ouvrez un terminal et exécutez la commande curl suivante, en remplaçant :

oauth2-client-id et oauth2-client-secret avec l'ID client et le code secret du client OAuth2 de vos identifiants Google Cloud.
authorization-code par le code que vous avez reçu à l'étape précédente.

Google OAuth renvoie deux jetons : un jeton d'accès et un jeton d'actualisation.

Requête

curl -L -X POST 'https://www.googleapis.com/oauth2/v4/token?client_id=oauth2-client-id&client_secret=oauth2-client-secret&code=authorization-code&grant_type=authorization_code&redirect_uri=https://www.google.com'

Réponse

{
  "access_token": "access-token",
  "expires_in": 3599,
  "refresh_token": "refresh-token",
  "scope": "https://www.googleapis.com/auth/sdm.service",
  "token_type": "Bearer"
}

4 Appel d'API

Vous devez utiliser l'un des appels d'API listés pour le champ d'application spécifié afin de finaliser l'autorisation.

sdm.service

appareils

Pour en savoir plus, consultez la documentation de référence de l'API devices.list.

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

5 Jeton d'actualisation

Ouvrez un terminal et exécutez la commande curl suivante, en remplaçant :

oauth2-client-id et oauth2-client-secret avec l'ID client et le code secret du client OAuth2 de vos identifiants Google Cloud.
refresh-token avec le code que vous avez reçu lorsque vous avez obtenu le jeton d'accès.

Google OAuth renvoie un nouveau jeton d'accès.

Requête

curl -L -X POST 'https://www.googleapis.com/oauth2/v4/token?client_id=oauth2-client-id&client_secret=oauth2-client-secret&refresh_token=refresh-token&grant_type=refresh_token'

Réponse

{
  "access_token": "new-access-token",
  "expires_in": 3599,
  "scope": "https://www.googleapis.com/auth/sdm.service",
  "token_type": "Bearer"
}

1. Commencer

3. Utiliser l'API

Autoriser un compte Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Associer votre compte

Obtenir un jeton d'accès

Effectuer un appel de liste d'appareils

Utiliser un jeton d'actualisation

Dépannage

Le jeton d'actualisation expire sans cesse

Accès refusé

Erreur du Gestionnaire des connexions partenaires (PCM)

Google n'a pas validé cette application

Client non valide

Requête non valide, champ d'application obligatoire manquant

Incohérence de l'URI de redirection

Modifier les autorisations du compte

Référence rapide

1 PCM

2 Code d'authentification

3. Jeton d'accès

Requête

Réponse

4 Appel d'API

sdm.service

appareils

5 Jeton d'actualisation

Requête

Réponse

Autoriser un compte