Method: activities.watch

Zacznij otrzymywać powiadomienia o aktywności na koncie. Więcej informacji znajdziesz w artykule Otrzymywanie 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

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 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, 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 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 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 podana w formacie RFC 3339, np. 2010-10-28T10:26:35.000Z. Wartość domyślna to przybliżony czas żądania do 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 aktualnej godziny w momencie wysłania żądania, w przeciwnym razie interfejs API zwróci błąd.
  • Data zakończenia raportu: koniec okresu 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ą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 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 zwróci wszystkie edytowane dokumenty, 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ó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 adresie URL (%3E).
  • >= – „większe niż 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 zostanie podany więcej niż raz w żądaniu do interfejsu API, interfejs API akceptuje tylko jego ostatnią wartość. 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
(deprecated)

string

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

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 o kolejne strony raportu w ciągu zapytania pageToken wpisz wartość nextPageToken.
startTime

string

Określa początek zakresu czasu widocznego 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 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 zawiera wystąpienie elementu SubscriptionChannel.

Treść odpowiedzi

Kanał powiadomień służący do sprawdzania zmian w zasobach.

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

Identyfikator UUID lub podobny unikalny ciąg znaków identyfikujący ten kanał.
token

string

Dowolny ciąg znaków dostarczany na adres docelowy wraz z każdym powiadomieniem przesłanym przez ten kanał. Opcjonalnie:
expiration

string (int64 format)

Data i godzina wygaśnięcia kanału powiadomień wyrażona jako sygnatura czasowa systemu Unix w milisekundach. Opcjonalnie:
type

string

Typ mechanizmu wyświetlania stosowanego w przypadku tego kanału. Wartość powinna być ustawiona na "web_hook".
address

string

Adres, na który wysyłane są powiadomienia z tego kanału.
payload

boolean

Wartość logiczna wskazująca, czy wymagany jest ładunek. Ładunek to dane wysyłane w ciele wiadomości HTTP POST, PUT lub PATCH, które zawierają ważne informacje o żądaniu. Opcjonalnie:
params

map (key: string, value: string)

dodatkowe parametry kontrolujące działanie kanału dostawczego; Opcjonalnie:

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

string

Nieprzejrzysty identyfikator określający zasób oglądany na tym kanale. stabilny w różnych wersjach interfejsu API;
resourceUri

string

Identyfikator wersji monitorowanego zasobu.
kind

string

Określa ten kanał powiadomień jako kanał używany do sprawdzania zmian w zasobach (wartość „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 dotyczącym autoryzacji.

ApplicationName

Nazwa aplikacji, z której mają być pobierane zdarzenia.

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 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 Google Workspace Enterprise.
gcp Raporty o aktywności aplikacji Google Cloud Platform zawierają informacje o różnych zdarzeniach 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 Enterprise zawierają informacje o różnych zdarzeniach związanych z aktywizmem w grupach Enterprise.
jamboard Raporty o aktywności Jamboarda zawierają informacje o różnych zdarzeniach aktywności Jamboarda.
login

Raporty o aktywności aplikacji logowania zawierają informacje o kontach o różnych typach zdarzeń aktywności związanej z logowaniem.
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 związanych z aktywizacją Google Keep. Raport o aktywności w Keep jest dostępny tylko dla klientów Google Workspace Business i Enterprise.