Method: activities.list

Mengambil daftar aktivitas untuk akun dan aplikasi pelanggan tertentu seperti aplikasi konsol Admin atau aplikasi Google Drive. Untuk mengetahui informasi selengkapnya, lihat panduan untuk laporan aktivitas administrator dan Google Drive. Untuk mengetahui 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 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.

Untuk permintaan Gmail, startTime dan endTime harus diberikan dan perbedaannya tidak boleh lebih dari 30 hari.

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

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

Untuk permintaan Gmail, startTime dan endTime harus diberikan dan perbedaannya tidak boleh lebih dari 30 hari.

groupIdFilter

string

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"

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 dari laporan lanjutan. Nilai nextPageToken digunakan dalam string kueri pageToken permintaan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui 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 peristiwa 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.
gmail Laporan aktivitas aplikasi Gmail menampilkan informasi tentang berbagai peristiwa aktivitas Gmail.
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 penolakan 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.
gemini_in_workspace_apps Laporan aktivitas Gemini untuk Workspace menampilkan informasi tentang berbagai jenis peristiwa aktivitas Gemini yang dilakukan oleh pengguna dalam aplikasi Workspace.
classroom Laporan aktivitas Classroom menampilkan informasi tentang berbagai jenis peristiwa aktivitas Classroom.

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)
                }
              ]
            }
          ]
        }
      ],
      "resourceIds": [
        string
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string,
    "applicationInfo": {
      "oauthClientId": string,
      "applicationName": string,
      "impersonation": boolean
    }
  },
  "networkInfo": {
    object (NetworkInfo)
  },
  "resourceDetails": [
    {
      object (ResourceDetails)
    }
  ]
}
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 Internet Protocol (IP) pengguna saat login ke Google Workspace, yang mungkin atau mungkin tidak mencerminkan lokasi fisik pengguna. Misalnya, alamat IP tersebut 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 acara. Layanan atau fitur Google Workspace yang diubah oleh administrator diidentifikasi dalam properti type yang mengidentifikasi peristiwa menggunakan properti eventName. Untuk mengetahui daftar lengkap kategori type API, lihat daftar nama peristiwa untuk berbagai aplikasi di atas dalam applicationName.

events[].name

string

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

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

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

events[].parameters[]

object

Pasangan nilai parameter untuk berbagai aplikasi. Untuk mengetahui informasi selengkapnya tentang parameter eventName, lihat daftar nama peristiwa untuk berbagai aplikasi di atas dalam 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)

Parameter value

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 bilangan bulat.

events[].parameters[].multiIntValue[]

string (int64 format)

Nilai bilangan bulat parameter.

events[].parameters[].boolValue

boolean

Nilai boolean parameter.

events[].parameters[].multiMessageValue[]

object

activities.list objek messageValue.

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

object (NestedParameter)

Parameter value

events[].resourceIds[]

string

ID resource yang terkait dengan peristiwa.

id

object

ID unik untuk setiap catatan aktivitas.

id.time

string

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

id.uniqueQualifier

string (int64 format)

Penentu unik jika beberapa acara memiliki waktu yang sama.

id.applicationName

string

Nama aplikasi tempat peristiwa terjadi. Untuk mengetahui kemungkinan nilai, 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 dari aktor. Nilai ini mungkin tidak ada jika aktor bukan pengguna Google Workspace, atau mungkin berupa angka 105250506097979753968 yang berfungsi 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 API OAuth 2LO atau ID untuk akun robot.

actor.applicationInfo

object

Detail aplikasi yang menjadi pelaku untuk aktivitas tersebut.

actor.applicationInfo.oauthClientId

string

ID klien OAuth aplikasi pihak ketiga yang digunakan untuk melakukan tindakan.

actor.applicationInfo.applicationName

string

Nama aplikasi yang digunakan untuk melakukan tindakan.

actor.applicationInfo.impersonation

boolean

Apakah aplikasi meniru identitas pengguna.

networkInfo

object (NetworkInfo)

Informasi jaringan pengguna yang melakukan tindakan.

resourceDetails[]

object (ResourceDetails)

Detail resource tempat tindakan dilakukan.

NetworkInfo

Informasi jaringan pengguna yang melakukan tindakan.

Representasi JSON
{
  "ipAsn": [
    integer
  ],
  "regionCode": string,
  "subdivisionCode": string
}
Kolom
ipAsn[]

integer

Alamat IP pengguna yang melakukan tindakan.

regionCode

string

Kode wilayah ISO 3166-1 alpha-2 pengguna yang melakukan tindakan.

subdivisionCode

string

Kode wilayah ISO 3166-2 (negara bagian dan provinsi) untuk negara pengguna yang melakukan tindakan.

ResourceDetails

Detail resource tempat tindakan dilakukan.

Representasi JSON
{
  "id": string,
  "title": string,
  "type": string,
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "relation": string
}
Kolom
id

string

ID resource.

title

string

Judul aset. Misalnya, untuk dokumen drive, ini adalah judul dokumen. Jika berupa email, ini akan menjadi subjek.

type

string

Jenis resource - dokumen, email, pesan chat

appliedLabels[]

object (AppliedLabel)

activities.list label yang diterapkan pada resource

relation

string

Menentukan hubungan resource dengan peristiwa

AppliedLabel

Detail label yang diterapkan pada resource.

Representasi JSON
{
  "id": string,
  "title": string,
  "fieldValues": [
    {
      object (FieldValue)
    }
  ],
  "reason": {
    object (Reason)
  }
}
Kolom
id

string

ID label - Hanya ID label, bukan nama resource OnePlatform lengkap.

title

string

Judul label

fieldValues[]

object (FieldValue)

activities.list kolom yang merupakan bagian dari label dan telah ditetapkan oleh pengguna. Jika label memiliki kolom yang tidak ditetapkan oleh pengguna, label tersebut tidak akan ada dalam daftar ini.

reason

object (Reason)

Alasan label diterapkan pada resource.

FieldValue

Detail nilai kolom yang ditetapkan oleh pengguna untuk label tertentu.

Representasi JSON
{
  "id": string,
  "displayName": string,
  "type": string,
  "reason": {
    object (Reason)
  },

  // Union field value can be only one of the following:
  "unsetValue": boolean,
  "longTextValue": string,
  "textValue": string,
  "textListValue": {
    object (TextListValue)
  },
  "selectionValue": {
    object (SelectionValue)
  },
  "selectionListValue": {
    object (SelectionListValue)
  },
  "integerValue": string,
  "userValue": {
    object (UserValue)
  },
  "userListValue": {
    object (UserListValue)
  },
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Kolom
id

string

ID kolom

displayName

string

Nama tampilan kolom

type

string

Jenis kolom

reason

object (Reason)

Alasan kolom diterapkan ke label.

Kolom union value. Nilai yang disimpan di kolom value hanya dapat berupa salah satu dari berikut:
unsetValue

boolean

Jika kolom tidak disetel, nilai ini akan benar (true).

longTextValue

string

Menetapkan nilai teks yang panjang.

textValue

string

Menetapkan nilai teks.

textListValue

object (TextListValue)

Menetapkan nilai daftar teks.

selectionValue

object (SelectionValue)

Menetapkan nilai pilihan dengan memilih satu nilai dari dropdown.

selectionListValue

object (SelectionListValue)

Menetapkan nilai daftar pilihan dengan memilih beberapa nilai dari dropdown.

integerValue

string (int64 format)

Menetapkan nilai bilangan bulat.

userValue

object (UserValue)

Menetapkan nilai pengguna dengan memilih satu pengguna.

userListValue

object (UserListValue)

Menetapkan nilai daftar pengguna dengan memilih beberapa pengguna.

dateValue

object (Date)

Menetapkan nilai tanggal.

TextListValue

Menetapkan nilai daftar teks.

Representasi JSON
{
  "values": [
    string
  ]
}
Kolom
values[]

string

activities.list nilai teks.

SelectionValue

Menetapkan nilai pilihan dengan memilih satu nilai dari dropdown.

Representasi JSON
{
  "id": string,
  "displayName": string,
  "badged": boolean
}
Kolom
id

string

ID pilihan.

displayName

string

Nama tampilan pilihan.

badged

boolean

Apakah pilihan diberi badge.

SelectionListValue

Menetapkan nilai daftar pilihan dengan memilih beberapa nilai dari dropdown.

Representasi JSON
{
  "values": [
    {
      object (SelectionValue)
    }
  ]
}
Kolom
values[]

object (SelectionValue)

activities.list of selections.

UserValue

Menetapkan nilai pengguna dengan memilih satu pengguna.

Representasi JSON
{
  "email": string
}
Kolom
email

string

Email pengguna.

UserListValue

Menetapkan nilai daftar pengguna dengan memilih beberapa pengguna.

Representasi JSON
{
  "values": [
    {
      object (UserValue)
    }
  ]
}
Kolom
values[]

object (UserValue)

activities.list of users.

Tanggal

Menunjukkan seluruh atau sebagian tanggal kalender, seperti ulang tahun. Waktu dan zona waktu ditentukan di tempat lain atau tidak signifikan. Tanggal ini terkait dengan Kalender Gregorian. Hal ini dapat mewakili salah satu dari berikut ini:

  • Tanggal lengkap, dengan nilai tahun, bulan, dan hari bukan nol.
  • Bulan dan hari, dengan tahun nol (misalnya, hari jadi).
  • Tahun saja, dengan bulan nol dan hari nol.
  • Tahun dan bulan, dengan hari nol (misalnya, tanggal habis masa berlaku kartu kredit).

Jenis terkait:

Representasi JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Kolom
year

integer

Tahun dalam tanggal. Harus dari 1 hingga 9999, atau 0 untuk menentukan tanggal tanpa tahun.

month

integer

Bulan dalam setahun. Harus dari 1 hingga 12, atau 0 untuk menentukan tahun tanpa bulan dan hari.

day

integer

Hari dalam sebulan. Harus dari 1 hingga 31 dan berlaku untuk tahun dan bulan, atau 0 untuk menentukan tahun saja atau tahun dan bulan jika hari dianggap tidak signifikan.

Alasan

Alasan label/kolom diterapkan.

Representasi JSON
{
  "reasonType": string
}
Kolom
reasonType

string

Jenis alasan.