Method: activities.list

Ruft eine Liste der Aktivitäten für das Konto und die Anwendung eines bestimmten Kunden ab, z. B. die App in der Admin-Konsole oder die Google Drive App Weitere Informationen finden Sie in den Leitfäden zu Aktivitätsberichten für Administratoren und Google Drive. Weitere Informationen zu den Parametern des Aktivitätsberichts finden Sie in den Referenzhandbüchern zu Aktivitätsparametern.

HTTP-Anfrage

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

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 durchgefü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 entspricht möglicherweise nicht dem physischen Standort des Nutzers. 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. 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.
  • Endzeit des Berichts: Das Ende des im Bericht angezeigten Zeitraums. 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 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 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 gibt der Bericht alle bearbeiteten Dokumente zurück, in denen der Wert doc_id ungleich 98765 ist. Der Operator <> wird im Abfragestring (%3C%3E) der Anfrage URL-codiert:

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

Für filters-Abfragen werden die folgenden relationalen Operatoren unterstützt:

  • ==: „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 für denselben Parameter. 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 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

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. Die nextPageToken-Eigenschaft 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

string

ID der Organisationseinheit, für die Berichte erstellt werden sollen. 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 in der Antwort die Property nextPageToken. 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 enthält alle Aktivitäten von startTime bis endTime. 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 muss leer sein.

Antworttext

JSON-Vorlage für eine Sammlung von Aktivitäten.

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

JSON-Darstellung 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
Felder
kind

string

Der Typ der API-Ressource. Bei einem Aktivitätsbericht ist der Wert reports#activities.
etag

string

ETag der Ressource.
items[]

object (Activity)

Für jeden Aktivitätseintrag in der Antwort.
nextPageToken

string

Token zum Abrufen der nächsten Seite des Berichts. Der Wert nextPageToken wird im Abfragestring pageToken der Anfrage verwendet.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

ApplicationName

Enums
access_transparency

Die Google Workspace-Aktivitätsberichte zu Access Transparency 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 App enthalten Informationen zu verschiedenen Google Drive-Aktivitätsereignissen. Der Bericht zu Drive-Aktivitäten ist nur für Google Workspace Business- und Enterprise-Kunden 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 enthalten Informationen zu verschiedenen Aktivitätsereignissen in Google Groups.
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 Meet-Audit-Aktivitätsereignissen.
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

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 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.
vault Die Vault-Aktivitätsberichte enthalten Informationen zu verschiedenen Arten von Vault-Aktivitätsereignissen.

Aktivität

JSON-Vorlage für die Aktivitätsressource.

JSON-Darstellung 
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string
  }
}
Felder
kind

string

Der Typ der API-Ressource. Bei einem Aktivitätsbericht ist der Wert audit#activity.
etag

string

ETag des Eintrags.
ownerDomain

string

Das ist die Domain, die vom Ereignis im Bericht betroffen ist. Beispiel: Domain der Admin-Konsole oder des Dokumentinhabers der Drive-Anwendung.
ipAddress

string

IP-Adresse des Nutzers, der die Aktion ausführt. Dies ist die IP-Adresse (Internet Protocol) des Nutzers bei der Anmeldung in Google Workspace. Sie entspricht möglicherweise nicht dem physischen Standort des Nutzers. Die IP-Adresse kann beispielsweise die Adresse des Proxyservers des Nutzers oder die Adresse eines virtuellen privaten Netzwerks (VPN) sein. Die API unterstützt IPv4 und IPv6.
events[]

object

Aktivitätsereignisse im Bericht
events[].type

string

Ereignistyp. Der Google Workspace-Dienst oder die Google Workspace-Funktion, die ein Administrator ändert, wird in der Property type angegeben, die ein Ereignis mithilfe der Property eventName identifiziert. Eine vollständige Liste der type-Kategorien der API finden Sie in der Liste der Ereignisnamen für verschiedene Anwendungen oben unter applicationName.
events[].name

string

Name des Ereignisses. Dies ist der spezifische Name der Aktivität, die von der API erfasst wurde. Jede eventName bezieht sich auf einen bestimmten Google Workspace-Dienst oder eine bestimmte Google Workspace-Funktion, die in der API in Ereignistypen unterteilt ist.
Für eventName-Anfrageparameter im Allgemeinen:

  • Wenn kein eventName angegeben ist, werden im Bericht alle möglichen Instanzen eines eventName zurückgegeben.
  • Wenn Sie eine eventName anfordern, gibt die API-Antwort alle Aktivitäten zurück, die diese eventName enthalten.

Weitere Informationen zu eventName-Properties finden Sie in der Liste der Ereignisnamen für verschiedene Anwendungen oben in applicationName.
events[].parameters[]

object

Parameter/Wert-Paare für verschiedene Anwendungen. Weitere Informationen zu eventName-Parametern finden Sie in der Liste der Ereignisnamen für verschiedene Anwendungen oben in applicationName.
events[].parameters[].messageValue

object

Verschachtelte Parameter/Wert-Paare, die mit diesem Parameter verknüpft sind. Komplexe Wertetypen für einen Parameter werden als Liste von Parameterwerten zurückgegeben. Der Adressparameter kann beispielsweise den Wert [{parameter: [{name: city, value: abc}]}] haben.
events[].parameters[].messageValue.parameter[]

object (NestedParameter)

Parameterwerte
events[].parameters[].name

string

Name des Parameters.
events[].parameters[].value

string

Stringwert des Parameters.
events[].parameters[].multiValue[]

string

Stringwerte des Parameters.
events[].parameters[].intValue

string (int64 format)

Ganzzahlwert des Parameters.
events[].parameters[].multiIntValue[]

string (int64 format)

Ganzzahlwerte des Parameters.
events[].parameters[].boolValue

boolean

Boolescher Wert des Parameters.
events[].parameters[].multiMessageValue[]

object

activities.list von messageValue-Objekten
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

Parameterwerte
id

object

Eindeutige Kennung für jeden Aktivitätseintrag.
id.time

string

Zeitpunkt des Auftretens der Aktivität. Dies ist die Zeit in Sekunden der UNIX-Epoche.
id.uniqueQualifier

string (int64 format)

Eindeutiger Qualifier, wenn mehrere Ereignisse zur selben Zeit stattfinden.
id.applicationName

string

Name der Anwendung, zu der das Ereignis gehört. Mögliche Werte finden Sie in der Liste der Anwendungen oben unter applicationName.
id.customerId

string

Die eindeutige Kennung für ein Google Workspace-Konto.
actor

object

Der Nutzer, der die Aktion ausführt.
actor.profileId

string

Die eindeutige Google Workspace-Profil-ID des Nutzers. Dieser Wert ist möglicherweise nicht vorhanden, wenn der Akteur kein Google Workspace-Nutzer ist. Möglicherweise ist es auch die Zahl 105250506097979753968, die als Platzhalter-ID dient.
actor.email

string

Die primäre E-Mail-Adresse des Akteurs. Kann nicht angegeben werden, wenn dem Akteur keine E-Mail-Adresse zugeordnet ist.
actor.callerType

string

Der Typ des Akteurs.
actor.key

string

Nur vorhanden, wenn callerType den Wert KEY hat. Kann die consumer_key des Anforderers für OAuth 2LO API-Anfragen oder eine ID für Robot-Konten sein.