Method: activities.list

เรียกรายการกิจกรรมสำหรับบัญชีและแอปพลิเคชันของลูกค้าที่ต้องการ เช่น แอปพลิเคชันคอนโซลผู้ดูแลระบบหรือแอปพลิเคชัน Google ไดรฟ์ โปรดดูข้อมูลเพิ่มเติมที่คำแนะนำสำหรับผู้ดูแลระบบและรายงานกิจกรรมของ Google ไดรฟ์ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์ของรายงานกิจกรรมได้ที่คู่มืออ้างอิงพารามิเตอร์กิจกรรม

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
userKey or all

string

แสดงรหัสโปรไฟล์หรืออีเมลของผู้ใช้ที่ควรกรองข้อมูล อาจเป็น all สำหรับข้อมูลทั้งหมด หรือเป็น userKey สำหรับรหัสโปรไฟล์ Google Workspace ที่ไม่ซ้ำกันของผู้ใช้ หรือที่อยู่อีเมลหลักของผู้ใช้ ต้องไม่ใช่ผู้ใช้ที่ถูกลบ สำหรับผู้ใช้ที่ถูกลบ ให้เรียกใช้ users.list ใน Directory API ด้วย showDeleted=true จากนั้นใช้ ID ที่แสดงผลเป็น userKey
applicationName

enum (ApplicationName)

ชื่อแอปพลิเคชันที่จะดึงข้อมูลเหตุการณ์

พารามิเตอร์การค้นหา

พารามิเตอร์
actorIpAddress

string

ที่อยู่ Internet Protocol (IP) ของโฮสต์ที่จัดกิจกรรม นี่เป็นวิธีการเพิ่มเติมในการกรองข้อมูลสรุปของรายงานโดยใช้ที่อยู่ IP ของผู้ใช้ที่มีการรายงานกิจกรรม ที่อยู่ IP นี้อาจแสดงหรือไม่แสดงสถานที่ตั้งทางกายภาพของผู้ใช้ เช่น ที่อยู่ IP อาจเป็นที่อยู่ของพร็อกซีเซิร์ฟเวอร์หรือที่อยู่เครือข่ายส่วนตัวเสมือน (VPN) ของผู้ใช้ก็ได้ พารามิเตอร์นี้รองรับทั้งเวอร์ชันที่อยู่ IPv4 และ IPv6
customerId

string

รหัสที่ไม่ซ้ำกันของลูกค้าที่ใช้เรียกข้อมูล
endTime

string

ตั้งค่าการสิ้นสุดช่วงเวลาที่แสดงในรายงาน วันที่อยู่ในรูปแบบ RFC 3339 เช่น 2010-10-28T10:26:35.000Z ค่าเริ่มต้นคือเวลาโดยประมาณของคำขอ API รายงาน API มีแนวคิดพื้นฐานเกี่ยวกับเวลา 3 ประการ ดังนี้

  • วันที่ส่งคำขอรายงานของ API: เมื่อ API สร้างและเรียกรายงาน
  • เวลาเริ่มต้นของรายงาน: จุดเริ่มต้นของช่วงเวลาที่แสดงในรายงาน startTime ต้องอยู่ก่อน endTime (หากระบุ) และเวลาปัจจุบันเมื่อมีการส่งคำขอ มิเช่นนั้น API จะแสดงข้อผิดพลาด
  • เวลาสิ้นสุดของรายงาน: เวลาสิ้นสุดของช่วงเวลาที่แสดงในรายงาน เช่น ระยะเวลาของเหตุการณ์ที่สรุปไว้ในรายงานอาจเริ่มต้นในเดือนเมษายนและสิ้นสุดในเดือนพฤษภาคม โดยคุณสามารถขอรายงานได้ในเดือนสิงหาคม
หากไม่ได้ระบุ endTime รายงานจะแสดงกิจกรรมทั้งหมดตั้งแต่ startTime จนถึงเวลาปัจจุบัน หรือ 180 วันล่าสุดหาก startTime นานกว่า 180 วันที่ผ่านมา
eventName

string

ชื่อของเหตุการณ์ที่ API ค้นหา eventName แต่ละรายการจะเกี่ยวข้องกับบริการหรือฟีเจอร์ของ Google Workspace ที่เฉพาะเจาะจง ซึ่ง API จะจัดแบ่งประเภทเหตุการณ์ เช่น กิจกรรมใน Google ปฏิทินในรายงานของแอปพลิเคชันคอนโซลผู้ดูแลระบบ โครงสร้าง type ของการตั้งค่าปฏิทินมีกิจกรรม eventName ทั้งหมดของปฏิทินที่รายงานโดย API เมื่อผู้ดูแลระบบเปลี่ยนการตั้งค่าปฏิทิน API จะรายงานกิจกรรมนี้ในการตั้งค่าปฏิทิน type และพารามิเตอร์ eventName ดูข้อมูลเพิ่มเติมเกี่ยวกับสตริงการค้นหาและพารามิเตอร์ของ eventName ได้ที่รายการชื่อเหตุการณ์สําหรับแอปพลิเคชันต่างๆ ด้านบนใน applicationName
filters

string

สตริงการค้นหา filters คือรายการที่คั่นด้วยคอมมา ซึ่งประกอบด้วยพารามิเตอร์เหตุการณ์ที่จัดการโดยโอเปอเรเตอร์เชิงสัมพันธ์ พารามิเตอร์เหตุการณ์จะอยู่ในรูปแบบ {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

พารามิเตอร์เหตุการณ์เหล่านี้เชื่อมโยงกับ eventName ที่เฉพาะเจาะจง ระบบจะแสดงผลรายงานที่ว่างเปล่าหากพารามิเตอร์ของคำขอไม่ได้เป็นของ eventName หากต้องการข้อมูลเพิ่มเติมเกี่ยวกับช่อง eventName ที่ใช้ได้ของแต่ละแอปพลิเคชันและพารามิเตอร์ที่เชื่อมโยง โปรดไปที่ตาราง ApplicationName แล้วคลิกผ่านไปยังหน้าเหตุการณ์กิจกรรมในภาคผนวกสำหรับแอปพลิเคชันที่ต้องการ

ในตัวอย่างกิจกรรมไดรฟ์ต่อไปนี้ รายการที่ส่งกลับประกอบด้วยเหตุการณ์ edit ทั้งหมด โดยที่ค่าพารามิเตอร์ doc_id ตรงกับเงื่อนไขที่กำหนดโดยโอเปอเรเตอร์เชิงสัมพันธ์ ในตัวอย่างแรก คำขอจะแสดงเอกสารที่แก้ไขทั้งหมดที่มีค่า doc_id เท่ากับ 12345 ในตัวอย่างที่ 2 รายงานจะแสดงเอกสารที่แก้ไขซึ่งค่า doc_id ไม่เท่ากับ 98765 โอเปอเรเตอร์ <> มีการเข้ารหัส URL ในสตริงการค้นหาของคำขอ (%3C%3E) ดังนี้

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

คำค้นหา filters รองรับโอเปอเรเตอร์เชิงสัมพันธ์ต่อไปนี้

  • ==—"เท่ากับ"
  • <> - "ไม่เท่ากับ" ต้องเข้ารหัส URL (%3C%3E)
  • < "น้อยกว่า" ต้องเข้ารหัส URL (%3C)
  • <= "น้อยกว่าหรือเท่ากับ" ต้องเข้ารหัส URL (%3C=)
  • > - "มากกว่า" ต้องเข้ารหัส URL (%3E)
  • >= - "มากกว่าหรือเท่ากับ" ต้องเข้ารหัส URL (%3E=)

หมายเหตุ: API ไม่ยอมรับค่าของพารามิเตอร์เดียวกันหลายค่า หากมีการระบุพารามิเตอร์มากกว่า 1 ครั้งในคำขอ API API จะยอมรับเฉพาะค่าสุดท้ายของพารามิเตอร์นั้น นอกจากนี้ หากระบุพารามิเตอร์ที่ไม่ถูกต้องในคำขอ API API จะไม่สนใจพารามิเตอร์นั้นและแสดงผลการตอบกลับที่เกี่ยวข้องกับพารามิเตอร์ที่ถูกต้องที่เหลืออยู่ หากไม่มีการขอพารามิเตอร์ ระบบจะแสดงผลพารามิเตอร์ทั้งหมด
maxResults

integer

กำหนดจำนวนบันทึกกิจกรรมที่จะแสดงในหน้าคำตอบแต่ละหน้า ตัวอย่างเช่น หากคำขอตั้งค่า maxResults=1 และรายงานมีกิจกรรม 2 รายการ รายงานจะมี 2 หน้า พร็อพเพอร์ตี้ nextPageToken ของการตอบกลับมีโทเค็นไปยังหน้าที่ 2 คุณไม่จำเป็นต้องระบุสตริงการค้นหา maxResults ในคำขอ ค่าเริ่มต้นคือ 1000
orgUnitID

string

รหัสของหน่วยขององค์กรที่จะรายงาน บันทึกกิจกรรมจะแสดงกับผู้ใช้ที่อยู่ในหน่วยขององค์กรที่ระบุเท่านั้น

pageToken

string

โทเค็นที่จะระบุหน้าถัดไป รายงานที่มีหลายหน้าจะมีพร็อพเพอร์ตี้ nextPageToken ในการตอบกลับ ในคำขอติดตามผลเพื่อรับหน้าถัดไปของรายงาน ให้ป้อนค่า nextPageToken ในสตริงคำค้นหา pageToken
startTime

string

ตั้งจุดเริ่มต้นของช่วงเวลาที่แสดงในรายงาน วันที่อยู่ในรูปแบบ RFC 3339 เช่น 2010-10-28T10:26:35.000Z รายงานจะแสดงกิจกรรมทั้งหมดตั้งแต่ startTime จนถึง endTime startTime ต้องอยู่ก่อน endTime (หากระบุ) และเวลาปัจจุบันเมื่อมีการส่งคำขอ มิเช่นนั้น API จะแสดงข้อผิดพลาด
groupIdFilter

string

รหัสกลุ่มที่คั่นด้วยคอมมา (ปรับให้ยากต่อการอ่าน (Obfuscate)) ซึ่งมีการกรองกิจกรรมของผู้ใช้ กล่าวคือ การตอบกลับจะมีกิจกรรมเฉพาะผู้ใช้ที่เป็นส่วนหนึ่งของรหัสกลุ่มที่ระบุไว้ที่นี่อย่างน้อย 1 รายการ รูปแบบ: "id:abc123,id:xyz456"

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

เทมเพลต JSON สําหรับคอลเล็กชันกิจกรรม

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
ช่อง
kind

string

ประเภทของทรัพยากร API สำหรับรายงานกิจกรรม ค่าจะเป็น reports#activities
etag

string

ETag ของทรัพยากร
items[]

object (Activity)

แต่ละกิจกรรมจะบันทึกในคำตอบ
nextPageToken

string

โทเค็นสำหรับเรียกข้อมูลหน้าถัดไปของรายงาน ระบบจะใช้ค่า nextPageToken ในสตริงการค้นหา pageToken ของคำขอ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์

ApplicationName

Enum
access_transparency

รายงานกิจกรรมเกี่ยวกับความโปร่งใสในการเข้าถึงของ Google Workspace จะแสดงข้อมูลเกี่ยวกับเหตุการณ์ของกิจกรรมเกี่ยวกับความโปร่งใสในการเข้าถึงประเภทต่างๆ
admin

รายงานกิจกรรมของแอปพลิเคชันคอนโซลผู้ดูแลระบบจะแสดงผลข้อมูลบัญชีเกี่ยวกับเหตุการณ์ของกิจกรรมของผู้ดูแลระบบประเภทต่างๆ
calendar

รายงานกิจกรรมของแอปพลิเคชัน Google ปฏิทินจะแสดงผลข้อมูลเกี่ยวกับกิจกรรมกิจกรรมในปฏิทินต่างๆ
chat รายงานกิจกรรม Chat จะแสดงข้อมูลเกี่ยวกับเหตุการณ์ของกิจกรรม Chat ต่างๆ
drive

รายงานกิจกรรมของแอปพลิเคชัน Google ไดรฟ์จะแสดงข้อมูลเกี่ยวกับเหตุการณ์ของกิจกรรมใน Google ไดรฟ์แบบต่างๆ รายงานกิจกรรมในไดรฟ์ใช้ได้เฉพาะกับลูกค้า Google Workspace Business และ Enterprise เท่านั้น
gcp รายงานกิจกรรมของแอปพลิเคชัน Google Cloud Platform จะแสดงข้อมูลเกี่ยวกับเหตุการณ์ของกิจกรรม GCP ต่างๆ
gplus รายงานกิจกรรมของแอปพลิเคชัน Google+ จะแสดงผลข้อมูลเกี่ยวกับเหตุการณ์กิจกรรม Google+ ต่างๆ
groups

รายงานกิจกรรมของแอปพลิเคชัน Google Groups จะแสดงข้อมูลเกี่ยวกับเหตุการณ์ของกิจกรรม Groups ต่างๆ
groups_enterprise

รายงานกิจกรรมกลุ่มองค์กรจะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมกลุ่มองค์กรต่างๆ
jamboard รายงานกิจกรรม Jamboard จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรม Jamboard ต่างๆ
login

รายงานกิจกรรมของแอปพลิเคชันการเข้าสู่ระบบจะแสดงข้อมูลบัญชีเกี่ยวกับเหตุการณ์กิจกรรมการเข้าสู่ระบบประเภทต่างๆ
meet รายงานกิจกรรมการตรวจสอบ Meet จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมการตรวจสอบ Meet ประเภทต่างๆ
mobile รายงานกิจกรรมการตรวจสอบอุปกรณ์จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมการตรวจสอบอุปกรณ์ประเภทต่างๆ
rules

รายงานกิจกรรมกฎจะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมกฎประเภทต่างๆ
saml

รายงานกิจกรรม SAML จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรม SAML ประเภทต่างๆ
token

รายงานกิจกรรมของแอปพลิเคชันโทเค็นจะแสดงข้อมูลบัญชีเกี่ยวกับเหตุการณ์กิจกรรมโทเค็นประเภทต่างๆ
user_accounts

รายงานกิจกรรมของแอปพลิเคชันบัญชีผู้ใช้จะแสดงข้อมูลบัญชีเกี่ยวกับเหตุการณ์กิจกรรมของผู้ใช้ประเภทต่างๆ
context_aware_access

รายงานกิจกรรมการเข้าถึงแบบ Context-Aware จะแสดงข้อมูลเกี่ยวกับผู้ใช้ เหตุการณ์ที่ถูกปฏิเสธการเข้าถึงเนื่องจาก กฎการเข้าถึงแบบ Context-Aware
chrome

รายงานกิจกรรม Chrome จะแสดงข้อมูลเกี่ยวกับ เหตุการณ์ในเบราว์เซอร์ Chrome และ Chrome OS
data_studio รายงานกิจกรรมใน Data Studio จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมใน Data Studio ประเภทต่างๆ
keep รายงานกิจกรรมของแอปพลิเคชัน Keep จะแสดงข้อมูลเกี่ยวกับเหตุการณ์ของกิจกรรมใน Google Keep ต่างๆ รายงานกิจกรรมใน Keep มีไว้สำหรับลูกค้า Google Workspace Business และ Enterprise เท่านั้น
vault รายงานกิจกรรมของห้องนิรภัยจะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมประเภทต่างๆ ของห้องนิรภัย

กิจกรรม

เทมเพลต JSON สำหรับทรัพยากรกิจกรรม

การแสดง 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
  }
}
ช่อง
kind

string

ประเภทของทรัพยากร API สำหรับรายงานกิจกรรม ค่าจะเป็น audit#activity
etag

string

ETag ของรายการ
ownerDomain

string

โดเมนที่ได้รับผลกระทบจากเหตุการณ์ของรายงาน เช่น โดเมนของคอนโซลผู้ดูแลระบบหรือเจ้าของเอกสารของแอปพลิเคชันไดรฟ์
ipAddress

string

ที่อยู่ IP ของผู้ใช้ที่ดำเนินการนั้นๆ ที่อยู่นี้คือที่อยู่ Internet Protocol (IP) ของผู้ใช้เมื่อเข้าสู่ระบบ Google Workspace ซึ่งอาจแสดงถึงสถานที่ตั้งจริงของผู้ใช้หรือไม่ก็ได้ เช่น ที่อยู่ IP อาจเป็นที่อยู่ของพร็อกซีเซิร์ฟเวอร์หรือที่อยู่เครือข่ายส่วนตัวเสมือน (VPN) ของผู้ใช้ก็ได้ API รองรับ IPv4 และ IPv6
events[]

object

เหตุการณ์กิจกรรมในรายงาน
events[].type

string

ประเภทเหตุการณ์ บริการหรือฟีเจอร์ของ Google Workspace ที่ผู้ดูแลระบบเปลี่ยนแปลงจะอยู่ในพร็อพเพอร์ตี้ type ซึ่งจะระบุเหตุการณ์โดยใช้พร็อพเพอร์ตี้ eventName ดูรายการหมวดหมู่ type ทั้งหมดของ API ได้ที่รายการชื่อเหตุการณ์สำหรับแอปพลิเคชันต่างๆ ด้านบนใน applicationName
events[].name

string

ชื่อเหตุการณ์ ชื่อนี้คือชื่อที่เจาะจงของกิจกรรมที่รายงานโดย API และ eventName แต่ละรายการจะเกี่ยวข้องกับบริการหรือฟีเจอร์ของ Google Workspace ที่เฉพาะเจาะจง ซึ่ง API จะจัดแบ่งประเภทเหตุการณ์
สำหรับพารามิเตอร์คำขอ eventName โดยทั่วไป

  • หากไม่ได้ระบุ eventName รายงานจะแสดงอินสแตนซ์ที่เป็นไปได้ทั้งหมดของ eventName
  • เมื่อคุณขอ eventName การตอบกลับของ API จะแสดงกิจกรรมทั้งหมดที่มี eventName ดังกล่าว

ดูข้อมูลเพิ่มเติมเกี่ยวกับพร็อพเพอร์ตี้ eventName ได้ที่รายการชื่อเหตุการณ์สำหรับแอปพลิเคชันต่างๆ ด้านบนใน applicationName
events[].parameters[]

object

คู่ค่าพารามิเตอร์สำหรับแอปพลิเคชันต่างๆ ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์ eventName ได้ที่รายการชื่อเหตุการณ์สำหรับแอปพลิเคชันต่างๆ ด้านบนใน applicationName
events[].parameters[].messageValue

object

คู่ค่าพารามิเตอร์ที่ซ้อนกันที่เชื่อมโยงกับพารามิเตอร์นี้ ระบบจะแสดงประเภทค่าที่ซับซ้อนของพารามิเตอร์เป็นรายการค่าพารามิเตอร์ เช่น พารามิเตอร์ที่อยู่อาจมีค่าเป็น [{parameter: [{name: city, value: abc}]}]
events[].parameters[].messageValue.parameter[]

object (NestedParameter)

ค่าพารามิเตอร์
events[].parameters[].name

string

ชื่อพารามิเตอร์
events[].parameters[].value

string

ค่าสตริงของพารามิเตอร์
events[].parameters[].multiValue[]

string

ค่าสตริงของพารามิเตอร์
events[].parameters[].intValue

string (int64 format)

ค่าที่เป็นจำนวนเต็มของพารามิเตอร์
events[].parameters[].multiIntValue[]

string (int64 format)

ค่าที่เป็นจำนวนเต็มของพารามิเตอร์
events[].parameters[].boolValue

boolean

ค่าบูลีนของพารามิเตอร์
events[].parameters[].multiMessageValue[]

object

activity.list จากวัตถุ messageValue รายการ
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

ค่าพารามิเตอร์
id

object

ตัวระบุที่ไม่ซ้ำกันสำหรับบันทึกกิจกรรมแต่ละรายการ
id.time

string

เวลาที่เกิดกิจกรรม เวลานี้เป็นเวลา UNIX Epoch ในหน่วยวินาที
id.uniqueQualifier

string (int64 format)

ตัวระบุที่ไม่ซ้ำกันในกรณีที่มีกิจกรรมหลายรายการเหมือนกัน
id.applicationName

string

ชื่อแอปพลิเคชันที่มีกิจกรรมอยู่ สำหรับค่าที่เป็นไปได้ โปรดดูรายการแอปพลิเคชันด้านบนใน applicationName
id.customerId

string

ตัวระบุที่ไม่ซ้ำกันสำหรับบัญชี Google Workspace
actor

object

ผู้ใช้ที่ดำเนินการ
actor.profileId

string

รหัสโปรไฟล์ Google Workspace ที่ไม่ซ้ำกันของผู้ดำเนินการ ค่านี้อาจไม่มีอยู่หากผู้ดำเนินการไม่ใช่ผู้ใช้ Google Workspace หรืออาจเป็นหมายเลข 105250506097979753968 ซึ่งทำหน้าที่เป็นรหัสตัวยึดตำแหน่ง
actor.email

string

อีเมลหลักของผู้ดำเนินการ อาจขาดหายไปหากไม่มีอีเมลที่เชื่อมโยงกับผู้ดำเนินการ
actor.callerType

string

ประเภทนักแสดง
actor.key

string

แสดงเมื่อ callerType เท่ากับ KEY เท่านั้น อาจเป็น consumer_key ของผู้ขอสำหรับคำขอ OAuth 2LO API หรือตัวระบุสำหรับบัญชีโรบ็อต