Method: activities.list

Pobiera listę działań na koncie i w aplikacji konkretnego klienta, np. konsoli administracyjnej lub Dysku Google. Więcej informacji znajdziesz w przewodnikach dotyczących raportów o aktywności administratoraDysku 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 or all

string

Reprezentuje identyfikator profilu lub adres e-mail użytkownika, którego dane mają zostać przefiltrowane. Może to być all dla wszystkich informacji lub userKey dla unikalnego identyfikatora profilu Google Workspace lub podstawowego adresu e-mail użytkownika. Nie może to być usunięty użytkownik. W przypadku usuniętego użytkownika wywołaj funkcję users.list w interfejsie Directory API z parametrem showDeleted=true, a następnie użyj zwróconej wartości ID jako userKey.

applicationName

enum (ApplicationName)

Nazwa aplikacji, z której mają być pobierane 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. Adres IP może na przykład wskazywać serwer proxy użytkownika lub sieć VPN. Ten parametr obsługuje adresy IPv4 i IPv6.

customerId

string

Unikalny identyfikator klienta, którego dane mają zostać pobrane.

endTime

string

Określa koniec zakresu czasu wyświetlanego 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 zakresu czasowego widocznego w raporcie. Wartość startTime musi być mniejsza od wartości endTime (jeśli została podana) i mniejsza od bieżącej godziny w momencie wysł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 są zdarzenia z Kalendarza Google w raportach aplikacji 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łosi tę aktywność w parametrach Ustawienia Kalendarza type i eventName. Więcej informacji o ciągu 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 rozdzielana 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 eventName. Jeśli parametr żądania nie należy do eventName, zwracany jest pusty raport. Więcej informacji o dostępnych polach eventName w przypadku poszczególnych aplikacji i powiązanych z nimi parametrach znajdziesz w tabeli ApplicationName (NazwaAplikacji) oraz na stronie Zdarzenia aktywności w Dodatku do wybranej aplikacji.

W tych przykładach aktywności na Dysku zwracana lista zawiera wszystkie zdarzenia edit, w których wartość parametru doc_id spełnia warunki zdefiniowane przez operator relacji. 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 w formacie 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 jego ostatnią wartość. Jeśli w żądaniu do 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 zostaną przesłane żadne parametry, 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, będzie on miał 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 kolejnych żądaniach, które mają pobrać kolejną stronę raportu, w ciągu zapytania pageToken wpisz wartość nextPageToken.

startTime

string

Określa początek zakresu czasu wyświetlanego w raporcie. Data jest podana w formacie RFC 3339, np. 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 mniejsza od bieżącej 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ą działania użytkowników, czyli odpowiedź będzie zawierać działania 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 aktywności dotyczące przejrzystości dostępu w Google Workspace zawierają informacje o różnych typach zdarzeń związanych z przejrzystością dostępu.

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 aktywności aplikacji Kalendarz Google zawierają informacje o różnych zdarzeniach aktywności w Kalendarzu.

chat

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

drive

Raporty o aktywności aplikacji Dysk Google zawierają informacje o różnych zdarzeniach 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 aplikacji Google Cloud Platform zawierają informacje o różnych zdarzeniach aktywności GCP.

gplus

Raporty aktywności aplikacji Google+ zawierają informacje o różnych zdarzeniach 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 Enterprise zawierają informacje o różnych zdarzeniach związanych z aktywizmem w grupach Enterprise.

jamboard

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

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 o aktywności związanej z kontrolą Meet zwraca informacje o różnych typach zdarzeń związanych z kontrolą aktywności w Meet.

mobile

Raport o aktywności w ramach kontroli urządzenia zwraca informacje o różnych typach zdarzeń z raportu kontrolnego urządzenia.

rules

Raport Aktywność reguł zwraca informacje o różnych typach zdarzeń związanych z aktywizmem reguł.

saml

Raport o działalnoś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 o aktywności w aplikacji Konta użytkowników zawierają informacje o koncie dotyczące różnych typów zdarzeń aktywności Kont użytkowników.

context_aware_access

Raporty o aktywności związanej z dostępem zależnym od kontekstu zawierają 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 związanych z aktywizmem w Google Keep. Raport o aktywności w Keep jest dostępny tylko dla klientów Google Workspace Business i Enterprise.

vault Raporty aktywności Vault zawierają informacje o różnych typach zdarzeń aktywności Vault.

Aktywność

Szablon kodu 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)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
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 podczas logowania się w Google Workspace, który może, ale nie musi odzwierciedlać jego fizycznej lokalizacji. Adres IP może na przykład wskazywać serwer proxy użytkownika lub sieć 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 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:

  • Jeśli nie podasz parametru eventName, raport zwróci wszystkie możliwe wystąpienia parametru 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ń dla różnych aplikacji w sekcji applicationName.

events[].parameters[].messageValue

object

Zagnieżdżone pary wartości parametrów powiązane z tym parametrem. Parametry o typie złożonym zwracają listę wartości. 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 parametru.

events[].parameters[].multiValue[]

string

Wartości ciągu parametru.

events[].parameters[].intValue

string (int64 format)

Wartość liczby całkowitej przypisana do parametru.

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 obiektami.

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

object (NestedParameter)

Wartości parametrów

events[].resourceIds[]

string

Identyfikatory zasobów powiązane ze zdarzeniem.

id

object

Unikalny identyfikator każdego rekordu aktywności.

id.time

string

Czas wystąpienia aktywności. 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, który wykonał działanie. Może nie być dostępny, 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 OAuth 2LO API lub identyfikator konta robota.

actor.applicationInfo

object

Szczegóły aplikacji, która była wykonawcą działania.

actor.applicationInfo.oauthClientId

string

Identyfikator klienta OAuth aplikacji innej firmy, która wykonała czynność.

actor.applicationInfo.applicationName

string

Nazwa aplikacji użytej do wykonania czynności.

actor.applicationInfo.impersonation

boolean

Czy aplikacja podszywał się pod użytkownika.

resourceDetails[]

object (ResourceDetails)

Szczegóły zasobu, w którym wykonano działanie.

ResourceDetails

Szczegóły zasobu, w którym wykonano działanie.

Zapis JSON
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
Pola
id

string

Identyfikator zasobu.

title

string

Tytuł zasobu. Na przykład w przypadku dokumentu na Dysku będzie to tytuł dokumentu. W przypadku e-maila będzie to temat.

type

string

Typ zasobu – dokument, e-mail, wiadomość na czacie

appliedLabels[]

object (AppliedLabel)

activities.lista etykiet zastosowanych w zasobie

relation

string

Określa relację zasobu do zdarzeń.

AppliedLabel

Szczegóły etykiety zastosowanej do zasobu.

Zapis JSON
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
Pola
id

string

Identyfikator etykiety – tylko identyfikator etykiety, a nie pełna nazwa zasobu OnePlatform.

title

string

Tytuł etykiety

fieldValues[]

object (FieldValue)

activities.lista pól, które są częścią etykiety i zostały ustawione przez użytkownika. Jeśli etykieta zawiera pole, które nie zostało ustawione przez użytkownika, nie będzie widoczne na tej liście.

reason

object (Reason)

Przyczyna zastosowania etykiety do zasobu.

FieldValue

Szczegóły wartości pola ustawionej przez użytkownika dla danej etykiety.

Zapis JSON
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Pola
id

string

Identyfikator pola

displayName

string

Wyświetlana nazwa pola

type

string

Typ pola

reason

object (Reason)

Przyczyna zastosowania pola do etykiety.

Pole unii value. Wartości przechowywane w polu value mogą być tylko jednej z tych postaci:
unsetValue

boolean

Jeśli pole nie jest ustawione, ta wartość będzie miała wartość TRUE.

longTextValue

string

Ustawienie długiej wartości tekstowej.

textValue

string

Ustawianie wartości tekstowej.

textListValue

object (TextListValue)

Ustawianie wartości listy tekstowej.

selectionValue

object (SelectionValue)

Ustawienie wartości wyboru przez wybranie jednej wartości z menu.

selectionListValue

object (SelectionListValue)

Ustawienie wartości listy wyboru przez wybranie wielu wartości z listy.

integerValue

string (int64 format)

Ustawianie wartości całkowitej.

userValue

object (UserValue)

Ustawianie wartości użytkownika przez wybranie pojedynczego użytkownika.

userListValue

object (UserListValue)

Ustawianie wartości listy użytkowników przez wybranie wielu użytkowników.

dateValue

object (Date)

Ustawianie wartości daty.

TextListValue

Ustawianie wartości listy tekstowej.

Zapis JSON
{
  "values": [
    string
  ]
}
Pola
values[]

string

activities.list z wartościami tekstowymi.

SelectionValue

Ustawienie wartości wyboru przez wybranie jednej wartości z menu.

Zapis JSON
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
Pola
id

string

Identyfikator wyboru.

displayName

string

Wyświetlana nazwa wybranego elementu.

badged

boolean

Wskazuje, czy wybór ma plakietkę.

SelectionListValue

Ustawienie wartości listy opcji przez wybranie kilku wartości z listy.

Zapis JSON
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
Pola
values[]

object (SelectionValue)

activities.list of selections.

UserValue

Ustawianie wartości użytkownika przez wybranie pojedynczego użytkownika.

Zapis JSON
{
  "email": string
}
Pola
email

string

Adres e-mail użytkownika.

UserListValue

Ustawianie wartości listy użytkowników przez wybranie wielu użytkowników.

Zapis JSON
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
Pola
values[]

object (UserValue)

activities.list of users.

Data

Reprezentuje całą lub częściową datę kalendarzową, np. urodziny. Godzina i strefa czasowa są określone gdzie indziej lub nie mają znaczenia. Data jest wyrażona w kalendarzu gregoriańskim. Może to być:

  • Pełna data z wartościami roku, miesiąca i dnia innymi niż 0.
  • miesiąc i dzień z zerowym rokiem (np. rocznica).
  • Rok bez miesiąca i dnia.
  • Rok i miesiąc z zerowym dniem (np. data ważności karty kredytowej).

Powiązane typy:

Zapis JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Pola
year

integer

Rok daty. Musi być liczbą z zakresu 1–9999 lub 0, jeśli chcesz podać datę bez roku.

month

integer

Miesiąc w roku. Wartość musi mieścić się w przedziale od 1 do 12, lub 0, jeśli chcesz określić rok bez miesiąca i dnia.

day

integer

Dzień miesiąca. Musi zawierać wartość od 1 do 31 i być prawidłową dla roku lub miesiąca albo 0, aby określić tylko rok lub rok i miesiąc, w których przypadku dzień nie ma znaczenia.

Przyczyna

powód zastosowania etykiety lub pola.

Zapis JSON
{
  "reasonType": string
}
Pola
reasonType

string

Typ powodu.