Method: activities.watch

Mulai menerima notifikasi untuk aktivitas akun. Untuk mengetahui informasi selengkapnya, lihat Menerima Notifikasi Push.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userKey or all

string

Mewakili ID profil atau email pengguna yang datanya harus difilter. Dapat berupa all untuk semua informasi, atau userKey untuk ID profil Google Workspace unik pengguna atau alamat email utama mereka. Tidak boleh berupa pengguna yang dihapus. Untuk pengguna yang dihapus, panggil users.list di Directory API dengan showDeleted=true, lalu gunakan ID yang ditampilkan sebagai userKey.

applicationName

enum (ApplicationName)

Nama aplikasi yang peristiwanya akan diambil.

Parameter kueri

Parameter
actorIpAddress

string

Alamat Protokol Internet (IP) host tempat acara dilakukan. Ini adalah cara tambahan untuk memfilter ringkasan laporan menggunakan alamat IP pengguna yang aktivitasnya dilaporkan. Alamat IP ini mungkin atau mungkin tidak mencerminkan lokasi fisik pengguna. Misalnya, alamat IP dapat berupa alamat server proxy pengguna atau alamat virtual private network (VPN). Parameter ini mendukung versi alamat IPv4 dan IPv6.

customerId

string

ID unik pelanggan yang datanya akan diambil.

endTime

string

Menetapkan akhir rentang waktu yang ditampilkan dalam laporan. Tanggalnya dalam format RFC 3339, misalnya 2010-10-28T10:26:35.000Z. Nilai defaultnya adalah perkiraan waktu permintaan API. Laporan API memiliki tiga konsep waktu dasar:

  • Tanggal permintaan laporan API: Saat API membuat dan mengambil laporan.
  • Waktu mulai laporan: Awal rentang waktu yang ditampilkan dalam laporan. startTime harus sebelum endTime (jika ditentukan) dan waktu saat ini saat permintaan dibuat, atau API akan menampilkan error.
  • Waktu berakhir laporan: Akhir rentang waktu yang ditampilkan dalam laporan. Misalnya, rentang waktu peristiwa yang diringkas dalam laporan dapat dimulai pada bulan April dan berakhir pada bulan Mei. Laporan itu sendiri dapat diminta pada bulan Agustus.
Jika endTime tidak ditentukan, laporan akan menampilkan semua aktivitas dari startTime hingga waktu saat ini atau 180 hari terakhir jika startTime lebih dari 180 hari yang lalu.

eventName

string

Nama peristiwa yang dikueri oleh API. Setiap eventName terkait dengan layanan atau fitur Google Workspace tertentu yang diatur API ke dalam jenis peristiwa. Contohnya adalah acara Google Kalender di laporan aplikasi konsol Admin. Struktur type Setelan Kalender memiliki semua aktivitas eventName Kalender yang dilaporkan oleh API. Saat administrator mengubah setelan Kalender, API akan melaporkan aktivitas ini di parameter Setelan Kalender type dan eventName. Untuk informasi selengkapnya tentang parameter dan string kueri eventName, lihat daftar nama peristiwa untuk berbagai aplikasi di atas dalam applicationName.

filters

string

String kueri filters adalah daftar yang dipisahkan koma yang terdiri dari parameter peristiwa yang dimanipulasi oleh operator relasional. Parameter peristiwa ditampilkan dalam format {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

Parameter peristiwa ini dikaitkan dengan eventName tertentu. Laporan kosong akan ditampilkan jika parameter permintaan bukan milik eventName. Untuk informasi selengkapnya tentang kolom eventName yang tersedia untuk setiap aplikasi dan parameter terkait, buka tabel ApplicationName, lalu klik halaman Peristiwa Aktivitas di Lampiran untuk aplikasi yang Anda inginkan.

Dalam contoh aktivitas Drive berikut, daftar yang ditampilkan terdiri dari semua peristiwa edit dengan nilai parameter doc_id yang cocok dengan kondisi yang ditetapkan oleh operator relasional. Pada contoh pertama, permintaan menampilkan semua dokumen yang diedit dengan nilai doc_id sama dengan 12345. Pada contoh kedua, laporan menampilkan dokumen yang diedit dengan nilai doc_id tidak sama dengan 98765. Operator <> dienkode ke URL dalam string kueri permintaan (%3C%3E):

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

Kueri filters mendukung operator relasional ini:

  • ==—'sama dengan'.
  • <>—'tidak sama dengan'. Harus dienkode ke URL (%3C%3E).
  • <—'kurang dari'. Harus dienkode ke URL (%3C).
  • <=—'kurang dari atau sama dengan'. Harus dienkode ke URL (%3C=).
  • >—'lebih besar dari'. Harus dienkode ke URL (%3E).
  • >=—'lebih dari atau sama dengan'. Harus dienkode ke URL (%3E=).

Catatan: API tidak menerima banyak nilai parameter yang sama. Jika parameter diberikan lebih dari sekali dalam permintaan API, API hanya menerima nilai terakhir parameter tersebut. Selain itu, jika parameter tidak valid diberikan dalam permintaan API, API akan mengabaikan parameter tersebut dan menampilkan respons yang sesuai dengan parameter valid lainnya. Jika tidak ada parameter yang diminta, semua parameter akan ditampilkan.

maxResults

integer

Menentukan berapa banyak catatan aktivitas yang ditampilkan di setiap halaman respons. Misalnya, jika permintaan menetapkan maxResults=1 dan laporan memiliki dua aktivitas, laporan memiliki dua halaman. Properti nextPageToken respons memiliki token ke halaman kedua. String kueri maxResults bersifat opsional dalam permintaan. Nilai defaultnya adalah 1.000.

orgUnitID
(deprecated)

string

Deprecated. Kolom ini tidak digunakan lagi dan tidak lagi didukung.

ID unit organisasi yang akan dilaporkan. Catatan aktivitas hanya akan ditampilkan untuk pengguna yang termasuk dalam unit organisasi yang ditentukan.

pageToken

string

Token untuk menentukan halaman berikutnya. Laporan yang berisi beberapa halaman memiliki properti nextPageToken dalam responsnya. Dalam permintaan berikutnya untuk mendapatkan halaman laporan berikutnya, masukkan nilai nextPageToken dalam string kueri pageToken.

startTime

string

Menetapkan awal rentang waktu yang ditampilkan dalam laporan. Tanggalnya dalam format RFC 3339, misalnya 2010-10-28T10:26:35.000Z. Laporan ini menampilkan semua aktivitas dari startTime sampai endTime. startTime harus sebelum endTime (jika ditentukan) dan waktu saat ini saat permintaan dibuat, atau API akan menampilkan error.

groupIdFilter

string

ID grup yang dipisahkan koma (di-obfuscate) tempat aktivitas pengguna difilter, yaitu respons akan berisi aktivitas hanya untuk pengguna yang merupakan bagian dari setidaknya salah satu ID grup yang disebutkan di sini. Format: "id:abc123,id:xyz456"

Isi permintaan

Isi permintaan memuat instance SubscriptionChannel.

Isi respons

Saluran notifikasi yang digunakan untuk mengawasi perubahan resource.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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

string

UUID atau string unik serupa yang mengidentifikasi channel ini.

token

string

String arbitrer yang dikirimkan ke alamat target dengan setiap notifikasi yang dikirimkan melalui saluran ini. Opsional.

expiration

string (int64 format)

Tanggal dan waktu berakhirnya saluran notifikasi, yang dinyatakan sebagai stempel waktu Unix, dalam milidetik. Opsional.

type

string

Jenis mekanisme pengiriman yang digunakan untuk saluran ini. Nilai harus ditetapkan ke "web_hook".

address

string

Alamat tujuan notifikasi dikirim untuk channel ini.

payload

boolean

Nilai Boolean untuk menunjukkan apakah payload diinginkan. Payload adalah data yang dikirim dalam isi pesan HTTP POST, PUT, atau PATCH dan berisi informasi penting tentang permintaan. Opsional.

params

map (key: string, value: string)

Parameter tambahan yang mengontrol perilaku saluran penayangan. Opsional.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

resourceId

string

ID buram yang mengidentifikasi resource yang sedang ditonton di saluran ini. Stabil di berbagai versi API.

resourceUri

string

ID khusus versi untuk resource yang ditonton.

kind

string

Mengidentifikasi ini sebagai saluran notifikasi yang digunakan untuk memantau perubahan pada resource, yaitu "api#channel".

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.

ApplicationName

Nama aplikasi yang peristiwanya akan diambil.

Enum
access_transparency

Laporan aktivitas Transparansi Akses Google Workspace menampilkan informasi tentang berbagai jenis peristiwa aktivitas Transparansi Akses.

admin

Laporan aktivitas aplikasi konsol Admin menampilkan informasi akun tentang berbagai jenis peristiwa aktivitas administrator.

calendar

Laporan aktivitas aplikasi Google Kalender menampilkan informasi tentang berbagai acara aktivitas Kalender.

chat Laporan aktivitas Chat menampilkan informasi tentang berbagai peristiwa aktivitas Chat.
drive

Laporan aktivitas aplikasi Google Drive menampilkan informasi tentang berbagai peristiwa aktivitas Google Drive. Laporan aktivitas Drive hanya tersedia untuk pelanggan Google Workspace Business dan Google Workspace Enterprise.

gcp Laporan aktivitas aplikasi Google Cloud Platform menampilkan informasi tentang berbagai peristiwa aktivitas GCP.
gplus Laporan aktivitas aplikasi Google+ menampilkan informasi tentang berbagai peristiwa aktivitas Google+.
groups

Laporan aktivitas aplikasi Google Grup menampilkan informasi tentang berbagai peristiwa aktivitas Grup.

groups_enterprise

Laporan aktivitas Grup Enterprise menampilkan informasi tentang berbagai peristiwa aktivitas grup Enterprise.

jamboard Laporan aktivitas Jamboard menampilkan informasi tentang berbagai peristiwa aktivitas Jamboard.
login

Laporan aktivitas Aplikasi login menampilkan informasi akun tentang berbagai jenis Peristiwa aktivitas login.

meet Laporan aktivitas Audit Meet menampilkan informasi tentang berbagai jenis peristiwa aktivitas Audit Meet.
mobile Laporan aktivitas Audit Perangkat menampilkan informasi tentang berbagai jenis peristiwa aktivitas Audit Perangkat.
rules

Laporan aktivitas Aturan menampilkan informasi tentang berbagai jenis Peristiwa aktivitas Aturan.

saml

Laporan aktivitas SAML menampilkan informasi tentang berbagai jenis peristiwa aktivitas SAML.

token

Laporan aktivitas aplikasi Token menampilkan informasi akun tentang berbagai jenis Peristiwa aktivitas token.

user_accounts

Laporan aktivitas aplikasi Akun Pengguna menampilkan informasi akun tentang berbagai jenis peristiwa aktivitas Akun Pengguna.

context_aware_access

Laporan aktivitas Akses kontekstual menampilkan informasi tentang peristiwa yang ditolak akses pengguna karena Aturan akses kontekstual.

chrome

Laporan aktivitas Chrome menampilkan informasi tentang peristiwa browser Chrome dan Chrome OS.

data_studio Laporan aktivitas Data Studio menampilkan informasi tentang berbagai jenis peristiwa aktivitas Data Studio.
keep Laporan aktivitas aplikasi Keep menampilkan informasi tentang berbagai peristiwa aktivitas Google Keep. Laporan aktivitas Keep hanya tersedia untuk pelanggan Google Workspace Business dan Enterprise.