REST Resource: users.availability

Ressource: Availability

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 sich auf den Anrufer zu beziehen. Beispiel: users/user@example.comoder users/me
state

enum (State)

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

object (CustomStatus)

Optional. Der benutzerdefinierte Status des Nutzers.
Zusätzliche Metadaten, die mit dem Verfügbarkeitsstatus des Nutzers verknüpft sind. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Nur Ausgabe. Metadaten, wenn der Nutzerstatus auf DO_NOT_DISTURB gesetzt ist.
Ende der sich gegenseitig ausschließenden Felder.

Bundesland

Stellt den aktuellen Verfügbarkeitsstatus des Nutzers dar.

Enums
STATE_UNSPECIFIED Standardwert. Kein Status angegeben.
ACTIVE Der Nutzer ist anhand der letzten Aktivitäten derzeit aktiv.
IDLE Der Nutzer ist derzeit inaktiv. Dieser Status gibt einen Zeitraum der Inaktivität nach dem Status AKTIV an, bevor möglicherweise zum Status ABWESEND gewechselt wird.
AWAY Der Nutzer ist derzeit nicht da. Dies kann entweder nach einer gewissen Zeit der Inaktivität im Status „AKTIV“ oder „INAKTIV“ automatisch festgelegt oder vom Nutzer manuell eingestellt werden. Wenn der Status manuell über availability.markAsAway festgelegt wird, bleibt er unabhängig von der Nutzeraktivität bestehen.
DO_NOT_DISTURB Der Nutzer befindet sich im Modus „Bitte nicht stören“, der manuell festgelegt wurde.

DoNotDisturbMetadata

Metadaten, die mit dem Verfügbarkeitsstatus DO_NOT_DISTURB verknüpft sind und angeben, wann der Status ablaufen soll.

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

string (Timestamp format)

Nur Ausgabe. Zeitstempel, bis zu dem der Nutzer als DO_NOT_DISTURB markiert werden soll. Das Datum darf 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.
Die Ablaufzeit des benutzerdefinierten Status. Er kann entweder als absoluter Zeitstempel oder als TTL-Dauer (Time-to-Live) angegeben werden. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
expireTime

string (Timestamp format)

Der Zeitstempel, der angibt, wann der benutzerdefinierte Status abläuft.
ttl

string (Duration format)

Nur Eingabe. Die Gültigkeitsdauer, nach der der benutzerdefinierte Status abläuft.
Ende der sich gegenseitig ausschließenden Felder.

Methoden

get

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

markAsActive

 Markiert den Nutzer in Google Chat als ACTIVE.

markAsAway

 Markiert den Nutzer in Google Chat als AWAY.

markAsDoNotDisturb

 Markiert den Nutzer in Google Chat als DO_NOT_DISTURB.

patch

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