Method: activities.watch

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

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

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

enum (ApplicationName)

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

Abfrageparameter

Parameter
actorIpAddress

string

Die IP-Adresse des Hosts, für den das Ereignis durchgeführt wurde Dies ist eine zusätzliche Möglichkeit, die Zusammenfassung eines Berichts anhand der IP-Adresse des Nutzers zu filtern, dessen Aktivität gemeldet wird. Diese IP-Adresse gibt den physischen Standort des Nutzers an oder nicht. Bei der IP-Adresse kann es sich beispielsweise um die Adresse des Proxyservers des Nutzers oder um die Adresse eines virtuellen privaten Netzwerks (VPN) handeln. 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 angezeigten Zeitraums fest. Das Datum ist im RFC 3339-Format, 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, an dem die API einen Bericht anfordert: der Zeitpunkt, zu dem die API den Bericht erstellt und abgerufen hat
  • Beginn des Berichts: Der Anfang des Zeitraums, der im Bericht angezeigt wird. startTime muss vor dem endTime (falls angegeben) und dem aktuellen Zeitpunkt liegen, an dem die Anfrage gesendet wird. Andernfalls gibt die API einen Fehler zurück.
  • Ende des Berichts: Das Ende des Zeitraums, der im Bericht angezeigt wird. Beispielsweise kann der Zeitraum von Ereignissen in einem Bericht im April beginnen und im Mai enden. Der Bericht selbst kann im August angefordert werden.
Wenn die endTime nicht angegeben ist, gibt der Bericht alle Aktivitäten vom startTime bis zur aktuellen Zeit zurück. Falls die startTime mehr als 180 Tage zurückliegt, werden die letzten 180 Tage angezeigt.
eventName

string

Der Name des Ereignisses, das von der API abgefragt wird. Jeder eventName ist mit einem bestimmten Google Workspace-Dienst oder einer bestimmten Funktion verknüpft, die die API in Ereignistypen organisiert. Ein Beispiel sind die Google Kalender-Termine in den Berichten der Admin-Konsole. Die Struktur der Kalendereinstellungen type enthält alle eventName-Aktivitäten in Google Kalender, die von der API gemeldet werden. Wenn ein Administrator eine Kalendereinstellung ändert, meldet die API diese Aktivität in den Parametern type und eventName in den Kalendereinstellungen. Weitere Informationen zu eventName-Abfragestrings und -Parametern finden Sie oben in der Liste der Ereignisnamen für verschiedene Anwendungen in applicationName.
filters

string

Der Abfragestring filters ist eine durch Kommas getrennte Liste mit Ereignisparametern, die von relationalen Operatoren geändert werden. Ereignisparameter haben das Format {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

Diese Ereignisparameter sind mit einem bestimmten eventName verknüpft. Wenn der Parameter der Anfrage nicht zu eventName gehört, wird ein leerer Bericht zurückgegeben. Weitere Informationen zu den verfügbaren eventName-Feldern für die einzelnen Anwendungen und die zugehörigen Parameter finden Sie in der Tabelle Anwendungsname. Klicken Sie dann im Anhang der gewünschten Anwendung auf die Seite mit den Aktivitätsereignissen.

In den folgenden Beispielen zur Drive-Aktivität enthält die zurückgegebene Liste alle edit-Ereignisse, bei denen der Parameterwert doc_id den Bedingungen des relationalen Operators entspricht. Im ersten Beispiel gibt die Anfrage alle bearbeiteten Dokumente mit einem doc_id-Wert von 12345 zurück. Im zweiten Beispiel gibt der Bericht alle bearbeiteten Dokumente zurück, bei denen der Wert von doc_id nicht 98765 ist. Der Operator <> ist im Abfragestring der Anfrage (%3C%3E) URL-codiert:

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

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

  • ==: „ist gleich“.
  • <>: „ist nicht gleich“. Muss URL-codiert sein (%3C%3E).
  • <: „kleiner 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 ein ungültiger Parameter in der API-Anfrage 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 in der Anfrage beispielsweise maxResults=1 festgelegt ist und der Bericht zwei Aktivitäten hat, hat der Bericht zwei Seiten. Die Eigenschaft nextPageToken der Antwort enthält das Token zur zweiten Seite. Der Abfragestring maxResults ist in der Anfrage optional. Der Standardwert ist 1.000.
orgUnitId

string

ID der Organisationseinheit, für die ein Bericht erstellt werden soll. Aktivitätseinträge werden nur für Nutzer angezeigt, die zur angegebenen Organisationseinheit gehören.

pageToken

string

Das Token, das die nächste Seite angeben soll. Ein Bericht mit mehreren Seiten enthält die Property nextPageToken in der Antwort. Geben Sie in Ihrer Folgeanfrage zur nächsten Seite des Berichts den Wert nextPageToken im Abfragestring pageToken ein.
startTime

string

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

string

Kommagetrennte Gruppen-IDs (verschleiert), nach denen Nutzeraktivitäten gefiltert werden, d.h. die Antwort enthält Aktivitäten nur für diejenigen Nutzer, die zu mindestens einer der hier genannten Gruppen-IDs gehören. Format: „id:abc123,id:xyz456“

Anfragetext

Der Anfragetext enthält eine Instanz von SubscriptionChannel.

Antworttext

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

Ein Benachrichtigungskanal, der zum Überwachen von Ressourcenänderungen verwendet wird.

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 Kanal identifiziert.
token

string

Ein beliebiger String, der an die Zieladresse gesendet wird, wobei jede Benachrichtigung über diesen Kanal gesendet wird. Optional.
expiration

string (int64 format)

Datum und Uhrzeit des Ablaufs des Benachrichtigungskanals, ausgedrückt als Unix-Zeitstempel in Millisekunden. Optional.
type

string

Die Art der Auslieferungsmethode, die für diesen Kanal verwendet wird. Der Wert sollte auf "web_hook" festgelegt werden.
address

string

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

boolean

Boolescher Wert, der angibt, ob die Nutzlast benötigt wird Eine Nutzlast ist Daten, die im Text einer HTTP POST-, PUT- oder PATCH-Nachricht gesendet werden und wichtige Informationen über die Anfrage enthalten. Optional.
params

map (key: string, value: string)

Zusätzliche Parameter, die das Verhalten des Bereitstellungskanals steuern. 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 Ressource identifiziert, die auf diesem Kanal beobachtet wird. Stabile API-Versionen
resourceUri

string

Eine versionsspezifische Kennung für die beobachtete Ressource.
kind

string

Kennzeichnet dies als Benachrichtigungskanal, über den nach Änderungen an einer Ressource gesucht wird (api#channel).

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Übersicht zu OAuth 2.0.

Anwendungsname

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

Enums
access_transparency

Die Berichte zur Access Transparency-Aktivität von Google Workspace enthalten Informationen zu verschiedenen Arten von Access Transparency-Aktivitätsereignissen.
admin

Die Aktivitätsberichte der Admin-Konsole geben Kontoinformationen zu verschiedenen Arten von Administratoraktivitätsereignissen zurück.
calendar

Die Aktivitätsberichte der Google Kalender App geben Informationen zu verschiedenen Kalenderaktivitätsereignissen zurück.
chat Die Berichte zu Chataktivitäten enthalten Informationen zu verschiedenen Chataktivitätsereignissen.
drive

Die Aktivitätsberichte der Google Drive-Anwendung enthalten Informationen über verschiedene Google Drive-Aktivitätsereignisse. Der Bericht zur Drive-Aktivität ist nur für Google Workspace Business- und Google Workspace Enterprise-Kunden verfügbar.
gcp Die Aktivitätsberichte der Google Cloud Platform geben Informationen zu verschiedenen GCP-Aktivitätsereignissen zurück.
gplus Die Aktivitätsberichte der Google+ App geben Informationen zu verschiedenen Google+ Aktivitätsereignissen zurück.
groups

Die Aktivitätsberichte der Google Groups App geben Informationen zu verschiedenen Gruppenaktivitätsereignissen zurück.
groups_enterprise

Die Aktivitätsberichte für Enterprise-Gruppen geben Informationen zu verschiedenen Aktivitätsereignissen für Enterprise-Gruppen zurück.
jamboard Die Berichte zu Jamboard-Aktivitäten geben Informationen zu verschiedenen Jamboard-Aktivitätsereignissen zurück.
login

Die Aktivitätsberichte der Anmeldeanwendung geben Kontoinformationen zu verschiedenen Arten von Anmeldeaktivitätsereignissen zurück.
meet Der Bericht zur Meet-Auditaktivität enthält Informationen zu verschiedenen Arten von Meet-Auditaktivitäten.
mobile Der Bericht zur Geräteaudit-Aktivität gibt Informationen zu verschiedenen Arten von Aktivitätsereignissen aus.
rules

Der Bericht zur Regelaktivität enthält Informationen zu verschiedenen Arten von Regelaktivitätsereignissen.
saml

Der Bericht zu SAML-Aktivitäten enthält Informationen zu verschiedenen Arten von SAML-Aktivitätsereignissen.
token

Die Aktivitätsberichte der Token-App geben Kontoinformationen zu verschiedenen Arten von Token-Aktivitätsereignissen zurück.
user_accounts

Die Aktivitätsberichte der Nutzerkonten geben Kontoinformationen zu verschiedenen Arten von Aktivitätsereignissen der Nutzerkonten zurück.
context_aware_access

Die Berichte zu kontextsensitiven Zugriffsaktivitäten geben aufgrund von Regeln für den kontextsensitiven Zugriff Informationen zu Ereignissen zurück, für die der Zugriff verweigert wurde.
chrome

Die Berichte zu Chrome-Aktivitäten enthalten Informationen zu Chrome-Browser- und Chrome OS-Ereignissen.
data_studio Die Aktivitätsberichte in Data Studio enthalten Informationen zu verschiedenen Arten von Aktivitätsereignissen.
keep Die Aktivitätsberichte der Notizen App geben Informationen zu verschiedenen Aktivitäten der Google Notizen App zurück. Dieser Bericht ist nur für Kunden von Google Workspace Business und Google Workspace Enterprise verfügbar.