REST Resource: users.availability

リソース: Availability

Google Chat でのユーザーの現在のステータス情報（状態（オンライン、オフライン、サイレント モードなど）やカスタム ステータスなど）を表します。

JSON 表現 
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
フィールド
name

string

ID。ユーザーの空き状況のリソース名。

形式: users/{user}/availability

{user} は、People API または Admin SDK Directory API の Person の ID です。例: users/123456789

ユーザーのメールアドレスまたは me を、発信者を指すエイリアスとして使用することもできます。たとえば、users/user@example.com や users/me です。
state

enum (State)

出力専用。ユーザーの現在の空き状況。
customStatus

object (CustomStatus)

省略可。ユーザーのカスタム ステータス。
ユーザーのステータスに関連付けられた追加のメタデータ。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
doNotDisturbMetadata

object (DoNotDisturbMetadata)

出力専用。ユーザーの状態が DO_NOT_DISTURB に設定されている場合のメタデータ。
相互に排他的なフィールドの終了。

州

ユーザーの現在の空き状況を表します。

列挙型
STATE_UNSPECIFIED デフォルト値。状態は指定されていません。
ACTIVE 最近のアクティビティに基づいて、ユーザーが現在アクティブである。
IDLE ユーザーは現在アイドル状態です。この状態は、ACTIVE 状態から AWAY 状態に移行する可能性があるまでの、操作がない期間を示します。
AWAY 現在、お客様は外出中です。これは、ACTIVE 状態または IDLE 状態が一定期間続いた後に自動的に設定することも、ユーザーが手動で設定することもできます。availability.markAsAway で手動で設定した場合、この状態はユーザーのアクティビティに関係なく維持されます。
DO_NOT_DISTURB ユーザーが手動で設定したサイレント モードになっている。

DoNotDisturbMetadata

DO_NOT_DISTURB の可用性状態に関連付けられたメタデータ。状態の有効期限が切れる日時を指定します。

JSON 表現 
{
  "expirationTime": string
}
フィールド
expirationTime

string (Timestamp format)

出力専用。ユーザーを DO_NOT_DISTURB としてマークする期限のタイムスタンプ。最長で 1 年先まで設定できます。

CustomStatus

Google Chat でのユーザーのカスタム ステータスを表します。これには、ユーザーが設定した短いテキスト メッセージと、空き状況に関するコンテキストをより詳しく伝えるための絵文字（省略可）が含まれます。

JSON 表現 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

  "expireTime": string,
  "ttl": string
}
フィールド
text

string

必須。カスタム ステータスのテキスト。これは最大長が 64 の文字列になります。
emoji

object (Emoji)

必須。カスタム ステータスの絵文字。Unicode 絵文字のみがサポートされています。カスタム絵文字は対象外です。
カスタム ステータスの有効期限。絶対タイムスタンプまたは存続期間として指定できます。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
expireTime

string (Timestamp format)

カスタム ステータスの有効期限のタイムスタンプ。
ttl

string (Duration format)

入力専用。カスタム ステータスの有効期限が切れるまでの存続期間。
相互に排他的なフィールドの終了。

メソッド

get

 Google Chat のユーザーの空き情報を返します。

markAsActive

 Google Chat でユーザーを ACTIVE としてマークします。

markAsAway

 Google Chat でユーザーを AWAY としてマークします。

markAsDoNotDisturb

 Google Chat でユーザーを DO_NOT_DISTURB としてマークします。

patch

 人間のユーザーの空き情報を更新します。