Method: activities.list

Mengambil daftar aktivitas untuk akun dan aplikasi pelanggan tertentu seperti aplikasi konsol Admin atau aplikasi Google Drive. Untuk informasi selengkapnya, lihat panduan untuk laporan aktivitas administrator dan Google Drive. Untuk informasi selengkapnya tentang parameter laporan aktivitas, lihat panduan referensi parameter aktivitas.

Permintaan HTTP

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

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

string

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 harus kosong.

Isi respons

Template JSON untuk kumpulan aktivitas.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
Kolom
kind

string

Jenis resource API. Untuk laporan aktivitas, nilainya adalah reports#activities.

etag

string

ETag resource.

items[]

object (Activity)

Setiap catatan aktivitas dalam respons.

nextPageToken

string

Token untuk mengambil halaman berikutnya dalam laporan. Nilai nextPageToken digunakan dalam string kueri pageToken permintaan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.

ApplicationName

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 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.
vault Laporan aktivitas Vault menampilkan informasi tentang berbagai jenis peristiwa aktivitas Vault.

Aktivitas

Template JSON untuk resource aktivitas.

Representasi JSON
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string
  }
}
Kolom
kind

string

Jenis resource API. Untuk laporan aktivitas, nilainya adalah audit#activity.

etag

string

ETag entri.

ownerDomain

string

Ini adalah domain yang terpengaruh oleh peristiwa laporan. Misalnya, domain konsol Admin atau pemilik dokumen aplikasi Drive.

ipAddress

string

Alamat IP pengguna yang melakukan tindakan. Ini adalah alamat Protokol Internet (IP) pengguna saat login ke Google Workspace, yang mungkin atau mungkin tidak mencerminkan lokasi fisik pengguna. Misalnya, alamat IP dapat berupa alamat server proxy pengguna atau alamat virtual private network (VPN). API ini mendukung IPv4 dan IPv6.

events[]

object

Peristiwa aktivitas dalam laporan.

events[].type

string

Jenis peristiwa. Layanan atau fitur Google Workspace yang diubah oleh administrator diidentifikasi di properti type yang mengidentifikasi peristiwa menggunakan properti eventName. Untuk mengetahui daftar lengkap kategori type API, lihat daftar nama peristiwa untuk berbagai aplikasi di atas di applicationName.

events[].name

string

Nama peristiwa. Ini adalah nama spesifik aktivitas yang dilaporkan oleh API. Dan setiap eventName terkait dengan layanan atau fitur Google Workspace tertentu yang diatur API ke dalam jenis peristiwa.
Untuk parameter permintaan eventName secara umum:

  • Jika eventName tidak diberikan, laporan akan menampilkan semua kemungkinan instance eventName.
  • Saat Anda meminta eventName, respons API akan menampilkan semua aktivitas yang berisi eventName tersebut.

Untuk informasi selengkapnya tentang properti eventName, lihat daftar nama peristiwa untuk berbagai aplikasi di atas di applicationName.

events[].parameters[]

object

Pasangan nilai parameter untuk berbagai aplikasi. Untuk informasi selengkapnya tentang parameter eventName, lihat daftar nama peristiwa untuk berbagai aplikasi di atas di applicationName.

events[].parameters[].messageValue

object

Pasangan nilai parameter bertingkat yang terkait dengan parameter ini. Jenis nilai kompleks untuk parameter ditampilkan sebagai daftar nilai parameter. Misalnya, parameter alamat mungkin memiliki nilai sebagai [{parameter: [{name: city, value: abc}]}]

events[].parameters[].messageValue.parameter[]

object (NestedParameter)

Nilai parameter

events[].parameters[].name

string

Nama parameter.

events[].parameters[].value

string

Nilai string parameter.

events[].parameters[].multiValue[]

string

Nilai string parameter.

events[].parameters[].intValue

string (int64 format)

Nilai parameter yang berupa bilangan bulat.

events[].parameters[].multiIntValue[]

string (int64 format)

Nilai bilangan bulat parameter.

events[].parameters[].boolValue

boolean

Nilai Boolean parameter.

events[].parameters[].multiMessageValue[]

object

activity.list objek messageValue.

events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

Nilai parameter

id

object

ID unik untuk setiap catatan aktivitas.

id.time

string

Waktu terjadinya aktivitas. Ini adalah waktu epoch UNIX dalam detik.

id.uniqueQualifier

string (int64 format)

Penentu unik jika beberapa peristiwa memiliki waktu yang sama.

id.applicationName

string

Nama aplikasi tempat peristiwa tersebut berada. Untuk mengetahui kemungkinan nilainya, lihat daftar aplikasi di atas dalam applicationName.

id.customerId

string

ID unik untuk akun Google Workspace.

actor

object

Pengguna yang melakukan tindakan.

actor.profileId

string

ID profil Google Workspace unik untuk pelaku. Nilai ini mungkin tidak ada jika pelakunya bukan pengguna Google Workspace, atau nomor 105250506097979753968 yang bertindak sebagai ID placeholder.

actor.email

string

Alamat email utama pelaku. Mungkin tidak ada jika tidak ada alamat email yang terkait dengan pelaku.

actor.callerType

string

Jenis aktor.

actor.key

string

Hanya ada jika callerType adalah KEY. Dapat berupa consumer_key pemohon untuk permintaan OAuth 2LO API atau ID untuk akun robot.