Ta strona została przetłumaczona przez Cloud Translation API.

Method: activities.watch

Żądanie HTTP
Parametry ścieżki
Parametry zapytania
Treść żądania
Treść odpowiedzi
- Zapis JSON
Zakresy autoryzacji
ApplicationName

zacząć 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

Parametry
`userKey or all`	`string` Zawiera identyfikator profilu lub adres e-mail użytkownika, według którego mają być filtrowane dane. Może to być `all` w przypadku wszystkich informacji lub `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óconego parametru `ID` jako parametru `userKey`.
`applicationName`	`enum (ApplicationName)` Nazwa aplikacji, dla której mają zostać pobrane zdarzenia.

userKey or all

string

Zawiera identyfikator profilu lub adres e-mail użytkownika, według którego mają być filtrowane dane. Może to być all w przypadku wszystkich informacji lub 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óconego parametru ID jako parametru userKey.

applicationName

enum (ApplicationName)

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

Parametry zapytania

Parametry
`actorIpAddress`	`string` Adres IP hosta, na którym wykonano zdarzenie. Jest to dodatkowy sposób filtrowania podsumowania raportu za pomocą adresu IP użytkownika, którego aktywność jest raportowana. Ten adres IP może odzwierciedlać fizyczną lokalizację użytkownika, ale nie musi. Może to być na przykład adres serwera proxy użytkownika lub adres wirtualnej sieci prywatnej (VPN). Ten parametr obsługuje wersje adresów IPv4 i IPv6.
`customerId`	`string` Unikalny identyfikator klienta, dla którego chcesz pobrać dane.
`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 żądania interfejsu API. Raport API zawiera 3 podstawowe pojęcia związane z czasem: Data wysłania przez interfejs API żądania raportu: data utworzenia i pobrania raportu przez interfejs API. Godzina rozpoczęcia raportu: początek okresu wyświetlanego w raporcie. Wartość `startTime` musi być wcześniejsza niż wartość `endTime` (jeśli jest określona) i bieżąca godzina, w której wysłano żądanie. W przeciwnym razie interfejs API zwróci błąd. Czas zakończenia raportu: koniec okresu wyświetlanego w raporcie. Na przykład okres zdarzeń podsumowanych w raporcie może zaczynać się w kwietniu, a kończyć w maju. Sam raport można poprosić w sierpniu. Jeśli nie podasz parametru `endTime`, raport zwróci wszystkie działania od daty `startTime` do bieżącego czasu lub z ostatnich 180 dni, jeśli data `startTime` przypada na okres sprzed ponad 180 dni.
`eventName`	`string` Nazwa zdarzenia, o którego dane wysyła zapytanie interfejs API. Każdy `eventName` jest powiązany z konkretną usługą lub funkcją Google Workspace, którą interfejs API porządkuje w typy zdarzeń. Przykładem są zdarzenia z Kalendarza Google w raportach aplikacji konsoli administracyjnej. Struktura Ustawienia Kalendarza `type` zawiera wszystkie działania w Kalendarzu `eventName` zgłaszane 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 `eventName` ciągach zapytań i parametrach znajdziesz na liście nazw zdarzeń w różnych aplikacjach powyżej w sekcji `applicationName`.
`filters`	`string` `filters` to ciąg zapytania, który jest listą parametrów zdarzenia oddzielonych przecinkami i zmodyfikowanych 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 konkretnym `eventName`. Jeśli parametr żądania nie należy do `eventName`, zwracany jest pusty raport. Więcej informacji o dostępnych `eventName` polach w poszczególnych aplikacjach i powiązanych z nimi parametrach znajdziesz w tabeli ApplicationName. Następnie kliknij stronę Zdarzenia dotyczące aktywności w dodatku do wybranej aplikacji. W poniższych przykładach aktywności na Dysku zwrócona lista zawiera wszystkie zdarzenia `edit`, w których wartość parametru `doc_id` spełnia warunki określone przez operator relacyjny. W pierwszym przykładzie żądanie zwraca wszystkie edytowane dokumenty, w których wartość `doc_id` jest równa `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 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 się”. `<>` – „nie równa się”. Musi być zakodowany w formacie URL (%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 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 w żądaniu API więcej niż raz, interfejs API zaakceptuje tylko jego ostatnią wartość. Jeśli w żądaniu do interfejsu API podano nieprawidłowy parametr, interfejs API ignoruje ten parametr i zwraca odpowiedź odpowiadającą pozostałym prawidłowym parametrom. Jeśli nie zażądasz żadnych parametrów, zostaną zwrócone wszystkie.
`maxResults`	`integer` Określa, ile rekordów aktywności jest wyświetlanych na każdej stronie odpowiedzi. Jeśli na przykład żądanie zawiera `maxResults=1`, a raport obejmuje 2 aktywności, będzie on miał 2 strony. Właściwość `nextPageToken` odpowiedzi zawiera token do drugiej strony. Ciąg zapytania `maxResults` w żądaniu jest opcjonalny. 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ą wyświetlane tylko w przypadku użytkowników należących do określonej jednostki organizacyjnej. Dane sprzed 17 grudnia 2018 roku nie są pokazywane w filtrowanych wynikach.
`pageToken`	`string` Token określający następną stronę. Raport z wieloma stronami ma w odpowiedzi właściwość `nextPageToken`. W kolejnym żądaniu pobrania następnej strony raportu wpisz wartość `nextPageToken` w ciągu zapytania `pageToken`.
`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 zawiera wszystkie działania od `startTime` do `endTime`. Wartość `startTime` musi być wcześniejsza niż wartość `endTime` (jeśli jest określona) i bieżąca godzina, w której wysłano żądanie. W przeciwnym razie interfejs API zwróci błąd.
`groupIdFilter (deprecated)`	`string` `Deprecated`. To pole zostało wycofane i nie jest już obsługiwane. Identyfikatory grup (zaciemnione) oddzielone przecinkami, według których filtrowane są działania użytkowników, tzn. odpowiedź będzie zawierać działania tylko tych użytkowników, którzy należą do co najmniej jednego z wymienionych tu identyfikatorów grup. Format: „id:abc123,id:xyz456” Ważne: aby filtrować według grup, musisz samodzielnie dodać je do listy dozwolonych grup filtrowania. Więcej informacji o dodawaniu grup do listy dozwolonych grup filtrowania znajdziesz w artykule Filtrowanie wyników według grup dyskusyjnych Google .

Treść żądania

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

Treść odpowiedzi

Kanał powiadomień używany do śledzenia zmian 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 }

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 z każdym powiadomieniem wysyłanym tym kanałem. Opcjonalnie.
`expiration`	`string (int64 format)` Data i godzina wygaśnięcia kanału powiadomień w formacie sygnatury czasowej systemu UNIX (w milisekundach). Opcjonalnie.
`type`	`string` Typ mechanizmu dostarczania używanego w przypadku tego kanału. Wartość powinna być ustawiona na `"web_hook"`.
`address`	`string` Adres, na który są dostarczane powiadomienia z tego kanału.
`payload`	`boolean` Wartość logiczna wskazująca, czy ładunek jest potrzebny. Ładunek to dane wysyłane w treści 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 dostarczania. Opcjonalnie. Obiekt zawierający listę par `"key": value`. Przykład: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`resourceId`	`string` Nieczytelny identyfikator, który wskazuje zasób oglądany na tym kanale. Stabilny w różnych wersjach interfejsu API.
`resourceUri`	`string` Identyfikator oglądanego zasobu właściwy dla konkretnej wersji.
`kind`	`string` Określa, że jest to kanał powiadomień używany do śledzenia zmian w zasobie, czyli „`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