REST Resource: users.availability

Ressource: Verfügbarkeit

Stellt die aktuellen Verfügbarkeitsinformationen eines Nutzers in Google Chat dar, einschließlich seines Status (z. B. „Aktiv“, „Abwesend“, „Bitte nicht stören“) und eines benutzerdefinierten Status.

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

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

string

ID. Ressourcenname der Verfügbarkeit des Nutzers.

Format: users/{user}/availability

{user} ist die ID für die Person in der People API oder Admin SDK Directory API. Beispiel: users/123456789.

Die E-Mail-Adresse des Nutzers oder me kann auch als Alias verwendet werden, um auf den Anrufer zu verweisen. Beispiel: users/user@example.com oder users/me.
state

enum (State)

Nur Ausgabe. Der aktuelle Verfügbarkeitsstatus des Nutzers.
customStatus

object (CustomStatus)

Optional. Der benutzerdefinierte Status des Nutzers.
Union-Feld state_metadata. Zusätzliche Metadaten, die mit dem Verfügbarkeitsstatus des Nutzers verknüpft sind. Für state_metadata ist nur einer der folgenden Werte zulässig:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Nur Ausgabe. Metadaten, wenn der Nutzerstatus auf „Bitte nicht stören“ gesetzt ist.

Bundesland

Stellt den aktuellen Verfügbarkeitsstatus des Nutzers dar.

Enums
STATE_UNSPECIFIED Standardwert. Kein Status angegeben.
ACTIVE Der Nutzer ist derzeit aktiv, basierend auf der letzten Aktivität.
IDLE Der Nutzer ist derzeit inaktiv. Dieser Status gibt einen Zeitraum der Inaktivität nach dem Status „Aktiv“ an, bevor möglicherweise zu „Abwesend“ gewechselt wird.
AWAY Der Nutzer ist derzeit abwesend. Dieser Status kann entweder automatisch nach einer gewissen Zeit der Inaktivität im Status „Aktiv“ oder „Inaktiv“ festgelegt werden oder manuell vom Nutzer. Wenn dieser Status manuell über availability.markAsAway festgelegt wird, bleibt er unabhängig von der Nutzeraktivität bestehen.
DO_NOT_DISTURB Der Nutzer hat den Status „Bitte nicht stören“ festgelegt.

DoNotDisturbMetadata

Metadaten, die mit dem Verfügbarkeitsstatus DO_NOT_DISTURB verknüpft sind und angeben, wann der Status abläuft.

JSON-Darstellung 
{
  "expirationTime": string
}
Felder
expirationTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel, bis zu dem der Nutzer als „Bitte nicht stören“ gekennzeichnet werden soll. Dieser Wert kann maximal ein Jahr in der Zukunft liegen.

CustomStatus

Stellt den benutzerdefinierten Status eines Nutzers in Google Chat dar. Dazu gehört eine kurze Textnachricht mit einem optionalen Emoji, die ein Nutzer festlegt, um mehr Kontext zu seiner Verfügbarkeit zu geben.

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

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

string

Erforderlich. Der Text des benutzerdefinierten Status. Dies ist ein String mit einer maximalen Länge von 64 Zeichen.
emoji

object (Emoji)

Erforderlich. Das Emoji des benutzerdefinierten Status. Es werden nur Unicode-Emojis unterstützt. Benutzerdefinierte Emojis werden nicht unterstützt.
Union-Feld expiration. Die Ablaufzeit des benutzerdefinierten Status. Sie kann entweder als absoluter Zeitstempel oder als Gültigkeitsdauer angegeben werden. Für expiration ist nur einer der folgenden Werte zulässig:
expireTime

string (Timestamp format)

Der Zeitstempel, an dem der benutzerdefinierte Status abläuft.
ttl

string (Duration format)

Nur Eingabe. Die Gültigkeitsdauer, nach der der benutzerdefinierte Status abläuft.

Methoden

get

 Gibt Verfügbarkeitsinformationen für einen menschlichen Nutzer in Google Chat zurück.

markAsActive

 Kennzeichnet den Nutzer in Google Chat als ACTIVE.

markAsAway

 Kennzeichnet den Nutzer in Google Chat als AWAY.

markAsDoNotDisturb

 Kennzeichnet den Nutzer in Google Chat als DO_NOT_DISTURB.

patch

 Aktualisiert die Verfügbarkeitsinformationen für einen menschlichen Nutzer.