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

Die Profil-ID oder die E-Mail-Adresse des Nutzers, nach dem 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 den zurückgegebenen 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 durchgeführt wurde. Dies ist eine zusätzliche Möglichkeit, die Zusammenfassung eines Berichts anhand der IP-Adresse des Nutzers zu filtern, dessen Aktivitäten gemeldet werden. 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 wird 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 besteht aus drei grundlegenden Zeitkonzepten:

  • 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. Der startTime muss vor der 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. 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, gibt der Bericht alle Aktivitäten vom startTime bis zum aktuellen Zeitpunkt oder zu den letzten 180 Tagen zurück, wenn der 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 Google Workspace-Funktion, die von der API in Arten von Ereignissen organisiert wird. Ein Beispiel hierfür sind die Google Kalender-Termine 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 type und eventName der Kalendereinstellungen. Weitere Informationen zu eventName-Abfragestrings und -Parametern finden Sie oben in der applicationName in der Liste der Ereignisnamen für verschiedene Anwendungen.
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 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 mit den Aktivitätsereignissen.

In den folgenden Beispielen für Drive-Aktivitäten enthält die zurückgegebene Liste alle edit-Ereignisse, bei denen der Parameterwert doc_id mit den durch den relationalen Operator definierten Bedingungen übereinstimmt. Im ersten Beispiel gibt die Anfrage alle bearbeiteten Dokumente mit einem doc_id-Wert gleich 12345 zurück. Im zweiten Beispiel gibt der Bericht alle bearbeiteten Dokumente zurück, in denen der Wert doc_id ungleich 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).
  • < – „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, ignoriert das 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 wird und der Bericht zwei Aktivitäten enthält, umfasst 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 ist veraltet 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 hat die Property nextPageToken in der Antwort. Geben Sie in Ihrer Folgeanfrage zum Abrufen der nächsten Seite des Berichts 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. Der startTime muss vor der 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. Das heißt, 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

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

Ein UUID oder ein ähnlicher eindeutiger String, der diesen Kanal identifiziert.
token

string

Beliebiger String, der bei 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

Boolescher Wert, der angibt, ob Nutzlast erwünscht ist. Eine Nutzlast besteht aus Daten, die im Text 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. Stabil bei verschiedenen API-Versionen.
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 liefern Kontoinformationen zu verschiedenen Arten von Administrator-Aktivitätsereignissen.
calendar

Die Aktivitätsberichte der Google Kalender-Anwendung liefern Informationen zu verschiedenen Aktivitäten in Google Kalender.
chat Die Berichte zu Chataktivitäten enthalten Informationen zu verschiedenen Chataktivitätsereignissen.
drive

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

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

Die Aktivitätsberichte für Unternehmensgruppen liefern Informationen zu verschiedenen Gruppenaktivitätsereignissen.
jamboard In den Berichten zu Jamboard-Aktivitäten finden Sie Informationen zu verschiedenen Jamboard-Aktivitätsereignissen.
login

Die Aktivitätsberichte der Anmeldeanwendung geben Kontoinformationen zu verschiedenen Arten von Anmeldeaktivitäten zurück.
meet Der Bericht zu Audit-Aktivitäten in Meet enthält Informationen zu verschiedenen Arten von Audit-Aktivitätsereignissen von Meet.
mobile Der Bericht „Geräteprüfaktivitäten“ enthält Informationen zu verschiedenen Arten von Aktivitätsereignissen aus dem 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 Nutzerkontenanwendung geben Kontoinformationen über verschiedene Arten von Aktivitätsereignissen von Nutzerkonten zurück.
context_aware_access

Die Berichte über Aktivitäten zum kontextsensitiven Zugriff liefern Informationen über die Ereignisse des Typs „Zugriff verweigert“ aufgrund von Regeln für den kontextsensitiven Zugriff.
chrome

In den Berichten zu Chrome-Aktivitäten finden Sie Informationen zu Chrome-Browser- und Chrome OS-Ereignissen.
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 aus Google Notizen. Der Google Notizen-Aktivitätsbericht ist nur für Kunden von Google Workspace Business und Google Workspace Enterprise verfügbar.