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 o aktywności administratora i Dysku Google. Więcej informacji o parametrach raportu o aktywności znajdziesz w przewodnikach na temat 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

string

Reprezentuje identyfikator profilu lub adres e-mail użytkownika, którego dane mają zostać odfiltrowane. 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 to być usunięty użytkownik. 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 adresu 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 działanie. Jest to dodatkowy sposób filtrowania podsumowania raportu za pomocą adresu IP użytkownika, którego aktywność jest raportowana. Adres IP może, ale nie musi odzwierciedlać fizycznej lokalizacji użytkownika. Przykładowo adres IP może być adresem serwera proxy użytkownika lub wirtualnej sieci prywatnej (VPN). Ten parametr obsługuje adresy w wersji IPv4 i IPv6.
customerId

string

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

string

Określa koniec zakresu czasu pokazywanego w raporcie. Data jest podana w formacie RFC 3339, np. 2010-10-28T10:26:35.000Z. Wartością domyślną jest przybliżony czas wysłania żądania interfejsu API. Raport interfejsu API zawiera 3 podstawowe ujęcia czasowe:

  • 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.
  • Czas zakończenia raportu: koniec zakresu czasowego widocznego w raporcie. Na przykład zakres czasowy zdarzeń podsumowanych w raporcie może obejmować okres od kwietnia do maja, a sam raport można poprosić w sierpniu.
Jeśli nie podasz wartości endTime, raport zwróci wszystkie działania od momentu podania wartości endTime do bieżącej godziny lub ostatnie 180 dni, jeśli wartość endTime jest starsza niż 180 dni.startTimestartTime
eventName

string

Nazwa zdarzenia, którego dotyczy zapytanie 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 Ustawienia kalendarza type zawiera wszystkie aktywności kalendarza eventName zgłoszone 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ągłach zapytania i parametrach eventName znajdziesz na liście nazw zdarzeń dla różnych aplikacji w sekcji applicationName.
filters

string

Ciąg znaków filters to lista oddzielona przecinkami, która składa się z parametrów zdarzenia manipulowanych przez operatory relacji. 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 poszczególnych aplikacji i powiązanych z nimi parametrach znajdziesz w tabeli ApplicationName, a następnie w załączniku 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 zwraca wszystkie edytowane dokumenty, w których wartość doc_id nie jest równa wartości 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 relacji:

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

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

integer

Określa, ile rekordów aktywności jest wyświetlanych na każdej stronie odpowiedzi. Jeśli na przykład żądanie zawiera zestawy maxResults=1, a raport ma 2 działania, ma on 2 strony. Właściwość nextPageToken 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 dotyczy raport. Rekordy aktywności będą widoczne tylko dla użytkowników należących do określonej jednostki organizacyjnej.

pageToken

string

Token określający następną stronę. Raport obejmujący kilka stron 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 działania od startTime do endTime. Wartość startTime musi być mniejsza od wartości endTime (jeśli została podana) i aktualnej godziny w momencie wysłania żądania, w przeciwnym razie interfejs API zwróci błąd.
groupIdFilter

string

Identyfikatory grup (zaciemnione) oddzielone przecinkami, według których filtrowane są aktywności użytkowników, czyli odpowiedź będzie zawierać aktywności tylko tych użytkowników, którzy należą do co najmniej 1 z wymienionych tutaj identyfikatorów grup. 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

ETag zasobu.
items[]

object (Activity)

Każdy rekord 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.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.

ApplicationName

Wartości w polu enum
access_transparency

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

Raporty o aktywności w aplikacji Konsole administracyjnej zawierają informacje o różnych zdarzeniach związanych z działalnością administratora na koncie.
calendar

Raporty o aktywności w aplikacji Kalendarz Google zawierają informacje o różnych zdarzeniach związanych z aktywizmem 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 o aktywności na Dysku jest dostępny tylko dla klientów 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 o 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 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 Jamboarda zawierają informacje o różnych zdarzeniach aktywności Jamboarda.
login

Raporty o aktywności aplikacji Logowanie zwracają informacje o koncie dotyczące różnych typów zdarzeń związanych z aktywizacją logowania.
meet Raport Aktywność w Meet Audit zwraca informacje o różnych typach zdarzeń związanych z kontrolą aktywności w Meet.
mobile Raport Aktywność w kontroli urządzenia zwraca informacje o różnych typach zdarzeń w kontroli urządzenia.
rules

Raport Aktywność reguł zwraca 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 aktywności aplikacji Token zwracają informacje o koncie dotyczące różnych typów zdarzeń aktywności Tokena.
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 związanej z dostępem zależnym od kontekstu zwracają informacje o zdarzeniach odmowy dostępu użytkownikom z powodu reguł dostępu zależnego od kontekstu.
chrome

Raporty aktywności w Chrome zawierają informacje o  zdarzeniach w przeglądarce Chrome i ChromeOS.
data_studio Raporty aktywności Studia danych zawierają informacje o różnych typach zdarzeń aktywności Studia danych.
keep Raporty o aktywności w aplikacji Keep zawierają informacje o różnych zdarzeniach aktywności w Google Keep. Raport o aktywności w Keep jest dostępny tylko dla klientów 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 kodu 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

Domena, której dotyczy zdarzenie w raporcie. Na przykład domena konsoli administracyjnej lub właściciel dokumentu w aplikacji Dysk.
ipAddress

string

Adres IP użytkownika, który wykonał 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 i IPv6.
events[]

object

Zdarzenia aktywności w raporcie.
events[].type

string

Typ zdarzenia. Usługa lub funkcja Google Workspace, którą zmienia administrator, jest identyfikowana w przypadku właściwości type, która identyfikuje zdarzenie za pomocą właściwości eventName. Pełną listę kategorii type interfejsu API znajdziesz w sekcji applicationName, w której podano listę nazw zdarzeń dla różnych aplikacji.
events[].name

string

Nazwa zdarzenia. Jest to konkretna nazwa aktywności zgłaszanej przez interfejs API. Każdy z nich eventName jest powiązany z konkretną usługą lub funkcją Google Workspace, którą interfejs API porządkuje według typów zdarzeń.
W przypadku parametrów żądania eventName ogólnie:

  • Jeśli nie podasz argumentu eventName, raport zwróci wszystkie możliwe wystąpienia argumentu eventName.
  • Gdy żądasz informacji o eventName, odpowiedź interfejsu API zwraca wszystkie aktywności, które zawierają ten eventName.

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

object

Pary wartości parametrów w różnych zastosowaniach. 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ść ciągu parametru.
events[].parameters[].multiValue[]

string

Wartości ciągu parametru.
events[].parameters[].intValue

string (int64 format)

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

string (int64 format)

Wartości liczb całkowitych parametru.
events[].parameters[].boolValue

boolean

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

object

activities.list z messageValue elementami.
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 wyróżnik, jeśli kilka 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 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 wykonawcy. Ta wartość może być nieobecna, jeśli aktor nie jest użytkownikiem Google Workspace, lub może być liczbą 105250506097979753968, która pełni funkcję identyfikatora zastępczego.
actor.email

string

Podstawowy adres e-mail użytkownika. Może nie być podany, jeśli z aktorem nie jest powiązany adres e-mail.
actor.callerType

string

Typ użytkownika, który wykonał czynność.
actor.key

string

Występuje tylko wtedy, gdy callerType ma wartość KEY. Może to być consumer_key w przypadku żądań interfejsu API OAuth 2LO lub identyfikator konta robota.