Method: activities.watch

Zacznij otrzymywać powiadomienia o aktywności na koncie. Więcej informacji znajdziesz w artykule Odbieranie powiadomień push.

Żądanie HTTP

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

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, według którego dane mają być filtrowane. Może to być all w przypadku wszystkich informacji albo userKey w przypadku unikalnego identyfikatora profilu Google Workspace lub podstawowego adresu e-mail użytkownika. Nie może być usuniętym użytkownikiem. W przypadku usuniętego konta użytkownika wywołaj users.list w interfejsie Directory API z użyciem funkcji showDeleted=true, a następnie użyj zwróconego ID jako wartoś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 miało miejsce zdarzenie. To dodatkowy sposób filtrowania podsumowania raportu na podstawie adresu IP użytkownika, którego aktywność jest zgłaszana. Adres ten może, ale nie musi, odzwierciedlać fizyczną lokalizację użytkownika. Na przykład adres IP może być adresem serwera proxy użytkownika lub wirtualnej sieci prywatnej (VPN). Ten parametr obsługuje zarówno wersję adresu IPv4, jak i IPv6.
customerId

string

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

string

Określa koniec zakresu czasu wskazanego w raporcie. Data ma format 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 koncepcje czasu:

  • Data żądania raportu przez interfejs API: data utworzenia i pobrania raportu przez interfejs API.
  • Czas rozpoczęcia raportu: początek okresu wskazanego w raporcie. Wartość startTime musi być przed datą endTime (jeśli została określona) i czasem wysyłania żądania. W przeciwnym razie interfejs API zwróci błąd.
  • Czas zakończenia raportu: koniec okresu wskazanego w raporcie. Na przykład okres zdarzeń podsumowanych w raporcie może rozpoczynać się w kwietniu, a kończyć w maju. Raport można zamówić w sierpniu.
Jeśli endTime nie zostanie określony, raport zwróci wszystkie działania z okresu startTime do aktualnej godziny lub z ostatnich 180 dni, jeśli startTime obejmuje ponad 180 dni wstecz.
eventName

string

Nazwa zdarzenia, którego dotyczy zapytanie wysłane przez interfejs API. Każdy element eventName jest powiązany z konkretną usługą lub funkcją Google Workspace, którą interfejs API podzieli na typy zdarzeń. Przykładem mogą być wydarzenia Kalendarza Google w raportach aplikacji konsoli administracyjnej. Struktura type w Ustawieniach kalendarza zawiera wszystkie aktywności eventName Kalendarza raportowane przez interfejs API. Gdy administrator zmieni ustawienie Kalendarza, interfejs API zgłasza tę aktywność w parametrach type i eventName w ustawieniach kalendarza. Więcej informacji o ciągach zapytań i parametrach eventName znajdziesz powyżej na liście nazw zdarzeń używanych w różnych aplikacjach w sekcji applicationName.
filters

string

Ciąg zapytania filters to rozdzielona przecinkami lista złożona z parametrów zdarzeń zmienianych 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 określonym eventName. Jeśli parametr żądania nie należy do interfejsu eventName, zwracany jest pusty raport. Aby dowiedzieć się więcej o polach eventName dostępnych w przypadku każdej aplikacji i powiązanych z nimi parametrów, otwórz tabelę ApplicationName, a potem w Dodatku przejdź do strony zdarzeń działań w dodatku dla wybranej aplikacji.

W poniższych przykładach aktywności na Dysku zwracana lista zawiera wszystkie zdarzenia edit, w przypadku których wartość parametru doc_id spełnia warunki określone przez operatora relacyjnego. 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 98765. Operator <> jest zakodowany w adresie 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ówne”.
  • <> – „nie równa się”. Musi być zakodowanym adresem URL (%3C%3E).
  • < – „mniejsze niż”. Musi być zakodowanym adresem URL (%3C).
  • <= – „mniejsze lub równe”. Musi być zakodowany na potrzeby adresu URL (%3C=).
  • > – „większe niż”. Musi być zakodowanym adresem URL (%3E).
  • >= – „większe niż lub równe”. Musi być zakodowanym adresem 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 zaakceptuje tylko jego ostatnią wartość. Poza tym, jeśli w żądaniu do interfejsu API zostanie podany nieprawidłowy parametr, interfejs API zignoruje ten parametr i zwróci odpowiedź odpowiadającą pozostałym prawidłowym parametrom. Jeśli nie zostanie zażądane żadne parametry, zwracane zostaną wszystkie parametry.
maxResults

integer

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

string

Deprecated. To pole jest wycofane i nie jest już obsługiwane.

Identyfikator jednostki organizacyjnej, której ma dotyczyć raport. Rekordy aktywności będą wyświetlane tylko w przypadku użytkowników należących do określonej jednostki organizacyjnej.

pageToken

string

Token, który ma być określony na następnej stronie. Raport z wieloma stronami zawiera w odpowiedzi właściwość nextPageToken. W kolejnym żądaniu, by wyświetlić następną stronę raportu, wpisz wartość nextPageToken w ciągu zapytania pageToken.
startTime

string

Określa początek zakresu czasu wskazanego w raporcie. Data ma format RFC 3339, na przykład 2010-10-28T10:26:35.000Z. Raport zawiera wszystkie aktywności od startTime do endTime. Wartość startTime musi być przed datą endTime (jeśli została określona) i czasem wysyłania żądania. W przeciwnym razie interfejs API zwróci błąd.
groupIdFilter

string

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

Treść żądania

Treść żądania zawiera wystąpienie elementu SubscriptionChannel.

Treść odpowiedzi

Kanał powiadomień używany do oglądania informacji o zmianach zasobów.

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

Zapis JSON 
{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}
Pola
id

string

UUID lub podobny unikalny ciąg znaków, który identyfikuje ten kanał.
token

string

Dowolny ciąg znaków dostarczany na adres docelowy w każdym powiadomieniu wysyłanym na ten kanał. Opcjonalnie.
expiration

string (int64 format)

Data i godzina wygaśnięcia kanału powiadomień, wyrażone w postaci sygnatury czasowej uniksowej (w milisekundach). Opcjonalnie.
type

string

Typ mechanizmu przesyłania używany w tym kanale. Wartość powinna być ustawiona na "web_hook".
address

string

Adres, na który są dostarczane powiadomienia dotyczące tego kanału.
payload

boolean

Wartość logiczna wskazująca, czy potrzebny jest ładunek. Ładunek to dane wysyłane w treści wiadomości HTTP POST, PUT lub PATCH i zawierające ważne informacje o żądaniu. Opcjonalnie.
params

map (key: string, value: string)

Dodatkowe parametry kontrolujące działanie kanału wyświetlania. Opcjonalnie.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
resourceId

string

Nieprzezroczysty identyfikator identyfikujący zasób, który jest oglądany na tym kanale. Stabilność w różnych wersjach interfejsu API.
resourceUri

string

Identyfikator wersji obserwowanego zasobu.
kind

string

Identyfikuje to jako kanał powiadomień służący do monitorowania zmian w zasobie „api#channel”.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

ApplicationName

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

Wartości w polu enum
access_transparency

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

Raporty aktywności 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 aplikacji Kalendarz Google zawierają informacje o różnych wydarzeniach związanych z aktywnością z Kalendarza.
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 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 Google Workspace Enterprise.
gcp Raporty aktywności aplikacji Google Cloud Platform zwracają informacje o różnych zdarzeniach związanych z działaniami GCP.
gplus Raporty aktywności aplikacji Google+ zawierają informacje o różnych zdarzeniach związanych z aktywnością w Google+.
groups

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

Raporty aktywności Grup 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 związanych z aktywnością na Jamboardzie.
login

Raporty aktywności aplikacji Logowanie zwracają informacje o koncie dotyczące różnych typów zdarzeń związanych z aktywnością logowania.
meet Raport aktywności kontroli Meet zawiera informacje o różnych typach zdarzeń związanych z kontrolą Meet.
mobile Raport aktywności związanej z kontrolą urządzeń zawiera informacje o różnych typach zdarzeń związanych z kontrolą urządzeń.
rules

Raport aktywności związanej 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 aplikacji Token zwracają informacje o koncie o różnych typach zdarzeń związanych z aktywnością tokena.
user_accounts

Raporty o aktywności kont użytkowników zawierają informacje o koncie związane z różnymi typami zdarzeń związanych z kontami użytkowników.
context_aware_access

Raporty aktywności dostępu zależnego od kontekstu zwracają informacje o zdarzeniach odmowy dostępu zależnego od kontekstu przez reguły dostępu zależnego od kontekstu.
chrome

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