Method: activities.watch

Sie erhalten Benachrichtigungen zu Kontoaktivitäten. 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

string

Stellt die Profil-ID oder die E-Mail-Adresse des Nutzers dar, für den die Daten gefiltert werden sollen. Kann all für alle Informationen oder userKey für die eindeutige Google Workspace-Profil-ID oder die primäre E-Mail-Adresse eines Nutzers sein. Der Nutzer darf nicht gelöscht worden 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)

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

Abfrageparameter

Parameter
actorIpAddress

string

Die IP-Adresse (Internet Protocol) des Hosts, auf dem das Ereignis ausgeführt wurde. So können Sie die Zusammenfassung eines Berichts zusätzlich anhand der IP-Adresse des Nutzers filtern, dessen Aktivität erfasst wird. Diese IP-Adresse kann den physischen Standort des Nutzers widerspiegeln oder 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 angezeigten Zeitraums fest. Das Datum ist im RFC 3339-Format, z. B. 2010-10-28T10:26:35.000Z. Der Standardwert ist die ungefähre Uhrzeit der API-Anfrage. Ein API-Bericht umfasst drei grundlegende Zeitkonzepte:

  • Datum der API-Anfrage für einen Bericht: Das Datum, an dem die API den Bericht erstellt und abgerufen hat.
  • Beginn des Berichts: Der Beginn der im Bericht angezeigten Zeitspanne. Das startTime muss vor dem endTime (falls angegeben) und der aktuellen Uhrzeit liegen, wenn die Anfrage gestellt wird. Andernfalls gibt die API einen Fehler zurück.
  • Ende des Berichts: Ende der im Bericht angezeigten Zeitspanne. Der Zeitraum der Ereignisse, die in einem Bericht zusammengefasst werden, 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 vom startTime bis zur aktuellen Uhrzeit oder die letzten 180 Tage zurückgegeben, wenn das startTime mehr als 180 Tage zurückliegt.

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 Google Workspace-Funktion, die in der API in Ereignistypen unterteilt ist. Ein Beispiel hierfür sind die Google Kalender-Ereignisse in den Berichten der Admin-Konsole. Die Struktur type in den Kalendereinstellungen enthält alle eventName-Aktivitäten in Google Kalender, die von der API gemeldet wurden. Wenn ein Administrator eine Kalendereinstellung ändert, meldet die API diese Aktivität in den Parametern „Kalendereinstellungen“ type und eventName. Weitere Informationen zu eventName-Suchstrings und ‑Parametern finden Sie in der Liste der Ereignisnamen für verschiedene Anwendungen oben in applicationName.

filters

string

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

Diese Ereignisparameter sind mit einer 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 jede Anwendung und die zugehörigen Parameter finden Sie in der Tabelle ApplicationName. Klicken Sie dann im Anhang auf die Seite „Aktivitätsereignisse“ für die gewünschte Anwendung.

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 vom relationalen Operator definierten Bedingungen entspricht. Im ersten Beispiel gibt die Anfrage alle bearbeiteten Dokumente zurück, deren doc_id-Wert mit 12345 übereinstimmt. Im zweiten Beispiel werden im Bericht alle bearbeiteten Dokumente zurückgegeben, bei denen der doc_id-Wert nicht mit 98765 übereinstimmt. 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:

  • ==: „ist gleich“.
  • <> – „ungleich“. 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 für denselben Parameter. Wird ein Parameter in der API-Anfrage mehrmals angegeben, akzeptiert die API nur den letzten Wert dieses Parameters. Wenn in der API-Anfrage ein ungültiger Parameter angegeben wird, wird dieser von der API ignoriert und die Antwort wird entsprechend den verbleibenden gültigen Parametern zurückgegeben. Wenn keine Parameter angefordert werden, werden alle Parameter zurückgegeben.

maxResults

integer

Damit wird festgelegt, wie viele Aktivitätseinträge auf jeder Antwortseite angezeigt werden. Wenn in der Anfrage beispielsweise maxResults=1 festgelegt ist und der Bericht zwei Aktivitäten enthält, hat er 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 wurde eingestellt und wird nicht mehr unterstützt.

ID der Organisationseinheit, für die Berichte erstellt werden sollen. Aktivitätsdaten werden nur für Nutzer angezeigt, die der angegebenen Organisationseinheit angehören.

pageToken

string

Das Token, das die nächste Seite angeben soll. Ein Bericht mit mehreren Seiten enthält in der Antwort die Property nextPageToken. Geben Sie in der nachfolgenden Anfrage, mit der die nächste Seite des Berichts abgerufen wird, den Wert nextPageToken in den Abfragestring pageToken ein.

startTime

string

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

groupIdFilter

string

Kommagetrennte Gruppen-IDs (verschleiert), nach denen Nutzeraktivitäten gefiltert werden. Die Antwort enthält also nur Aktivitäten der 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

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

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

token

string

Ein beliebiger String, der mit jeder Benachrichtigung über diesen Kanal an die Zieladresse 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 des Auslieferungsmechanismus, der für diesen Kanal verwendet wird. 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 ist. 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, die das Verhalten des Auslieferungschannels 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 auf diesem Kanal beobachtete Ressource identifiziert. Sie sind für verschiedene API-Versionen stabil.

resourceUri

string

Eine versionsspezifische Kennung für die überwachte Ressource.

kind

string

Gibt an, dass es sich hierbei um einen Benachrichtigungskanal handelt, der zum Überwachen von Änderungen an einer Ressource verwendet wird (api#channel).

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

ApplicationName

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-Konsole enthalten Kontoinformationen zu verschiedenen Arten von Ereignissen zu Administratoraktivitäten.

calendar

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

chat Die Berichte zu Chat-Aktivitäten enthalten Informationen zu verschiedenen Ereignissen.
drive

Die Aktivitätsberichte der Google Drive-Anwendung geben Informationen über verschiedene Google Drive-Aktivitätsereignisse zurück. Der Bericht zu Drive-Aktivitäten 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 geben Informationen zu verschiedenen Google Groups-Aktivitätsereignissen zurück.

groups_enterprise

Die Berichte zu Enterprise-Gruppenaktivitäten 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 Anmelde-App enthalten Kontoinformationen zu verschiedenen Arten von Ereignissen zu Anmeldeaktivitäten.

meet Der Bericht zu Meet-Audit-Aktivitäten enthält Informationen zu verschiedenen Arten von Audit-Aktivitätsereignissen von Meet.
mobile Der Bericht zu Geräteaudit-Aktivitäten enthält Informationen zu verschiedenen Arten von Aktivitätsereignissen der Geräteaudit.
rules

Der Bericht „Regelaktivität“ enthält Informationen zu verschiedenen Arten von Ereignissen für Regelaktivitäten.

saml

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

token

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

user_accounts

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

context_aware_access

Die Berichte zu Aktivitäten mit kontextsensitivem Zugriff enthalten Informationen zu Zugriffsverweigerungen für Nutzer aufgrund von Regeln für den kontextsensitiven Zugriff.

chrome

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

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