Method: activities.watch

Benachrichtigungen zu Kontoaktivitäten erhalten Weitere Informationen finden Sie unter Push-Benachrichtigungen erhalten.

HTTP-Anfrage

POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
userKey or all

string

Stellt die Profil-ID oder die E-Mail-Adresse des Nutzers dar, nach der die Daten gefiltert werden sollen. Kann all für alle Informationen oder userKey für die eindeutige Google Workspace-Profil-ID eines Nutzers oder seine primäre E-Mail-Adresse sein. Darf kein gelöschter Nutzer sein. Rufen Sie für einen gelöschten Nutzer users.list in der Directory API mit showDeleted=true auf und verwenden Sie dann die zurückgegebene ID als userKey.

applicationName

enum (ApplicationName)

Der Name der Anwendung, für die die Ereignisse abgerufen werden sollen.

Abfrageparameter

Parameter
actorIpAddress

string

Die IP-Adresse des Hosts, auf dem das Ereignis ausgeführt wurde. So können Sie die Zusammenfassung eines Berichts zusätzlich nach der IP-Adresse des Nutzers filtern, dessen Aktivitäten erfasst werden. Diese IP-Adresse kann den physischen Standort des Nutzers angeben, muss es aber nicht. Die IP-Adresse kann beispielsweise die Adresse des Proxyservers des Nutzers oder die Adresse eines virtuellen privaten Netzwerks (VPN) sein. Dieser Parameter unterstützt sowohl IPv4- als auch IPv6-Adressversionen.

customerId

string

Die eindeutige ID des Kunden, für den Daten abgerufen werden sollen.

endTime

string

Legt das Ende des im Bericht dargestellten Zeitbereichs fest. Das Datum ist im RFC 3339-Format angegeben, z. B. 2010-10-28T10:26:35.000Z. Der Standardwert ist die ungefähre Zeit der API-Anfrage. Ein API-Bericht hat drei grundlegende Zeitkonzepte:

  • Datum der Anfrage der API für einen Bericht: Das Datum, an dem der Bericht von der API erstellt und abgerufen wurde.
  • Startzeit des Berichts: Der Beginn des im Bericht dargestellten Zeitraums. startTime muss vor endTime (falls angegeben) und der aktuellen Uhrzeit liegen, zu der die Anfrage gestellt wird. Andernfalls gibt die API einen Fehler zurück.
  • Ende des Berichtszeitraums: Das Ende des im Bericht dargestellten Zeitraums. Der Zeitraum der in einem Bericht zusammengefassten Ereignisse kann beispielsweise im April beginnen und im Mai enden. Der Bericht selbst kann im August angefordert werden.
Wenn endTime nicht angegeben ist, werden im Bericht alle Aktivitäten ab dem startTime bis zur aktuellen Zeit oder den letzten 180 Tagen zurückgegeben, wenn das startTime mehr als 180 Tage in der Vergangenheit liegt.

eventName

string

Der Name des Ereignisses, das von der API abgefragt wird. Jede eventName bezieht sich auf einen bestimmten Google Workspace-Dienst oder eine bestimmte Funktion, die von der API in Ereignistypen organisiert wird. Ein Beispiel sind die Google Kalender-Termine in den Berichten der Admin-Konsolenanwendung. Die Struktur type für Kalendereinstellungen enthält alle eventName-Aktivitäten für Google Kalender, die von der API gemeldet werden. Wenn ein Administrator eine Kalendereinstellung ändert, wird diese Aktivität in der API in den Parametern type und eventName für Kalendereinstellungen gemeldet. Weitere Informationen zu eventName-Suchstrings und ‑Parametern finden Sie oben in applicationName in der Liste der Ereignisnamen für verschiedene Anwendungen.

filters

string

Der Abfragestring filters ist eine durch Kommas getrennte Liste, die aus Ereignisparametern besteht, die durch relationale Operatoren manipuliert werden. Ereignisparameter haben das Format {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},....

Diese Ereignisparameter sind einer bestimmten eventName zugeordnet. Ein leerer Bericht wird zurückgegeben, wenn der Parameter der Anfrage nicht zu eventName gehört. Weitere Informationen zu den verfügbaren eventName-Feldern für jede Anwendung und den zugehörigen Parametern finden Sie in der Tabelle ApplicationName. Klicken Sie dann im Anhang für die gewünschte Anwendung auf die Seite „Activity Events“ (Aktivitätsereignisse).

In den folgenden Beispielen für Drive-Aktivitäten besteht die zurückgegebene Liste aus allen edit-Ereignissen, bei denen der Parameterwert doc_id den durch den relationalen Operator definierten Bedingungen entspricht. Im ersten Beispiel werden alle bearbeiteten Dokumente mit dem Wert doc_id gleich 12345 zurückgegeben. Im zweiten Beispiel werden alle bearbeiteten Dokumente zurückgegeben, in denen der Wert doc_id nicht gleich 98765 ist. Der Operator <> ist im Abfragestring der Anfrage URL-codiert (%3C%3E):

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

Eine filters-Abfrage unterstützt die folgenden relationalen Operatoren:

  • ==: „gleich“.
  • <> – „ungleich“. Muss URL-codiert sein (%3C%3E).
  • < – „weniger als“ Muss URL-codiert sein (%3C).
  • <=: „kleiner als oder gleich“. Muss URL-codiert sein (%3C=).
  • > – „größer als“ Muss URL-codiert sein (%3E).
  • >=: „größer als oder gleich“ Muss URL-codiert sein (%3E=).

Hinweis:Die API akzeptiert nicht mehrere Werte desselben Parameters. Wenn ein Parameter in der API-Anfrage mehrmals angegeben wird, akzeptiert die API nur den letzten Wert dieses Parameters. Wenn in der API-Anfrage ein ungültiger Parameter angegeben wird, ignoriert die API diesen Parameter und gibt die Antwort zurück, die den verbleibenden gültigen Parametern entspricht. Wenn keine Parameter angefordert werden, werden alle Parameter zurückgegeben.

maxResults

integer

Legt fest, wie viele Aktivitätsdatensätze auf jeder Antwortseite angezeigt werden. Wenn im Antrag beispielsweise maxResults=1 festgelegt ist und der Bericht zwei Aktivitäten enthält, hat der Bericht zwei Seiten. Das Attribut nextPageToken der Antwort enthält das Token für die zweite Seite. Der maxResults-Suchstring ist in der Anfrage optional. Der Standardwert ist 1.000.

orgUnitID
(deprecated)

string

Deprecated. Dieses Feld ist veraltet und wird nicht mehr unterstützt.

ID der Organisationseinheit, für die ein Bericht erstellt werden soll. Aktivitätsdatensätze werden nur für Nutzer angezeigt, die der angegebenen Organisationseinheit angehören.

pageToken

string

Das Token, mit dem die nächste Seite angegeben wird. Ein Bericht mit mehreren Seiten hat in der Antwort das Attribut nextPageToken. Geben Sie in Ihrer Folgeanfrage zum Abrufen der nächsten Seite des Berichts den Wert nextPageToken im Abfragestring pageToken ein.

startTime

string

Legt den Beginn des im Bericht angezeigten Zeitbereichs fest. Das Datum ist im RFC 3339-Format angegeben, z. B. 2010-10-28T10:26:35.000Z. Der Bericht enthält alle Aktivitäten vom startTime bis zum endTime. startTime muss vor endTime (falls angegeben) und der aktuellen Uhrzeit liegen, zu der die Anfrage gestellt wird. Andernfalls gibt die API einen Fehler zurück.

groupIdFilter
(deprecated)

string

Deprecated. Dieses Feld ist veraltet und wird nicht mehr unterstützt.

Durch Kommas getrennte Gruppen-IDs (verschleiert), nach denen Nutzeraktivitäten gefiltert werden. Die Antwort enthält also nur Aktivitäten für Nutzer, die mindestens einer der hier genannten Gruppen-IDs angehören. Format: „id:abc123,id:xyz456“

.

Anfragetext

Der Anfragetext enthält eine Instanz von SubscriptionChannel.

Antworttext

Ein Benachrichtigungskanal, der verwendet wird, um nach Ressourcenänderungen zu suchen.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}
Felder
id

string

Eine UUID oder ein ähnlicher eindeutiger String, der diesen Channel identifiziert.

token

string

Ein beliebiger String, der mit jeder Benachrichtigung, die über diesen Kanal gesendet wird, an die Zieladresse übermittelt wird. Optional.

expiration

string (int64 format)

Datum und Uhrzeit des Ablaufs des Benachrichtigungschannels als Unix-Zeitstempel in Millisekunden. Optional.

type

string

Der Typ des für diesen Channel verwendeten Bereitstellungsmechanismus. Der Wert sollte auf "web_hook" festgelegt sein.

address

string

Die Adresse, an die Benachrichtigungen für diesen Kanal gesendet werden.

payload

boolean

Ein boolescher Wert, der angibt, ob eine Nutzlast gewünscht wird. Eine Nutzlast sind Daten, die im Textkörper einer HTTP-POST-, PUT- oder PATCH-Nachricht gesendet werden und wichtige Informationen zur Anfrage enthalten. Optional.

params

map (key: string, value: string)

Zusätzliche Parameter zur Steuerung des Verhaltens des Auslieferungskanals. Optional.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

resourceId

string

Eine intransparente ID, die die auf diesem Kanal überwachte Ressource identifiziert. Stabil über verschiedene API-Versionen hinweg.

resourceUri

string

Eine versionsspezifische Kennung für die überwachte Ressource.

kind

string

Gibt an, dass dies ein Benachrichtigungskanal ist, der verwendet wird, um Änderungen an einer Ressource zu beobachten, die „api#channel“ ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.

ApplicationName

Der Name der Anwendung, für die die Ereignisse abgerufen werden sollen.

Enums
access_transparency

Die Google Workspace Access Transparency-Aktivitätsberichte enthalten Informationen zu verschiedenen Arten von Access Transparency-Aktivitätsereignissen.

admin

Die Aktivitätsberichte der Admin-Konsolenanwendung enthalten Kontoinformationen zu verschiedenen Arten von Administratoraktivitätsereignissen.

calendar

Die Aktivitätsberichte der Google Kalender App enthalten Informationen zu verschiedenen Kalenderaktivitäten.

chat Die Berichte zur Chat-Aktivität enthalten Informationen zu verschiedenen Chat-Aktivitätsereignissen.
drive

Die Aktivitätsberichte der Google Drive-Anwendung enthalten Informationen zu verschiedenen Google Drive-Aktivitätsereignissen. Der Drive-Aktivitätsbericht ist nur für Google Workspace Business- und Google Workspace Enterprise-Kunden verfügbar.

gcp Die Aktivitätsberichte der Google Cloud Platform-Anwendung enthalten Informationen zu verschiedenen GCP-Aktivitätsereignissen.
gplus Die Aktivitätsberichte der Google+ App enthalten Informationen zu verschiedenen Google+ Aktivitätsereignissen.
groups

Die Aktivitätsberichte der Google Groups-Anwendung enthalten Informationen zu verschiedenen Groups-Aktivitätsereignissen.

groups_enterprise

Die Aktivitätsberichte für Enterprise-Gruppen enthalten Informationen zu verschiedenen Aktivitätsereignissen für Enterprise-Gruppen.

jamboard Die Jamboard-Aktivitätsberichte enthalten Informationen zu verschiedenen Jamboard-Aktivitätsereignissen.
login

Die Aktivitätsberichte der Anmeldeanwendung enthalten Kontoinformationen zu verschiedenen Arten von Anmeldeaktivitätsereignissen.

meet Der Aktivitätsbericht „Meet-Audit“ enthält Informationen zu verschiedenen Arten von Meet-Audit-Aktivitätsereignissen.
mobile Der Aktivitätsbericht „Geräte-Audit“ enthält Informationen zu verschiedenen Arten von Geräte-Audit-Aktivitätsereignissen.
rules

Der Aktivitätsbericht für Regeln enthält Informationen zu verschiedenen Arten von Regelaktivitätsereignissen.

saml

Der SAML-Aktivitätsbericht enthält Informationen zu verschiedenen Arten von SAML-Aktivitätsereignissen.

token

Die Aktivitätsberichte der Token-Anwendung enthalten Kontoinformationen zu verschiedenen Arten von Token-Aktivitätsereignissen.

user_accounts

Die Aktivitätsberichte der Anwendung „Nutzerkonten“ enthalten Kontoinformationen zu verschiedenen Arten von Aktivitätsereignissen für Nutzerkonten.

context_aware_access

Die Aktivitätsberichte zum kontextsensitiven Zugriff enthalten Informationen zu Ereignissen, bei denen der Zugriff von Nutzern aufgrund von Regeln für den kontextsensitiven Zugriff verweigert wurde.

chrome

Die Chrome-Aktivitätsberichte enthalten Informationen zu Chrome-Browser- und ChromeOS-Ereignissen.

data_studio Die Data Studio-Aktivitätsberichte enthalten Informationen zu verschiedenen Arten von Data Studio-Aktivitätsereignissen.
keep Die Aktivitätsberichte der Keep App enthalten Informationen zu verschiedenen Google Keep-Aktivitätsereignissen. Der Bericht zu Keep-Aktivitäten ist nur für Google Workspace Business- und Enterprise-Kunden verfügbar.
classroom Die Classroom-Aktivitätsberichte enthalten Informationen zu verschiedenen Arten von Classroom-Aktivitätsereignissen.