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

Parameters
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 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)

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

Abfrageparameter

Parameters
actorIpAddress

string

Die Internet Protocol-Adresse (IP-Adresse) des Hosts, auf dem das Ereignis stattgefunden hat. Dies ist eine zusätzliche Möglichkeit, die Zusammenfassung eines Berichts nach der IP-Adresse des Nutzers zu filtern, dessen Aktivität gemeldet wird. Diese IP-Adresse kann den physischen Standort des Nutzers widerspiegeln. Beispielsweise kann die IP-Adresse 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 hat das RFC 3339-Format, z. B. 2010-10-28T10:26:35.000Z. Der Standardwert ist die ungefähre Zeit der API-Anfrage. Ein API-Bericht umfasst drei grundlegende Zeitkonzepte:

  • Datum der Berichtsanfrage durch die API: Zeitpunkt, zu dem die API den Bericht erstellt und abgerufen hat.
  • Startzeit des Berichts: Der Beginn der im Bericht angezeigten Zeitspanne. startTime muss vor dem endTime (falls angegeben) und der aktuellen Uhrzeit der Anfrage liegen. Andernfalls gibt die API einen Fehler zurück.
  • Ende des Berichts: Das Ende des Zeitraums, der im Bericht angezeigt wird. Beispielsweise kann der Zeitraum der in einem Bericht zusammengefassten Ereignisse im April beginnen und im Mai enden. Der Bericht selbst kann im August angefordert werden.
Wenn endTime nicht angegeben ist, enthält der Bericht alle Aktivitäten vom startTime bis zur aktuellen Uhrzeit oder zu den letzten 180 Tagen, wenn die startTime mehr als 180 Tage in der Vergangenheit liegt.
eventName

string

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

string

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

Diese Ereignisparameter sind einem bestimmten eventName zugeordnet. Wenn der Parameter der Anfrage nicht zum eventName gehört, wird ein leerer Bericht zurückgegeben. 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 der gewünschten Anwendung auf die Seite „Aktivitätsereignisse“.

In den folgenden Drive-Aktivitätsbeispielen 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 zurück, der gleich 12345 ist. Im zweiten Beispiel werden im Bericht alle bearbeiteten Dokumente zurückgegeben, bei denen der doc_id-Wert nicht gleich 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 diese relationalen Operatoren:

  • == – „gleich“.
  • <> – nicht gleich. Muss URL-codiert sein (%3C%3E).
  • < – „kleiner als“. Muss URL-codiert sein (%3C).
  • <= – „kleiner 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. Wird ein Parameter in der API-Anfrage mehrmals angegeben, akzeptiert die API nur den letzten Wert des Parameters. Wird in der API-Anfrage ein ungültiger Parameter angegeben, ignoriert die API diesen Parameter und gibt die Antwort zurück, die den verbleibenden gültigen Parametern entspricht. Werden keine Parameter angefordert, werden alle Parameter zurückgegeben.
maxResults

integer

Legt fest, wie viele Aktivitätsdatensätze auf jeder Antwortseite angezeigt werden. Wenn die Anfrage beispielsweise maxResults=1 festlegt 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 Abfragestring maxResults 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 der 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 der Folgeanfrage zum Abrufen der 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 hat das RFC 3339-Format, z. B. 2010-10-28T10:26:35.000Z. Der Bericht enthält alle Aktivitäten vom startTime bis zum endTime. startTime muss vor dem endTime (falls angegeben) und der aktuellen Uhrzeit der Anfrage liegen. 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 nur Aktivitäten für die 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

Benachrichtigungskanal zur Überwachung von Ressourcenänderungen.

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

Eine beliebige Zeichenfolge, die 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 als Unix-Zeitstempel in Millisekunden. Optional.
type

string

Der für diesen Kanal verwendete Übermittlungsmechanismus. Der Wert sollte auf "web_hook" festgelegt werden.
address

string

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

boolean

Ein boolescher Wert, der angibt, ob Nutzlast gebraucht wird. Eine Nutzlast sind Daten, die im Textkörper 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 auf diesem Kanal angesehene Ressource identifiziert. Stabil über verschiedene API-Versionen hinweg.
resourceUri

string

Eine versionsspezifische Kennung für die beobachtete Ressource.
kind

string

Kennzeichnet dies als Benachrichtigungskanal zur Überwachung von Änderungen an einer Ressource (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 Access Transparency-Aktivitätsberichte für Google Workspace enthalten Informationen zu verschiedenen Arten von Access Transparency-Aktivitätsereignissen.
admin

In den Aktivitätsberichten der Admin-Konsole werden Kontoinformationen zu verschiedenen Arten von Administratoraktivitätsereignissen zurückgegeben.
calendar

Die Aktivitätsberichte der Google Kalender-Anwendung enthalten Informationen zu verschiedenen Kalenderaktivitätsereignissen.
chat Die Berichte zur Chataktivität enthalten Informationen zu verschiedenen Ereignissen der Chataktivität.
drive

Die Aktivitätsberichte der Google Drive-Anwendung enthalten Informationen zu verschiedenen Google Drive-Aktivitätsereignissen. Der Aktivitätsbericht in Drive ist nur für Kunden von Google Workspace Business und Google Workspace Enterprise 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 App enthalten Informationen zu verschiedenen Google Groups-Aktivitätsereignissen.
groups_enterprise

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

In den Aktivitätsberichten der Anmeldeanwendung werden Kontoinformationen zu verschiedenen Arten von Ereignissen der Anmeldeaktivität zurückgegeben.
meet Dieser enthält Informationen zu den verschiedenen Arten von Meet-Audit-Aktivitätsereignissen.
mobile Dieser Bericht enthält Informationen zu verschiedenen Arten von Aktivitätsereignissen der Geräteprüfung.
rules

Der Bericht zur Regelaktivität enthält Informationen zu verschiedenen Arten von Aktivitätsereignissen für Regeln.
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 Nutzerkonten-Anwendung geben Kontoinformationen zu verschiedenen Arten von Aktivitätsereignissen der Nutzerkonten zurück.
context_aware_access

Die Berichte zu Aktivitäten für den kontextsensitiven Zugriff enthalten Informationen zu Ereignissen, die Nutzern aufgrund von Regeln für den kontextsensitiven Zugriff den Zugriff verweigert haben.
chrome

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