Method: activities.list

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

คำขอ HTTP

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

URL ใช้ไวยากรณ์ gRPC Transcoding

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

พารามิเตอร์
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&#39 สําหรับรายงาน: เมื่อสร้าง API และดึงรายงาน
  • Start's start time: จุดเริ่มต้นของระยะเวลาที่แสดงในรายงาน 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)
  • <—'less&' ต้องเป็น URL ที่เข้ารหัส (%3C)
  • <= - 'น้อยกว่าหรือเท่ากับ' ต้องเข้ารหัส URL (%3C=)
  • >—'สําคัญกว่า' ต้องเป็น URL ที่เข้ารหัส (%3E)
  • >=—'มากกว่าหรือเท่ากับ' ต้องเข้ารหัส URL (%3E=)

หมายเหตุ: API ไม่ยอมรับค่าหลายค่าของพารามิเตอร์เดียวกัน หากระบุพารามิเตอร์มากกว่า 1 ครั้งในคําขอ 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

รหัสกลุ่มที่คั่นด้วยเครื่องหมายจุลภาค (สร้างความสับสน) ซึ่งมีการกรองกิจกรรมของผู้ใช้ ซึ่งได้แก่ การตอบกลับจะประกอบด้วยกิจกรรมซึ่งมีเฉพาะผู้ใช้ที่เป็นส่วนหนึ่งของรหัสกลุ่มอย่างน้อย 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

โปรดดูข้อมูลเพิ่มเติมที่หัวข้อภาพรวมของ OAuth 2.0

ชื่อแอปพลิเคชัน

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

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

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

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

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

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

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

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

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

กิจกรรม

เทมเพลต 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&#39 จะแสดงกิจกรรมทั้งหมดที่มี eventName ดังกล่าว อาจเป็นไปได้ว่ากิจกรรมที่แสดงผลมีพร็อพเพอร์ตี้ 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 หรือตัวระบุสําหรับบัญชีโรบ็อต