เลือกขอบเขต Google Workspace Events API

เอกสารนี้มีข้อมูลการให้สิทธิ์และการตรวจสอบสิทธิ์เฉพาะสำหรับ Google Workspace Events API ก่อนอ่านเอกสารนี้ โปรดอ่านข้อมูลการตรวจสอบสิทธิ์และการให้สิทธิ์ทั่วไปของ Google Workspace ที่ดูข้อมูลเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์

กำหนดค่า OAuth 2.0 สำหรับการให้สิทธิ์

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

ขอบเขตของ Google Workspace Events API

หากต้องการกำหนดระดับการเข้าถึงที่ให้แก่แอป คุณต้องระบุและ ประกาศขอบเขตการให้สิทธิ์ ขอบเขตการให้สิทธิ์คือสตริง URI ของ OAuth 2.0 ซึ่งมีชื่อแอป Google Workspace, ประเภทข้อมูลที่เข้าถึง และ ระดับการเข้าถึง ขอบเขตคือคำขอของแอปในการทำงานกับข้อมูล Google Workspace ซึ่งรวมถึงข้อมูลในบัญชี Google ของผู้ใช้

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

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

ตารางต่อไปนี้แสดงขอบเขตที่รองรับสำหรับ Google Workspace Events API

รหัสขอบเขต คำอธิบาย การใช้งาน
Google Chat  
https://www.googleapis.com/auth/chat.bot แอป Lets Chat จะดูแชทและส่งข้อความได้ ให้สิทธิ์เข้าถึงฟีเจอร์ทั้งหมดที่แอป Chat ใช้ได้ ไม่ละเอียดอ่อน
https://www.googleapis.com/auth/chat.memberships ดู เพิ่ม และนำสมาชิกออกจากการสนทนาใน Chat
ละเอียดอ่อน
https://www.googleapis.com/auth/chat.memberships.readonly ดูสมาชิกในการสนทนาใน Chat
ละเอียดอ่อน
https://www.googleapis.com/auth/chat.app.memberships

ดู เพิ่ม อัปเดต และนำสมาชิกออกจากการสนทนาและพื้นที่ทำงานใน Chat ในฐานะแอป Chat

ต้องได้รับการอนุมัติจากผู้ดูแลระบบ

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


ละเอียดอ่อน
https://www.googleapis.com/auth/chat.spaces สร้างการสนทนาและพื้นที่ทำงาน ตลอดจนดูหรืออัปเดตข้อมูลเมตา (รวมถึง การตั้งค่าประวัติ) ใน Chat ละเอียดอ่อน
https://www.googleapis.com/auth/chat.spaces.readonly ดูแชทและพื้นที่ทำงานใน Chat
ละเอียดอ่อน
https://www.googleapis.com/auth/chat.app.spaces

สร้างการสนทนาและพื้นที่ทำงาน รวมถึงดูหรืออัปเดตข้อมูลเมตา (รวมถึง การตั้งค่าประวัติ) ใน Chat ในฐานะ แอป Chat

ต้องได้รับการอนุมัติจากผู้ดูแลระบบ

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


ละเอียดอ่อน
https://www.googleapis.com/auth/chat.messages.reaction วินาที ดู เพิ่ม และลบรีแอ็กชันที่มีต่อข้อความใน Chat
ละเอียดอ่อน
https://www.googleapis.com/auth/chat.messages.reactions.readonly ดูรีแอ็กชันที่มีต่อข้อความใน Chat
ละเอียดอ่อน
https://www.googleapis.com/auth/chat.messages ดู เขียน ส่ง อัปเดต และลบข้อความ รวมถึงเพิ่ม ดู และลบรีแอ็กชันที่มีต่อข้อความ จำกัด
https://www.googleapis.com/auth/chat.messages.readonly ดูข้อความและความรู้สึกใน Chat
ถูกจำกัด
https://www.googleapis.com/auth/chat.app.messages.readonly

ดูข้อความและความรู้สึกใน Chat ในฐานะ แอป Chat

ต้องได้รับการอนุมัติจากผู้ดูแลระบบ

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


ถูกจำกัด
Google ไดรฟ์  
https://www.googleapis.com/auth/drive.file สร้างไฟล์ใหม่ในไดรฟ์หรือแก้ไขไฟล์ที่มีอยู่ซึ่ง คุณเปิดด้วยแอปหรือที่ผู้ใช้แชร์กับแอปขณะใช้ Google Picker API หรือเครื่องมือเลือกไฟล์ของแอป ไม่ละเอียดอ่อน
https://www.googleapis.com/auth/drive ดูและจัดการไฟล์ทั้งหมดในไดรฟ์ จำกัด
https://www.googleapis.com/auth/drive.readonly ดูและดาวน์โหลดไฟล์ในไดรฟ์ทั้งหมด จำกัด
https://www.googleapis.com/auth/drive.metadata ดูและจัดการข้อมูลเมตาของไฟล์ในไดรฟ์ จำกัด
https://www.googleapis.com/auth/drive.metadata.readonly ดูข้อมูลเมตาของไฟล์ในไดรฟ์ จำกัด
Google Meet  
https://www.googleapis.com/auth/meetings.space.created อนุญาตให้แอปสร้าง แก้ไข และอ่านข้อมูลเมตาเกี่ยวกับพื้นที่การประชุมที่แอปของคุณสร้างขึ้น
ละเอียดอ่อน
https://www.googleapis.com/auth/meetings.space.readonly อนุญาตให้แอปอ่านข้อมูลเมตาเกี่ยวกับพื้นที่การประชุมที่ผู้ใช้มีสิทธิ์เข้าถึง
ละเอียดอ่อน

คอลัมน์การใช้งานในตารางก่อนหน้าจะระบุความละเอียดอ่อนของแต่ละขอบเขต ดังนี้

  • ไม่ละเอียดอ่อน: ขอบเขตเหล่านี้ให้สิทธิ์เข้าถึงที่เล็กที่สุด และต้องมีการตรวจสอบแอประดับพื้นฐานเท่านั้น ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่ข้อกำหนดในการยืนยัน

  • มีความละเอียดอ่อน: ขอบเขตเหล่านี้ให้สิทธิ์เข้าถึงข้อมูลผู้ใช้ Google ที่เฉพาะเจาะจง ซึ่งผู้ใช้ให้สิทธิ์แอปของคุณ และกำหนดให้คุณต้องผ่าน การตรวจสอบแอปเพิ่มเติม ดูข้อมูลเกี่ยวกับข้อกำหนดนี้ได้ที่ ข้อกำหนดเกี่ยวกับขอบเขตที่ละเอียดอ่อนและถูกจำกัด

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

หากแอปของคุณต้องเข้าถึง Google API อื่นๆ คุณก็เพิ่มขอบเขตเหล่านั้นได้เช่นกัน ดูข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต Google API ได้ที่การใช้ OAuth 2.0 เพื่อเข้าถึง Google API

ดูข้อมูลเพิ่มเติมเกี่ยวกับขอบเขต OAuth 2.0 ที่เฉพาะเจาะจงได้ที่ขอบเขต OAuth 2.0 สำหรับ Google APIs

การยืนยัน OAuth

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

ประเภทการตรวจสอบสิทธิ์ที่จำเป็น

ส่วนนี้จะอธิบายประเภทการตรวจสอบสิทธิ์ที่จำเป็นหรือรองรับ และขอบเขตที่รองรับสำหรับแต่ละวิธีของ Google Workspace Events API

สำหรับการสมัครรับข้อมูลกิจกรรมใน Chat นั้น Google Workspace Events API รองรับทั้งการตรวจสอบสิทธิ์ของผู้ใช้และแอปเพื่อเรียกใช้เมธอดบางรายการ หากเมธอด API รองรับข้อมูลเข้าสู่ระบบทั้งสองประเภท ประเภทของข้อมูลเข้าสู่ระบบที่ใช้ในการเรียกจะส่งผลต่อผลลัพธ์ที่แสดง เช่น หากคุณเรียกใช้เมธอด subscriptions.list ด้วยการตรวจสอบสิทธิ์ผู้ใช้ API จะแสดงรายการการสมัครใช้บริการที่ผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์เข้าถึงได้ หากคุณใช้การตรวจสอบสิทธิ์แอป API จะแสดงรายการการสมัครใช้บริการที่แอปเข้าถึงได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับ ประเภทการตรวจสอบสิทธิ์ของ Chat ได้ที่หัวข้อตรวจสอบสิทธิ์และให้สิทธิ์ แอปใน Chat และคำขอ Chat API

ตารางต่อไปนี้แสดงขอบเขตและประเภทการตรวจสอบสิทธิ์ที่ จำเป็นหรือรองรับสำหรับเมธอด Google Workspace Events API แต่ละรายการ

วิธีการ ต้องมีการตรวจสอบสิทธิ์ผู้ใช้หรือรองรับการตรวจสอบสิทธิ์ผู้ใช้ รองรับการตรวจสอบสิทธิ์แอป (แอปใน Chat เท่านั้น) ขอบเขตการให้สิทธิ์ที่รองรับ
สร้างการสมัครใช้บริการ —

เมื่อมีการตรวจสอบสิทธิ์ผู้ใช้ จะต้องมีขอบเขตที่รองรับสำหรับเหตุการณ์แต่ละประเภท

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์: เมื่อใช้การตรวจสอบสิทธิ์แอปและการอนุมัติจากผู้ดูแลระบบ (แอป Chat เท่านั้น) จะต้องมีขอบเขตที่รองรับสำหรับเหตุการณ์แต่ละประเภท

  • chat.app.memberships
  • chat.app.spaces
  • chat.app.messages.readonly
สมัครใช้บริการ เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ วิธีนี้ต้องมีขอบเขตที่รองรับประเภทเหตุการณ์อย่างน้อย 1 ประเภทสำหรับการสมัครใช้บริการ

เมื่อใช้การตรวจสอบสิทธิ์แอป (แอป Chat เท่านั้น) คุณจะทำสิ่งต่อไปนี้ได้

  • chat.bot
แสดงรายการการสมัครใช้บริการ เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ วิธีนี้ต้องมีขอบเขตที่รองรับประเภทเหตุการณ์อย่างน้อย 1 ประเภทสำหรับการสมัครใช้บริการ

เมื่อใช้การตรวจสอบสิทธิ์แอป (แอป Chat เท่านั้น) คุณจะทำสิ่งต่อไปนี้ได้

  • chat.bot
อัปเดตการสมัครใช้บริการ —

เมื่อมีการตรวจสอบสิทธิ์ผู้ใช้ จะต้องมีขอบเขตที่รองรับสำหรับเหตุการณ์แต่ละประเภท

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์: เมื่อใช้การตรวจสอบสิทธิ์แอปและการอนุมัติจากผู้ดูแลระบบ (แอป Chat เท่านั้น) จะต้องมีขอบเขตที่รองรับสำหรับเหตุการณ์แต่ละประเภท ดังนี้

  • chat.app.memberships
  • chat.app.spaces
  • chat.app.messages.readonly
เปิดใช้งานการสมัครใช้บริการอีกครั้ง —

เมื่อมีการตรวจสอบสิทธิ์ผู้ใช้ จะต้องมีขอบเขตที่รองรับสำหรับเหตุการณ์แต่ละประเภท

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์: เมื่อใช้การตรวจสอบสิทธิ์แอปและการอนุมัติจากผู้ดูแลระบบ (แอป Chat เท่านั้น) จะต้องมีขอบเขตที่รองรับสำหรับเหตุการณ์แต่ละประเภท

  • chat.app.memberships
  • chat.app.spaces
  • chat.app.messages.readonly
ลบการสมัครใช้บริการ เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ วิธีนี้ต้องมีขอบเขตที่รองรับประเภทเหตุการณ์อย่างน้อย 1 ประเภทสำหรับการสมัครใช้บริการ

เมื่อใช้การตรวจสอบสิทธิ์แอป (แอป Chat เท่านั้น) คุณจะทำสิ่งต่อไปนี้ได้

  • chat.bot

ขอบเขตตามประเภทเหตุการณ์

เมื่อเรียกใช้ Google Workspace Events API โดยใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณต้องระบุขอบเขตอย่างน้อย 1 รายการที่สอดคล้องกับประเภทเหตุการณ์ของการสมัครใช้บริการ

ตารางต่อไปนี้แสดงขอบเขตการให้สิทธิ์ที่รองรับสำหรับ ประเภทเหตุการณ์แต่ละประเภท

เหตุการณ์ ประเภทเหตุการณ์ ขอบเขตการให้สิทธิ์ที่รองรับ
Chat  
มีการโพสต์หรืออัปเดตข้อความ
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
 เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณจะทำสิ่งต่อไปนี้ได้
  • chat.messages
  • chat.messages.readonly
เมื่อใช้การตรวจสอบสิทธิ์แอปและการอนุมัติจากผู้ดูแลระบบ (พร้อมใช้งานในเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์) คุณจะทำสิ่งต่อไปนี้ได้
  • chat.app.messages.readonly
มีการเพิ่มหรือลบรีแอ็กชัน หรือมีการเปลี่ยนแปลงรีแอ็กชันหลายรายการ
  • google.workspace.chat.reaction.v1.created
  • google.workspace.chat.reaction.v1.deleted
  • google.workspace.chat.reaction.v1.batchChanged
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.messages
  • chat.messages.readonly
มีการสร้าง อัปเดต หรือนำการเป็นสมาชิกออก หรือมีการเปลี่ยนแปลงการเป็นสมาชิกหลายรายการ
  • google.workspace.chat.membership.v1.created
  • google.workspace.chat.membership.v1.updated
  • google.workspace.chat.membership.v1.deleted
  • google.workspace.chat.membership.v1.batchChanged
 เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณจะทำสิ่งต่อไปนี้ได้
  • chat.memberships
  • chat.memberships.readonly
เมื่อใช้การตรวจสอบสิทธิ์แอปและการอนุมัติจากผู้ดูแลระบบ (พร้อมใช้งานในเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์) คุณจะทำสิ่งต่อไปนี้ได้
  • chat.app.memberships
มีการอัปเดตหรือลบพื้นที่ทำงาน แล้ว
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
 เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณจะทำสิ่งต่อไปนี้ได้
  • chat.spaces
  • chat.spaces.readonly
เมื่อใช้การตรวจสอบสิทธิ์แอปและการอนุมัติจากผู้ดูแลระบบ (พร้อมใช้งานในเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์) คุณจะทำสิ่งต่อไปนี้ได้
  • chat.app.spaces
ไดรฟ์  
ไฟล์ถูก สร้าง เปลี่ยนแปลง ย้าย ลบ เปลี่ยนชื่อ ทิ้ง หรือนำออกจาก ถังขยะ
  • google.workspace.drive.file.v3.added
  • google.workspace.drive.file.v3.moved
  • google.workspace.drive.file.v3.contentChanged
  • google.workspace.drive.file.v3.deleted
  • google.workspace.drive.file.v3.renamed
  • google.workspace.drive.file.v3.trashed
  • google.workspace.drive.file.v3.untrashed
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
มีการสร้างหรือแก้ไขคำขอเข้าถึง ในไฟล์
  • google.workspace.drive.accessProposal.v3.created
  • google.workspace.drive.accessProposal.v3.resolved
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
การอนุมัติ ถูกยกเลิก เสร็จสมบูรณ์ สร้างใหม่ รีเซ็ต เปลี่ยนผู้ตรวจสอบ หรือผู้ตรวจสอบตอบกลับในไฟล์
  • google.workspace.drive.approval.v3.cancelled
  • google.workspace.drive.approval.v3.completed
  • google.workspace.drive.approval.v3.created
  • google.workspace.drive.approval.v3.reset
  • google.workspace.drive.approval.v3.reviewersChanged
  • google.workspace.drive.approval.v3.reviewerResponded
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
มีการสร้าง ลบ แก้ไข เปิดอีกครั้ง หรือแก้ปัญหาความคิดเห็น ในไฟล์
  • google.workspace.drive.comment.v3.created
  • google.workspace.drive.comment.v3.deleted
  • google.workspace.drive.comment.v3.edited
  • google.workspace.drive.comment.v3.reopened
  • google.workspace.drive.comment.v3.resolved
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
มีการสร้าง ลบ หรือแก้ไขการตอบกลับ ในไฟล์
  • google.workspace.drive.reply.v3.created
  • google.workspace.drive.reply.v3.deleted
  • google.workspace.drive.reply.v3.edited
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
มีการสร้าง ลบ หรือแก้ไขสิทธิ์ ในไฟล์
  • google.workspace.drive.permission.v3.created
  • google.workspace.drive.permission.v3.deleted
  • google.workspace.drive.permission.v3.edited
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
Meet  
การประชุมเริ่มหรือสิ้นสุด
  • google.workspace.meet.conference.v2.started
  • google.workspace.meet.conference.v2.ended
  • meetings.space.created
  • meetings.space.readonly
ผู้เข้าร่วมเข้าร่วมหรือ ออกจากห้องประชุม
  • google.workspace.meet.participant.v2.joined
  • google.workspace.meet.participant.v2.left
  • meetings.space.created
  • meetings.space.readonly
ระบบสร้างการบันทึกแล้ว
  • google.workspace.meet.recording.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly
ระบบได้สร้างข้อความถอดเสียงแล้ว
  • google.workspace.meet.transcript.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly