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)

省略可。ユーザーのカスタム ステータス。
共用体フィールド state_metadata。ユーザーのステータスに関連付けられた追加のメタデータ。state_metadata は次のいずれかになります。
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 絵文字のみがサポートされています。カスタム絵文字はサポートされていません。
共用体フィールド expiration。カスタム ステータスの有効期限。絶対タイムスタンプまたは有効期間として指定できます。expiration は次のいずれかになります。
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

 ユーザーのステータス情報を更新します。