Halaman ini diterjemahkan oleh Cloud Translation API.

Method: activities.watch

Permintaan HTTP
Parameter lokasi
Parameter kueri
Isi permintaan
Isi respons
- Representasi JSON
Cakupan otorisasi
ApplicationName

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

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

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 utamanya. 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 peristiwa 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 tersebut 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 untuk mengambil data.
`endTime`	`string` Menetapkan akhir rentang waktu yang ditampilkan dalam laporan. Tanggal 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 API untuk laporan: 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 akhir 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 peristiwa Google Kalender dalam laporan aplikasi konsol Admin. Struktur Setelan Kalender `type` memiliki semua aktivitas Kalender `eventName` yang dilaporkan oleh API. Saat administrator mengubah setelan Kalender, API akan melaporkan aktivitas ini dalam parameter Setelan Kalender `type` dan `eventName`. Untuk mengetahui informasi selengkapnya tentang string kueri dan parameter `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 berbentuk `{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 mengetahui informasi selengkapnya tentang kolom `eventName` yang tersedia untuk setiap aplikasi dan parameter terkaitnya, 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` yang nilai parameter `doc_id`-nya cocok dengan kondisi yang ditentukan oleh operator relasional. Dalam contoh pertama, permintaan menampilkan semua dokumen yang diedit dengan nilai `doc_id` sama dengan `12345`. Dalam contoh kedua, laporan menampilkan dokumen yang diedit dan nilai `doc_id`-nya 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 berikut: `==`—'sama dengan'. `<>`—'tidak sama dengan'. Harus dienkode ke URL (%3C%3E). `<`—'kurang dari'. Harus dienkode URL (%3C). `<=`—'kurang dari atau sama dengan'. Harus berenkode URL (%3C=). `>`—'lebih besar dari'. Harus dienkode URL (%3E). `>=`—'lebih dari atau sama dengan'. Harus dienkode URL (%3E=). Catatan: API tidak menerima beberapa nilai dari parameter yang sama. Jika parameter diberikan lebih dari sekali dalam permintaan API, API hanya menerima nilai terakhir dari parameter tersebut. Selain itu, jika parameter yang tidak valid diberikan dalam permintaan API, API akan mengabaikan parameter tersebut dan menampilkan respons yang sesuai dengan parameter valid yang tersisa. Jika tidak ada parameter yang diminta, semua parameter akan ditampilkan.
`maxResults`	`integer` Menentukan jumlah 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 didukung lagi. ID unit organisasi yang akan dilaporkan. Catatan aktivitas hanya akan ditampilkan untuk pengguna yang termasuk dalam unit organisasi yang ditentukan. Data sebelum 17 Desember 2018 tidak akan muncul di hasil filter.
`pageToken`	`string` Token untuk menentukan halaman berikutnya. Laporan dengan beberapa halaman memiliki properti `nextPageToken` dalam respons. Dalam permintaan lanjutan Anda untuk mendapatkan halaman laporan berikutnya, masukkan nilai `nextPageToken` dalam string kueri `pageToken`.
`startTime`	`string` Menetapkan awal rentang waktu yang ditampilkan dalam laporan. Tanggal dalam format RFC 3339, misalnya 2010-10-28T10:26:35.000Z. Laporan ini menampilkan semua aktivitas dari `startTime` hingga `endTime`. `startTime` harus sebelum `endTime` (jika ditentukan) dan waktu saat ini saat permintaan dibuat, atau API akan menampilkan error.
`groupIdFilter (deprecated)`	`string` `Deprecated`. Kolom ini tidak digunakan lagi dan tidak didukung lagi. ID grup yang dipisahkan koma (di-obfuscate) yang digunakan untuk memfilter aktivitas pengguna, yaitu respons hanya akan berisi aktivitas untuk pengguna yang merupakan bagian dari setidaknya salah satu ID grup yang disebutkan di sini. Format: "id:abc123,id:xyz456" Penting: Untuk memfilter menurut grup, Anda harus secara eksplisit menambahkan grup tersebut ke daftar grup pemfilteran yang diizinkan. Untuk mengetahui informasi selengkapnya tentang cara menambahkan grup ke daftar grup pemfilteran yang diizinkan, lihat Memfilter hasil menurut Google Grup

Isi permintaan

Isi permintaan memuat instance SubscriptionChannel.

Isi respons

Saluran notifikasi yang digunakan untuk memantau 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 }

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 dikirim ke alamat target dengan setiap notifikasi yang dikirim melalui saluran ini. Opsional.
`expiration`	`string (int64 format)` Tanggal dan waktu berakhirnya masa berlaku saluran notifikasi, dinyatakan sebagai stempel waktu Unix, dalam milidetik. Opsional.
`type`	`string` Jenis mekanisme penayangan yang digunakan untuk saluran ini. Nilai harus ditetapkan ke `"web_hook"`.
`address`	`string` Alamat tempat notifikasi dikirimkan 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 pengiriman. 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 dipantau di channel ini. Stabil di berbagai versi API.
`resourceUri`	`string` ID khusus versi untuk resource yang dipantau.
`kind`	`string` Mengidentifikasi ini sebagai saluran notifikasi yang digunakan untuk memantau perubahan pada resource, yaitu "`api#channel`".

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.

ApplicationName