Method: activities.list

Pobiera listę działań na koncie i w aplikacji klienta, takich jak konsola administracyjna lub aplikacja Dysk Google. Więcej informacji znajdziesz w przewodnikach dotyczących raportów aktywności administratora i Dysku Google. Więcej informacji o parametrach raportu aktywności znajdziesz w przewodnikach dotyczących parametrów aktywności.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
userKey or all

string

Określa identyfikator profilu lub adres e-mail użytkownika, którego dane mają zostać odfiltrowane. Może to być all w przypadku wszystkich informacji lub userKey w przypadku unikalnego identyfikatora profilu użytkownika Google Workspace lub jego podstawowego adresu e-mail. Nie może być usuniętym użytkownikiem. W przypadku usuniętego użytkownika wywołaj interfejs users.list w interfejsie Directory API przy użyciu showDeleted=true, a następnie użyj zwróconego pliku ID jako właściwości userKey.

applicationName

enum (ApplicationName)

Nazwa aplikacji, dla której mają zostać pobrane zdarzenia.

Parametry zapytania

Parametry
actorIpAddress

string

Adres IP hosta, na którym wystąpiło zdarzenie. Jest to dodatkowy sposób filtrowania podsumowania raportu na podstawie adresu IP użytkownika, którego aktywność jest zgłaszana. Ten adres IP może nie odpowiadać fizycznej lokalizacji użytkownika. Może to być na przykład adres serwera proxy użytkownika lub wirtualna sieć prywatna (VPN). Ten parametr obsługuje zarówno wersje adresów IPv4, jak i IPv6.

customerId

string

Unikalny identyfikator klienta, dla którego zostaną pobrane dane.

endTime

string

Ustawia koniec zakresu czasu wyświetlanego w raporcie. Data jest w formacie RFC 3339, na przykład 2010-10-28T10:26:35.000Z. Wartość domyślna to przybliżony czas żądania do interfejsu API. Raport dotyczący interfejsu API obejmuje 3 podstawowe zagadnienia dotyczące czasu:

  • Data przesłania żądania raportu o interfejsie API: data utworzenia i pobrania raportu przez interfejs API.
  • Czas rozpoczęcia raportu: początek okresu wybranego w raporcie. Wartość w polu startTime musi być wcześniejsza niż endTime (jeśli została określona) i bieżąca data wysłania żądania. W przeciwnym razie interfejs API zwróci błąd.
  • Czas zakończenia raportu: koniec okresu wybranego w raporcie. Na przykład podsumowanie zdarzeń w raporcie może się rozpocząć w kwietniu, a w maju. Można poprosić o ten raport w sierpniu.
Jeśli nie określisz wartości endTime, raport zwróci wszystkie działania z okresu startTime do bieżącego czasu lub ostatnich 180 dni, jeśli startTime przekracza 180 dni w przeszłości.

eventName

string

Nazwa zdarzenia, którego dotyczy interfejs API. Każda właściwość eventName jest powiązana z konkretną usługą lub funkcją Google Workspace, którą interfejs API dzieli na typy zdarzeń. Przykładem mogą być zdarzenia z Kalendarza Google w raportach w konsoli administracyjnej. Struktura type ustawień kalendarza zawiera wszystkie działania z Kalendarza eventName raportowane przez interfejs API. Gdy administrator zmieni ustawienie Kalendarza, interfejs API zgłosi tę aktywność w ustawieniach Kalendarza type i eventName. Więcej informacji o eventName ciągach zapytań i parametrach znajdziesz na liście nazw zdarzeń dla różnych aplikacji powyżej w applicationName.

filters

string

Ciąg zapytania filters to lista rozdzielonych przecinkami, złożona z parametrów zdarzenia wykonywanych przez operatory relacyjne. Parametry zdarzenia mają postać {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

Te parametry zdarzenia są powiązane z konkretną wartością eventName. Jeśli parametr żądania nie należy do eventName, zwracany jest pusty raport. Więcej informacji o polach eventName dostępnych w przypadku poszczególnych aplikacji i powiązanych parametrach znajdziesz w tabeli ApplicationName, a następnie na stronie „Zdarzenia związane z aktywnością” wybranej aplikacji otwórz stronę Zdarzenia.

W poniższych przykładach aktywności na Dysku zwracana lista zawiera wszystkie zdarzenia edit, w których wartość parametru doc_id jest zgodna z warunkami określonymi przez operator relacyjny. W pierwszym przykładzie żądanie zwraca wszystkie edytowane dokumenty z wartością doc_id równą 12345. W drugim przykładzie raport zwraca wszystkie edytowane dokumenty, których wartość doc_id nie jest równa 98765. Operator <> jest zakodowany w adresie URL w ciągu zapytania (%3C%3E):

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

Zapytanie filters obsługuje te operatory relacyjne:

  • ==&&33;równa się&&33;
  • <>—&33;nie równa się' Musi być zakodowany na potrzeby adresu URL (%3C%3E).
  • <&&33;mniej niż'. Musi być zakodowany na potrzeby adresu URL (%3C).
  • <=—' mniejsze niż lub równe; Musi być zakodowany na potrzeby adresu URL (%3C=).
  • >—i ponad 39; Musi być zakodowany na potrzeby adresu URL (%3E).
  • >=&&33; ma wartość większą lub równą '. Musi być zakodowany na potrzeby adresu URL (%3E=).

Uwaga: interfejs API nie akceptuje wielu wartości tego samego parametru. Jeśli parametr zostanie podany w żądaniu więcej niż raz, interfejs API zaakceptuje tylko jego ostatnią wartość. Jeśli w żądaniu interfejsu API zostanie podany nieprawidłowy parametr, interfejs zignoruje ten parametr i zwróci odpowiedź odpowiadającą pozostałym prawidłowym parametrom. Jeśli nie zażądano żadnych parametrów, zostaną zwrócone wszystkie parametry.

maxResults

integer

Określa liczbę rekordów aktywności wyświetlanych na każdej stronie odpowiedzi. Jeśli na przykład żądanie zawiera żądanie maxResults=1, a raport zawiera 2 działania, będzie on zawierał 2 strony. Właściwość „nextPageToken” w odpowiedzi zawiera token do drugiej strony. Ciąg zapytania maxResults jest opcjonalny w żądaniu. Wartością domyślną jest 1000.

orgUnitId

string

Identyfikator jednostki organizacyjnej, której ma dotyczyć raport. Zapisy aktywności będą widoczne tylko dla użytkowników, którzy należą do określonej jednostki organizacyjnej.

pageToken

string

Token określający następną stronę. Raport z wieloma stronami ma właściwość nextPageToken. W kolejnym żądaniu pobrania następnej strony raportu wpisz wartość nextPageToken w ciągu zapytania pageToken.

startTime

string

Ustawia początek zakresu czasu wyświetlanego w raporcie. Data jest w formacie RFC 3339, na przykład 2010-10-28T10:26:35.000Z. Raport zawiera wszystkie działania od startTime do endTime. Wartość w polu startTime musi być wcześniejsza niż endTime (jeśli została określona) i bieżąca data wysłania żądania. W przeciwnym razie interfejs API zwróci błąd.

groupIdFilter

string

Rozdzielone przecinkami identyfikatory grup (zaciemnione), w przypadku których działania użytkowników są filtrowane. Oznacza to, że odpowiedź będzie zawierać informacje tylko o tych użytkownikach, którzy należą do co najmniej jednego z wymienionych tutaj identyfikatorów grup. Format: "id:abc123,id:xyz456"

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Szablon JSON kolekcji aktywności.

Zapis JSON
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
Pola
kind

string

Typ zasobu interfejsu API. W raporcie o aktywności wartość wynosi reports#activities.

etag

string

ETag zasobu.

items[]

object (Activity)

Każdy zapis aktywności w odpowiedzi.

nextPageToken

string

Token do pobierania następnej strony raportu. W ciągu zapytania pageToken używana jest wartość nextPageToken z żądania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie OAuth 2.0.

Nazwa aplikacji

Wartości w polu enum
access_transparency

Raporty Aktywność związana z Przejrzystością dostępu Google Workspace zawierają informacje o różnych typach zdarzeń związanych z Przejrzystością dostępu.

admin

Raporty o aktywności w aplikacji konsoli administracyjnej zwracają informacje o koncie dotyczące różnych typów zdarzeń związanych z aktywnością administratora.

calendar

Raporty o aktywności w aplikacji Kalendarz Google zawierają informacje o różnych wydarzeniach związanych z aktywnością w Kalendarzu.

chat Raporty o aktywności w Google Chat zawierają informacje o różnych zdarzeniach związanych z aktywnością w Google Chat.
drive

Raporty o aktywności w aplikacji Dysk Google zawierają informacje o różnych zdarzeniach związanych z aktywnością na Dysku Google. Raport aktywności na Dysku jest dostępny tylko dla klientów korzystających z Google Workspace Business i Google Workspace Enterprise.

gcp Raporty o aktywności w aplikacji Google Cloud Platform zawierają informacje o różnych zdarzeniach związanych z aktywnością w GCP.
gplus Raporty o aktywności w aplikacji Google+ zawierają informacje o różnych wydarzeniach związanych z aktywnością w Google+.
groups

Raporty o aktywności w Grupach dyskusyjnych Google zawierają informacje o różnych zdarzeniach związanych z aktywnością w Grupach dyskusyjnych.

groups_enterprise

Raporty o aktywności w grupach firmowych zawierają informacje o zdarzeniach związanych z aktywnością w grupach firmowych.

jamboard Raporty o aktywności w Jamboardzie zawierają informacje o różnych zdarzeniach Jamboard.
login

Raporty o aktywności w aplikacji logowania podają informacje o koncie dotyczące różnych typów zdarzeń związanych z logowaniem.

meet Raport z aktywności w Meet zawiera informacje o różnych typach zdarzeń związanych z aktywnością w Meet.
mobile Raport z kontroli urządzenia zawiera informacje o różnych typach zdarzeń związanych z aktywnością na urządzeniu.
rules

Raport działań związanych z regułami zawiera informacje o różnych typach zdarzeń związanych z regułami.

saml

Raport aktywności SAML zawiera informacje o różnych typach zdarzeń związanych z aktywnością SAML.

token

Raporty o aktywności związanej z tokenami zwracają informacje o koncie dotyczące różnych typów zdarzeń związanych z aktywnością tokena.

user_accounts

Raporty o aktywności w kontach użytkowników zwracają informacje o kontach różnych typów zdarzeń na kontach użytkowników.

context_aware_access

Raporty o aktywności z dostępem zależnym od kontekstu zwracają informacje o użytkownikach i zdarzeniach odmowy dostępu wynikających z reguł dostępu zależnego od kontekstu.

chrome

Raporty o aktywności w Chrome zwracają informacje o zdarzeniach w przeglądarce Chrome i zdarzeniach Chrome OS.

data_studio Raporty aktywności w Studiu danych zawierają informacje o różnych typach zdarzeń związanych ze aktywnością w Studiu danych.
keep Raporty o aktywności w aplikacji Keep zawierają informacje o różnych zdarzeniach związanych z aktywnością w Google Keep. Raport aktywności w Keep jest dostępny tylko dla klientów korzystających z Google Workspace Business i Google Workspace Enterprise.

Aktywność

Szablon JSON zasobu aktywności.

Zapis JSON
{
  "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
  }
}
Pola
kind

string

Typ zasobu interfejsu API. W raporcie o aktywności wartość wynosi audit#activity.

etag

string

ETag wpisu.

ownerDomain

string

Jest to domena, której dotyczy raport. na przykład domena w konsoli administracyjnej lub właściciel dokumentu na Dysku;

ipAddress

string

Adres IP użytkownika wykonującego działanie. Jest to adres IP użytkownika podczas logowania się w Google Workspace, który może nie odpowiadać fizycznej lokalizacji użytkownika. Może to być na przykład adres serwera proxy użytkownika lub wirtualna sieć prywatna (VPN). Interfejs API obsługuje IPv4 i IPv6.

events[]

object

Zdarzenia w raporcie.

events[].type

string

Typ zdarzenia. Usługa lub funkcja Google Workspace, którą administrator zmieni, jest określana we właściwości type, która identyfikuje zdarzenie przy użyciu właściwości eventName. Pełną listę kategorii interfejsu API type znajdziesz powyżej w sekcji applicationName.

events[].name

string

Nazwa zdarzenia. To jest nazwa aktywności zgłaszanej przez interfejs API. Każda właściwość eventName jest powiązana z konkretną usługą lub funkcją Google Workspace, którą interfejs API dzieli na typy zdarzeń.
Ogólnie w przypadku eventName parametrów żądań:

  • Jeśli nie podano eventName, raport zwróci wszystkie możliwe wystąpienia eventName.
  • Gdy zażądasz eventName, odpowiedź interfejsu API zwróci wszystkie działania zawierające ten obiekt eventName. Możliwe, że zwrócone działania będą miały inne właściwości eventName niż żądana.

Więcej informacji o właściwościach eventName znajdziesz powyżej na liście nazw zdarzeń w różnych aplikacjach w narzędziu applicationName.

events[].parameters[]

object

Pary wartości parametrów na potrzeby różnych aplikacji. Więcej informacji o parametrach eventName znajdziesz na liście nazw zdarzeń dla różnych aplikacji powyżej w applicationName.

events[].parameters[].messageValue

object

Zagnieżdżone pary wartości parametru powiązane z tym parametrem. Typ wartości złożonej dla parametru jest zwracany jako lista wartości parametrów. Na przykład parametr adresu może mieć wartość [{parameter: [{name: city, value: abc}]}]

events[].parameters[].messageValue.parameter[]

object (NestedParameter)

Wartości parametrów

events[].parameters[].name

string

Nazwa parametru.

events[].parameters[].value

string

Wartość ciągu przypisana do parametru.

events[].parameters[].multiValue[]

string

Wartość ciągu przypisana do parametru.

events[].parameters[].intValue

string (int64 format)

Wartość w formie liczby całkowitej.

events[].parameters[].multiIntValue[]

string (int64 format)

Wartość w formie liczby całkowitej.

events[].parameters[].boolValue

boolean

Wartość logiczna parametru.

events[].parameters[].multiMessageValue[]

object

activity.list obiektów: messageValue.

events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

Wartości parametrów

id

object

Unikalny identyfikator każdego zapisu aktywności.

id.time

string

Czas wystąpienia aktywności. To jest czas uniksowy w sekundach.

id.uniqueQualifier

string (int64 format)

Unikalny kwalifikator, jeśli wiele zdarzeń ma ten sam czas.

id.applicationName

string

Nazwa aplikacji, do której należy zdarzenie. Możliwe wartości znajdziesz na liście aplikacji powyżej w applicationName.

id.customerId

string

Niepowtarzalny identyfikator konta Google Workspace.

actor

object

Użytkownik wykonuje działanie.

actor.profileId

string

Unikalny identyfikator profilu użytkownika Google Workspace. Tej wartości może brakować, jeśli użytkownik nie korzysta z Google Workspace, lub numer 105250506097979753968 działający jako identyfikator zastępczy.

actor.email

string

Główny adres e-mail użytkownika, który wykonał czynność. Może być niedostępny, jeśli z aktorem nie jest powiązany żaden adres e-mail.

actor.callerType

string

Typ aktora.

actor.key

string

Wyświetlane tylko wtedy, gdy wartość callerType ma wartość KEY. Może to być consumer_key żądającego żądań do interfejsu OAuth 2LO API lub identyfikator kont robota.