Method: users.availability.markAsActive

在 Google Chat 中将用户标记为 ACTIVE

将用户的空闲状态设置为 ACTIVEACTIVE 状态会持续到指定的到期时间,届时用户的状态会变为 AWAY。请注意,如果用户正在积极使用 Chat,ACTIVE 状态的持续时间可能会超出提供的过期时间。

此方法仅更新经过身份验证的用户的空闲情况。

需要使用授权范围进行用户身份验证

  • https://www.googleapis.com/auth/chat.users.availability

HTTP 请求

POST https://chat.googleapis.com/v1/{name=users/*/availability}:markAsActive

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要标记为有效的空闲时间的资源名称。格式:users/{user}/availability

{user} 是 People API 或 Admin SDK Directory API 中人员的 ID。例如 users/123456789

用户的电子邮件地址或 me 也可用作别名来指代调用者。例如 users/user@example.comusers/me

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{

  "expireTime": string,
  "ttl": string
}
字段
“ACTIVE”可用性状态的过期时间。订阅到期后,用户将被标记为“不在”。如果未提供到期时间,则“有效”状态将在当前时间 30 分钟后过期。以下是互斥字段的列表。在响应中,最多只能设置一个字段:
expireTime

string (Timestamp format)

有效状态失效的绝对时间戳。

ttl

string (Duration format)

从当前时间到 ACTIVE 状态过期的时间段。使用较短的 TTL 可以有效地将用户状态重置为基于此短暂时间后的 activity。

互斥字段的结束位置。

响应正文

如果成功,则响应正文包含一个 Availability 实例。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/chat.users.availability

如需了解详情,请参阅授权指南