Method: activities.list

Pobiera listę działań dla konta określonego klienta i aplikacji, na przykład aplikacji konsoli administracyjnej czy aplikacji Dysk Google. Więcej informacji znajdziesz w przewodnikach dotyczących raportów aktywności na Dysku Google dla administratorów i na 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

Reprezentuje identyfikator profilu lub adres e-mail użytkownika, w przypadku którego dane mają być filtrowane. Może to być all w przypadku wszystkich informacji, userKey w przypadku unikalnego identyfikatora profilu Google Workspace użytkownika lub jego podstawowego adresu e-mail. Nie może być usuniętym użytkownikiem. W przypadku usuniętego konta użytkownika wywołaj users.list w interfejsie Directory API za pomocą polecenia showDeleted=true, a następnie użyj zwróconego ID jako userKey.
applicationName

enum (ApplicationName)

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

Parametry zapytania

Parametry
actorIpAddress

string

Adres IP hosta, na którym zostało wykonane zdarzenie. Jest to dodatkowy sposób filtrowania podsumowania raportu na podstawie adresu IP użytkownika, którego aktywność została zgłoszona. Ten adres IP może, ale nie musi, odzwierciedlać fizyczną lokalizację użytkownika. Przykładowo adres IP może być adresem serwera proxy użytkownika lub wirtualnej sieci prywatnej (VPN). Ten parametr obsługuje adresy IPv4 oraz IPv6.
customerId

string

Unikalny identyfikator klienta, dla którego chcesz pobrać dane.
endTime

string

Określa koniec zakresu czasu pokazywanego 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 interfejsu API obejmuje 3 podstawowe pojęcia związane z czasem:

  • Data żądania raportu przez interfejs API: data utworzenia i pobrania raportu przez interfejs API.
  • Czas rozpoczęcia raportu: początek okresu widocznego w raporcie. Wartość startTime musi być wcześniejsza niż endTime (jeśli została określona) i bieżąca godzina przesłania żądania. W przeciwnym razie interfejs API zwróci błąd.
  • Data zakończenia raportu: koniec okresu widocznego w raporcie. Na przykład przedział czasu wydarzeń podsumowanych w raporcie może rozpoczynać się w kwietniu, a kończyć w maju. Sam raport można pobrać w sierpniu.
Jeśli wartość endTime nie jest określona, raport zwróci wszystkie aktywności z okresu startTime do bieżącej godziny lub z ostatnich 180 dni, jeśli wartość startTime jest większa niż 180 dni w przeszłości.
eventName

string

Nazwa zdarzenia, którego dotyczy zapytanie wysyłane przez interfejs API. Każdy element eventName jest powiązany z konkretną usługą lub funkcją Google Workspace, którą interfejs API porządkuje według typów zdarzeń. Przykładem mogą być wydarzenia z Kalendarza Google w raportach aplikacji w konsoli administracyjnej. Struktura type ustawień kalendarza zawiera wszystkie działania z Kalendarza eventName zgłaszane przez interfejs API. Gdy administrator zmieni ustawienie Kalendarza, interfejs API zgłasza tę aktywność w parametrach type i eventName ustawień Kalendarza. Więcej informacji o ciągach zapytań i parametrach eventName znajdziesz na liście nazw zdarzeń w różnych aplikacjach w części applicationName.
filters

string

Ciąg zapytania filters to rozdzielana przecinkami lista złożona z parametrów zdarzenia objętych działaniem operatorów relacyjnych. Parametry zdarzenia mają postać {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

Te parametry zdarzenia są powiązane z konkretnym elementem eventName. Jeśli parametr żądania nie należy do eventName, zwracany jest pusty raport. Więcej informacji o dostępnych polach eventName dla każdej aplikacji i powiązanych z nimi parametrach znajdziesz w tabeli ApplicationName, a następnie w dodatku do odpowiedniej aplikacji przejdź na stronę Zdarzenia związane z aktywnością.

W poniższych przykładach aktywności na Dysku zwracana lista zawiera wszystkie zdarzenia edit, w których wartość parametru doc_id pasuje do warunków zdefiniowanych przez operator relacyjny. W pierwszym przykładzie żądanie zwraca wszystkie edytowane dokumenty o wartości doc_id równej 12345. W drugim przykładzie raport zwróci wszystkie edytowane dokumenty, których wartość doc_id nie jest równa 98765. Operator <> jest zakodowany na potrzeby adresu URL w ciągu zapytania żądania (%3C%3E):

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

Zapytanie filters obsługuje te operatory relacyjne:

  • == – „równa się”.
  • <> – „nie równa się”. Musi być zakodowany w adresie URL (%3C%3E).
  • < – „mniej niż”. Musi być zakodowany na potrzeby adresu URL (%3C).
  • <= – „mniejsze lub równe”. Musi być zakodowany w adresie URL (%3C=).
  • > – „większe niż”. Musi być zakodowany w adresie URL (%3E).
  • >= – „większe niż lub równe”. Musi być zakodowany w adresie URL (%3E=).

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

integer

Określa, ile rekordów aktywności ma być wyświetlanych na każdej stronie odpowiedzi. Jeśli np. żądanie ustawia maxResults=1, a raport zawiera 2 działania, raport ma 2 strony. Właściwość nextPageToken odpowiedzi ma token drugiej strony. Ciąg zapytania maxResults jest w żądaniu opcjonalny. Wartością domyślną jest 1000.
orgUnitID

string

Identyfikator jednostki organizacyjnej, której ma dotyczyć raport. Rekordy aktywności będą wyświetlane 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 zawiera w odpowiedzi właściwość nextPageToken. W kolejnym żądaniu pobierającym następną stronę raportu wpisz wartość nextPageToken w ciągu zapytania pageToken.
startTime

string

Określa początek zakresu czasu widocznego w raporcie. Data jest w formacie RFC 3339, na przykład 2010-10-28T10:26:35.000Z. Raport zwraca wszystkie aktywności z okresu od startTime do endTime. Wartość startTime musi być wcześniejsza niż endTime (jeśli została określona) i bieżąca godzina przesłania żądania. W przeciwnym razie interfejs API zwróci błąd.
groupIdFilter

string

Rozdzielone przecinkami identyfikatory grup (zaciemnione), według których działania użytkowników są filtrowane. Odpowiedź będzie zawierać działania tylko dla tych użytkowników, którzy są częścią co najmniej jednego z wymienionych tutaj identyfikatorów grupy. Format: „id:abc123,id:xyz456”

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Szablon JSON kolekcji aktywności.

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

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

string

Typ zasobu interfejsu API. W przypadku raportu aktywności wartość to reports#activities.
etag

string

Tag ETag zasobu.
items[]

object (Activity)

Każdy zapis aktywności w odpowiedzi.
nextPageToken

string

Token umożliwiający pobranie następnej strony raportu. Wartość nextPageToken jest używana w ciągu zapytania pageToken żądania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.

ApplicationName

Wartości w polu enum
access_transparency

Raporty o aktywności w ramach Przejrzystości dostępu do Google Workspace zawierają informacje o różnych typach zdarzeń związanych z funkcją Przejrzystość dostępu.
admin

Raporty o aktywności w aplikacji w konsoli administracyjnej zawierają 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 zwracają informacje o różnych zdarzeniach aktywności w Kalendarzu.
chat Raporty o aktywności w Google Chat zawierają informacje o różnych zdarzeniach 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 dotyczący aktywności na Dysku jest dostępny tylko dla klientów korzystających z Google Workspace Business i Enterprise.
gcp Raporty o aktywności w aplikacji Google Cloud Platform zawierają informacje o różnych zdarzeniach związanych z aktywnością GCP.
gplus Raporty aktywności aplikacji Google+ zawierają informacje o różnych zdarzeniach związanych z aktywnością w Google+.
groups

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

Raporty o aktywności w Grupach dyskusyjnych Google Enterprise zawierają informacje o różnych zdarzeniach związanych z aktywnością w grupach firmowych.
jamboard Raporty o aktywności w Jamboard zawierają informacje o różnych zdarzeniach związanych z aktywnością w Jamboard.
login

Raporty o aktywności aplikacji logowania zawierają informacje o kontach o różnych typach zdarzeń aktywności związanej z logowaniem.
meet Raport dotyczący działań kontroli w Meet zawiera informacje o różnych typach zdarzeń związanych z kontrolą w Meet.
mobile Raport o aktywności związanej z kontrolą urządzenia zwraca informacje o różnych typach zdarzeń związanych z kontrolą urządzeń.
rules

Raport „Działania związane z regułami” zawiera informacje o różnych typach zdarzeń związanych z aktywnością reguł.
saml

Raport o aktywności SAML zwraca informacje o różnych typach zdarzeń aktywności SAML.
token

Raporty o aktywności aplikacji tokenowe zawierają informacje o koncie dotyczące różnych typów zdarzeń związanych z aktywnością tokenów.
user_accounts

Raporty aktywności w aplikacji Konta użytkowników zawierają informacje o różnych rodzajach zdarzeń związanych z aktywnością na kontach użytkowników.
context_aware_access

Raporty o aktywności w zakresie dostępu zależnego od kontekstu zawierają informacje o użytkownikach zdarzeń odmowy dostępu z powodu reguł dostępu zależnego od kontekstu.
chrome

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

Aktywność

Szablon JSON dla 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 przypadku raportu aktywności wartość to audit#activity.
etag

string

ETag wpisu.
ownerDomain

string

Jest to domena, której dotyczy zdarzenie z raportu. Na przykład domena konsoli administracyjnej lub właściciel dokumentów aplikacji Dysk.
ipAddress

string

Adres IP użytkownika wykonującego działanie. Jest to adres IP użytkownika logującego się w Google Workspace, który może, ale nie musi, odzwierciedlać jego fizyczną lokalizację. Przykładowo adres IP może być adresem serwera proxy użytkownika lub wirtualnej sieci prywatnej (VPN). Interfejs API obsługuje IPv4 oraz IPv6.
events[]

object

Zdarzenia aktywności uwzględnione w raporcie.
events[].type

string

Typ zdarzenia. Usługa lub funkcja Google Workspace zmieniona przez administratora jest określana we właściwości type, która identyfikuje zdarzenie za pomocą właściwości eventName. Pełną listę kategorii type interfejsu API znajdziesz powyżej w sekcji applicationName.
events[].name

string

Nazwa zdarzenia. Jest to konkretna nazwa aktywności zgłaszanej przez interfejs API. Każdy element eventName jest powiązany z konkretną usługą lub funkcją Google Workspace, którą interfejs API dzieli na typy zdarzeń.
Ogólnie w przypadku eventName parametrów żądania:

  • Jeśli nie podasz żadnej wartości eventName, raport zwróci wszystkie możliwe wystąpienia wartości eventName.
  • Gdy wysyłasz żądanie eventName, odpowiedź interfejsu API zwraca wszystkie aktywności, które zawierają ten element eventName.

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

object

Pary wartości parametrów dla różnych aplikacji. Więcej informacji o parametrach eventName znajdziesz na liście nazw zdarzeń w różnych aplikacjach w sekcji applicationName.
events[].parameters[].messageValue

object

Zagnieżdżone pary wartości parametrów powiązane z tym parametrem. Złożone typy wartości parametru są zwracane w postaci listy wartości parametru. Na przykład parametr address 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ść parametru w postaci ciągu znaków.
events[].parameters[].multiValue[]

string

Wartości parametru w postaci ciągu znaków.
events[].parameters[].intValue

string (int64 format)

Wartość parametru (liczba całkowita).
events[].parameters[].multiIntValue[]

string (int64 format)

Wartość parametru (liczba całkowita).
events[].parameters[].boolValue

boolean

Wartość logiczna parametru.
events[].parameters[].multiMessageValue[]

object

actions.list z messageValue obiektami.
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

Wartości parametrów
id

object

Unikalny identyfikator każdego rekordu aktywności.
id.time

string

Czas wystąpienia działania. Jest to czas uniksowy w sekundach.
id.uniqueQualifier

string (int64 format)

Unikalny kwalifikator, jeśli wiele wydarzeń dotyczy tego samego czasu.
id.applicationName

string

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

string

Unikalny identyfikator konta Google Workspace.
actor

object

Użytkownik wykonujący działanie.
actor.profileId

string

Unikalny identyfikator profilu Google Workspace użytkownika, który wykonał czynność. Może brakować tej wartości, jeśli użytkownik nie jest użytkownikiem Google Workspace. Może to być też numer 105250506097979753968, który działa jako identyfikator zastępczy.
actor.email

string

Podstawowy adres e-mail użytkownika, który wykonał czynność. Tego pola może nie być, jeśli z użytkownikiem nie jest powiązany żaden adres e-mail.
actor.callerType

string

Rodzaj aktora.
actor.key

string

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