Ereignisformate

In diesem Abschnitt wird das Format von Ereignissen beschrieben, die Ihre Anwendung von Google Chat empfängt.

Ereignisfelder

Wenn Ihre App ein Ereignis von Google Chat empfängt, enthält das Ereignis einen Anfragetext: Dies ist die JSON-Nutzlast, die das Ereignis darstellt. Diese Nutzlast enthält Elemente, die für alle Ereignistypen gelten, sowie Elemente, die für den jeweiligen Ereignistyp spezifisch sind. Das folgende Diagramm zeigt die Felder, die in der Nutzlast vorhanden sein können:

Häufige Ereignisfelder

Häufige Felder werden unabhängig von ihrem Typ immer in der Nutzlast aller Ereignisse bereitgestellt.

Feld Typ Beschreibung
type String Die Art des Ereignisses, das die App empfängt.
eventTime String Der Zeitstempel (gemäß RFC 3339), der angibt, wann das Ereignis ausgelöst wurde.

Typspezifische Ereignisfelder

In der Nutzlast der Anfrage können zusätzliche Felder vorhanden sein, sofern sie für den Ereignistyp relevant sind.

Feld Typ Beschreibung Veranstaltungsart
message die Botschaft und Die Nachricht, die sich auf das Ereignis bezieht. Nachricht wurde dem Gruppenbereich hinzugefügt.
space Leertaste Der Gruppenbereich, der sich auf das Ereignis bezieht. Die Nachricht wurde dem Gruppenbereich hinzugefügt und aus dem Gruppenbereich entfernt.
user Nutzer Der Nutzer, der sich auf das Ereignis bezieht. Die Nachricht wurde dem Gruppenbereich hinzugefügt und aus dem Gruppenbereich entfernt.
thread Thread Der Thread, zu dem eine Nachricht gehört. Nur Nachrichtenereignisse.

Ereignistypen

In diesem Abschnitt werden Beispiele für die Arten von Ereignissen beschrieben, die Ihre Anwendung erhalten kann.

MESSAGE

Dieses Ereignis steht für eine Nachricht, die an die App gesendet wird.

Die Nachrichtendetails werden als Felder im Feld message gespeichert. Antwortverhalten: Die Nachricht wird im selben Thread wie die ursprüngliche Nutzernachricht gepostet.

Beispiel für eine Nutzlast:

{
  "type": "MESSAGE",
  "eventTime": "2017-03-02T19:02:59.910959Z",
  "space": {
    "name": "spaces/AAAAAAAAAAA",
    "displayName": "Customer Support Superstars",
    "spaceType": "SPACE"
  },
  "message": {
    "name": "spaces/AAAAAAAAAAA/messages/CCCCCCCCCCC",
    "sender": {
      "name": "users/12345678901234567890",
      "displayName": "Izumi",
      "avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
      "email": "izumi@example.com"
    },
    "createTime": "2017-03-02T19:02:59.910959Z",
    "text": "@TestBot Create ticket.",
    "argumentText": " Create ticket.",
    "thread": {
      "name": "spaces/AAAAAAAAAAA/threads/BBBBBBBBBBB"
    },
    "annotations": [
      {
        "length": 8,
        "startIndex": 0,
        "userMention": {
          "type": "MENTION",
          "user": {
            "avatarUrl": "https://.../avatar.png",
            "displayName": "TestBot",
            "name": "users/1234567890987654321",
            "type": "BOT"
          }
        },
        "type": "USER_MENTION"
      }
    ],
    "attachment": [
      {
        "name": "spaces/5o6pDgAAAAE/messages/Ohu1LlUVcS8.Ohu1LlUVcS8/attachments/AATUf-Iz7d8kySEdRRZd-dznqBk3",
        "content_name": "solar.png",
        "content_type": "image/png",
        "drive_data_ref": {
          "drive_file_id": "H1HqaqRuH2Pfd_TOa1fF2_ltwDlV_yKRrr"
        },
        "source": "DRIVE_FILE"
      }
    ]
  },
  "user": {
    "name": "users/12345678901234567890",
    "displayName": "Izumi",
    "avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
    "email": "izumi@example.com"
  }
}

ADDED_TO_SPACE

Dieses Ereignis zeigt an, dass Ihre App einem Gruppenbereich hinzugefügt wurde. Anwendungen reagieren normalerweise auf diese Veranstaltung, indem sie eine Willkommensnachricht in einem neuen Thread im Gruppenbereich posten.

Das folgende JSON-Beispiel zeigt den Anfragetext für ein ADDED_TO_SPACE-Ereignis, wenn ein Nutzer eine Chat-App zu einem Gruppenbereich hinzufügt:

{
  "type": "ADDED_TO_SPACE",
  "eventTime": "2017-03-02T19:02:59.910959Z",
  "space": {
    "name": "spaces/AAAAAAAAAAA",
    "displayName": "Customer Support Superstars",
    "spaceType": "SPACE",
    "adminInstalled": "false"
  },
  "user": {
    "name": "users/12345678901234567890",
    "displayName": "Izumi",
    "avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
    "email": "izumi@example.com"
  }
}

Von Google Workspace-Administratoren installiert

Das Ereignis ADDED_TO_SPACE kann auch anzeigen, dass ein Google Workspace-Administrator die Chat-App für einen Nutzer in seiner Organisation installiert hat.

Administratoren können eine Chat-App nur für Direktnachrichten zwischen der App und dem Nutzer installieren. Die installierte App wird im Bereich für Direktnachrichten der Nutzer angezeigt. Nutzer können keine Apps deinstallieren, die von ihrem Administrator installiert wurden. Weitere Informationen zu von Administratoren installierten Chat-Apps finden Sie in der Google Workspace-Admin-Hilfe unter Marketplace-Apps in Ihrer Domain installieren.

Das folgende JSON-Beispiel zeigt den Anfragetext für ein ADDED_TO_SPACE-Ereignis, wenn ein Google Workspace-Administrator eine Chat-App für einen Nutzer installiert. Da die Anwendung von einem Administrator installiert wurde, wird adminInstalled auf true gesetzt:

{
  "type": "ADDED_TO_SPACE",
  "eventTime": "2017-03-02T19:02:59.910959Z",
  "space": {
    "name": "spaces/AAAAAAAAAAA",
    "displayName": "Customer Support Superstars",
    "spaceType": "DIRECT_MESSAGE",
    "adminInstalled": "true"
  },
  "user": {
    "name": "users/12345678901234567890",
    "displayName": "Izumi",
    "avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
    "email": "izumi@example.com"
  }
}

REMOVED_FROM_SPACE

Dieses Ereignis zeigt an, dass Ihre App aus einem Gruppenbereich entfernt wurde. Apps reagieren nicht auf dieses Ereignis, da sie bereits entfernt wurden.

Das folgende JSON-Beispiel zeigt den Anfragetext für ein REMOVED_FROM_SPACE-Ereignis, wenn ein Nutzer eine Anwendung aus einem Gruppenbereich entfernt:

{
  "type": "REMOVED_FROM_SPACE",
  "eventTime": "2017-03-02T19:02:59.910959Z",
  "space": {
    "name": "spaces/AAAAAAAAAAA",
    "spaceType": "SPACE",
    "adminInstalled": "false"
  },
  "user": {
    "name": "users/12345678901234567890",
    "displayName": "Izumi,
    "avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
    "email": "izumi@example.com"
  }
}

Von Google Workspace-Administratoren deinstalliert

Das Ereignis REMOVED_FROM_SPACE kann auch anzeigen, dass ein Google Workspace-Administrator die Chat-App für einen Nutzer in seiner Organisation deinstalliert hat. Nach der Deinstallation wird die App nicht mehr im Bereich für Direktnachrichten des Nutzers angezeigt.

Wenn ein Nutzer Ihre Anwendung vor dem Administrator installiert hat, bleibt sie für den Nutzer installiert. Da die App noch installiert ist, empfängt sie in diesem Fall kein REMOVED_FROM_SPACE-Ereignis.

Das folgende JSON-Beispiel zeigt den Anfragetext für ein REMOVED_FROM_SPACE-Ereignis, wenn ein Google Workspace-Administrator eine Chat-App für einen Nutzer deinstalliert. Da die Anwendung von einem Administrator deinstalliert wurde, wird adminInstalled auf true gesetzt:

{
  "type": "REMOVED_FROM_SPACE",
  "eventTime": "2017-03-02T19:02:59.910959Z",
  "space": {
    "name": "spaces/AAAAAAAAAAA",
    "spaceType": "DIRECT_MESSAGE",
    "adminInstalled": "true"
  },
  "user": {
    "name": "users/12345678901234567890",
    "displayName": "Izumi,
    "avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
    "email": "izumi@example.com"
  }
}