REST Resource: users.availability

Resource: Availability

Mewakili informasi ketersediaan pengguna saat ini di Google Chat, termasuk statusnya (misalnya, Aktif, Pergi, Jangan Ganggu) dan status kustom apa pun.

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

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
Kolom
name

string

ID. Nama resource ketersediaan pengguna.

Format: users/{user}/availability

{user} adalah ID untuk Orang di People API atau Admin SDK Directory API. Misalnya, users/123456789.

Alamat email atau me pengguna juga dapat digunakan sebagai alias untuk merujuk pemanggil. Misalnya, users/user@example.com atau users/me.
state

enum (State)

Hanya output. Status ketersediaan pengguna saat ini.
customStatus

object (CustomStatus)

Opsional. Status kustom pengguna.
Metadata tambahan yang terkait dengan status ketersediaan pengguna. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Hanya output. Metadata jika status pengguna disetel ke DO_NOT_DISTURB.
Akhir kolom yang saling eksklusif.

Negara bagian/Provinsi

Menunjukkan status ketersediaan pengguna saat ini.

Enum
STATE_UNSPECIFIED Nilai default. Status tidak ditentukan.
ACTIVE Pengguna saat ini aktif, berdasarkan aktivitas terbaru.
IDLE Pengguna saat ini tidak aktif. Status ini menunjukkan periode tidak aktif setelah AKTIF, sebelum berpotensi beralih ke TIDAK ADA.
AWAY Pengguna sedang tidak ada. Setelan ini dapat disetel secara otomatis setelah periode tidak aktif dalam status AKTIF atau IDLE, atau dapat disetel secara manual oleh pengguna. Jika disetel secara manual melalui availability.markAsAway, status ini akan tetap ada terlepas dari aktivitas pengguna.
DO_NOT_DISTURB Pengguna dalam status Jangan Ganggu, yang ditetapkan secara manual.

DoNotDisturbMetadata

Metadata yang terkait dengan status ketersediaan DO_NOT_DISTURB, yang menentukan kapan status akan berakhir.

Representasi JSON 
{
  "expirationTime": string
}
Kolom
expirationTime

string (Timestamp format)

Hanya output. Stempel waktu hingga pengguna harus ditandai sebagai JANGAN_GANGGU. Tanggal ini dapat ditetapkan maksimum 1 tahun ke depan.

CustomStatus

Mewakili status kustom pengguna di Google Chat. Hal ini mencakup pesan teks singkat dengan emoji opsional yang ditetapkan pengguna untuk memberikan lebih banyak konteks tentang ketersediaan mereka.

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

  "expireTime": string,
  "ttl": string
}
Kolom
text

string

Wajib. Teks status kustom. Ini akan berupa string dengan panjang maksimum 64.
emoji

object (Emoji)

Wajib. Emoji status kustom. Hanya emoji Unicode yang didukung; emoji kustom tidak didukung.
Waktu habis masa berlaku status kustom. Dapat ditentukan sebagai stempel waktu absolut atau durasi time-to-live. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
expireTime

string (Timestamp format)

Stempel waktu saat status kustom berakhir.
ttl

string (Duration format)

Hanya input. Durasi time-to-live setelah status kustom berakhir.
Akhir kolom yang saling eksklusif.

Metode

get

 Menampilkan informasi ketersediaan untuk pengguna manusia di Google Chat.

markAsActive

 Menandai pengguna sebagai ACTIVE di Google Chat.

markAsAway

 Menandai pengguna sebagai AWAY di Google Chat.

markAsDoNotDisturb

 Menandai pengguna sebagai DO_NOT_DISTURB di Google Chat.

patch

 Memperbarui informasi ketersediaan untuk pengguna manusia.