REST Resource: users.availability

리소스: 이용 가능 여부

상태 (예: 활동 중, 자리 비움, 방해 금지 모드) 및 맞춤 상태를 비롯한 Google Chat의 사용자 현재 대화 가능 상태 정보를 나타냅니다.

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

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
필드
name

string

식별자. 사용자 일정의 리소스 이름입니다.

형식: users/{user}/availability

{user}는 People API 또는 Admin SDK 디렉터리 API의 사용자 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)

필수 항목입니다. 맞춤 상태의 그림 이모티콘입니다. 유니코드 그림 이모티콘만 지원되며 맞춤 그림 이모티콘은 지원되지 않습니다.
통합 필드 expiration. 맞춤 상태의 만료 시간입니다. 절대 타임스탬프 또는 TTL 기간으로 지정할 수 있습니다. 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

 실제 사용자의 참석 여부 정보를 업데이트합니다.