此页面由 Cloud Translation API 翻译。

对帐号授权

创建 Google Cloud 和 Device Access 项目后，您可以为支持的 Google Nest 设备授权 Google 账号使用 SDM API。

关联您的账号

如需查看结构和设备，您必须使用 PCM 将 Google 账号关联到Device Access 项目。PCM 允许 user 授予权限，以允许 developer访问其结构和设备数据。

在本指南中，您既是 user 也是 developer。

在网络浏览器中打开以下链接，并替换以下内容：

将 project-id 替换为您的 Device Access Project ID
oauth2-client-id 替换为您的 Google Cloud 凭据中的 OAuth2 客户端 ID

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

如果您最近使用多个账号登录过 Google，系统可能会先显示一个选择账号界面，其中列出了您的 Google 账号。如果是，请选择与您要授权的设备关联的 Google 账号 Device Access。
Google Nest 权限界面就是 PCM 本身。您可以在此处授予结构和设备权限。为住宅（第 1 步）和 SDM API 支持的住宅中的所有设备（第 2 步）开启相应权限，然后点击下一步。
在选择一个账号以继续到 Project Name 页面上（其中 Project Name 是您的 Google Cloud 项目的名称），选择您要为 SDM API 授权的 Google 账号。使用之前的 Google 账号。
选择账号后，您可能会看到一条警告屏幕，其中指出 Google 尚未验证此应用。如果出现这种情况，请点击高级选项，然后点击前往“Project Name”（项目名称）（不安全）以继续操作。如需了解详情，请参阅此应用未经 Google 验证。
在授予项目名称权限界面中，点击允许以向项目授予访问您的 Google 账号的权限。
在确认您的选择界面上，确保已选中您要授予的权限，然后点击允许进行确认。
系统应将您重定向至 https://www.google.com。授权代码会作为网址中的 code 参数返回，该参数应采用以下格式：
```
https://www.google.com?code=authorization-code&scope=https://www.googleapis.com/auth/sdm.service
```
复制授权代码。

获取访问令牌

使用授权代码检索访问令牌，以便调用 SDM API。

打开终端并运行以下 curl 命令，替换以下内容：
1. oauth2-client-id 和 oauth2-client-secret 使用 Google Cloud 凭据中的 OAuth2 客户端 ID 和客户端密钥
2. 将 authorization-code 替换为您在上一步中收到的代码
```
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 会返回两个令牌：访问令牌和刷新令牌。

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

复制这两个值。访问令牌用于调用 SDM API，刷新令牌用于获取新的访问令牌。

进行设备列表调用

只有在您使用新访问令牌进行首次 devices.list 调用后，授权才会完成。如果您已设置 Pub/Sub 订阅，此初始调用会完成授权流程并启用事件。

使用 curl 对 devices 端点进行以下调用：

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

成功调用会返回与您的 Device Access项目关联的设备列表。每部设备都有自己独特的可用 trait 列表：

{
  "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"
        }
      ]
    }
  ]
}

如何使用刷新令牌

SDM API 的访问令牌仅在 1 小时内有效，如 Google OAuth 返回的 expires_in 参数中所述。如果访问令牌过期，请使用刷新令牌获取新的访问令牌。

该命令与访问令牌命令类似，只不过您使用的是其他 grant_type。

打开一个终端并运行以下 curl 命令，替换以下内容：
1. oauth2-client-id 和 oauth2-client-secret 使用 Google Cloud 凭据中的 OAuth2 客户端 ID 和客户端密钥
2. refresh-token 替换为您在首次获取访问令牌时收到的代码。
```
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 会返回新的访问令牌。

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

问题排查

如需详细了解 Google OAuth，请参阅使用 OAuth 2.0 访问 Google API。

刷新令牌不断过期

刷新令牌可能会在 7 天后失效，客户端 ID 未获批准可能是其中一个原因。7 天令牌过期与商用或沙盒审批无关。服务账号或用户账号需要先让其 OAuth 2.0 客户端 ID 获得批准并投入生产环境，才能延长令牌的有效期。如需了解详情，请参阅刷新令牌过期。

访问遭拒

如果您已在 Google Cloud 中设置 OAuth 权限请求页面，并且用户类型为外部，那么如果您尝试与未列为应用测试用户的 Google 账号建立账号关联，则会收到“拒绝访问”错误。请务必将该 Google 账号添加到 OAuth 权限请求页面中的测试用户部分。

合作伙伴连接管理工具 (PCM) 错误

如需有关访问 PCM 时遇到的任何错误的帮助，请参阅 Partner Connections Manager (PCM) 错误参考文档。

此应用未经 Google 验证

SDM API 使用受限范围，这意味着，除非完成 OAuth API 验证，否则在授权期间使用此范围的任何应用都将处于“未经验证”状态。在个人使用 Device Access 时，无需进行 OAuth API 验证。

在授权过程中，您可能会看到“Google 尚未验证此应用”屏幕。如果您未在 Google Cloud 的 OAuth 权限请求页面上配置 sdm.service 范围，系统就会显示此屏幕。如需绕过此屏幕，请点击高级选项，然后点击前往项目名称（不安全）。

如需了解详情，请参阅“未验证的应用”屏幕。

客户端无效

如果您在尝试获取访问令牌或刷新令牌时提供的 OAuth 2.0 客户端密钥不正确，则会收到“无效的客户端”错误。确保您在访问令牌和刷新令牌调用中使用的 client_secret 值与所使用的 OAuth 2.0 客户端 ID 的值相同（请参阅 Google Cloud 凭据页面）。

请求无效，缺少必需的范围

在 PCM 中授予权限后，您可能会遇到“缺少必需参数：scope”的“请求无效”错误。确保您在授权调用中使用的 scope 值与您为 OAuth 2.0 客户端设置的值相同（如 Google Cloud 凭据页面中所示）。

重定向 URI 不匹配

在授权过程中，您可能会遇到“重定向 URI 不匹配”错误。确保您在授权调用中使用的 redirect_uri 值与您为 OAuth 2.0 客户端设置的值相同，如 Google Cloud 凭据页面中所示。

修改账号权限

如需修改向 Device Access 项目授予的权限或完全断开与项目的关联，请前往 PCM：

https://nestservices.google.com/partnerconnections

此页面会显示与您的账号关联的所有第三方开发者服务（Device Access 项目）。选择您要更改的 Device Access 项目。在下一个屏幕上，根据需要修改权限。

如需仅撤消已获授权服务的特定权限，请切换要撤消的权限，然后点击返回箭头进行保存。

如需完全解除与已获授权服务的关联，请点击解除与 Google 账号的关联，以撤消项目已向该账号授予的所有权限和访问令牌。

如果 PCM 未显示所需的服务，您可能需要先发出设备列表调用。

快速参考

请参阅此参考文档，快速执行授权user 并关联其 Google 账号的步骤。

如需使用此快速参考，请使用您具体集成的值修改代码示例中的每个占位符变量，并根据需要进行复制和粘贴：

1 PCM

在网络浏览器中打开以下链接，并替换以下内容：

将 project-id 替换为您的 Device Access Project ID
oauth2-client-id 替换为您的 Google Cloud 凭据中的 OAuth2 客户端 ID

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 个 Auth 代码

系统应将您重定向至 https://www.google.com。授权代码会作为网址中的 code 参数返回，该参数应采用以下格式：

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

3 访问令牌

使用授权代码检索访问令牌，以便调用 SDM API。

打开终端并运行以下 curl 命令，替换以下内容：

oauth2-client-id 和 oauth2-client-secret 使用 Google Cloud 凭据中的 OAuth2 客户端 ID 和客户端密钥
将 authorization-code 替换为您在上一步中收到的代码

Google OAuth 会返回两个令牌：访问令牌和刷新令牌。

请求

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'

响应

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

4 API 调用

只有在您使用新访问令牌进行首次 devices.list 调用后，授权才会完成。如果您已设置 Pub/Sub 订阅，此初始调用会完成授权流程并启用事件。

您必须使用为指定范围列出的 API 调用之一来完成授权。

sdm.service

设备

如需了解详情，请参阅 devices.list API 参考文档。

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

5 刷新令牌

SDM API 的访问令牌仅在 1 小时内有效，如 Google OAuth 返回的 expires_in 参数中所述。如果访问令牌过期，请使用刷新令牌获取新的访问令牌。

打开一个终端并运行以下 curl 命令，替换以下内容：

oauth2-client-id 和 oauth2-client-secret 使用 Google Cloud 凭据中的 OAuth2 客户端 ID 和客户端密钥
refresh-token 替换为您在首次获取访问令牌时收到的代码。

Google OAuth 会返回新的访问令牌。

请求

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'

响应

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

1. 开始使用

3. 使用 API