Package google.chat.v1

ดัชนี

ChatService

ช่วยให้นักพัฒนาซอฟต์แวร์สร้างแอปใน Chat และการผสานรวมในแพลตฟอร์ม Google Chat ได้

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้และการมอบสิทธิ์ทั่วทั้งโดเมนที่มีขอบเขตการให้สิทธิ์ดังนี้

  • https://www.googleapis.com/auth/chat.import

ดูข้อมูลเพิ่มเติมได้ที่หัวข้อให้สิทธิ์แอป Google Chat ในการนำเข้าข้อมูล

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

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

  • https://www.googleapis.com/auth/chat.import

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

สร้างอีโมจิที่กำหนดเอง

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.customemojis
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.customemojis

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

สร้างการเป็นสมาชิกสำหรับแอป Chat ที่เรียกใช้ ผู้ใช้ หรือ Google Group ระบบไม่รองรับการสร้างการเป็นสมาชิกสำหรับแอปใน Chat อื่นๆ เมื่อสร้างการเป็นสมาชิก หากสมาชิกที่ระบุปิดนโยบายการยอมรับอัตโนมัติไว้ ระบบจะส่งคำเชิญให้สมาชิกดังกล่าว และสมาชิกต้องยอมรับคำเชิญเข้าร่วมพื้นที่ทำงานก่อนจึงจะเข้าร่วมได้ หรือสร้างการเป็นสมาชิกเพื่อเพิ่มสมาชิกไปยังพื้นที่ทำงานที่ระบุโดยตรง

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

  • การตรวจสอบสิทธิ์แอปด้วยการอนุมัติจากผู้ดูแลระบบและขอบเขตการให้สิทธิ์:

    • https://www.googleapis.com/auth/chat.app.memberships

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (เพื่อเพิ่มแอปการโทรไปยังพื้นที่ทำงาน)
    • https://www.googleapis.com/auth/chat.import (พื้นที่ทำงานโหมดการนำเข้าเท่านั้น)
    • การตรวจสอบสิทธิ์ผู้ใช้จะให้สิทธิ์ของผู้ดูแลระบบเมื่อบัญชีผู้ดูแลระบบตรวจสอบสิทธิ์ use_admin_access คือ true และใช้ขอบเขตการให้สิทธิ์ต่อไปนี้
      • https://www.googleapis.com/auth/chat.admin.memberships

ระบบไม่รองรับการตรวจสอบสิทธิ์แอปสำหรับกรณีการใช้งานต่อไปนี้

  • การเชิญผู้ใช้ภายนอกองค์กร Workspace ที่เป็นเจ้าของพื้นที่ทำงาน
  • การเพิ่ม Google Group ในพื้นที่ทำงาน
  • การเพิ่มแอปใน Chat ไปยังพื้นที่ทำงาน

ดูตัวอย่างการใช้งานได้ที่หัวข้อต่อไปนี้

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

สร้างข้อความในพื้นที่ทำงานของ Google Chat ดูตัวอย่างได้ที่หัวข้อส่งข้อความ

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

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

รูปภาพต่อไปนี้แสดงวิธีที่ Chat ระบุแหล่งที่มาของข้อความเมื่อคุณใช้การตรวจสอบสิทธิ์แอป Chat จะแสดงแอปใน Chat เป็นผู้ส่งข้อความ เนื้อหาของข้อความอาจประกอบด้วยข้อความ (text) การ์ด (cardsV2) และวิดเจ็ตเสริม (accessoryWidgets)

ข้อความที่ส่งพร้อมการตรวจสอบสิทธิ์แอป

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

ข้อความที่ส่งพร้อมการตรวจสอบสิทธิ์ผู้ใช้

ขนาดข้อความสูงสุดรวมถึงเนื้อหาข้อความคือ 32,000 ไบต์

สำหรับคำขอ Webhook การตอบกลับจะไม่มีข้อความแบบเต็ม การตอบกลับจะป้อนข้อมูลเฉพาะในช่อง name และ thread.name นอกเหนือจากข้อมูลที่อยู่ในคำขอ

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
CreateMessagePin

rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin)

สร้างการปักหมุดข้อความ

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

สร้างความรู้สึกและเพิ่มลงในข้อความ ตัวอย่างเช่น ดูหัวข้อเพิ่มรีแอ็กชันในข้อความ

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (พื้นที่ทำงานโหมดการนำเข้าเท่านั้น)
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
CreateSection

rpc CreateSection(CreateSectionRequest) returns (Section)

สร้างส่วนใน Google Chat ส่วนต่างๆ จะช่วยให้ผู้ใช้จัดกลุ่มการสนทนาและปรับแต่งรายการพื้นที่ทำงานที่แสดงในแผงการนำทางของ Chat ได้ สร้างได้เฉพาะส่วนประเภท CUSTOM_SECTION เท่านั้น โปรดดูรายละเอียดที่หัวข้อสร้างและจัดระเบียบส่วนต่างๆ ใน Google Chat

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.sections
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.sections

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

สร้างพื้นที่ทำงาน ใช้เพื่อสร้างพื้นที่ทำงานที่มีชื่อหรือแชทเป็นกลุ่มใน Import mode ได้ โปรดดูตัวอย่างที่หัวข้อสร้างพื้นที่ทำงาน

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

เมื่อตรวจสอบสิทธิ์ในฐานะแอป คุณต้องตั้งค่าช่อง space.customer ในคำขอ

เมื่อตรวจสอบสิทธิ์ในฐานะแอป ระบบจะเพิ่มแอปใน Chat เป็นสมาชิกของพื้นที่ทำงาน อย่างไรก็ตาม แอปใน Chat จะไม่ได้รับการเพิ่มเป็นผู้จัดการพื้นที่ทำงานเหมือนกับการตรวจสอบสิทธิ์โดยมนุษย์ โดยค่าเริ่มต้น สมาชิกทุกคนในพื้นที่ทำงานจะนำแอปใน Chat ออกจากพื้นที่ทำงานได้ หากต้องการอนุญาตให้เฉพาะผู้จัดการพื้นที่ทำงานนำแอปออกจากพื้นที่ทำงานได้ ให้ตั้งค่า space.permission_settings.manage_apps เป็น managers_allowed

การเป็นสมาชิกของพื้นที่ทำงานเมื่อสร้างจะขึ้นอยู่กับว่ามีการสร้างพื้นที่ทำงานใน Import mode หรือไม่ ดังนี้

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

หากได้รับข้อความแสดงข้อผิดพลาด ALREADY_EXISTS เมื่อสร้างพื้นที่ทำงาน ให้ลองใช้ displayName อื่น พื้นที่ทำงานที่มีอยู่ภายในองค์กร Google Workspace อาจใช้ชื่อที่แสดงนี้อยู่แล้ว

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

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

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.customemojis
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.customemojis

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

ลบการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้อนำผู้ใช้หรือแอป Google Chat ออกจากพื้นที่ทำงาน

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

  • การตรวจสอบสิทธิ์แอปด้วยการอนุมัติจากผู้ดูแลระบบและขอบเขตการให้สิทธิ์:

    • https://www.googleapis.com/auth/chat.app.memberships

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (เพื่อนำแอปการโทรออกจากพื้นที่ทำงาน)
    • https://www.googleapis.com/auth/chat.import (พื้นที่ทำงานโหมดการนำเข้าเท่านั้น)
    • การตรวจสอบสิทธิ์ผู้ใช้จะให้สิทธิ์ของผู้ดูแลระบบเมื่อบัญชีผู้ดูแลระบบตรวจสอบสิทธิ์ use_admin_access คือ true และใช้ขอบเขตการให้สิทธิ์ต่อไปนี้
      • https://www.googleapis.com/auth/chat.admin.memberships

ระบบไม่รองรับการตรวจสอบสิทธิ์แอปสำหรับกรณีการใช้งานต่อไปนี้

  • การนำกลุ่มใน Google Groups ออกจากพื้นที่ทำงาน
  • การนำแอปใน Chat ออกจากพื้นที่ทำงาน

หากต้องการลบการเป็นสมาชิกของผู้จัดการพื้นที่ทำงาน ผู้ขอต้องเป็นผู้จัดการพื้นที่ทำงาน หากใช้การตรวจสอบสิทธิ์แอป แอปใน Chat ต้องเป็นผู้สร้างพื้นที่ทำงาน

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

ลบข้อความ ดูตัวอย่างได้ที่หัวข้อลบข้อความ

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

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

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
DeleteMessagePin

rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty)

ลบข้อความที่ปักหมุดไว้

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

ลบความรู้สึกต่อข้อความ ดูตัวอย่างได้ที่หัวข้อลบรีแอ็กชัน

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (พื้นที่ทำงานโหมดการนำเข้าเท่านั้น)
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
DeleteSection

rpc DeleteSection(DeleteSectionRequest) returns (Empty)

ลบส่วนของประเภท CUSTOM_SECTION

หากส่วนดังกล่าวมีรายการต่างๆ เช่น พื้นที่ทำงาน ระบบจะย้ายรายการเหล่านั้นไปยังส่วนเริ่มต้นของ Google Chat และจะไม่ลบรายการดังกล่าว

โปรดดูรายละเอียดที่หัวข้อสร้างและจัดระเบียบส่วนต่างๆ ใน Google Chat

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.sections
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.sections

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

  • การตรวจสอบสิทธิ์แอปด้วยการอนุมัติจากผู้ดูแลระบบและขอบเขตการให้สิทธิ์:

    • https://www.googleapis.com/auth/chat.app.delete (เฉพาะในพื้นที่ทำงานที่แอปสร้างขึ้น)

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.delete
    • https://www.googleapis.com/auth/chat.import (พื้นที่ทำงานโหมดการนำเข้าเท่านั้น)
    • การตรวจสอบสิทธิ์ผู้ใช้จะให้สิทธิ์ของผู้ดูแลระบบเมื่อบัญชีผู้ดูแลระบบตรวจสอบสิทธิ์ use_admin_access คือ true และใช้ขอบเขตการให้สิทธิ์ต่อไปนี้
      • https://www.googleapis.com/auth/chat.admin.delete
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

แสดงผลข้อความส่วนตัวที่มีอยู่กับผู้ใช้ที่ระบุ หากไม่พบพื้นที่ทำงานของข้อความส่วนตัว ระบบจะแสดงข้อผิดพลาด 404 NOT_FOUND ดูตัวอย่างได้ที่หัวข้อค้นหาข้อความส่วนตัว

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

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
FindGroupChats

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

แสดงผลพื้นที่ทำงานทั้งหมดที่มี spaceType == GROUP_CHAT ซึ่งการเป็นสมาชิกของบุคคลมีผู้ใช้ที่โทรและผู้ใช้ที่ระบุใน FindGroupChatsRequest.users เท่านั้น ระบบรองรับเฉพาะสมาชิกที่เข้าร่วมการสนทนาเท่านั้น โปรดดูตัวอย่างที่หัวข้อค้นหาแชทเป็นกลุ่ม

หากผู้ใช้ที่โทรบล็อกหรือถูกบล็อกโดยผู้ใช้บางราย และไม่พบพื้นที่ทำงานที่มีชุดผู้ใช้ที่ระบุทั้งหมด วิธีนี้จะแสดงผลพื้นที่ทำงานที่ไม่มีผู้ใช้ที่ถูกบล็อกหรือผู้ใช้ที่บล็อก

ชุดผู้ใช้ที่ระบุต้องมีเฉพาะการเป็นสมาชิกที่เป็นมนุษย์ (ไม่ใช่แอป) เท่านั้น คำขอที่มีผู้ใช้ที่ไม่ใช่มนุษย์จะไม่แสดงพื้นที่ทำงานใดๆ

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

รับข้อมูลเมตาของไฟล์แนบของข้อความ ระบบจะดึงข้อมูลไฟล์แนบโดยใช้ media API ดูตัวอย่างได้ที่หัวข้อรับข้อมูลเมตาเกี่ยวกับไฟล์แนบของข้อความ

ต้องมีการตรวจสอบสิทธิ์แอปที่มีขอบเขตการให้สิทธิ์ดังนี้

  • https://www.googleapis.com/auth/chat.bot
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.bot

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
GetAvailability

rpc GetAvailability(GetAvailabilityRequest) returns (Availability)

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

วิธีนี้จะดึงข้อมูลความพร้อมของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วเท่านั้น

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.availability.readonly
  • https://www.googleapis.com/auth/chat.users.availability
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.availability
  • https://www.googleapis.com/auth/chat.users.availability.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

แสดงรายละเอียดเกี่ยวกับอีโมจิที่กำหนดเอง

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

แสดงรายละเอียดเกี่ยวกับการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้อดูรายละเอียดเกี่ยวกับการเป็นสมาชิกของผู้ใช้หรือแอป Google Chat

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

  • การตรวจสอบสิทธิ์แอปด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • การตรวจสอบสิทธิ์ผู้ใช้จะให้สิทธิ์ของผู้ดูแลระบบเมื่อบัญชีผู้ดูแลระบบตรวจสอบสิทธิ์ use_admin_access คือ true และใช้ขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

แสดงรายละเอียดเกี่ยวกับข้อความ ดูตัวอย่างได้ที่หัวข้อดูรายละเอียดเกี่ยวกับข้อความ

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

  • การตรวจสอบสิทธิ์แอปด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

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

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages

หมายเหตุ: อาจแสดงข้อความจากสมาชิกหรือพื้นที่ทำงานที่ถูกบล็อก

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

แสดงรายละเอียดเกี่ยวกับพื้นที่ทำงาน ดูตัวอย่างได้ที่หัวข้อดูรายละเอียดเกี่ยวกับพื้นที่ทำงาน

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

  • การตรวจสอบสิทธิ์แอปด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • การตรวจสอบสิทธิ์ผู้ใช้จะให้สิทธิ์ของผู้ดูแลระบบเมื่อบัญชีผู้ดูแลระบบตรวจสอบสิทธิ์ use_admin_access คือ true และใช้ขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

การตรวจสอบสิทธิ์ของแอปมีข้อจำกัดดังต่อไปนี้

  • space.access_settings จะป้อนข้อมูลเมื่อใช้ขอบเขต chat.app.spaces เท่านั้น
  • space.predefind_permission_settings และ space.permission_settings จะป้อนข้อมูลเมื่อใช้ขอบเขต chat.app.spaces เท่านั้น และเฉพาะสำหรับพื้นที่ทำงานที่แอปสร้างขึ้น
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

หมายเหตุ: ระบบจะไม่แสดงช่อง permissionSettings ในออบเจ็กต์ Space ของข้อมูลเหตุการณ์ Space สำหรับคำขอนี้

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้ด้วยขอบเขตการให้สิทธิ์ที่เหมาะสมสำหรับการอ่านข้อมูลที่ขอ

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

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.spaces.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

หากต้องการรับกิจกรรม ผู้โทรที่ตรวจสอบสิทธิ์แล้วต้องเป็นสมาชิกของพื้นที่ทำงาน

ดูตัวอย่างได้ที่หัวข้อดูรายละเอียดเกี่ยวกับกิจกรรมจากพื้นที่ทำงานใน Google Chat

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

รับการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน ดูตัวอย่างได้ที่หัวข้อรับการตั้งค่าการแจ้งเตือนพื้นที่ทำงานของผู้โทร

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.spacesettings
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.spacesettings

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

แสดงรายการอีโมจิที่กำหนดเองซึ่งผู้ใช้ที่ตรวจสอบสิทธิ์แล้วมองเห็นได้

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

  • การตรวจสอบสิทธิ์แอปด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (พื้นที่ทำงานโหมดการนำเข้าเท่านั้น)
    • การตรวจสอบสิทธิ์ผู้ใช้จะให้สิทธิ์ของผู้ดูแลระบบเมื่อบัญชีผู้ดูแลระบบตรวจสอบสิทธิ์ use_admin_access คือ true และใช้ขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
ListMessagePins

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse)

แสดงรายการข้อความที่ปักหมุดในพื้นที่ทำงาน ผู้ใช้สามารถปักหมุดข้อความสำคัญในพื้นที่ทำงานเพื่อให้เข้าถึงได้ง่าย โปรดดูข้อมูลเพิ่มเติมที่หัวข้อปักหมุดหรือเลิกปักหมุดการสนทนาใน Google Chat

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

แสดงข้อความในพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก ซึ่งรวมถึงข้อความจากสมาชิกและพื้นที่ทำงานที่ถูกบล็อก แต่จะไม่รวมข้อความของระบบ เช่น ข้อความที่ประกาศสมาชิกใหม่ในพื้นที่ทำงาน หากคุณแสดงข้อความจากพื้นที่ทำงานที่ไม่มีข้อความ การตอบกลับจะเป็นออบเจ็กต์ว่างเปล่า เมื่อใช้อินเทอร์เฟซ REST/HTTP การตอบกลับจะมีออบเจ็กต์ JSON ที่ว่างเปล่า {} ดูตัวอย่างได้ที่หัวข้อแสดงรายการข้อความ

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

  • การตรวจสอบสิทธิ์แอปด้วยการอนุมัติจากผู้ดูแลระบบที่มีขอบเขตการให้สิทธิ์ต่อไปนี้

    • https://www.googleapis.com/auth/chat.app.messages.readonly เมื่อใช้ขอบเขตการตรวจสอบสิทธิ์นี้ เมธอดนี้จะแสดงเฉพาะข้อความสาธารณะในพื้นที่ทำงาน แต่จะไม่รวมข้อความส่วนตัว

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (พื้นที่ทำงานโหมดการนำเข้าเท่านั้น)
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

แสดงรายการรีแอ็กชันต่อข้อความ ดูตัวอย่างได้ที่หัวข้อแสดงรายการรีแอ็กชันสำหรับข้อความ

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
ListSectionItems

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse)

แสดงรายการในส่วน

เฉพาะพื้นที่ทำงานเท่านั้นที่เป็นรายการในส่วนได้ โปรดดูรายละเอียดที่หัวข้อสร้างและจัดระเบียบส่วนต่างๆ ใน Google Chat

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
ListSections

rpc ListSections(ListSectionsRequest) returns (ListSectionsResponse)

แสดงรายการส่วนที่พร้อมใช้งานสำหรับผู้ใช้ Chat ส่วนต่างๆ จะช่วยให้ผู้ใช้จัดกลุ่มการสนทนาและปรับแต่งรายการพื้นที่ทำงานที่แสดงในแผงการนำทางของ Chat ได้ โปรดดูรายละเอียดที่หัวข้อสร้างและจัดระเบียบส่วนต่างๆ ใน Google Chat

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้ด้วยขอบเขตการให้สิทธิ์ที่เหมาะสมสำหรับการอ่านข้อมูลที่ขอ

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

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.spaces.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

หากต้องการแสดงรายการกิจกรรม ผู้โทรที่ตรวจสอบสิทธิ์แล้วต้องเป็นสมาชิกของพื้นที่ทำงาน

ดูตัวอย่างได้ที่หัวข้อแสดงรายการเหตุการณ์จากพื้นที่ทำงานใน Google Chat

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

หากต้องการแสดงรายการพื้นที่ทำงานที่มีชื่อทั้งหมดตามองค์กร Google Workspace ให้ใช้เมธอด spaces.search() โดยใช้สิทธิ์ของผู้ดูแลระบบ Workspace แทน

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
MarkAsActive

rpc MarkAsActive(MarkAsActiveRequest) returns (Availability)

ทำเครื่องหมายผู้ใช้เป็นACTIVEใน Google Chat

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

วิธีนี้จะอัปเดตเฉพาะความพร้อมของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วเท่านั้น

ต้องมีการตรวจสอบสิทธิ์ของผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.availability
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.availability

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
MarkAsAway

rpc MarkAsAway(MarkAsAwayRequest) returns (Availability)

ทำเครื่องหมายผู้ใช้เป็นAWAYใน Google Chat

ตั้งค่าสถานะของผู้ใช้เป็นไม่อยู่และไม่ได้รับผลกระทบจากกิจกรรมของผู้ใช้

วิธีนี้จะอัปเดตเฉพาะความพร้อมของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วเท่านั้น

ต้องมีการตรวจสอบสิทธิ์ของผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.availability
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.availability

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
MarkAsDoNotDisturb

rpc MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest) returns (Availability)

ทำเครื่องหมายผู้ใช้เป็นDO_NOT_DISTURBใน Google Chat

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

วิธีนี้จะอัปเดตเฉพาะความพร้อมของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วเท่านั้น

ต้องมีการตรวจสอบสิทธิ์ของผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.availability
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.availability

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
MoveSectionItem

rpc MoveSectionItem(MoveSectionItemRequest) returns (MoveSectionItemResponse)

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.sections
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.sections

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
PositionSection

rpc PositionSection(PositionSectionRequest) returns (PositionSectionResponse)

เปลี่ยนลำดับการจัดเรียงของส่วน โปรดดูรายละเอียดที่หัวข้อสร้างและจัดระเบียบส่วนต่างๆ ใน Google Chat

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.sections
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.sections

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
ReplaceMessageCards

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse)

แทนที่การ์ดที่รวมอยู่ในข้อความ

แอปใน Chat จะแทนที่การ์ดในข้อความที่มนุษย์สร้างขึ้นได้ก็ต่อเมื่อข้อความนั้นมีการ์ดอยู่แล้ว และการ์ดดังกล่าวสร้างขึ้นโดยแอป

หากแอปแทนที่การ์ดด้วยรายการว่างเปล่า ระบบจะนำการ์ดออก หลังจากนำการ์ดออกแล้ว แอปจะเพิ่มการ์ดกลับเข้าไปในข้อความไม่ได้

ต้องมีการตรวจสอบสิทธิ์แอปที่มีขอบเขตการให้สิทธิ์: - https://www.googleapis.com/auth/chat.bot

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

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

  • https://www.googleapis.com/auth/chat.bot

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
SearchMessages

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse)

ค้นหาข้อความใน Google Chat ที่ผู้ใช้ที่โทรมีสิทธิ์เข้าถึง แสดงรายการข้อความที่ตรงกับเกณฑ์การค้นหา

หากต้องการค้นหาในพื้นที่ทำงานทั้งหมดที่ผู้ใช้มีสิทธิ์เข้าถึง ให้ตั้งค่า parent เป็น spaces/- การใช้ค่าอื่นสำหรับ parent จะทำให้เกิดข้อผิดพลาด INVALID_ARGUMENT ข้อความที่แสดงผลจะมีช่อง name ที่ป้อนชื่อทรัพยากรแบบเต็ม ซึ่งรวมถึง space ที่เฉพาะเจาะจงซึ่งมีข้อความอยู่

API นี้ไม่แสดงข้อความทุกประเภท ข้อความประเภทที่แสดงด้านล่างจะไม่รวมอยู่ในการตอบกลับ ใช้ ListMessages เพื่อแสดงรายการข้อความทั้งหมด

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

แสดงรายการพื้นที่ทำงานในองค์กร Google Workspace ดูตัวอย่างได้ที่หัวข้อค้นหาและจัดการพื้นที่ทำงาน

เมื่อตั้งค่า use_admin_access เป็น false ผลลัพธ์จะจำกัดเฉพาะพื้นที่ทำงานที่ผู้ใช้ที่โทรเป็นสมาชิกที่เข้าร่วม หากต้องการค้นหาด้วยสิทธิ์ของผู้ดูแลระบบ ให้ตั้งค่า use_admin_access เป็น true

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

หากต้องการระบุสมาชิกที่เป็นบุคคลธรรมดาที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย membership.member.name ที่เหมาะสม หากต้องการเพิ่มผู้ใช้ที่เป็นมนุษย์ ให้ใช้ users/{user} โดยที่ {user} เป็นอีเมลของผู้ใช้ได้ สำหรับผู้ใช้ในองค์กร Workspace เดียวกัน {user} ยังสามารถเป็น id สำหรับบุคคลจาก People API หรือ id สำหรับผู้ใช้ใน Directory API ได้ด้วย ตัวอย่างเช่น หากรหัสโปรไฟล์บุคคลใน People API สำหรับ user@example.com คือ 123456789 คุณสามารถเพิ่มผู้ใช้ไปยังพื้นที่ทำงานได้โดยตั้งค่า membership.member.name เป็น users/user@example.com หรือ users/123456789

หากต้องการระบุ Google Groups ที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย membership.group_member.name ที่เหมาะสม หากต้องการเพิ่มหรือเชิญ Google Group ให้ใช้ groups/{group} โดยที่ {group} คือ id สำหรับกลุ่มจาก Cloud Identity Groups API เช่น คุณสามารถใช้ Cloud Identity Groups lookup API เพื่อดึงข้อมูลรหัส 123456789 สำหรับอีเมลกลุ่ม group@example.com จากนั้นคุณสามารถเพิ่มกลุ่มลงในพื้นที่ทำงานได้โดยตั้งค่า membership.group_member.name เป็น groups/123456789 ระบบไม่รองรับอีเมลของกลุ่ม และจะเพิ่ม Google Groups เป็นสมาชิกได้เฉพาะในพื้นที่ทำงานที่มีชื่อเท่านั้น

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

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

หากต้องการสร้าง DM ระหว่างผู้ใช้ที่โทรและแอปการโทร ให้ตั้งค่า Space.singleUserBotDm เป็น true และไม่ต้องระบุการเป็นสมาชิกใดๆ คุณใช้วิธีนี้ได้เฉพาะกับการตั้งค่า DM กับแอปการโทรเท่านั้น หากต้องการเพิ่มแอปการโทรเป็นสมาชิกของพื้นที่ทำงานหรือ DM ที่มีอยู่ระหว่างผู้ใช้ 2 คน โปรดดูหัวข้อเชิญหรือเพิ่มผู้ใช้หรือแอปไปยังพื้นที่ทำงาน

หากมี DM ระหว่างผู้ใช้ 2 คนอยู่แล้ว แม้ว่าผู้ใช้รายหนึ่งจะบล็อกอีกรายหนึ่งในขณะที่ส่งคำขอ ระบบจะแสดงผล DM ที่มีอยู่

ระบบไม่รองรับพื้นที่ทำงานที่มีการตอบกลับแบบแยกชุดข้อความ หากได้รับข้อความแสดงข้อผิดพลาด ALREADY_EXISTS เมื่อตั้งค่าพื้นที่ทำงาน ให้ลองใช้ displayName อื่น พื้นที่ทำงานที่มีอยู่ภายในองค์กร Google Workspace อาจใช้ชื่อที่แสดงนี้อยู่แล้ว

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
UpdateAvailability

rpc UpdateAvailability(UpdateAvailabilityRequest) returns (Availability)

อัปเดตข้อมูลความพร้อมของผู้ใช้ที่เป็นมนุษย์ คุณอัปเดตได้เฉพาะช่อง custom_status ผ่านวิธีนี้เท่านั้น

วิธีนี้จะอัปเดตเฉพาะความพร้อมของผู้ใช้ที่ตรวจสอบสิทธิ์แล้วเท่านั้น

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.availability
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.availability

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

อัปเดตการเป็นสมาชิก โปรดดูตัวอย่างที่หัวข้ออัปเดตการเป็นสมาชิกของผู้ใช้ในพื้นที่ทำงาน

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

  • การตรวจสอบสิทธิ์แอปด้วยการอนุมัติจากผู้ดูแลระบบและขอบเขตการให้สิทธิ์:

    • https://www.googleapis.com/auth/chat.app.memberships (เฉพาะในพื้นที่ทำงานที่แอปสร้างขึ้น)

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (พื้นที่ทำงานโหมดการนำเข้าเท่านั้น)
    • การตรวจสอบสิทธิ์ผู้ใช้จะให้สิทธิ์ของผู้ดูแลระบบเมื่อบัญชีผู้ดูแลระบบตรวจสอบสิทธิ์ use_admin_access คือ true และใช้ขอบเขตการให้สิทธิ์ต่อไปนี้
      • https://www.googleapis.com/auth/chat.admin.memberships
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

อัปเดตข้อความ วิธีการของ patch และ update มีความแตกต่างกัน เมธอด patch ใช้คำขอ patch ส่วนเมธอด update ใช้คำขอ put เราขอแนะนำให้ใช้วิธี patch ดูตัวอย่างได้ที่หัวข้ออัปเดตข้อความ

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

เมื่อใช้การตรวจสอบสิทธิ์แอป คำขอจะอัปเดตได้เฉพาะข้อความที่สร้างโดยแอป Chat ที่เรียกใช้เท่านั้น

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
UpdateSection

rpc UpdateSection(UpdateSectionRequest) returns (Section)

อัปเดตส่วน อัปเดตได้เฉพาะส่วนประเภท CUSTOM_SECTION เท่านั้น โปรดดูรายละเอียดที่หัวข้อสร้างและจัดระเบียบส่วนต่างๆ ใน Google Chat

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.sections
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.sections

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

อัปเดตพื้นที่ทำงาน ดูตัวอย่างได้ที่หัวข้ออัปเดตพื้นที่ทำงาน

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

รองรับการตรวจสอบสิทธิ์ประเภทต่อไปนี้

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

    • https://www.googleapis.com/auth/chat.app.spaces

  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (พื้นที่ทำงานโหมดการนำเข้าเท่านั้น)
    • การตรวจสอบสิทธิ์ผู้ใช้จะให้สิทธิ์ของผู้ดูแลระบบเมื่อบัญชีผู้ดูแลระบบตรวจสอบสิทธิ์ use_admin_access คือ true และใช้ขอบเขตการให้สิทธิ์ต่อไปนี้
      • https://www.googleapis.com/auth/chat.admin.spaces

การตรวจสอบสิทธิ์ของแอปมีข้อจำกัดดังต่อไปนี้

  • หากต้องการอัปเดต space.predefined_permission_settings หรือ space.permission_settings แอปต้องเป็นผู้สร้างพื้นที่ทำงาน
  • ไม่รองรับการอัปเดต space.access_settings.audience สำหรับการตรวจสอบสิทธิ์ของแอป
ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

อัปเดตการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน ดูตัวอย่างได้ที่หัวข้ออัปเดตการตั้งค่าการแจ้งเตือนพื้นที่ทำงานของผู้โทร

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.spacesettings
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.spacesettings

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

ต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.readstate
ขอบเขตการให้สิทธิ์

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

  • https://www.googleapis.com/auth/chat.users.readstate

ดูข้อมูลเพิ่มเติมได้ในคู่มือการให้สิทธิ์

AccessoryWidget

วิดเจ็ตแบบอินเทอร์แอกทีฟอย่างน้อย 1 รายการที่ปรากฏที่ด้านล่างของข้อความ โปรดดูรายละเอียดที่หัวข้อเพิ่มวิดเจ็ตแบบอินเทอร์แอกทีฟที่ด้านล่างของข้อความ

ช่อง
ฟิลด์ Union action ประเภทการดำเนินการ action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
button_list

ButtonList

รายการปุ่ม

ActionResponse

พารามิเตอร์ที่แอปใน Chat ใช้กำหนดค่าวิธีโพสต์คำตอบได้

ช่อง
type

ResponseType

อินพุตเท่านั้น ประเภทการตอบกลับของแอปใน Chat
url

string

อินพุตเท่านั้น URL สำหรับให้ผู้ใช้ตรวจสอบสิทธิ์หรือกำหนดค่า (สำหรับประเภทการตอบกลับ REQUEST_CONFIG เท่านั้น)
dialog_action

DialogAction

อินพุตเท่านั้น การตอบสนองต่อเหตุการณ์การโต้ตอบที่เกี่ยวข้องกับกล่องโต้ตอบ ต้องมี ResponseType.Dialog กำกับด้วย
updated_widget

UpdatedWidget

อินพุตเท่านั้น คำตอบของวิดเจ็ตที่อัปเดต

ResponseType

ประเภทการตอบกลับของแอปใน Chat

Enum
TYPE_UNSPECIFIED ประเภทเริ่มต้นที่จัดการเป็น NEW_MESSAGE
NEW_MESSAGE โพสต์เป็นข้อความใหม่ในหัวข้อ
UPDATE_MESSAGE อัปเดตข้อความของแอปใน Chat การดำเนินการนี้จะทำได้เฉพาะในเหตุการณ์ CARD_CLICKED ที่ประเภทผู้ส่งข้อความเป็น BOT เท่านั้น
UPDATE_USER_MESSAGE_CARDS อัปเดตการ์ดในข้อความของผู้ใช้ การดำเนินการนี้จะได้รับอนุญาตก็ต่อเมื่อเป็นการตอบสนองต่อเหตุการณ์ MESSAGE ที่มี URL ที่ตรงกัน หรือเหตุการณ์ CARD_CLICKED ที่ประเภทผู้ส่งข้อความเป็น HUMAN ระบบจะไม่สนใจข้อความ
REQUEST_CONFIG ขอให้ผู้ใช้ตรวจสอบสิทธิ์หรือกำหนดค่าเพิ่มเติมแบบส่วนตัว
DIALOG แสดงกล่องโต้ตอบ
UPDATE_WIDGET คำค้นหาตัวเลือกการเติมข้อความอัตโนมัติของวิดเจ็ต

SelectionItems

รายการผลการเติมข้อความอัตโนมัติของวิดเจ็ต

ช่อง
items[]

SelectionItem

อาร์เรย์ของออบเจ็กต์ SelectionItem

UpdatedWidget

สำหรับวิดเจ็ต selectionInput จะแสดงคำแนะนำที่เติมข้อความอัตโนมัติสำหรับเมนูแบบเลือกได้หลายรายการ

ช่อง
widget

string

รหัสของวิดเจ็ตที่อัปเดต รหัสต้องตรงกับรหัสของวิดเจ็ตที่ทริกเกอร์คำขออัปเดต
ฟิลด์ Union updated_widget วิดเจ็ตอัปเดตเพื่อตอบสนองต่อการดำเนินการของผู้ใช้ updated_widget ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
suggestions

SelectionItems

รายการผลการเติมข้อความอัตโนมัติของวิดเจ็ต

ActionStatus

แสดงสถานะของคำขอเพื่อเรียกใช้หรือส่งกล่องโต้ตอบ

ช่อง
status_code

Code

รหัสสถานะ
user_facing_message

string

ข้อความที่จะส่งถึงผู้ใช้เกี่ยวกับสถานะคำขอ หากไม่ได้ตั้งค่า ระบบจะส่งข้อความทั่วไปตาม status_code

หมายเหตุ

คำอธิบายประกอบสามารถเชื่อมโยงกับเนื้อหาข้อความธรรมดาของข้อความหรือชิปที่ลิงก์ไปยังแหล่งข้อมูล Google Workspace เช่น Google เอกสารหรือชีตที่มี start_index และ length เป็น 0 หากต้องการเพิ่มการจัดรูปแบบพื้นฐานให้กับ SMS โปรดดูหัวข้อจัดรูปแบบ SMS

ตัวอย่างเนื้อหาข้อความธรรมดา

Hello @FooBot how are you!"

ข้อมูลเมตาของคำอธิบายประกอบที่เกี่ยวข้อง

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
ช่อง
type

AnnotationType

ประเภทของคำอธิบายประกอบนี้
length

int32

ความยาวของสตริงย่อยในเนื้อหาข้อความธรรมดาที่คำอธิบายประกอบนี้สอดคล้องด้วย หากไม่มี จะแสดงความยาวเป็น 0
start_index

int32

ดัชนีเริ่มต้น (แบบ 0, รวม) ในเนื้อหาข้อความธรรมดาที่คำอธิบายประกอบนี้สอดคล้องด้วย
ฟิลด์ Union metadata ข้อมูลเมตาเพิ่มเติมเกี่ยวกับคำอธิบายประกอบ metadata ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
user_mention

UserMentionMetadata

ข้อมูลเมตาของการพูดถึงผู้ใช้
slash_command

SlashCommandMetadata

ข้อมูลเมตาสำหรับคำสั่งเครื่องหมายทับ
custom_emoji_metadata

CustomEmojiMetadata

ข้อมูลเมตาสำหรับอีโมจิที่กำหนดเอง

AnnotationType

ประเภทของคำอธิบายประกอบ

Enum
ANNOTATION_TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum ไม่ใช้
USER_MENTION มีการพูดถึงผู้ใช้
SLASH_COMMAND มีการเรียกใช้คำสั่งเครื่องหมายทับ
CUSTOM_EMOJI คำอธิบายประกอบอีโมจิที่กำหนดเอง

AppCommandMetadata

ข้อมูลเมตาเกี่ยวกับคำสั่งแอปใน Chat

ช่อง
app_command_id

int32

รหัสสำหรับคำสั่งที่ระบุไว้ในการกำหนดค่า Chat API
app_command_type

AppCommandType

ประเภทคำสั่งของแอปใน Chat

AppCommandType

ประเภทคำสั่งของแอปใน Chat โปรดดูรายละเอียดที่หัวข้อประเภทคำสั่งของแอปใน Chat

Enum
APP_COMMAND_TYPE_UNSPECIFIED ค่าเริ่มต้น ไม่ระบุ
SLASH_COMMAND คำสั่งเครื่องหมายทับ ผู้ใช้ส่งคำสั่งในข้อความแชท
QUICK_COMMAND คำสั่งด่วน ผู้ใช้เลือกคำสั่งจากเมนู Chat ในส่วนตอบกลับข้อความ
MESSAGE_ACTION การดำเนินการกับข้อความ ผู้ใช้เลือกคำสั่งจากเมนูตามบริบทของข้อความใน Chat

AttachedGif

รูปภาพ GIF ที่ระบุโดย URL

ช่อง
uri

string

เอาต์พุตเท่านั้น URL ที่โฮสต์รูปภาพ GIF

ไฟล์แนบ

ไฟล์แนบใน Google Chat

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของไฟล์แนบ

รูปแบบ: spaces/{space}/messages/{message}/attachments/{attachment}
content_name

string

เอาต์พุตเท่านั้น ชื่อไฟล์ต้นฉบับของเนื้อหา ไม่ใช่เส้นทางแบบเต็ม
content_type

string

เอาต์พุตเท่านั้น ประเภทเนื้อหา (ประเภท MIME) ของไฟล์
thumbnail_uri

string

เอาต์พุตเท่านั้น URL ภาพขนาดย่อที่ควรใช้เพื่อแสดงตัวอย่างไฟล์แนบต่อผู้ใช้ที่เป็นมนุษย์ แอปใน Chat ไม่ควรใช้ URL นี้เพื่อดาวน์โหลดเนื้อหาไฟล์แนบ
download_uri

string

เอาต์พุตเท่านั้น URL สำหรับดาวน์โหลดที่ควรใช้เพื่อให้ผู้ใช้ที่เป็นมนุษย์ดาวน์โหลดไฟล์แนบได้ แอปใน Chat ไม่ควรใช้ URL นี้เพื่อดาวน์โหลดเนื้อหาไฟล์แนบ
source

Source

เอาต์พุตเท่านั้น แหล่งที่มาของไฟล์แนบ
ฟิลด์ Union data_ref การอ้างอิงข้อมูลไปยังไฟล์แนบ data_ref ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
attachment_data_ref

AttachmentDataRef

ไม่บังคับ การอ้างอิงถึงข้อมูลไฟล์แนบ ช่องนี้ใช้เพื่อสร้างหรืออัปเดตข้อความที่มีไฟล์แนบ หรือใช้กับ Media API เพื่อดาวน์โหลดข้อมูลไฟล์แนบ
drive_data_ref

DriveDataRef

เอาต์พุตเท่านั้น การอ้างอิงถึงไฟล์แนบ Google ไดรฟ์ ช่องนี้ใช้กับ Google Drive API

แหล่งที่มา

แหล่งที่มาของไฟล์แนบ

Enum
SOURCE_UNSPECIFIED Reserved.
DRIVE_FILE ไฟล์ดังกล่าวเป็นไฟล์ใน Google ไดรฟ์
UPLOADED_CONTENT ระบบจะอัปโหลดไฟล์ไปยัง Chat

AttachmentDataRef

การอ้างอิงถึงข้อมูลไฟล์แนบ

ช่อง
resource_name

string

ไม่บังคับ ชื่อทรัพยากรของข้อมูลไฟล์แนบ ช่องนี้ใช้กับ Media API เพื่อดาวน์โหลดข้อมูลไฟล์แนบ
attachment_upload_token

string

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

กลุ่มเป้าหมาย

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

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

ช่อง
name

string

ชื่อทรัพยากรของกลุ่มเป้าหมายที่สามารถค้นพบหรือเข้าร่วมพื้นที่ทำงานได้ โปรดดูรายละเอียดที่หัวข้อทำให้กลุ่มเป้าหมายค้นพบพื้นที่ทำงานได้ รูปแบบ: audiences/{audience}

หากต้องการใช้กลุ่มเป้าหมายเริ่มต้นสำหรับองค์กร Google Workspace ให้ตั้งค่าเป็น audiences/default

ความพร้อมใช้งาน

แสดงข้อมูลสถานะปัจจุบันของผู้ใช้ใน Google Chat ซึ่งรวมถึงสถานะ (เช่น ใช้งานอยู่ ไม่อยู่ ห้ามรบกวน) และสถานะที่กำหนดเอง

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของเวลาว่างของผู้ใช้

รูปแบบ: users/{user}/availability

{user} คือรหัสของบุคคลใน People API หรือ Admin SDK Directory API เช่น users/123456789

นอกจากนี้ คุณยังใช้อีเมลของผู้ใช้หรือ me เป็นชื่อแทนเพื่ออ้างอิงถึงผู้โทรได้ด้วย เช่น users/user@example.com หรือ users/me
state

State

เอาต์พุตเท่านั้น สถานะความพร้อมใช้งานปัจจุบันของผู้ใช้
custom_status

CustomStatus

ไม่บังคับ สถานะที่กำหนดเองของผู้ใช้
ฟิลด์ Union state_metadata ข้อมูลเมตาเพิ่มเติมที่เชื่อมโยงกับสถานะความพร้อมของผู้ใช้ state_metadata ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
do_not_disturb_metadata

DoNotDisturbMetadata

เอาต์พุตเท่านั้น ข้อมูลเมตาหากสถานะผู้ใช้ตั้งค่าเป็น DO_NOT_DISTURB

รัฐ

แสดงสถานะความพร้อมใช้งานปัจจุบันของผู้ใช้

Enum
STATE_UNSPECIFIED ค่าเริ่มต้น ไม่ได้ระบุสถานะ
ACTIVE ผู้ใช้กำลังใช้งานอยู่ โดยอิงตามกิจกรรมล่าสุด
IDLE ผู้ใช้ไม่มีการใช้งานในขณะนี้ สถานะนี้บ่งบอกถึงช่วงเวลาที่ไม่มีการใช้งานหลังจากที่เคยอยู่ในสถานะ "ใช้งานอยู่" ก่อนที่จะเปลี่ยนเป็นสถานะ "ไม่อยู่"
AWAY ผู้ใช้ไม่อยู่ในขณะนี้ ซึ่งอาจตั้งค่าโดยอัตโนมัติหลังจากไม่มีการใช้งานเป็นระยะเวลาหนึ่งในสถานะใช้งานอยู่หรือไม่มีการใช้งาน หรือผู้ใช้อาจตั้งค่าด้วยตนเองก็ได้ เมื่อตั้งค่าด้วยตนเองผ่าน MarkAsAway สถานะนี้จะยังคงอยู่ไม่ว่าผู้ใช้จะทำกิจกรรมใดก็ตาม
DO_NOT_DISTURB ผู้ใช้อยู่ในสถานะห้ามรบกวน ซึ่งตั้งค่าด้วยตนเอง

CalendarEventLinkData

ข้อมูลสำหรับลิงก์กิจกรรมในปฏิทิน

ช่อง
calendar_id

string

ตัวระบุปฏิทินของปฏิทินที่ลิงก์
event_id

string

ตัวระบุกิจกรรมของกิจกรรมในปฏิทินที่ลิงก์

CardWithId

การ์ดในข้อความ Google Chat

แอปใน Chat สามารถสร้างการ์ดด้วยการตรวจสอบสิทธิ์ของแอป ในฐานะส่วนหนึ่งของเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ หากแอปใน Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ แอปจะสร้างข้อความการ์ดได้ หากแอปใน Chat ไม่ได้อยู่ในโปรแกรมเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ แอปจะสร้างการ์ดที่มีการตรวจสอบสิทธิ์ของผู้ใช้ไม่ได้

หากต้องการดูวิธีสร้างข้อความที่มีการ์ด โปรดดูหัวข้อส่งข้อความ

ออกแบบและดูตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด

เปิดเครื่องมือสร้างการ์ด

ช่อง
card_id

string

ต้องระบุหากข้อความมีการ์ดหลายรายการ ตัวระบุที่ไม่ซ้ำกันสำหรับการ์ดในข้อความ
card

Card

การ์ด ขนาดสูงสุดคือ 32 KB
owner_user

User

เอาต์พุตเท่านั้น แอปที่เป็นเจ้าของบัตร

ChatSpaceLinkData

ข้อมูลสำหรับลิงก์พื้นที่ใน Chat

ช่อง
space

string

พื้นที่ทำงานของทรัพยากรพื้นที่ใน Chat ที่ลิงก์

รูปแบบ: spaces/{space}
thread

string

ชุดข้อความของทรัพยากรพื้นที่ใน Chat ที่ลิงก์

รูปแบบ: spaces/{space}/threads/{thread}
message

string

ข้อความของทรัพยากรพื้นที่ใน Chat ที่ลิงก์

รูปแบบ: spaces/{space}/messages/{message}

การอ้างอิง

การอ้างอิงคือการอ้างอิงในบรรทัดที่ให้ข้อมูลโดยละเอียดเพิ่มเติมแก่ผู้ใช้เกี่ยวกับการอ้างอิงในบรรทัด การอ้างอิงในบรรทัดที่เกี่ยวข้องควรปรากฏในข้อความในรูปแบบมาร์กอัป <chat-citation data-id="{id}">{text}</chat-citation> ระบบจะรองรับการอ้างอิงเมื่อตั้งค่า markup_syntax ของข้อความเป็น MARKDOWN เท่านั้น

ระบบจะไม่สนใจการอ้างอิงที่ไม่มีการอ้างถึงใน Elements.citations (การอ้างอิงที่ไม่มีแท็ก <chat-citation> ที่ตรงกันในข้อความ) และจะไม่ทำให้ข้อความถูกปฏิเสธ

ช่อง
id

string

ต้องระบุ รหัสที่แอปกำหนด ต้องมีเฉพาะตัวอักษรและตัวเลข ASCII และมีความยาวน้อยกว่า 63 อักขระ
cited_sources[]

CitedSource

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

CitedSource

การอ้างอิงแหล่งข้อมูล

ช่อง
title

string

ต้องระบุ ชื่อข้อความธรรมดาของ CitedSource ช่องนี้ไม่รองรับการจัดรูปแบบ
uri

string

ต้องระบุ URI ที่ชี้ไปยังทรัพยากรที่อ้างอิงโดย CitedSource นี้
snippet

Snippet

ไม่บังคับ ตัวอย่างข้อมูลที่มีข้อมูลส่งตรงจากแหล่งที่มา
footer

Footer

ไม่บังคับ ข้อมูลเพิ่มเติมที่จะแสดงควบคู่ไปกับตัวอย่างข้อมูลในรูปแบบส่วนท้าย

ส่วนท้ายของแหล่งที่มา ซึ่งใช้สำหรับการระบุแหล่งที่มา

ช่อง
text

string

ไม่บังคับ ข้อความที่จะแสดงในส่วนท้าย

ตัวอย่างข้อมูล

ออบเจ็กต์ตัวอย่างข้อมูลที่แสดงข้อความที่ตัดตอนมาจากคลังข้อมูลขนาดใหญ่

ช่อง
text

string

ไม่บังคับ ข้อความที่ตัดตอนมาสั้นๆ แบบข้อความธรรมดาจากคลังข้อมูลที่อาจแสดงผลใน Chat ไม่รองรับรูปแบบมาร์กดาวน์
image_preview

ElementsImage

ไม่บังคับ ตัวอย่างรูปภาพของตัวอย่างข้อมูลที่ระบุเป็นอินพุตเมื่อสร้างการอ้างอิง

CompleteImportSpaceRequest

ข้อความคำขอสำหรับการดำเนินการนำเข้าพื้นที่ทำงานให้เสร็จสมบูรณ์

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานโหมดการนำเข้า

รูปแบบ: spaces/{space}

CompleteImportSpaceResponse

ข้อความตอบกลับสำหรับการดำเนินการนำเข้าพื้นที่ทำงานให้เสร็จสมบูรณ์

ช่อง
space

Space

พื้นที่ทำงานโหมดการนำเข้า

ContextualAddOnMarkup

ประเภทนี้ไม่มีช่อง

มาร์กอัปสำหรับนักพัฒนาซอฟต์แวร์เพื่อระบุเนื้อหาของส่วนเสริมตามบริบท

การ์ด

การ์ดคือองค์ประกอบ UI ที่มีวิดเจ็ต UI เช่น ข้อความและรูปภาพได้

ช่อง
header

CardHeader

ส่วนหัวของการ์ด โดยปกติแล้วส่วนหัวจะมีชื่อและรูปภาพ
sections[]

Section

โดยแต่ละส่วนจะคั่นด้วยเส้นแบ่ง
card_actions[]

CardAction

การดำเนินการของการ์ดนี้
name

string

ชื่อบัตร

CardAction

การดำเนินการกับการ์ดคือการดำเนินการที่เชื่อมโยงกับการ์ด สำหรับการ์ดใบแจ้งหนี้ การดำเนินการทั่วไปคือลบใบแจ้งหนี้ ส่งอีเมลใบแจ้งหนี้ หรือเปิดใบแจ้งหนี้ในเบราว์เซอร์

แอป Google Chat ไม่รองรับ

ช่อง
action_label

string

ป้ายกำกับที่ใช้แสดงในรายการเมนูการดำเนินการ
on_click

OnClick

การดำเนินการ onclick สำหรับรายการการทำงานนี้

CardHeader

ช่อง
title

string

ต้องระบุชื่อ ส่วนหัวมีความสูงคงที่ โดยหากระบุทั้งชื่อและคำบรรยาย แต่ละรายการจะใช้พื้นที่ 1 บรรทัด หากระบุเฉพาะชื่อ ชื่อจะใช้ทั้ง 2 บรรทัด
subtitle

string

คำบรรยายของส่วนหัวของการ์ด
image_style

ImageStyle

ประเภทของรูปภาพ (เช่น เส้นขอบสี่เหลี่ยมจัตุรัสหรือเส้นขอบวงกลม)
image_url

string

URL ของรูปภาพในส่วนหัวของการ์ด

ImageStyle

Enum
IMAGE_STYLE_UNSPECIFIED
IMAGE เส้นขอบสี่เหลี่ยมจัตุรัส
AVATAR เส้นขอบวงกลม

ส่วน

ส่วนประกอบด้วยคอลเล็กชันวิดเจ็ตที่แสดงผล (แนวตั้ง) ตามลำดับที่ระบุไว้ การ์ดมีความกว้างคงที่แคบในทุกแพลตฟอร์ม จึงไม่จำเป็นต้องใช้พร็อพเพอร์ตี้เลย์เอาต์ (เช่น float) ในขณะนี้

ช่อง
header

string

ส่วนหัวของส่วน รองรับข้อความที่จัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace
widgets[]

WidgetMarkup

ส่วนต้องมีวิดเจ็ตอย่างน้อย 1 รายการ

CreateCustomEmojiRequest

คำขอสร้างอีโมจิที่กำหนดเอง

ช่อง
custom_emoji

CustomEmoji

ต้องระบุ อีโมจิที่กำหนดเองที่จะสร้าง

CreateMembershipRequest

ข้อความคำขอสำหรับการสร้างการเป็นสมาชิก

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างการเป็นสมาชิก

รูปแบบ: spaces/{space}
membership

Membership

ต้องระบุ ความสัมพันธ์ของการเป็นสมาชิกที่จะสร้าง

ช่อง memberType ต้องมีผู้ใช้ที่มีข้อมูลในช่อง user.name และ user.type เซิร์ฟเวอร์จะกำหนดชื่อทรัพยากรและเขียนทับสิ่งที่ระบุไว้

เมื่อแอปใน Chat สร้างความสัมพันธ์ของการเป็นสมาชิกสำหรับผู้ใช้ที่เป็นมนุษย์ แอปจะต้องใช้ขอบเขตการให้สิทธิ์บางอย่างและตั้งค่าเฉพาะสำหรับบางฟิลด์ ดังนี้

  • เมื่อตรวจสอบสิทธิ์ในฐานะผู้ใช้ คุณต้องมีขอบเขตการให้สิทธิ์ chat.memberships

  • เมื่อตรวจสอบสิทธิ์ในฐานะแอป คุณต้องใช้ขอบเขตการให้สิทธิ์ chat.app.memberships

  • ตั้งค่า user.type เป็น HUMAN และตั้งค่า user.name ด้วยรูปแบบ users/{user} โดยที่ {user} เป็นอีเมลของผู้ใช้ได้ สำหรับผู้ใช้ในองค์กร Workspace เดียวกัน {user} ยังสามารถเป็น id ของบุคคลจาก People API หรือ id สำหรับผู้ใช้ใน Directory API ได้ด้วย ตัวอย่างเช่น หากรหัสโปรไฟล์บุคคลใน People API สำหรับ user@example.com คือ 123456789 คุณสามารถเพิ่มผู้ใช้ไปยังพื้นที่ทำงานได้โดยตั้งค่า membership.member.name เป็น users/user@example.com หรือ users/123456789

การเชิญผู้ใช้ภายนอกองค์กร Workspace ที่เป็นเจ้าของพื้นที่ทำงานต้องมีการตรวจสอบสิทธิ์ผู้ใช้

เมื่อแอปใน Chat สร้างความสัมพันธ์ของการเป็นสมาชิกสำหรับตัวเอง แอปจะต้องตรวจสอบสิทธิ์ในฐานะผู้ใช้และใช้ขอบเขต chat.memberships.app, ตั้งค่า user.type เป็น BOT และตั้งค่า user.name เป็น users/app
use_admin_access

bool

ไม่บังคับ เมื่อ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการการสนทนาในแชทและพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.memberships

การสร้างการเป็นสมาชิกแอปหรือการสร้างการเป็นสมาชิกสำหรับผู้ใช้ภายนอกองค์กร Google Workspace ของผู้ดูแลระบบไม่รองรับการใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ

CreateMessageNotificationOptions

ตัวเลือกสำหรับลักษณะการทำงานของการแจ้งเตือนเมื่อโพสต์ข้อความ

ช่อง
notification_type

NotificationType

ประเภทการแจ้งเตือนสำหรับข้อความ

NotificationType

ตัวเลือกประเภทการแจ้งเตือนสำหรับข้อความ

Enum
NOTIFICATION_TYPE_NONE ลักษณะการทำงานเริ่มต้น ลักษณะการทำงานของการแจ้งเตือนจะคล้ายกับเมื่อผู้ใช้ที่เป็นมนุษย์ส่งข้อความโดยใช้ UI ของ Chat กล่าวคือ ระบบจะไม่ส่งการแจ้งเตือนไปยังผู้ส่งที่เป็นมนุษย์
NOTIFICATION_TYPE_FORCE_NOTIFY

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

ต้องใช้การตรวจสอบสิทธิ์ของแอป
NOTIFICATION_TYPE_SILENT

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

ต้องใช้การตรวจสอบสิทธิ์ของแอป

CreateMessagePinRequest

ข้อความคำขอสำหรับการสร้างการปักหมุดข้อความ

ช่อง
parent

string

ต้องระบุ พื้นที่ทำงานหลักที่จะสร้างการปักหมุดข้อความ รูปแบบ: spaces/{space}
message_pin

MessagePin

ต้องระบุ MessagePin ที่จะสร้าง

CreateMessageRequest

สร้างข้อความ

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะสร้างข้อความ

รูปแบบ: spaces/{space}
message

Message

ต้องระบุ เนื้อหาข้อความ
thread_key
(deprecated)

string

ไม่บังคับ เลิกใช้งานแล้ว: โปรดใช้ thread.thread_key แทน รหัสสำหรับชุดข้อความ รองรับอักขระสูงสุด 4,000 ตัว หากต้องการเริ่มหรือเพิ่มข้อความในชุดข้อความ ให้สร้างข้อความและระบุ threadKey หรือ thread.name ดูตัวอย่างการใช้งานได้ที่หัวข้อเริ่มหรือตอบกลับชุดข้อความ
request_id

string

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

วิธีใช้ช่องนี้อย่างมีประสิทธิภาพ

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

MessageReplyOption

ไม่บังคับ ระบุว่าข้อความจะเริ่มชุดข้อความหรือตอบกลับชุดข้อความ รองรับเฉพาะในพื้นที่ทำงานที่มีชื่อเท่านั้น

เมื่อตอบสนองต่อการโต้ตอบของผู้ใช้ ระบบจะไม่สนใจช่องนี้ สำหรับการโต้ตอบภายในชุดข้อความ ระบบจะสร้างการตอบกลับในชุดข้อความเดียวกัน ไม่เช่นนั้น ระบบจะสร้างการตอบกลับเป็นชุดข้อความใหม่
message_id

string

ไม่บังคับ รหัสที่กำหนดเองสำหรับข้อความ ช่วยให้แอปใน Chat รับ อัปเดต หรือลบข้อความได้โดยไม่ต้องจัดเก็บรหัสที่ระบบกำหนดไว้ในชื่อทรัพยากรของข้อความ (แสดงในช่อง name ของข้อความ)

ค่าสำหรับช่องนี้ต้องเป็นไปตามข้อกำหนดต่อไปนี้

  • เริ่มต้นด้วย client- เช่น client-custom-name เป็นรหัสที่กำหนดเองที่ถูกต้อง แต่ custom-name ไม่ถูกต้อง
  • มีอักขระได้ไม่เกิน 63 ตัว และมีได้เฉพาะตัวอักษรพิมพ์เล็ก ตัวเลข และขีดกลางเท่านั้น
  • ไม่ซ้ำกันภายในพื้นที่ทำงาน แอปใน Chat ไม่สามารถใช้รหัสที่กำหนดเองเดียวกันสำหรับข้อความที่ต่างกันได้

โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ
create_message_notification_options

CreateMessageNotificationOptions

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

MessageReplyOption

ระบุวิธีตอบกลับข้อความ ทั้งนี้อาจมีการเพิ่มรัฐอื่นๆ ในอนาคต

Enum
MESSAGE_REPLY_OPTION_UNSPECIFIED ค่าเริ่มต้น เริ่มชุดข้อความใหม่ การใช้ตัวเลือกนี้จะละเว้น thread ID หรือ thread_key ที่รวมอยู่
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD สร้างข้อความเป็นคำตอบสำหรับชุดข้อความที่ระบุโดย thread ID หรือ thread_key หากดำเนินการไม่สำเร็จ ข้อความจะเริ่มชุดข้อความใหม่แทน
REPLY_MESSAGE_OR_FAIL สร้างข้อความเป็นคำตอบสำหรับชุดข้อความที่ระบุโดย thread ID หรือ thread_key หากใช้ thread_key ใหม่ ระบบจะสร้างชุดข้อความใหม่ หากสร้างข้อความไม่สำเร็จ ระบบจะแสดงข้อผิดพลาด NOT_FOUND แทน

CreateReactionRequest

สร้างความรู้สึกต่อข้อความ

ช่อง
parent

string

ต้องระบุ ข้อความที่มีการสร้างรีแอ็กชัน

รูปแบบ: spaces/{space}/messages/{message}
reaction

Reaction

ต้องระบุ รีแอ็กชันที่จะสร้าง

CreateSectionRequest

ข้อความคำขอสำหรับการสร้างส่วน

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรหลักที่สร้างส่วนนี้

รูปแบบ: users/{user}
section

Section

ต้องระบุ ส่วนที่จะสร้าง

CreateSpaceRequest

คำขอสร้างพื้นที่ทำงานที่มีชื่อซึ่งไม่มีสมาชิก

ช่อง
space

Space

ต้องระบุ ต้องป้อนข้อมูลในช่อง displayName และ spaceType รองรับเฉพาะ SpaceType.SPACE และ SpaceType.GROUP_CHAT เท่านั้น SpaceType.GROUP_CHAT จะใช้ได้ก็ต่อเมื่อตั้งค่า importMode เป็น "จริง" เท่านั้น

หากได้รับข้อความแสดงข้อผิดพลาด ALREADY_EXISTS ให้ลองใช้ displayName อื่น พื้นที่ทำงานที่มีอยู่ภายในองค์กร Google Workspace อาจใช้ชื่อที่แสดงนี้อยู่แล้ว

ระบบจะกำหนดพื้นที่ name บนเซิร์ฟเวอร์ ดังนั้นระบบจะไม่สนใจสิ่งที่ระบุในช่องนี้
request_id

string

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

วิธีใช้ช่องนี้อย่างมีประสิทธิภาพ

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

CustomEmoji

แสดงอีโมจิที่กำหนดเอง

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของอีโมจิที่กำหนดเองซึ่งเซิร์ฟเวอร์กำหนดให้

รูปแบบ: customEmojis/{customEmoji}
uid

string

เอาต์พุตเท่านั้น คีย์ที่ไม่ซ้ำกันสำหรับแหล่งข้อมูลอีโมจิที่กำหนดเอง
emoji_name

string

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

ต้องระบุเมื่อสร้างอีโมจิที่กำหนดเอง และเป็นเอาต์พุตเท่านั้นในกรณีอื่นๆ

ชื่ออีโมจิต้องขึ้นต้นและลงท้ายด้วยโคลอน ต้องเป็นตัวพิมพ์เล็ก และมีได้เฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกัน เครื่องหมายขีดกลาง และเครื่องหมายขีดล่างเท่านั้น ควรใช้ขีดกลางและขีดล่างเพื่อแยกคำ แต่จะใช้ต่อกันไม่ได้

ตัวอย่าง: :valid-emoji-name:
temporary_image_uri

string

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

CustomEmojiPayload

ไม่บังคับ อินพุตเท่านั้น ข้อมูลเพย์โหลด ต้องระบุเมื่อสร้างอีโมจิที่กำหนดเอง

CustomEmojiPayload

ข้อมูลเพย์โหลดสำหรับอีโมจิที่กำหนดเอง

ช่อง
file_content

bytes

ต้องระบุ อินพุตเท่านั้น รูปภาพที่ใช้สำหรับอีโมจิที่กำหนดเอง

เพย์โหลดต้องมีขนาดไม่เกิน 256 KB และขนาดของรูปภาพต้องเป็นสี่เหลี่ยมจัตุรัสและมีขนาดระหว่าง 64 ถึง 500 พิกเซล ทั้งนี้ ข้อจำกัดอาจมีการเปลี่ยนแปลง
filename

string

ต้องระบุ อินพุตเท่านั้น ชื่อไฟล์ภาพ

นามสกุลไฟล์ที่รองรับ ได้แก่ .png, .jpg, .gif

CustomEmojiMetadata

ข้อมูลเมตาของคำอธิบายประกอบสำหรับอีโมจิที่กำหนดเอง

ช่อง
custom_emoji

CustomEmoji

อีโมจิที่กำหนดเอง

CustomStatus

แสดงสถานะที่กำหนดเองของผู้ใช้ใน Google Chat ซึ่งรวมถึงข้อความสั้นๆ พร้อมอีโมจิ (ไม่บังคับ) ที่ผู้ใช้ตั้งค่าไว้เพื่อให้บริบทเพิ่มเติมเกี่ยวกับความพร้อมของตนเอง

ช่อง
text

string

ต้องระบุ ข้อความของสถานะที่กำหนดเอง ซึ่งจะเป็นสตริงที่มีความยาวสูงสุด 64 ตัวอักษร
emoji

Emoji

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

Timestamp

การประทับเวลาเมื่อสถานะที่กำหนดเองหมดอายุ
ttl

Duration

อินพุตเท่านั้น ระยะเวลาที่สถานะที่กำหนดเองจะหมดอายุ

DeleteCustomEmojiRequest

คำขอให้ลบอีโมจิที่กำหนดเอง

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของอีโมจิที่กำหนดเองที่จะลบ

รูปแบบ: customEmojis/{customEmoji}

คุณสามารถใช้ชื่ออีโมจิเป็นชื่อแทนสำหรับ {customEmoji} ได้ เช่น customEmojis/:example-emoji: โดยที่ :example-emoji: คือชื่ออีโมจิสำหรับอีโมจิที่กำหนดเอง

DeleteMembershipRequest

ส่งคำขอเพื่อลบการเป็นสมาชิกในพื้นที่ทำงาน

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของการเป็นสมาชิกที่จะลบ แอปใน Chat สามารถลบการเป็นสมาชิกของผู้ใช้ที่เป็นมนุษย์หรือของตนเองได้ แอปใน Chat จะลบการเป็นสมาชิกของแอปอื่นๆ ไม่ได้

เมื่อลบการเป็นสมาชิกของบุคคลธรรมดา ต้องใช้ขอบเขต chat.memberships ที่มีการตรวจสอบสิทธิ์ผู้ใช้ หรือขอบเขต chat.memberships.app ที่มีการตรวจสอบสิทธิ์แอป และรูปแบบ spaces/{space}/members/{member} คุณใช้อีเมลเป็นอีเมลแทนสำหรับ {member} ได้ เช่น spaces/{space}/members/example@gmail.com โดยที่ example@gmail.com คืออีเมลของผู้ใช้ Google Chat

เมื่อลบการเป็นสมาชิกของแอป ต้องใช้ขอบเขต chat.memberships.app และรูปแบบ spaces/{space}/members/app

รูปแบบ: spaces/{space}/members/{member} หรือ spaces/{space}/members/app
use_admin_access

bool

ไม่บังคับ เมื่อ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการการสนทนาในแชทและพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.memberships

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

DeleteMessagePinRequest

ข้อความคำขอสำหรับการลบข้อความที่ปักหมุดไว้

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของข้อความที่ปักหมุดไว้ซึ่งต้องการนำออก รูปแบบ: spaces/{space}/messagePins/{message_pin}

DeleteMessageRequest

คำขอลบข้อความ

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของข้อความ

รูปแบบ: spaces/{space}/messages/{message}

หากคุณตั้งค่ารหัสที่กำหนดเองสำหรับข้อความ คุณสามารถใช้ค่าจากช่อง clientAssignedMessageId สำหรับ {message} ได้ โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ
force

bool

ไม่บังคับ เมื่อtrue การลบข้อความจะเป็นการลบการตอบกลับแบบแยกชุดข้อความด้วย เมื่อfalse หากข้อความมีการตอบกลับแบบแยกชุดข้อความ การลบจะไม่สำเร็จ

มีผลเฉพาะเมื่อตรวจสอบสิทธิ์ในฐานะผู้ใช้ ไม่มีผลเมื่อตรวจสอบสิทธิ์ในฐานะแอปใน Chat

DeleteReactionRequest

ลบความรู้สึกต่อข้อความ

ช่อง
name

string

ต้องระบุ ชื่อของรีแอ็กชันที่จะลบ

รูปแบบ: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSectionRequest

ข้อความคำขอสำหรับการลบส่วน

ช่อง
name

string

ต้องระบุ ชื่อของส่วนที่จะลบ

รูปแบบ: users/{user}/sections/{section}

DeleteSpaceRequest

คำขอลบพื้นที่ทำงาน

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะลบ

รูปแบบ: spaces/{space}
use_admin_access

bool

ไม่บังคับ เมื่อ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการการสนทนาในแชทและพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.delete

DeletionMetadata

ข้อมูลเกี่ยวกับข้อความที่ถูกลบ ระบบจะลบข้อความเมื่อตั้งค่า delete_time

ช่อง
deletion_type

DeletionType

ระบุผู้ที่ลบข้อความ

DeletionType

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

Enum
DELETION_TYPE_UNSPECIFIED ค่านี้ไม่ได้ใช้
CREATOR ผู้ใช้ลบข้อความของตนเอง
SPACE_OWNER เจ้าของหรือผู้จัดการลบข้อความ
ADMIN ผู้ดูแลระบบ Google Workspace ลบข้อความ ผู้ดูแลระบบสามารถลบข้อความใดก็ได้ในพื้นที่ทำงาน รวมถึงข้อความที่ส่งโดยสมาชิกในพื้นที่ทำงานหรือแอปใน Chat
APP_MESSAGE_EXPIRY แอปใน Chat ลบข้อความของตนเองเมื่อหมดอายุ
CREATOR_VIA_APP แอปใน Chat ลบข้อความในนามของผู้สร้าง (โดยใช้การตรวจสอบสิทธิ์ผู้ใช้)
SPACE_OWNER_VIA_APP แอปใน Chat ลบข้อความในนามของผู้จัดการพื้นที่ทำงาน (โดยใช้การตรวจสอบสิทธิ์ผู้ใช้)
SPACE_MEMBER สมาชิกของพื้นที่ทำงานลบข้อความ ผู้ใช้สามารถลบข้อความที่แอปส่งได้

Dialog

Wrapper รอบเนื้อหาการ์ดของกล่องโต้ตอบ

ช่อง
body

Card

อินพุตเท่านั้น เนื้อหาของกล่องโต้ตอบ ซึ่งแสดงผลในโมดัล แอป Google Chat ไม่รองรับเอนทิตีการ์ดต่อไปนี้ DateTimePicker, OnChangeAction

DialogAction

มีกล่องโต้ตอบและรหัสสถานะคำขอ

ช่อง
action_status

ActionStatus

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

Dialog

อินพุตเท่านั้น กล่องโต้ตอบสำหรับคำขอ

DoNotDisturbMetadata

ข้อมูลเมตาที่เชื่อมโยงกับสถานะความพร้อมใช้งาน DO_NOT_DISTURB ซึ่งระบุเวลาที่สถานะจะหมดอายุ

ช่อง
expiration_time

Timestamp

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

DriveDataRef

การอ้างอิงถึงข้อมูลของไฟล์แนบในไดรฟ์

ช่อง
drive_file_id

string

รหัสของไฟล์ในไดรฟ์ ใช้กับ Drive API

DriveLinkData

ข้อมูลสำหรับลิงก์ Google ไดรฟ์

ช่อง
drive_data_ref

DriveDataRef

DriveDataRef ซึ่งอ้างอิงไฟล์ Google ไดรฟ์
mime_type

string

ประเภท MIME ของทรัพยากร Google ไดรฟ์ที่ลิงก์

องค์ประกอบ

องค์ประกอบคือคอมโพเนนต์เพิ่มเติมที่อาจเชื่อมโยงหรือไม่เชื่อมโยงกับข้อความที่ระบุระหว่างการสร้างข้อความ

ช่อง
cited_sources[]

CitedSource

รายการแหล่งข้อมูลที่จะแสดงใต้ข้อความเป็นลิงก์ส่วนท้าย โดยจะไม่มีการอ้างอิงในบรรทัด สำหรับการอ้างอิงในบรรทัด ให้ใช้ citations
citations[]

Citation

รายการการอ้างอิงในบรรทัดที่อ้างอิงภายในข้อความ (ผ่านแท็ก <chat-citation>) ซึ่งแสดงผลเป็นการ์ดข้อมูลย่อแบบอินเทอร์แอกทีฟ

ElementsImage

ออบเจ็กต์ที่รวมวิธีต่างๆ ในการแสดงรูปภาพ การนำเสนอที่รองรับในปัจจุบัน: - รูปภาพที่ดึงมาจาก URI เราอาจรองรับการนำเสนอเพิ่มเติมในอนาคต

ช่อง
ฟิลด์ Union image ต้องระบุ การแสดงรูปภาพที่รองรับรายการใดรายการหนึ่ง image ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
image_uri

string

ต้องระบุ URI ที่เข้าถึงได้แบบสาธารณะสำหรับรูปภาพ

อีโมจิ

อีโมจิที่ใช้เป็นรีแอ็กชันต่อข้อความ

ช่อง
ฟิลด์ Union content ต้องระบุ เนื้อหาของอีโมจิ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
unicode

string

ไม่บังคับ อีโมจิพื้นฐานที่แสดงด้วยสตริง Unicode
custom_emoji

CustomEmoji

อีโมจิที่กำหนดเอง

EmojiReactionSummary

จำนวนผู้ที่แสดงความรู้สึกต่อข้อความด้วยอีโมจิที่เฉพาะเจาะจง

ช่อง
emoji

Emoji

เอาต์พุตเท่านั้น อีโมจิที่เชื่อมโยงกับรีแอ็กชัน
reaction_count

int32

เอาต์พุตเท่านั้น จำนวนรีแอ็กชันทั้งหมดที่ใช้อีโมจิที่เกี่ยวข้อง

FindDirectMessageRequest

คำขอรับพื้นที่ทำงานของข้อความส่วนตัวตามทรัพยากรของผู้ใช้

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของผู้ใช้ที่ต้องการค้นหาข้อความส่วนตัว

รูปแบบ: users/{user} โดยที่ {user} คือ id สำหรับบุคคลจาก People API หรือ id สำหรับผู้ใช้ใน Directory API ตัวอย่างเช่น หากรหัสโปรไฟล์ People API คือ 123456789 คุณจะค้นหาข้อความส่วนตัวกับบุคคลนั้นได้โดยใช้ users/123456789 เป็น name เมื่อตรวจสอบสิทธิ์ในฐานะผู้ใช้แล้ว คุณจะใช้อีเมลเป็นชื่อแทนสำหรับ {user} ได้ เช่น users/example@gmail.com โดยที่ example@gmail.com คืออีเมลของผู้ใช้ Google Chat

FindGroupChatsRequest

คำขอรับพื้นที่แชทเป็นกลุ่มตามทรัพยากรของผู้ใช้

ช่อง
users[]

string

ไม่บังคับ ชื่อทรัพยากรของผู้ใช้ที่เป็นมนุษย์ทั้งหมดในแชทเป็นกลุ่มกับผู้ใช้ที่โทร ไม่สามารถรวมแอปใน Chat ไว้ในคำขอได้

จำนวนผู้ใช้สูงสุดที่ระบุได้ในคำขอเดียวคือ 49 ราย

รูปแบบ: users/{user} โดยที่ {user} คือ id สำหรับบุคคลจาก People API หรือ id สำหรับผู้ใช้ใน Directory API ตัวอย่างเช่น หากต้องการค้นหาแชทเป็นกลุ่มทั้งหมดที่มีผู้ใช้ที่โทรและผู้ใช้อีก 2 คนซึ่งมีรหัสโปรไฟล์ People API เป็น 123456789 และ 987654321 คุณสามารถใช้ users/123456789 และ users/987654321 ได้ นอกจากนี้ คุณยังใช้อีเมลเป็นอีเมลแทนสำหรับ {user} ได้ด้วย เช่น users/example@gmail.com โดยที่ example@gmail.com คืออีเมลของผู้ใช้ Google Chat
page_size

int32

ไม่บังคับ จำนวนพื้นที่ทำงานสูงสุดที่จะแสดงผล บริการอาจแสดงผลลัพธ์น้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลพื้นที่ทำงานไม่เกิน 10 รายการ

ค่าสูงสุดคือ 30 หากคุณใช้ค่ามากกว่า 30 ระบบจะเปลี่ยนค่าเป็น 30 โดยอัตโนมัติ

ค่าลบจะแสดงข้อผิดพลาด INVALID_ARGUMENT
page_token

string

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

เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ระบุโทเค็น การส่งค่าที่แตกต่างกันอาจทําให้เกิดผลลัพธ์ที่ไม่คาดคิด
space_view

SpaceView

ประเภทมุมมองพื้นที่ทำงานที่ขอ หากไม่ได้ตั้งค่าไว้ ระบบจะใช้ค่าเริ่มต้นเป็น SPACE_VIEW_RESOURCE_NAME_ONLY คำขอที่ระบุ SPACE_VIEW_EXPANDED ต้องมีขอบเขตที่อนุญาตให้อ่านข้อมูลพื้นที่ทำงาน เช่น https://www.googleapis.com/auth/chat.spaces หรือ https://www.googleapis.com/auth/chat.spaces.readonly

FindGroupChatsResponse

การตอบกลับที่มีพื้นที่ทำงานของแชทเป็นกลุ่มซึ่งมีผู้ใช้ที่โทรและผู้ใช้ที่ขออย่างถูกต้อง

ช่อง
spaces[]

Space

รายการพื้นที่ทำงานในหน้าที่ขอ (หรือหน้าแรก)
next_page_token

string

โทเค็นที่คุณส่งเป็น pageToken เพื่อดึงข้อมูลผลการค้นหาหน้าถัดไปได้ หากว่างเปล่า แสดงว่าไม่มีหน้าถัดไป

ForwardedMetadata

ข้อมูลเมตาเกี่ยวกับพื้นที่ทำงานต้นทางที่มีการส่งต่อข้อความ

ช่อง
space

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของพื้นที่ทำงานต้นทาง รูปแบบ: spaces/{space}
space_display_name

string

เอาต์พุตเท่านั้น ชื่อที่แสดงของพื้นที่ทำงานหรือ DM ต้นทาง ณ เวลาที่ส่งต่อ สำหรับ SPACE นี่คือชื่อพื้นที่ทำงาน สำหรับ DIRECT_MESSAGE นี่คือชื่อของผู้เข้าร่วมคนอื่น (เช่น "ผู้ใช้ ก") สำหรับ GROUP_CHAT นี่คือชื่อที่สร้างขึ้นโดยอิงตามชื่อจริงของสมาชิก โดยจำกัดไว้ที่ 5 ชื่อรวมถึงครีเอเตอร์ (เช่น "ผู้ใช้ ก, ผู้ใช้ ข")

GetAttachmentRequest

ส่งคำขอเพื่อรับไฟล์แนบ

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของไฟล์แนบในรูปแบบ spaces/{space}/messages/{message}/attachments/{attachment}

GetAvailabilityRequest

ข้อความคำขอสำหรับเมธอด GetAvailability

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของความพร้อมใช้งานที่จะดึงข้อมูล

รูปแบบ: users/{user}/availability

{user} คือรหัสของบุคคลใน People API หรือ Admin SDK Directory API เช่น users/123456789

นอกจากนี้ คุณยังใช้อีเมลของผู้ใช้หรือ me เป็นชื่อแทนเพื่ออ้างอิงถึงผู้โทรได้ด้วย เช่น users/user@example.com หรือ users/me

GetCustomEmojiRequest

คำขอให้แสดงผลอีโมจิที่กำหนดเองรายการเดียว

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของอีโมจิที่กำหนดเอง

รูปแบบ: customEmojis/{customEmoji}

คุณสามารถใช้ชื่ออีโมจิเป็นชื่อแทนสำหรับ {customEmoji} ได้ เช่น customEmojis/:example-emoji: โดยที่ :example-emoji: คือชื่ออีโมจิสำหรับอีโมจิที่กำหนดเอง

GetMembershipRequest

ส่งคำขอเพื่อเป็นสมาชิกของพื้นที่ทำงาน

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของการเป็นสมาชิกที่จะดึงข้อมูล

หากต้องการรับการเป็นสมาชิกของแอปเองโดยใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณสามารถเลือกใช้ spaces/{space}/members/app ได้

รูปแบบ: spaces/{space}/members/{member} หรือ spaces/{space}/members/app

คุณสามารถใช้อีเมลของผู้ใช้เป็นชื่อแทนสำหรับ {member} ได้ เช่น spaces/{space}/members/example@gmail.com โดยที่ example@gmail.com คืออีเมลของผู้ใช้ Google Chat
use_admin_access

bool

ไม่บังคับ เมื่อ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการการสนทนาในแชทและพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.memberships หรือ chat.admin.memberships.readonly

ระบบไม่รองรับการรับการเป็นสมาชิกแอปในพื้นที่ทำงานเมื่อใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ

GetMessageRequest

ส่งคำขอเพื่อรับข้อความ

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของข้อความ

รูปแบบ: spaces/{space}/messages/{message}

หากคุณตั้งค่ารหัสที่กำหนดเองสำหรับข้อความ คุณสามารถใช้ค่าจากช่อง clientAssignedMessageId สำหรับ {message} ได้ โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ
markup_syntax

MarkupSyntax

ไม่บังคับ ระบุไวยากรณ์เอาต์พุตที่ต้องการสำหรับช่อง formatted_text ของข้อความแชท

GetSpaceEventRequest

ข้อความคำขอสำหรับการรับเหตุการณ์ในพื้นที่ทำงาน

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของเหตุการณ์ในพื้นที่ทำงาน

รูปแบบ: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceNotificationSettingRequest

ข้อความคำขอเพื่อรับการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน รองรับเฉพาะการรับการตั้งค่าการแจ้งเตือนสำหรับผู้ใช้ที่โทรเท่านั้น

ช่อง
name

string

ต้องระบุ รูปแบบ: users/{user}/spaces/{space}/spaceNotificationSetting

  • users/me/spaces/{space}/spaceNotificationSetting หรือ
  • users/user@example.com/spaces/{space}/spaceNotificationSetting หรือ
  • users/123456789/spaces/{space}/spaceNotificationSetting หมายเหตุ: อนุญาตให้ใช้เฉพาะรหัสผู้ใช้หรืออีเมลของผู้โทรในเส้นทางเท่านั้น

GetSpaceReadStateRequest

ข้อความคำขอสำหรับ GetSpaceReadState API

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของสถานะการอ่านพื้นที่ทำงานที่จะดึงข้อมูล

รองรับเฉพาะการรับสถานะการอ่านสำหรับผู้ใช้ที่โทรเท่านั้น

หากต้องการอ้างอิงถึงผู้ใช้ที่โทร ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้

  • ชื่อแทน me เช่น users/me/spaces/{space}/spaceReadState

  • อีเมล Workspace ของบุคคลดังกล่าว เช่น users/user@example.com/spaces/{space}/spaceReadState

  • รหัสผู้ใช้ เช่น users/123456789/spaces/{space}/spaceReadState

รูปแบบ: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

คำขอให้แสดงผลพื้นที่ทำงานเดียว

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานในรูปแบบ spaces/{space}

รูปแบบ: spaces/{space}
use_admin_access

bool

ไม่บังคับ เมื่อ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการการสนทนาในแชทและพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.spaces หรือ chat.admin.spaces.readonly

GetThreadReadStateRequest

ข้อความคำขอสำหรับ GetThreadReadStateRequest API

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของสถานะการอ่านชุดข้อความที่จะดึงข้อมูล

รองรับเฉพาะการรับสถานะการอ่านสำหรับผู้ใช้ที่โทรเท่านั้น

หากต้องการอ้างอิงถึงผู้ใช้ที่โทร ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้

  • ชื่อแทน me เช่น users/me/spaces/{space}/threads/{thread}/threadReadState

  • อีเมล Workspace ของบุคคลดังกล่าว เช่น users/user@example.com/spaces/{space}/threads/{thread}/threadReadState

  • รหัสผู้ใช้ เช่น users/123456789/spaces/{space}/threads/{thread}/threadReadState

รูปแบบ: users/{user}/spaces/{space}/threads/{thread}/threadReadState

กลุ่ม

Google Group ใน Google Chat

ช่อง
name

string

ชื่อทรัพยากรสำหรับ Google Group

แสดงกลุ่มใน Cloud Identity Groups API

รูปแบบ: groups/{group}

HistoryState

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

Enum
HISTORY_STATE_UNSPECIFIED ค่าเริ่มต้น โปรดอย่าใช้
HISTORY_OFF ประวัติปิดอยู่ ระบบจะเก็บข้อความและชุดข้อความไว้เป็นเวลา 24 ชั่วโมง
HISTORY_ON ประวัติเปิดอยู่ กฎการเก็บรักษาของห้องนิรภัยขององค์กรจะระบุระยะเวลาที่จะเก็บข้อความและชุดข้อความไว้

ListCustomEmojisRequest

คำขอให้แสดงรายการอีโมจิที่กำหนดเอง

ช่อง
page_size

int32

ไม่บังคับ จำนวนอีโมจิที่กำหนดเองสูงสุดที่แสดงผล บริการสามารถแสดงอีโมจิที่กำหนดเองน้อยกว่าค่านี้ได้ หากไม่ได้ระบุ ค่าเริ่มต้นจะเป็น 25 ค่าสูงสุดคือ 200 โดยค่าที่มากกว่า 200 จะเปลี่ยนเป็น 200
page_token

string

ไม่บังคับ (หากกลับมาดำเนินการต่อจากการค้นหาก่อนหน้า)

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

เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด
filter

string

ไม่บังคับ ตัวกรองการค้นหา

รองรับการกรองตามผู้สร้าง

หากต้องการกรองตามผู้สร้าง คุณต้องระบุค่าที่ถูกต้อง ปัจจุบันระบบยอมรับเฉพาะ creator("users/me") และ NOT creator("users/me") เพื่อกรองอีโมจิที่กำหนดเองตามว่าผู้ใช้ที่โทรเป็นผู้สร้างหรือไม่

ตัวอย่างเช่น คำค้นหาต่อไปนี้จะแสดงผลอีโมจิที่กำหนดเองซึ่งสร้างโดยผู้โทร

creator("users/me")

ระบบจะปฏิเสธการค้นหาที่ไม่ถูกต้องพร้อมข้อผิดพลาด INVALID_ARGUMENT

ListCustomEmojisResponse

การตอบกลับเพื่อแสดงรายการอีโมจิที่กำหนดเอง

ช่อง
custom_emojis[]

CustomEmoji

รายการที่ไม่เรียงลำดับ รายการอีโมจิที่กำหนดเอง
next_page_token

string

โทเค็นที่คุณส่งเป็น pageToken เพื่อดึงข้อมูลผลการค้นหาหน้าถัดไปได้ หากว่างเปล่า แสดงว่าไม่มีหน้าถัดไป

ListMembershipsRequest

ข้อความคำขอสำหรับการเป็นสมาชิกที่แสดงอยู่

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะดึงข้อมูลรายชื่อสมาชิก

รูปแบบ: spaces/{space}
page_size

int32

ไม่บังคับ จำนวนการเป็นสมาชิกสูงสุดที่จะแสดงผล บริการอาจแสดงผลลัพธ์น้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลการเป็นสมาชิกสูงสุด 100 รายการ

ค่าสูงสุดคือ 1,000 หากคุณใช้ค่าที่มากกว่า 1,000 ระบบจะเปลี่ยนค่าเป็น 1,000 โดยอัตโนมัติ

ค่าลบจะแสดงข้อผิดพลาด INVALID_ARGUMENT
page_token

string

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

เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ระบุโทเค็นหน้าเว็บ การส่งค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทําให้เกิดผลลัพธ์ที่ไม่คาดคิด
filter

string

ไม่บังคับ ตัวกรองการค้นหา

คุณสามารถกรองการเป็นสมาชิกตามบทบาท (role) และประเภท (member.type) ของสมาชิกได้

หากต้องการกรองตามบทบาท ให้ตั้งค่า role เป็น ROLE_MEMBER หรือ ROLE_MANAGER

หากต้องการกรองตามประเภท ให้ตั้งค่า member.type เป็น HUMAN หรือ BOT นอกจากนี้ คุณยังกรอง member.type โดยใช้โอเปอเรเตอร์ != ได้ด้วย

หากต้องการกรองตามทั้งบทบาทและประเภท ให้ใช้โอเปอเรเตอร์ AND หากต้องการกรองตามบทบาทหรือประเภท ให้ใช้โอเปอเรเตอร์ OR

ต้องระบุ member.type = "HUMAN" หรือ member.type != "BOT" เมื่อตั้งค่า use_admin_access เป็น "จริง" ระบบจะปฏิเสธตัวกรองประเภทการเป็นสมาชิกอื่นๆ

ตัวอย่างเช่น คำค้นหาต่อไปนี้ถูกต้อง

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

การค้นหาต่อไปนี้ไม่ถูกต้อง

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

เซิร์ฟเวอร์จะปฏิเสธคำค้นหาที่ไม่ถูกต้องพร้อมข้อผิดพลาด INVALID_ARGUMENT
show_groups

bool

ไม่บังคับ เมื่อ true จะแสดงการเป็นสมาชิกที่เชื่อมโยงกับ Google Group ด้วย นอกเหนือจากการเป็นสมาชิกประเภทอื่นๆ หากตั้งค่า filter ไว้ ระบบจะไม่แสดงการเป็นสมาชิก Google Group ที่ไม่ตรงกับเกณฑ์ตัวกรอง
show_invited

bool

ไม่บังคับ เมื่อ true จะแสดงการเป็นสมาชิกที่เชื่อมโยงกับสมาชิก invited ด้วย นอกเหนือจากการเป็นสมาชิกประเภทอื่นๆ หากตั้งค่าตัวกรองไว้ ระบบจะไม่แสดงการเป็นสมาชิก invited ที่ไม่ตรงกับเกณฑ์ตัวกรอง

ปัจจุบันต้องมีการตรวจสอบสิทธิ์ผู้ใช้
use_admin_access

bool

ไม่บังคับ เมื่อ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการการสนทนาในแชทและพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.memberships.readonly หรือ chat.admin.memberships

ระบบไม่รองรับการแสดงรายชื่อการเป็นสมาชิกของแอปในพื้นที่ทำงานเมื่อใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ

ListMembershipsResponse

การตอบกลับเพื่อแสดงรายชื่อสมาชิกของพื้นที่ทำงาน

ช่อง
memberships[]

Membership

รายการที่ไม่เรียงลำดับ รายการการเป็นสมาชิกในหน้าที่ขอ (หรือหน้าแรก)
next_page_token

string

โทเค็นที่คุณส่งเป็น pageToken เพื่อดึงข้อมูลผลการค้นหาหน้าถัดไปได้ หากว่างเปล่า แสดงว่าไม่มีหน้าถัดไป

ListMessagePinsRequest

ข้อความคำขอสำหรับการแสดงรายการปักหมุดข้อความ

ช่อง
parent

string

ต้องระบุ พื้นที่ทำงานหลักที่เป็นเจ้าของคอลเล็กชันรายการที่ปักหมุดไว้ รูปแบบ: spaces/{space}
page_size

int32

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

string

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

เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ระบุโทเค็นหน้าเว็บ การส่งค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทําให้เกิดผลลัพธ์ที่ไม่คาดคิด

ListMessagePinsResponse

ข้อความตอบกลับสำหรับหมุดข้อความที่แสดงอยู่

ช่อง
message_pins[]

MessagePin

ข้อความที่ปักหมุดจากพื้นที่ทำงานที่ระบุ
next_page_token

string

คุณสามารถส่งโทเค็นเป็น pageToken เพื่อดึงข้อมูลผลลัพธ์หน้าถัดไปได้ หากว่างเปล่า แสดงว่าไม่มีหน้าถัดไป

ListMessagesRequest

แสดงข้อความในพื้นที่ทำงานที่ระบุซึ่งผู้ใช้เป็นสมาชิก

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะแสดงข้อความ

รูปแบบ: spaces/{space}
page_size

int32

ไม่บังคับ จำนวนข้อความสูงสุดที่แสดงผล บริการอาจแสดงข้อความน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลไม่เกิน 25 รายการ

ค่าสูงสุดคือ 1,000 หากคุณใช้ค่าที่มากกว่า 1,000 ระบบจะเปลี่ยนค่าเป็น 1,000 โดยอัตโนมัติ

ค่าลบจะแสดงข้อผิดพลาด INVALID_ARGUMENT
page_token

string

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

เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ระบุโทเค็นหน้าเว็บ การส่งค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทําให้เกิดผลลัพธ์ที่ไม่คาดคิด
filter

string

ไม่บังคับ ตัวกรองการค้นหา

คุณสามารถกรองข้อความตามวันที่ (create_time) และชุดข้อความ (thread.name) ได้

หากต้องการกรองข้อความตามวันที่สร้าง ให้ระบุ create_time พร้อมการประทับเวลาในรูปแบบ RFC-3339 และเครื่องหมายคำพูดคู่ เช่น "2023-04-21T11:30:00-04:00" คุณสามารถใช้โอเปอเรเตอร์มากกว่า > เพื่อแสดงรายการข้อความที่สร้างขึ้นหลังจากการประทับเวลา หรือใช้โอเปอเรเตอร์น้อยกว่า < เพื่อแสดงรายการข้อความที่สร้างขึ้นก่อนการประทับเวลา หากต้องการกรองข้อความภายในช่วงเวลาหนึ่ง ให้ใช้โอเปอเรเตอร์ AND ระหว่างการประทับเวลา 2 รายการ

หากต้องการกรองตามชุดข้อความ ให้ระบุ thread.name ในรูปแบบ spaces/{space}/threads/{thread} คุณระบุ thread.name ได้เพียง 1 รายการต่อการค้นหา

หากต้องการกรองตามทั้งชุดข้อความและวันที่ ให้ใช้โอเปอเรเตอร์ AND ในการค้นหา

ตัวอย่างเช่น คำค้นหาต่อไปนี้ถูกต้อง

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

เซิร์ฟเวอร์จะปฏิเสธคำค้นหาที่ไม่ถูกต้องพร้อมข้อผิดพลาด INVALID_ARGUMENT
order_by

string

ไม่บังคับ วิธีจัดเรียงรายการข้อความ ระบุค่าเพื่อจัดเรียงตามการดำเนินการจัดเรียง ค่าการดำเนินการจัดลำดับที่ถูกต้องมีดังนี้

  • ASC สำหรับการเรียงลำดับจากน้อยไปมาก

  • DESC เพื่อเรียงจากมากไปน้อย

การเรียงลำดับเริ่มต้นคือ create_time ASC
show_deleted

bool

ไม่บังคับ เลือกว่าจะรวมข้อความที่ลบหรือไม่ ข้อความที่ลบจะมีเวลาที่ลบและข้อมูลเมตาเกี่ยวกับการลบ แต่เนื้อหาข้อความจะไม่พร้อมใช้งาน
markup_syntax

MarkupSyntax

ไม่บังคับ ระบุไวยากรณ์เอาต์พุตที่ต้องการสำหรับช่อง formatted_text ของข้อความแชท

ListMessagesResponse

ข้อความตอบกลับสำหรับข้อความที่แสดงอยู่

ช่อง
messages[]

Message

รายการข้อความ
next_page_token

string

คุณสามารถส่งโทเค็นเป็น pageToken เพื่อดึงข้อมูลผลลัพธ์หน้าถัดไปได้ หากว่างเปล่า แสดงว่าไม่มีหน้าถัดไป

ListReactionsRequest

แสดงรายการรีแอ็กชันต่อข้อความ

ช่อง
parent

string

ต้องระบุ ข้อความที่ผู้ใช้แสดงความรู้สึก

รูปแบบ: spaces/{space}/messages/{message}
page_size

int32

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

string

ไม่บังคับ (หากกลับมาดำเนินการต่อจากการค้นหาก่อนหน้า)

โทเค็นของหน้าที่ได้รับจากการเรียกใช้รายการรีแอ็กชันก่อนหน้า ระบุโทเค็นนี้เพื่อเรียกข้อมูลหน้าถัดไป

เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด
filter

string

ไม่บังคับ ตัวกรองการค้นหา

คุณสามารถกรองรีแอ็กชันตามอีโมจิ (emoji.unicode หรือ emoji.custom_emoji.uid) และผู้ใช้ (user.name) ได้

หากต้องการกรองรีแอ็กชันสำหรับอีโมจิหรือผู้ใช้หลายรายการ ให้รวมช่องที่คล้ายกันด้วยโอเปอเรเตอร์ OR เช่น emoji.unicode = "🙂" OR emoji.unicode = "👍" และ user.name = "users/AAAAAA" OR user.name = "users/BBBBBB"

หากต้องการกรองรีแอ็กชันตามอีโมจิและผู้ใช้ ให้ใช้โอเปอเรเตอร์ AND เช่น emoji.unicode = "🙂" AND user.name = "users/AAAAAA"

หากคำค้นหาใช้ทั้ง AND และ OR ให้จัดกลุ่มด้วยวงเล็บ

ตัวอย่างเช่น คำค้นหาต่อไปนี้ถูกต้อง

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

การค้นหาต่อไปนี้ไม่ถูกต้อง

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

ระบบจะปฏิเสธการค้นหาที่ไม่ถูกต้องพร้อมข้อผิดพลาด INVALID_ARGUMENT

ListReactionsResponse

การตอบกลับคำขอแสดงรายการรีแอ็กชัน

ช่อง
reactions[]

Reaction

รายการความรู้สึกในหน้าที่ขอ (หรือหน้าแรก)
next_page_token

string

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

ListSectionItemsRequest

ข้อความคำขอสำหรับแสดงรายการส่วนต่างๆ

ช่อง
parent

string

ต้องระบุ รายการหลัก ซึ่งเป็นชื่อทรัพยากรของส่วนที่เป็นเจ้าของคอลเล็กชันรายการส่วนนี้ รองรับเฉพาะการแสดงรายการส่วนสำหรับผู้ใช้ที่โทรเท่านั้น

เมื่อกรองตามพื้นที่ทำงาน ให้ใช้อักขระไวลด์การ์ด - เพื่อค้นหาในทุกส่วน เช่น users/{user}/sections/-

รูปแบบ: users/{user}/sections/{section}
page_size

int32

ไม่บังคับ จำนวนรายการสูงสุดในส่วนที่จะแสดงผล บริการอาจแสดงผลลัพธ์น้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลรายการส่วนไม่เกิน 10 รายการ

ค่าสูงสุดคือ 100 หากคุณใช้ค่ามากกว่า 100 ระบบจะเปลี่ยนค่าเป็น 100 โดยอัตโนมัติ

ค่าลบจะแสดงข้อผิดพลาด INVALID_ARGUMENT
page_token

string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการเรียกใช้รายการส่วนของรายการก่อนหน้า ระบุโทเค็นนี้เพื่อเรียกข้อมูลหน้าถัดไป

เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ระบุโทเค็นหน้าเว็บ การส่งค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทําให้เกิดผลลัพธ์ที่ไม่คาดคิด
filter

string

ไม่บังคับ ตัวกรองการค้นหา

ปัจจุบันรองรับเฉพาะการกรองตามพื้นที่ทำงานเท่านั้น

เช่น space = spaces/{space}

ระบบจะปฏิเสธการค้นหาที่ไม่ถูกต้องพร้อมข้อผิดพลาด INVALID_ARGUMENT

ListSectionItemsResponse

ข้อความตอบกลับสำหรับรายการส่วนของข้อมูล

ช่อง
section_items[]

SectionItem

รายการส่วนจากส่วนที่ระบุ
next_page_token

string

โทเค็นซึ่งสามารถส่งเป็น page_token เพื่อดึงข้อมูลหน้าถัดไป หากละเว้นช่องนี้ แสดงว่าไม่มีหน้าถัดไป

ListSectionsRequest

ข้อความคำขอสำหรับส่วนข้อมูล

ช่อง
parent

string

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

  • ชื่อแทน me เช่น users/me

  • อีเมล Workspace ของบุคคลดังกล่าว เช่น users/user@example.com

  • รหัสผู้ใช้ เช่น users/123456789

รูปแบบ: users/{user}
page_size

int32

ไม่บังคับ จำนวนส่วนสูงสุดที่จะแสดงผล บริการอาจแสดงผลลัพธ์น้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลไม่เกิน 10 ส่วน

ค่าสูงสุดคือ 100 หากคุณใช้ค่ามากกว่า 100 ระบบจะเปลี่ยนเป็น 100 โดยอัตโนมัติ

ค่าลบจะแสดงข้อผิดพลาด INVALID_ARGUMENT
page_token

string

ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการเรียกใช้ส่วนรายการก่อนหน้า ระบุโทเค็นนี้เพื่อเรียกข้อมูลหน้าถัดไป

เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ระบุโทเค็นหน้าเว็บ การส่งค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทําให้เกิดผลลัพธ์ที่ไม่คาดคิด

ListSectionsResponse

ข้อความตอบกลับสำหรับการแสดงรายการส่วนต่างๆ

ช่อง
sections[]

Section

ส่วนต่างๆ จากผู้ใช้ที่ระบุ
next_page_token

string

โทเค็นซึ่งสามารถส่งเป็น page_token เพื่อดึงข้อมูลหน้าถัดไป หากละเว้นช่องนี้ แสดงว่าไม่มีหน้าถัดไป

ListSpaceEventsRequest

ข้อความคำขอสำหรับการแสดงรายการเหตุการณ์ในพื้นที่ทำงาน

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานใน Google Chat ที่เกิดเหตุการณ์

รูปแบบ: spaces/{space}
page_size

int32

ไม่บังคับ จำนวนกิจกรรมในพื้นที่ทำงานสูงสุดที่แสดงผล บริการอาจแสดงผลลัพธ์น้อยกว่าค่านี้

ค่าลบจะแสดงข้อผิดพลาด INVALID_ARGUMENT
page_token

string

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

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

string

ต้องระบุ ตัวกรองการค้นหา

คุณต้องระบุประเภทเหตุการณ์ (event_type) อย่างน้อย 1 ประเภทโดยใช้โอเปอเรเตอร์ has : หากต้องการกรองตามประเภทเหตุการณ์หลายประเภท ให้ใช้โอเปอเรเตอร์ OR ละเว้นประเภทเหตุการณ์แบบกลุ่มในตัวกรอง คำขอจะแสดงเหตุการณ์แบบกลุ่มที่เกี่ยวข้องโดยอัตโนมัติ เช่น หากคุณกรองตามรีแอ็กชันใหม่ (google.workspace.chat.reaction.v1.created) เซิร์ฟเวอร์จะแสดงเหตุการณ์รีแอ็กชันใหม่แบบเป็นกลุ่ม (google.workspace.chat.reaction.v1.batchCreated) ด้วย ดูรายการประเภทเหตุการณ์ที่รองรับได้ที่เอกสารอ้างอิง SpaceEvents

นอกจากนี้ คุณยังกรองตามเวลาเริ่มต้น (start_time) และเวลาสิ้นสุด (end_time) ได้ด้วย (ไม่บังคับ) ดังนี้

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

หากต้องการระบุเวลาเริ่มต้นหรือเวลาสิ้นสุด ให้ใช้โอเปอเรเตอร์เท่ากับ = และจัดรูปแบบใน RFC-3339 หากต้องการกรองตามทั้ง start_time และ end_time ให้ใช้โอเปอเรเตอร์ AND

ตัวอย่างเช่น คำค้นหาต่อไปนี้ถูกต้อง

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

การค้นหาต่อไปนี้ไม่ถูกต้อง

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

เซิร์ฟเวอร์จะปฏิเสธคำค้นหาที่ไม่ถูกต้องพร้อมข้อผิดพลาด INVALID_ARGUMENT

ListSpaceEventsResponse

ข้อความตอบกลับสำหรับการแสดงรายการเหตุการณ์ในพื้นที่ทำงาน

ช่อง
space_events[]

SpaceEvent

ระบบจะแสดงผลลัพธ์ตามลำดับเวลา (เหตุการณ์เก่าสุดก่อน) หมายเหตุ: ระบบจะไม่แสดงช่อง permissionSettings ในออบเจ็กต์ Space สำหรับคำขอรายการ
next_page_token

string

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

ListSpacesRequest

คำขอแสดงรายการพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก

ช่อง
page_size

int32

ไม่บังคับ จำนวนพื้นที่ทำงานสูงสุดที่จะแสดงผล บริการอาจแสดงผลลัพธ์น้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลพื้นที่ทำงานไม่เกิน 100 รายการ

ค่าสูงสุดคือ 1,000 หากคุณใช้ค่าที่มากกว่า 1,000 ระบบจะเปลี่ยนค่าเป็น 1,000 โดยอัตโนมัติ

ค่าลบจะแสดงข้อผิดพลาด INVALID_ARGUMENT
page_token

string

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

เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นอาจทําให้เกิดผลลัพธ์ที่ไม่คาดคิด
filter

string

ไม่บังคับ ตัวกรองการค้นหา

คุณสามารถกรองพื้นที่ทำงานตามประเภทพื้นที่ทำงาน (space_type) ได้

หากต้องการกรองตามประเภทพื้นที่ทำงาน คุณต้องระบุค่า enum ที่ถูกต้อง เช่น SPACE หรือ GROUP_CHAT (space_type จะเป็น SPACE_TYPE_UNSPECIFIED ไม่ได้) หากต้องการค้นหาพื้นที่ทำงานหลายประเภท ให้ใช้โอเปอเรเตอร์ OR

ตัวอย่างเช่น คำค้นหาต่อไปนี้ถูกต้อง

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

เซิร์ฟเวอร์จะปฏิเสธคำค้นหาที่ไม่ถูกต้องพร้อมข้อผิดพลาด INVALID_ARGUMENT

ListSpacesResponse

การตอบกลับสำหรับคำขอพื้นที่ทำงานในรายการ

ช่อง
spaces[]

Space

รายการพื้นที่ทำงานในหน้าที่ขอ (หรือหน้าแรก) หมายเหตุ: ระบบจะไม่แสดงช่อง permissionSettings ในออบเจ็กต์ Space สำหรับคำขอรายการ
next_page_token

string

คุณสามารถส่งโทเค็นเป็น pageToken เพื่อดึงข้อมูลผลลัพธ์หน้าถัดไปได้ หากว่างเปล่า แสดงว่าไม่มีหน้าถัดไป

MarkAsActiveRequest

ข้อความคำขอสำหรับเมธอด MarkAsActive

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของความพร้อมให้บริการที่จะทำเครื่องหมายว่าใช้งานอยู่ รูปแบบ: users/{user}/availability

{user} คือรหัสของบุคคลใน People API หรือ Admin SDK Directory API เช่น users/123456789

นอกจากนี้ คุณยังใช้อีเมลของผู้ใช้หรือ me เป็นชื่อแทนเพื่ออ้างอิงถึงผู้โทรได้ด้วย เช่น users/user@example.com หรือ users/me
ฟิลด์ Union expiration วันหมดอายุสำหรับสถานะความพร้อมใช้งาน "ใช้งานอยู่" ระบบจะทำเครื่องหมายผู้ใช้เป็น "ไม่อยู่" หลังจากหมดอายุ หากไม่ได้ระบุวันหมดอายุ สถานะ ACTIVE จะหมดอายุใน 30 นาทีจากเวลาปัจจุบัน expiration ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
expire_time

Timestamp

การประทับเวลาแบบสัมบูรณ์เมื่อสถานะ ACTIVE หมดอายุ
ttl

Duration

ระยะเวลาตั้งแต่เวลาปัจจุบันจนกว่าสถานะ ACTIVE จะหมดอายุ การใช้ TTL แบบสั้นจะรีเซ็ตสถานะของผู้ใช้ให้เป็นไปตามกิจกรรมหลังจากระยะเวลาสั้นๆ นี้ได้อย่างมีประสิทธิภาพ

MarkAsAwayRequest

ข้อความคำขอสำหรับเมธอด MarkAsAway

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของเวลาว่างที่จะทำเครื่องหมายว่าไม่อยู่ รูปแบบ: users/{user}/availability

{user} คือรหัสของบุคคลใน People API หรือ Admin SDK Directory API เช่น users/123456789

นอกจากนี้ คุณยังใช้อีเมลของผู้ใช้หรือ me เป็นชื่อแทนเพื่ออ้างอิงถึงผู้โทรได้ด้วย เช่น users/user@example.com หรือ users/me

MarkAsDoNotDisturbRequest

ข้อความคำขอสำหรับเมธอด MarkAsDoNotDisturb

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของเวลาว่างที่จะทำเครื่องหมายเป็นห้ามรบกวน รูปแบบ: users/{user}/availability

{user} คือรหัสของบุคคลใน People API หรือ Admin SDK Directory API เช่น users/123456789

นอกจากนี้ คุณยังใช้อีเมลของผู้ใช้หรือ me เป็นชื่อแทนเพื่ออ้างอิงถึงผู้โทรได้ด้วย เช่น users/user@example.com หรือ users/me
ฟิลด์ Union expiration ต้องระบุ วันหมดอายุของสถานะความพร้อมใช้งานโหมดห้ามรบกวน ระบบจะทำเครื่องหมายผู้ใช้เป็น "ไม่อยู่" หลังจากหมดอายุ โดยต้องไม่เกิน 1 ปีนับจากเวลาปัจจุบัน expiration ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
expire_time

Timestamp

การประทับเวลาแบบสัมบูรณ์เมื่อสถานะห้ามรบกวนหมดอายุ
ttl

Duration

ระยะเวลาตั้งแต่เวลาปัจจุบันจนกว่าสถานะห้ามรบกวนจะหมดอายุ

MarkupSyntax

ระบุไวยากรณ์มาร์กอัปที่ใช้จัดรูปแบบข้อความแชท ใช้กับฟิลด์ text ของทรัพยากร Message

Enum
MARKUP_SYNTAX_UNSPECIFIED แสดงค่าที่ไม่ได้ระบุ
MARKUP_SYNTAX_CHAT ใช้ไวยากรณ์มาร์กอัปของ Google Chat ดูข้อมูลเพิ่มเติมได้ที่ https://developers.google.com/workspace/chat/format-messages#format-texts
MARKUP_SYNTAX_MARKDOWN ใช้ไวยากรณ์มาร์กดาวน์ ไวยากรณ์นี้อิงตามข้อกำหนด CommonMark โดยมีส่วนขยายเพิ่มเติม ดูข้อมูลเพิ่มเติมได้ที่ https://developers.google.com/workspace/chat/format-messages#format-texts

MatchedUrl

URL ที่ตรงกันในข้อความแชท แอปใน Chat จะดูตัวอย่าง URL ที่ตรงกันได้ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อดูตัวอย่างลิงก์

ช่อง
url

string

เอาต์พุตเท่านั้น URL ที่ตรงกัน

MeetSpaceLinkData

ข้อมูลสำหรับลิงก์พื้นที่ประชุม Meet

ช่อง
meeting_code

string

รหัสการประชุมของพื้นที่ Meet ที่ลิงก์ไว้
type

Type

ระบุประเภทของพื้นที่ประชุม Meet
huddle_status

HuddleStatus

ไม่บังคับ เอาต์พุตเท่านั้น หากการประชุม Meet เป็นการประชุมสั้นๆ จะระบุสถานะของการประชุมสั้นๆ ไม่เช่นนั้น ระบบจะไม่ตั้งค่านี้

HuddleStatus

สถานะของการประชุมสั้น

Enum
HUDDLE_STATUS_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum ไม่ใช้
STARTED เริ่มการประชุมสั้นแล้ว
ENDED การประชุมสั้นสิ้นสุดแล้ว ในกรณีนี้ URI และตัวระบุของพื้นที่ Meet จะใช้ไม่ได้อีกต่อไป
MISSED ไม่ได้รับสายการประชุมสั้น ในกรณีนี้ URI และตัวระบุของพื้นที่ Meet จะใช้ไม่ได้อีกต่อไป

ประเภท

ประเภทของพื้นที่ Meet

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum ไม่ใช้
MEETING พื้นที่ Meet คือการประชุม
HUDDLE พื้นที่ Meet คือการประชุมสั้นๆ

การเป็นสมาชิก

แสดงความสัมพันธ์ของการเป็นสมาชิกใน Google Chat เช่น ผู้ใช้หรือแอปใน Chat ได้รับเชิญ เป็นส่วนหนึ่ง หรือไม่ได้อยู่ในพื้นที่ทำงานหรือไม่

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของการเป็นสมาชิกที่เซิร์ฟเวอร์กำหนด

รูปแบบ: spaces/{space}/members/{member}
state

MembershipState

เอาต์พุตเท่านั้น สถานะของการเป็นสมาชิก
role

MembershipRole

ไม่บังคับ บทบาทของผู้ใช้ภายในพื้นที่ใน Chat ซึ่งจะกำหนดการดำเนินการที่ได้รับอนุญาตในพื้นที่ทำงาน

ช่องนี้ใช้เป็นอินพุตได้ใน UpdateMembership เท่านั้น
create_time

Timestamp

ไม่บังคับ เปลี่ยนแปลงไม่ได้ เวลาที่สร้างการเป็นสมาชิก เช่น เวลาที่สมาชิกเข้าร่วมหรือได้รับเชิญให้เข้าร่วมพื้นที่ทำงาน ช่องนี้เป็นเอาต์พุตเท่านั้น ยกเว้นเมื่อใช้เพื่อนำเข้าการเป็นสมาชิกที่ผ่านมาในพื้นที่ทำงานโหมดการนำเข้า
delete_time

Timestamp

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

Affiliation

เอาต์พุตเท่านั้น ความสัมพันธ์ของผู้ใช้กับองค์กร Workspace ที่เป็นเจ้าของพื้นที่ทำงาน ในพื้นที่ทำงานที่บัญชีผู้ใช้ทั่วไปเป็นเจ้าของ ความเกี่ยวข้องของสมาชิกทั้งหมดจะเป็น EXTERNAL
ฟิลด์ Union memberType สมาชิกที่เชื่อมโยงกับการเป็นสมาชิกนี้ เราอาจรองรับสมาชิกประเภทอื่นๆ ในอนาคต memberType ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
member

User

ไม่บังคับ ผู้ใช้หรือแอป Google Chat ที่สอดคล้องกับการเป็นสมาชิก หากแอปใน Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะป้อนข้อมูลเฉพาะในช่อง user name และ type สำหรับทั้งผู้ใช้ภายในและภายนอก เว้นแต่ว่าผู้ใช้เหล่านั้นจะเป็นสมาชิกของพื้นที่ทำงานหรือมีความสัมพันธ์ก่อนหน้านี้ เช่น การสนทนาผ่านข้อความส่วนตัว (DM) กับผู้ใช้ที่โทร
group_member

Group

ไม่บังคับ Google Group ที่สอดคล้องกับการเป็นสมาชิก

การอ่านหรือเปลี่ยนแปลงการเป็นสมาชิกสำหรับ Google Groups ต้องใช้การตรวจสอบสิทธิ์ผู้ใช้

แอฟฟิลิเอต

แสดงถึงความเกี่ยวข้องของผู้ใช้กับองค์กร Google Workspace ที่เป็นเจ้าของพื้นที่ทำงาน อาจมีการเพิ่มค่าอื่นๆ ลงใน enum นี้ในอนาคต

Enum
AFFILIATION_UNSPECIFIED ค่าเริ่มต้น ค่านี้ไม่ได้ใช้
INTERNAL บัญชีที่จัดการโดยองค์กร Google Workspace เดียวกันกับที่เป็นเจ้าของพื้นที่ทำงาน
EXTERNAL บัญชีภายนอกองค์กร Google Workspace ที่เป็นเจ้าของพื้นที่ทำงาน (เช่น บัญชีผู้ใช้ทั่วไป หรือบัญชีที่จัดการโดยองค์กร Workspace อื่น)
MANAGED_EXTERNAL บัญชีที่จัดการโดยองค์กร Workspace ที่เป็นเจ้าของพื้นที่ทำงาน แต่จัดสรรไว้สำหรับผู้ใช้ภายนอกองค์กร (เช่น ผู้ใช้ชั่วคราว) ดูข้อมูลเพิ่มเติมเกี่ยวกับผู้เข้าร่วมได้ที่ https://support.google.com/chat/answer/16997417

MembershipRole

แสดงถึงการดำเนินการที่ได้รับอนุญาตของผู้ใช้ในพื้นที่ใน Chat อาจมีการเพิ่มค่า enum อื่นๆ ในอนาคต

Enum
MEMBERSHIP_ROLE_UNSPECIFIED ค่าเริ่มต้น สำหรับ users: บุคคลนี้ไม่ได้เป็นสมาชิกของพื้นที่ทำงาน แต่สามารถเชิญได้ สำหรับ Google Groups: ระบบจะมอบหมายบทบาทนี้ให้เสมอ (อาจใช้ค่า enum อื่นๆ ในอนาคต)
ROLE_MEMBER

สมาชิกของพื้นที่ทำงาน ใน UI ของ Chat บทบาทนี้จะเรียกว่าสมาชิก

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

  • เพิ่มหรือนำสมาชิกออก
  • แก้ไขรายละเอียดของพื้นที่ทำงาน
  • เปิดหรือปิดประวัติ
  • พูดถึงทุกคนในพื้นที่ทำงานด้วย @all
  • จัดการแอปใน Chat และเว็บฮุคที่ติดตั้งในพื้นที่ทำงาน

ทุกคนจะมีบทบาทนี้ในข้อความส่วนตัวและการสนทนากลุ่มที่ไม่มีชื่อ
ROLE_MANAGER

เจ้าของพื้นที่ทำงาน ใน UI ของ Chat บทบาทนี้จะเรียกว่าเจ้าของ

ผู้ใช้มีสิทธิ์ในพื้นที่ทำงานครบชุดเพื่อจัดการพื้นที่ทำงาน ซึ่งรวมถึงสิทธิ์ต่อไปนี้

  • เปลี่ยนบทบาทของสมาชิกคนอื่นๆ ในพื้นที่ทำงานเป็นสมาชิก ผู้จัดการ หรือเจ้าของ
  • ลบพื้นที่ทำงาน

รองรับเฉพาะใน SpaceType.SPACE (พื้นที่ทำงานที่มีชื่อ)

โปรดดูข้อมูลเพิ่มเติมที่หัวข้อดูข้อมูลเพิ่มเติมเกี่ยวกับบทบาทของคุณในฐานะเจ้าของหรือผู้จัดการพื้นที่ทำงาน
ROLE_ASSISTANT_MANAGER

เป็นผู้จัดการพื้นที่ทำงาน ใน UI ของ Chat บทบาทนี้เรียกว่าผู้จัดการ

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

  • ลบพื้นที่ทำงาน
  • กำหนดให้สมาชิกรายอื่นในพื้นที่ทำงานเป็นเจ้าของ
  • เปลี่ยนบทบาทของเจ้าของ

โดยค่าเริ่มต้น สิทธิ์ของผู้จัดการจะรวมถึงแต่ไม่จำกัดเพียงสิทธิ์ต่อไปนี้

  • กำหนดให้สมาชิกคนอื่นเป็นผู้จัดการ
  • ลบข้อความในพื้นที่ทำงาน
  • จัดการสิทธิ์ของพื้นที่ทำงาน
  • รับการแจ้งเตือนคำขอเข้าร่วมพื้นที่ทำงานหากผู้จัดการมีสิทธิ์ "จัดการสมาชิก" ในการตั้งค่าพื้นที่ทำงาน
  • ทำให้พื้นที่ทำงานค้นพบได้

รองรับเฉพาะใน SpaceType.SPACE (พื้นที่ทำงานที่มีชื่อ)

ดูข้อมูลเพิ่มเติมได้ที่หัวข้อจัดการการตั้งค่าพื้นที่ทำงาน

MembershipState

ระบุความสัมพันธ์ของสมาชิกกับพื้นที่ทำงาน เราอาจรองรับสถานะการเป็นสมาชิกอื่นๆ ในอนาคต

Enum
MEMBERSHIP_STATE_UNSPECIFIED ค่าเริ่มต้น ไม่ใช้
JOINED ระบบจะเพิ่มผู้ใช้ไปยังพื้นที่ทำงาน และผู้ใช้จะเข้าร่วมในพื้นที่ทำงานได้
INVITED ผู้ใช้ได้รับเชิญให้เข้าร่วมพื้นที่ทำงาน แต่ยังไม่ได้เข้าร่วม
NOT_A_MEMBER ผู้ใช้ไม่ได้อยู่ในพื้นที่ทำงานและไม่มีคำเชิญที่รอดำเนินการเพื่อเข้าร่วมพื้นที่ทำงาน

MembershipBatchCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchCreated

ช่อง
memberships[]

MembershipCreatedEventData

รายชื่อการเป็นสมาชิกใหม่

MembershipBatchDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchDeleted

ช่อง
memberships[]

MembershipDeletedEventData

รายชื่อการเป็นสมาชิกที่ลบไปแล้ว

MembershipBatchUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchUpdated

ช่อง
memberships[]

MembershipUpdatedEventData

รายการการเป็นสมาชิกที่อัปเดตแล้ว

MembershipCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกใหม่

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.created

ช่อง
membership

Membership

การเป็นสมาชิกใหม่

MembershipDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.deleted

ช่อง
membership

Membership

การเป็นสมาชิกที่ลบแล้ว ระบบจะป้อนข้อมูลเฉพาะในช่อง name และ state เท่านั้น

MembershipUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตแล้ว

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.updated

ช่อง
membership

Membership

การเป็นสมาชิกที่อัปเดตแล้ว

ข้อความ

ข้อความในพื้นที่ใน Google Chat

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของข้อความ

รูปแบบ: spaces/{space}/messages/{message}

โดย {space} คือรหัสของพื้นที่ทำงานที่มีการโพสต์ข้อความ และ {message} คือรหัสที่ระบบกำหนดให้กับข้อความ เช่น spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

หากคุณตั้งค่ารหัสที่กำหนดเองเมื่อสร้างข้อความ คุณจะใช้รหัสนี้เพื่อระบุข้อความในคำขอได้โดยแทนที่ {message} ด้วยค่าจากช่อง clientAssignedMessageId เช่น spaces/AAAAAAAAAAA/messages/client-custom-name โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ
sender

User

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างข้อความ หากแอปใน Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะป้อนข้อมูลเฉพาะในช่อง user name และ type สำหรับทั้งผู้ใช้ภายในและภายนอก เว้นแต่ว่าผู้ใช้เหล่านั้นจะเป็นสมาชิกของพื้นที่ทำงานหรือมีความสัมพันธ์ก่อนหน้านี้ เช่น การสนทนาผ่านข้อความส่วนตัว (DM) กับผู้ใช้ที่โทร
create_time

Timestamp

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

สำหรับพื้นที่ทำงานในโหมดนำเข้า ให้ตั้งค่าช่องนี้เป็นการประทับเวลาที่ผ่านมาซึ่งมีการสร้างข้อความในแหล่งที่มาเพื่อรักษาเวลาที่สร้างเดิมไว้
last_update_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่ผู้ใช้แก้ไขข้อความครั้งล่าสุด หากไม่เคยแก้ไขข้อความ ช่องนี้จะว่างเปล่า
delete_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่ลบข้อความใน Google Chat หากไม่มีการลบข้อความ ช่องนี้จะว่างเปล่า
text

string

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

หากต้องการดูข้อมูลเกี่ยวกับการสร้าง SMS โปรดดูหัวข้อส่งข้อความ
formatted_text

string

เอาต์พุตเท่านั้น มีข้อความ text พร้อมมาร์กอัปที่เพิ่มเข้ามาเพื่อสื่อสารการจัดรูปแบบ ช่องนี้อาจไม่บันทึกการจัดรูปแบบทั้งหมดที่มองเห็นได้ใน UI แต่จะรวมข้อมูลต่อไปนี้

  • ไวยากรณ์มาร์กอัปสำหรับตัวหนา ตัวเอียง ขีดทับ ความกว้างอักษรขนาดเดียว บล็อกความกว้างอักษรขนาดเดียว รายการสัญลักษณ์หัวข้อย่อย และการยกข้อความมาอ้าง

  • การพูดถึงผู้ใช้โดยใช้รูปแบบ <users/{user}>

  • ไฮเปอร์ลิงก์ที่กำหนดเองโดยใช้รูปแบบ <{url}|{rendered_text}> โดยที่สตริงแรกคือ URL และสตริงที่ 2 คือข้อความที่แสดงผล เช่น <http://example.com|custom text>

  • อีโมจิที่กำหนดเองโดยใช้รูปแบบ :{emoji_name}: เช่น :smile: แต่จะไม่มีผลกับอีโมจิ Unicode เช่น U+1F600 สำหรับอีโมจิหน้ายิ้มกว้าง

  • รายการสัญลักษณ์หัวข้อย่อยที่ใช้เครื่องหมายดอกจัน (*) เช่น * item

ดูข้อมูลเพิ่มเติมได้ที่หัวข้อดูการจัดรูปแบบข้อความที่ส่งในข้อความ
cards[]
(deprecated)

Card

เลิกใช้งานแล้ว: โปรดใช้ cards_v2 แทน

การ์ดแบบอินเทอร์แอกทีฟที่มีการจัดรูปแบบและสมบูรณ์ซึ่งคุณสามารถใช้เพื่อแสดงองค์ประกอบ UI เช่น ข้อความที่จัดรูปแบบ ปุ่ม และรูปภาพที่คลิกได้ โดยปกติแล้ว การ์ดจะแสดงอยู่ใต้เนื้อหาข้อความธรรมดาของข้อความ cards และ cards_v2 มีขนาดได้สูงสุด 32 KB
cards_v2[]

CardWithId

ไม่บังคับ อาร์เรย์ของการ์ด

แอปใน Chat สามารถสร้างการ์ดด้วยการตรวจสอบสิทธิ์ของแอป ในฐานะส่วนหนึ่งของเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ หากแอปใน Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ แอปจะสร้างข้อความการ์ดได้ หากแอปใน Chat ไม่ได้อยู่ในโปรแกรมเวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ แอปจะสร้างการ์ดที่มีการตรวจสอบสิทธิ์ของผู้ใช้ไม่ได้

หากต้องการดูวิธีสร้างข้อความที่มีการ์ด โปรดดูหัวข้อส่งข้อความ

ออกแบบและดูตัวอย่างการ์ดด้วยเครื่องมือสร้างการ์ด

เปิดเครื่องมือสร้างการ์ด
annotations[]

Annotation

เอาต์พุตเท่านั้น คำอธิบายประกอบสามารถเชื่อมโยงกับเนื้อหาข้อความธรรมดาของข้อความหรือชิปที่ลิงก์ไปยังแหล่งข้อมูล Google Workspace เช่น Google เอกสารหรือชีตที่มี start_index และ length เป็น 0
thread

Thread

ชุดข้อความที่มีข้อความอยู่ ดูตัวอย่างการใช้งานได้ที่หัวข้อเริ่มหรือตอบกลับชุดข้อความ
space

Space

เอาต์พุตเท่านั้น หากแอปใน Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะป้อนข้อมูลเฉพาะ space name
fallback_text

string

ไม่บังคับ คำอธิบายข้อความธรรมดาของการ์ดของข้อความ ซึ่งใช้เมื่อไม่สามารถแสดงการ์ดจริงได้ เช่น การแจ้งเตือนบนมือถือ
action_response

ActionResponse

อินพุตเท่านั้น พารามิเตอร์ที่แอปใน Chat ใช้กำหนดค่าวิธีโพสต์คำตอบได้
argument_text

string

เอาต์พุตเท่านั้น เนื้อหาข้อความธรรมดาของข้อความที่มีการนำการพูดถึงแอปใน Chat ทั้งหมดออก
slash_command

SlashCommand

เอาต์พุตเท่านั้น ข้อมูลคำสั่งเครื่องหมายทับ (หากมี)
attachment[]

Attachment

ไม่บังคับ ไฟล์แนบที่ผู้ใช้อัปโหลด
matched_url

MatchedUrl

เอาต์พุตเท่านั้น URL ในช่องข้อความแชท text ที่ตรงกับรูปแบบตัวอย่างลิงก์ ดูข้อมูลเพิ่มเติมได้ที่ลิงก์ตัวอย่าง
thread_reply

bool

เอาต์พุตเท่านั้น เมื่อ true ข้อความจะเป็นการตอบกลับในชุดข้อความตอบกลับ เมื่อfalse ข้อความจะปรากฏในการสนทนาระดับบนสุดของพื้นที่ทำงานเป็นข้อความแรกของชุดข้อความหรือข้อความที่ไม่มีการตอบกลับแบบแยกชุดข้อความ

หากพื้นที่ทำงานไม่รองรับการตอบกลับในชุดข้อความ ช่องนี้จะเป็น false เสมอ
silent

bool

เอาต์พุตเท่านั้น ข้อความนี้เป็นข้อความแบบไม่มีการแจ้งเตือนหรือไม่ ข้อความแบบไม่มีเสียงคือข้อความที่ Chat ระงับข้อความ Push สำหรับผู้รับ
client_assigned_message_id

string

ไม่บังคับ รหัสที่กำหนดเองสำหรับข้อความ คุณสามารถใช้ช่องเพื่อระบุข้อความ หรือเพื่อรับ ลบ หรืออัปเดตข้อความได้ หากต้องการตั้งค่ารหัสที่กำหนดเอง ให้ระบุช่อง messageId เมื่อสร้างข้อความ โปรดดูรายละเอียดที่หัวข้อตั้งชื่อข้อความ
emoji_reaction_summaries[]

EmojiReactionSummary

เอาต์พุตเท่านั้น รายการสรุปรีแอ็กชันด้วยอีโมจิในข้อความ
private_message_viewer

User

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

โปรดดูรายละเอียดที่หัวข้อส่งข้อความส่วนตัว
deletion_metadata

DeletionMetadata

เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับข้อความที่ถูกลบ ระบบจะลบข้อความเมื่อตั้งค่า delete_time ไว้
quoted_message_metadata

QuotedMessageMetadata

ไม่บังคับ ข้อมูลเกี่ยวกับข้อความที่ข้อความอื่นยกมา

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

เมื่ออัปเดตข้อความ คุณจะเพิ่มหรือแทนที่ช่อง quotedMessageMetadata ไม่ได้ แต่จะนำออกได้

ดูตัวอย่างการใช้งานได้ที่หัวข้อยกคำพูดจากข้อความอื่น
attached_gifs[]

AttachedGif

เอาต์พุตเท่านั้น รูปภาพ GIF ที่แนบมากับข้อความ
accessory_widgets[]

AccessoryWidget

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

การสร้างข้อความที่มีวิดเจ็ตเสริมต้องใช้การตรวจสอบสิทธิ์ของแอป
elements

Elements

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

markup_syntax

MarkupSyntax

ไม่บังคับ ระบุวิธีที่เซิร์ฟเวอร์ตีความเนื้อหาช่อง text ของข้อความ

MessageBatchCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchCreated

ช่อง
messages[]

MessageCreatedEventData

รายการข้อความใหม่

MessageBatchDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความที่ถูกลบหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchDeleted

ช่อง
messages[]

MessageDeletedEventData

รายการข้อความที่ถูกลบ

MessageBatchUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดตหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchUpdated

ช่อง
messages[]

MessageUpdatedEventData

รายการข้อความที่อัปเดต

MessageCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความใหม่

ประเภทเหตุการณ์: google.workspace.chat.message.v1.created

ช่อง
message

Message

ข้อความใหม่

MessageDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความที่ลบ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.deleted

ช่อง
message

Message

ข้อความที่ลบ ระบบจะป้อนข้อมูลเฉพาะในช่อง name, createTime และ deletionMetadata

MessagePin

หมุดบนข้อความแชท ดูข้อมูลเพิ่มเติมได้ที่ปักหมุดข้อความ

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของข้อความที่ปักหมุด รูปแบบ: spaces/{space}/messagePins/{message_pin} คอมโพเนนต์รหัสทรัพยากรตรงกับคอมโพเนนต์รหัสทรัพยากรของข้อความ ตัวอย่างเช่น ข้อความที่มี spaces/AAA/messages/bbb.ccc จะสอดคล้องกับข้อความที่ปักหมุดซึ่งมีชื่อทรัพยากร spaces/AAA/messagePins/bbb.ccc
message

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ชื่อทรัพยากรของข้อความที่ปักหมุดไว้ รูปแบบ: spaces/{space}/messages/{message}

MessageUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดต

ประเภทเหตุการณ์: google.workspace.chat.message.v1.updated

ช่อง
message

Message

ข้อความที่อัปเดต

MoveSectionItemRequest

ข้อความคำขอสำหรับการย้ายรายการส่วนข้ามส่วน

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของรายการในส่วนที่จะย้าย

รูปแบบ: users/{user}/sections/{section}/items/{item}
target_section

string

ต้องระบุ ชื่อทรัพยากรของส่วนที่จะย้ายรายการในส่วนไปไว้

รูปแบบ: users/{user}/sections/{section}

MoveSectionItemResponse

ข้อความตอบกลับสำหรับการย้ายรายการในส่วน

ช่อง
section_item

SectionItem

รายการส่วนที่อัปเดต

PositionSectionRequest

ข้อความคำขอสำหรับการจัดตำแหน่งส่วน

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของส่วนที่จะจัดตำแหน่ง

รูปแบบ: users/{user}/sections/{section}
ฟิลด์ Union position ต้องระบุ ตำแหน่งใหม่ของส่วน position ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
sort_order

int32

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

Position

ไม่บังคับ ตำแหน่งสัมพัทธ์ของส่วนในรายการส่วน

ตำแหน่ง

ตำแหน่งของส่วน

Enum
POSITION_UNSPECIFIED ตำแหน่งที่ไม่ได้ระบุ
START จุดเริ่มต้นของรายการส่วน
END สิ้นสุดรายการส่วน

PositionSectionResponse

ข้อความตอบกลับสำหรับการจัดตำแหน่งส่วน

ช่อง
section

Section

ส่วนที่อัปเดต

QuotedMessageMetadata

ข้อมูลเกี่ยวกับข้อความที่ข้อความอื่นยกมา

เมื่ออัปเดตข้อความ คุณจะเพิ่มหรือแทนที่ช่อง quotedMessageMetadata ไม่ได้ แต่จะนำออกได้

ดูตัวอย่างการใช้งานได้ที่หัวข้อยกคำพูดจากข้อความอื่น

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของข้อความที่ยกมา

รูปแบบ: spaces/{space}/messages/{message}
last_update_time

Timestamp

ต้องระบุ การประทับเวลาเมื่อสร้างข้อความที่ยกมาหรือเมื่ออัปเดตข้อความที่ยกมาครั้งล่าสุด

หากมีการแก้ไขข้อความ ให้ใช้ช่องนี้ last_update_time หากไม่เคยแก้ไขข้อความ ให้ใช้ create_time

หาก last_update_time ไม่ตรงกับเวอร์ชันล่าสุดของข้อความที่ยกมา คำขอจะดำเนินการไม่สำเร็จ
quote_type

QuoteType

ไม่บังคับ ระบุประเภทใบเสนอราคา หากไม่ได้ตั้งค่าไว้ ระบบจะใช้ค่าเริ่มต้นเป็น REPLY ในเส้นทางการอ่าน/เขียนข้อความเพื่อความเข้ากันได้แบบย้อนหลัง
quoted_message_snapshot

QuotedMessageSnapshot

เอาต์พุตเท่านั้น ภาพรวมของเนื้อหาข้อความที่ยกมา
forwarded_metadata

ForwardedMetadata

เอาต์พุตเท่านั้น ข้อมูลเมตาเกี่ยวกับพื้นที่ทำงานต้นทางของข้อความที่ยกมา ป้อนข้อมูลสําหรับประเภทการเสนอราคาแบบ FORWARD เท่านั้น

QuoteType

ประเภทการอ้างอิงของข้อความที่ยกมา

Enum
QUOTE_TYPE_UNSPECIFIED Reserved. ค่านี้ไม่ได้ใช้
REPLY

เมื่อ quote_type เป็น REPLY คุณจะทำสิ่งต่อไปนี้ได้

  • หากตอบกลับในชุดข้อความ คุณจะยกข้อความอื่นในชุดข้อความนั้นมาได้

  • หากกำลังสร้างข้อความหลัก คุณจะยกข้อความหลักอีกข้อความหนึ่งในพื้นที่ทำงานนั้นได้
FORWARD

เมื่อ quote_type เป็น FORWARD คุณจะเสนอราคาได้ดังนี้

  • ข้อความจากพื้นที่ทำงานอื่น

  • การตอบกลับข้อความจากชุดข้อความอื่นในพื้นที่ทำงานเดียวกัน

QuotedMessageSnapshot

แสดงภาพรวมของเนื้อหาในข้อความที่ยกมา ณ เวลาที่ยกมาหรือส่งต่อ

ช่อง
sender

string

เอาต์พุตเท่านั้น ชื่อผู้เขียนข้อความที่ยกมา ป้อนข้อมูลสำหรับประเภทการอ้างอิงทั้ง REPLY และ FORWARD
text

string

เอาต์พุตเท่านั้น ภาพรวมของเนื้อหาข้อความที่ยกมา
formatted_text

string

เอาต์พุตเท่านั้น มีข้อความที่ยกมา text พร้อมมาร์กอัปที่เพิ่มเพื่อรองรับการจัดรูปแบบที่หลากหลาย เช่น ไฮเปอร์ลิงก์ อีโมจิที่กำหนดเอง มาร์กอัป ฯลฯ โดยจะป้อนข้อมูลสำหรับประเภทการยกคำพูดแบบ FORWARD เท่านั้น
annotations[]

Annotation

เอาต์พุตเท่านั้น คำอธิบายประกอบที่แยกวิเคราะห์จากเนื้อหาข้อความของข้อความที่ยกมา ป้อนข้อมูลสําหรับประเภทการเสนอราคาแบบ FORWARD เท่านั้น
attachments[]

Attachment

เอาต์พุตเท่านั้น ไฟล์แนบที่เป็นส่วนหนึ่งของข้อความที่ยกมา ซึ่งเป็นสำเนาข้อมูลเมตาของไฟล์แนบของข้อความที่ยกมา ป้อนข้อมูลสําหรับประเภทการเสนอราคาแบบ FORWARD เท่านั้น

รีแอ็กชัน

รีแอ็กชันต่อข้อความ

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของรีแอ็กชัน

รูปแบบ: spaces/{space}/messages/{message}/reactions/{reaction}
user

User

เอาต์พุตเท่านั้น ผู้ใช้ที่สร้างรีแอ็กชัน
emoji

Emoji

ต้องระบุ อีโมจิที่ใช้ในรีแอ็กชัน

ReactionBatchCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับรีแอ็กชันใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.batchCreated

ช่อง
reactions[]

ReactionCreatedEventData

รายการรีแอ็กชันใหม่

ReactionBatchDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ลบไปหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.batchDeleted

ช่อง
reactions[]

ReactionDeletedEventData

รายการรีแอ็กชันที่ลบแล้ว

ReactionCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับรีแอ็กชันใหม่

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.created

ช่อง
reaction

Reaction

รีแอ็กชันใหม่

ReactionDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ลบไปแล้ว

ประเภท: google.workspace.chat.reaction.v1.deleted

ช่อง
reaction

Reaction

รีแอ็กชันที่ลบ

ReplaceMessageCardsRequest

ข้อความคำขอสำหรับเมธอด ReplaceMessageCards API

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของข้อความ

รูปแบบ: spaces/{space}/messages/{message}
cards_v2[]

CardWithId

ไม่บังคับ อาร์เรย์ของการ์ดที่จะรวมไว้ในข้อความ การ์ดเหล่านี้จะแทนที่การ์ดที่มีอยู่ของข้อความ หากเว้นว่างไว้ ระบบจะล้างการ์ดเดิมที่รวมอยู่ในข้อความ

ReplaceMessageCardsResponse

ประเภทนี้ไม่มีช่อง

ข้อความตอบกลับสำหรับ ReplaceMessageCards API

RichLinkMetadata

ลิงก์แบบริชไปยังแหล่งข้อมูล ลิงก์ริชมีเดียสามารถเชื่อมโยงกับเนื้อหาข้อความธรรมดาของข้อความหรือแสดงชิปที่ลิงก์ไปยังแหล่งข้อมูล Google Workspace เช่น Google เอกสารหรือชีตที่มี start_index และ length เป็น 0

ช่อง
uri

string

URI ของลิงก์นี้
ฟิลด์ Union data ข้อมูลสำหรับทรัพยากรที่ลิงก์ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น

RichLinkType

ประเภทลิงก์แบบริชมีเดีย ทั้งนี้อาจมีการเพิ่มประเภทอื่นๆ ในอนาคต

Enum
DRIVE_FILE ประเภท Rich Link ของ Google ไดรฟ์
CHAT_SPACE ประเภทลิงก์แบบริชมีเดียของพื้นที่ใน Chat เช่น ชิปอัจฉริยะของพื้นที่ทำงาน
GMAIL_MESSAGE ประเภทริชลิงก์ของข้อความ Gmail โดยเฉพาะชิป Gmail จากแชร์ไปยัง Chat API รองรับเฉพาะการอ่านข้อความที่มีลิงก์ Rich Link ของ GMAIL_MESSAGE เท่านั้น
MEET_SPACE ประเภทลิงก์ Rich Link ของข้อความ Meet เช่น ชิป Meet
CALENDAR_EVENT ประเภทริชลิงก์ของข้อความในปฏิทิน เช่น ชิปปฏิทิน

SearchMessageResult

รายการผลลัพธ์รายการเดียวจากการค้นหาข้อความ

ช่อง
message

Message

ข้อความที่ตรงกัน
space_mute_setting

MuteSetting

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

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

  • https://www.googleapis.com/auth/chat.users.spacesettings
read

bool

ระบุว่าผู้ใช้ที่โทรเข้ามาได้อ่านข้อความที่ตรงกันหรือไม่

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

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate

SearchMessagesRequest

ข้อความคำขอสำหรับการค้นหาข้อความ

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรของพื้นที่ทำงานที่จะใช้ค้นหา

หากต้องการค้นหาในพื้นที่ทำงานทั้งหมดที่ผู้ใช้มีสิทธิ์เข้าถึง ให้ตั้งค่าช่องนี้เป็น spaces/- การใช้ค่าอื่นสำหรับ parent จะทำให้เกิดข้อผิดพลาด INVALID_ARGUMENT

หากต้องการจำกัดการค้นหาให้อยู่ในพื้นที่ทำงานอย่างน้อย 1 รายการ ให้ใช้ space.name หรือ space.display_name ใน filter
filter

string

ต้องระบุ คำค้นหา

คำค้นหาสามารถระบุคีย์เวิร์ดสำหรับโฆษณา Search อย่างน้อย 1 รายการ ซึ่งใช้เพื่อกรองผลลัพธ์

นอกจากนี้ คุณยังกรองผลลัพธ์โดยใช้ช่องข้อความต่อไปนี้ได้ด้วย

  • create_time: ยอมรับการประทับเวลาในรูปแบบ RFC-3339 และโอเปอเรเตอร์การเปรียบเทียบที่รองรับ ได้แก่ < และ >=
  • sender.name: ชื่อทรัพยากรของผู้ส่ง (users/{user}) รองรับเฉพาะ = คุณสามารถใช้อีเมลเป็นชื่อแทนสำหรับ {user} ได้ เช่น users/example@gmail.com โดยที่ example@gmail.com คืออีเมลของผู้ใช้ Google Chat
  • space.name: ชื่อทรัพยากรของพื้นที่ทำงานที่มีการโพสต์ข้อความ (spaces/{space}) รองรับเฉพาะ = หากไม่ได้ตั้งค่าตัวกรองนี้ ระบบจะค้นหาในข้อความส่วนตัวและพื้นที่ทำงานทั้งหมดที่ผู้ใช้มีสิทธิ์เข้าถึงในฐานะสมาชิกของพื้นที่ทำงาน
  • space.display_name: รองรับโอเปอเรเตอร์ : (มี) และกรองพื้นที่ทำงานตามการจับคู่บางส่วนของชื่อที่แสดง ผลการค้นหาจะจำกัดเฉพาะพื้นที่ทำงานที่ตรงกัน 5 อันดับแรก เช่น space.display_name:Project จะค้นหาข้อความในพื้นที่ทำงาน 5 อันดับแรกที่มีคำว่า "Project" ในชื่อที่แสดง
  • space.space_type: ประเภทของพื้นที่ทำงาน รองรับเฉพาะ = เท่านั้น เช่น space.space_type="DIRECT_MESSAGE" จะแสดงเฉพาะข้อความจากข้อความส่วนตัวเท่านั้น ค่าที่เป็นไปได้คือ DIRECT_MESSAGE, GROUP_CHAT และ SPACE
  • attachment: รองรับโอเปอเรเตอร์ :* (มี) เพื่อตรวจสอบว่ามีไฟล์แนบหรือไม่ หากระบุ attachment:* ระบบจะแสดงเฉพาะข้อความที่มีไฟล์แนบอย่างน้อย 1 ไฟล์
  • annotations.user_mentions.user.name: ชื่อทรัพยากรของผู้ใช้ที่กล่าวถึง (users/{user}) รองรับเฉพาะ : (มี) เช่น annotations.user_mentions.user.name:"users/1234567890" จะแสดงเฉพาะข้อความที่มีการพูดถึงผู้ใช้ที่ระบุเท่านั้น หรือจะใช้นามแฝง me เพื่อกรองข้อความที่พูดถึงผู้ใช้ที่โทรก็ได้ เช่น annotations.user_mentions.user.name:users/me นอกจากนี้ คุณยังใช้อีเมลเป็นชื่อแทนสำหรับ {user} ได้ด้วย เช่น users/example@gmail.com

สำหรับการกรองขั้นสูง คุณยังใช้ฟังก์ชันต่อไปนี้ได้ด้วย

  • has_link(): แสดงเฉพาะข้อความที่มีไฮเปอร์ลิงก์อย่างน้อย 1 รายการในข้อความ
  • is_unread(): กรองข้อความที่ผู้ใช้ที่โทรเข้ามาอ่านแล้วออก

การใช้ตัวกรอง space.display_name หรือ space.space_type กำหนดให้ข้อมูลเข้าสู่ระบบการเรียกต้องมีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

การใช้ตัวกรอง is_unread() กำหนดให้ข้อมูลเข้าสู่ระบบการเรียกต้องมีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate

ในช่องต่างๆ ระบบรองรับเฉพาะโอเปอเรเตอร์ AND เท่านั้น ตัวอย่างที่ถูกต้องคือ sender.name = "users/1234567890" AND is_unread() คำว่า AND เป็นคำที่ไม่บังคับและจะถือว่ามีอยู่หากละไว้ ตัวอย่างเช่น sender.name = "users/1234567890" is_unread() เป็นค่าที่ถูกต้องและเทียบเท่ากับตัวอย่างก่อนหน้า ตัวอย่างที่ไม่ถูกต้องคือ sender.name = "users/1234567890" OR is_unread() เนื่องจากระบบไม่รองรับ OR ระหว่างช่องต่างๆ

ในช่องเดียวกัน

  • create_time รองรับเฉพาะ AND และใช้เพื่อแสดงช่วงเวลาเท่านั้น เช่น create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00"
  • sender.name รองรับเฉพาะโอเปอเรเตอร์ OR เช่น sender.name = "users/1234567890" OR sender.name = "users/0987654321"
  • space.name รองรับเฉพาะโอเปอเรเตอร์ OR เช่น space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI"
  • space.display_name รองรับโอเปอเรเตอร์ AND และ OR แต่ไม่รองรับการใช้ทั้ง 2 อย่างร่วมกัน ตัวอย่างเช่น space.display_name:Project AND space.display_name:Tasks จะแสดงข้อความที่อยู่ในพื้นที่ทำงานซึ่งมีชื่อที่แสดงซึ่งมีทั้ง Project และ Tasks ส่วน space.display_name:Project OR space.display_name:Tasks จะแสดงข้อความที่อยู่ในพื้นที่ทำงานซึ่งมีชื่อที่แสดงซึ่งมี Project หรือ Tasks หรือทั้ง 2 อย่าง
  • space.space_type รองรับเฉพาะโอเปอเรเตอร์ OR เช่น space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT"
  • annotations.user_mentions.user.name รองรับโอเปอเรเตอร์ AND และ OR แต่ไม่รองรับทั้ง 2 อย่างผสมกัน เช่น annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" จะแสดงเฉพาะข้อความที่พูดถึงผู้ใช้ทั้ง 2 ราย ส่วน annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" จะแสดงข้อความที่พูดถึงผู้ใช้รายใดรายหนึ่งหรือทั้ง 2 ราย

ต้องใช้วงเล็บเพื่อแก้ความกำกวมของลำดับความสำคัญของโอเปอเรเตอร์เมื่อรวมโอเปอเรเตอร์ AND และ OR ไว้ในคำค้นหาเดียวกัน ตัวอย่างเช่น (sender.name="users/me" OR sender.name="users/123456") AND is_unread() หรือจะใส่วงเล็บหรือไม่ก็ได้

ตัวอย่างคำค้นหาต่อไปนี้ถูกต้อง

"Pending reports" AND create_time >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (create_time < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

ความยาวสูงสุดของคำค้นหาคือ 1,000 อักขระ

เซิร์ฟเวอร์จะปฏิเสธคำค้นหาที่ไม่ถูกต้องพร้อมข้อผิดพลาด INVALID_ARGUMENT
page_size

int32

ไม่บังคับ จำนวนผลลัพธ์สูงสุดที่จะแสดง บริการอาจแสดงผลลัพธ์น้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลไม่เกิน 25 รายการ

ค่าสูงสุดคือ 100 หากคุณใช้ค่ามากกว่า 100 ระบบจะเปลี่ยนค่าเป็น 100 โดยอัตโนมัติ
page_token

string

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

เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ระบุโทเค็นหน้าเว็บ การส่งค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทําให้เกิดผลลัพธ์ที่ไม่คาดคิด
order_by

string

ไม่บังคับ วิธีจัดเรียงรายการผลการค้นหา

แอตทริบิวต์ที่รองรับสำหรับการจัดเรียงตามมีดังนี้

การเรียงลำดับเริ่มต้นคือ create_time desc รองรับคำสั่งซื้อเพียงรายการเดียวต่อคำค้นหา (create_time หรือ relevance) ระบบรองรับเฉพาะลำดับจากมากไปน้อย (desc) และต้องระบุหลังแอตทริบิวต์ลำดับ
markup_syntax

MarkupSyntax

ไม่บังคับ ระบุไวยากรณ์เอาต์พุตที่ต้องการสำหรับช่อง formatted_text ของข้อความแชท
view

SearchMessagesView

ไม่บังคับ ระบุประเภทของมุมมองผลการค้นหาที่จะแสดงผล โดยมีค่าเริ่มต้นเป็น SEARCH_MESSAGES_VIEW_BASIC

SearchMessagesView

ประเภทของมุมมองที่รองรับสำหรับผลการค้นหาบางส่วน

Enum
SEARCH_MESSAGES_VIEW_UNSPECIFIED ค่าเริ่มต้น / ค่าที่ไม่ได้ตั้งค่า API จะใช้มุมมอง BASIC เป็นค่าเริ่มต้น
SEARCH_MESSAGES_VIEW_BASIC รวมเฉพาะข้อความที่ตรงกันในผลลัพธ์ แต่ไม่มีข้อมูลเมตาเพิ่มเติม นี่คือค่าเริ่มต้น
SEARCH_MESSAGES_VIEW_FULL รวมทุกอย่างในผลลัพธ์ ได้แก่ ข้อความที่ตรงกันและข้อมูลเมตาเพิ่มเติม

SearchMessagesResponse

ข้อความตอบกลับสำหรับการค้นหาข้อความ

ช่อง
results[]

SearchMessageResult

รายการผลการค้นหาที่ตรงกับคำค้นหา
next_page_token

string

โทเค็นที่ใช้ดึงข้อมูลหน้าถัดไปได้ หากช่องนี้ว่างเปล่า แสดงว่าไม่มีหน้าถัดไป

SearchSpacesRequest

คำขอค้นหารายการพื้นที่ทำงานตามคำค้นหา

ช่อง
use_admin_access

bool

เมื่อ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการการสนทนาในแชทและพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.spaces.readonly หรือ chat.admin.spaces
page_size

int32

จำนวนพื้นที่ทำงานสูงสุดที่จะแสดงผล บริการอาจแสดงผลลัพธ์น้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลพื้นที่ทำงานไม่เกิน 100 รายการ

ค่าสูงสุดคือ 1,000 เมื่อตั้งค่า useAdminAccess เป็น true ไม่เช่นนั้น ค่าสูงสุดจะเป็น 100 หากคุณใช้ค่าที่มากกว่าค่าสูงสุด ระบบจะเปลี่ยนค่าดังกล่าวเป็นค่าสูงสุดโดยอัตโนมัติ
page_token

string

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

เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุควรตรงกับการเรียกที่ระบุโทเค็นหน้าเว็บ การส่งค่าที่แตกต่างกันไปยังพารามิเตอร์อื่นๆ อาจทําให้เกิดผลลัพธ์ที่ไม่คาดคิด
query

string

ต้องระบุ คำค้นหา

คุณสามารถค้นหาโดยใช้พารามิเตอร์ต่อไปนี้เมื่อตั้งค่า useAdminAccess เป็น true

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

เมื่อตั้งค่า useAdminAccess เป็น false

  • display_name
  • external_user_allowed
  • space_type

create_time และ last_active_time ยอมรับการประทับเวลาในรูปแบบ RFC-3339 และตัวดำเนินการเปรียบเทียบที่รองรับ ได้แก่ =, <, >, <=, >=

ต้องระบุ customer เมื่อตั้งค่า useAdminAccess เป็น true และใช้เพื่อระบุลูกค้าที่จะดึงข้อมูลพื้นที่ทำงาน customers/my_customer เป็นค่าเดียวที่รองรับ

display_name ยอมรับเฉพาะโอเปอเรเตอร์ HAS (:) เท่านั้น ระบบจะแยกข้อความที่ต้องการจับคู่ออกเป็นโทเค็นก่อน จากนั้นจะจับคู่คำนำหน้าของแต่ละโทเค็นโดยไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ และจับคู่เป็นสตริงย่อยที่ใดก็ได้ใน display_name ของพื้นที่ทำงานอย่างเป็นอิสระ เช่น Fun Eve จะตรงกับ Fun event หรือ The evening was fun แต่ไม่ตรงกับ notFun event หรือ even เมื่อตั้งค่า useAdminAccess เป็น false คุณต้องระบุ display_name เพื่อให้ได้ผลลัพธ์ที่มีความหมาย ไม่เช่นนั้น ลักษณะการทำงานเริ่มต้นคือการแสดงคำตอบที่ว่างเปล่า

external_user_allowed ยอมรับ true หรือ false

space_history_state ยอมรับเฉพาะค่าจากช่อง historyState ของทรัพยากร space เท่านั้น

ต้องระบุ space_type และค่าที่ถูกต้องเพียงค่าเดียวคือ SPACE

ในช่องต่างๆ ระบบรองรับเฉพาะโอเปอเรเตอร์ AND เท่านั้น ตัวอย่างที่ถูกต้องคือ space_type = "SPACE" AND display_name:"Hello" และตัวอย่างที่ไม่ถูกต้องคือ space_type = "SPACE" OR display_name:"Hello"

ในช่องเดียวกัน space_type ไม่รองรับโอเปอเรเตอร์ AND หรือ OR display_name, 'space_history_state' และ 'external_user_allowed' รองรับเฉพาะโอเปอเรเตอร์ OR เท่านั้น last_active_time และ create_time รองรับทั้งโอเปอเรเตอร์ AND และ OR AND ใช้เพื่อแสดงช่วงเวลาได้เท่านั้น เช่น last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"

ตัวอย่างการค้นหาต่อไปนี้จะใช้ได้เมื่อตั้งค่า useAdminAccess เป็น true

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")

ตัวอย่างการค้นหาต่อไปนี้จะใช้ได้เมื่อตั้งค่า useAdminAccess เป็น false

display_name:"Hello World" AND space_type = "SPACE"

(display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"

(external_user_allowed = "true" AND space_type = "SPACE") // Returns an
empty response.

(external_user_allowed = "true" AND display_name:"Hello" AND space_type =
"SPACE")

ความยาวสูงสุดของคำค้นหาคือ 1,000 อักขระ

เซิร์ฟเวอร์จะปฏิเสธคำค้นหาที่ไม่ถูกต้องพร้อมข้อผิดพลาด INVALID_ARGUMENT
order_by

string

ไม่บังคับ วิธีจัดเรียงรายการพื้นที่ทำงาน

แอตทริบิวต์ที่รองรับสำหรับการจัดเรียงตามมีดังนี้

  • membership_count.joined_direct_human_user_count - แสดงจำนวนผู้ใช้ที่เป็นมนุษย์ซึ่งเข้าร่วมพื้นที่ทำงานโดยตรง
  • last_active_time — แสดงเวลาที่มีการเพิ่มรายการที่มีสิทธิ์ล่าสุดลงในหัวข้อใดๆ ของพื้นที่ทำงานนี้
  • create_time — แสดงเวลาที่สร้างพื้นที่ทำงาน

เมื่อ useAdminAccess เป็น false ระบบจะรองรับเฉพาะ create_time และ relevance สำหรับการสั่งซื้อ รองรับเฉพาะ DESC สำหรับช่องเหล่านี้ในการค้นหาที่ไม่ใช่ของผู้ดูแลระบบ

ค่าการดำเนินการจัดลำดับที่ถูกต้องมีดังนี้

  • ASC สำหรับการเรียงลำดับจากน้อยไปมาก ค่าเริ่มต้น

  • DESC เพื่อเรียงจากมากไปน้อย

ไวยากรณ์ที่รองรับเมื่อตั้งค่า useAdminAccess เป็น true มีดังนี้

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

เมื่อตั้งค่า useAdminAccess เป็น false

SearchSpacesResponse

การตอบกลับพร้อมรายการพื้นที่ทำงานที่สอดคล้องกับคำขอค้นหาพื้นที่ทำงาน

ช่อง
spaces[]
(deprecated)

Space

เลิกใช้งานแล้ว: โปรดใช้ช่อง results ใหม่แทน หน้าของพื้นที่ทำงานที่ขอ ระบบจะป้อนข้อมูลในช่องนี้ก็ต่อเมื่อตั้งค่า useAdminAccess เป็น true และเลิกใช้งานเพื่อใช้ช่อง results ใหม่แทน
next_page_token

string

โทเค็นที่ใช้ดึงข้อมูลหน้าถัดไปได้ หากช่องนี้ว่างเปล่า แสดงว่าไม่มีหน้าถัดไป

จะป้อนข้อมูลเมื่อตั้งค่า useAdminAccess เป็น true เท่านั้น
total_size

int32

จำนวนพื้นที่ทำงานทั้งหมดที่ตรงกับคำค้นหาในทุกหน้า หากผลลัพธ์มีพื้นที่ทำงานมากกว่า 10,000 รายการ ค่านี้จะเป็นค่าประมาณ

จะป้อนข้อมูลเมื่อตั้งค่า useAdminAccess เป็น true เท่านั้น
results[]

SearchSpaceResult

เอาต์พุตเท่านั้น รายการผลการค้นหาที่ตรงกับคำค้นหา

SearchSpaceResult

รายการผลการค้นหารายการเดียวจากการค้นหาพื้นที่ทำงาน

ช่อง
space

Space

เอาต์พุตเท่านั้น พื้นที่ทำงานที่ตรงกัน

ส่วน

แสดงส่วนใน Google Chat ส่วนต่างๆ จะช่วยให้ผู้ใช้จัดระเบียบพื้นที่ทำงานได้ ส่วนมี 2 ประเภท ได้แก่

  1. ส่วนของระบบ: ส่วนที่กำหนดไว้ล่วงหน้าซึ่งจัดการโดย Google Chat ชื่อทรัพยากรจะคงที่ และไม่สามารถสร้าง ลบ หรือแก้ไข display_name ได้ ตัวอย่างเช่น

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps

  2. หมวดที่กำหนดเอง: หมวดเหล่านี้สร้างและจัดการโดยผู้ใช้ การสร้างหมวดที่กำหนดเองโดยใช้ CreateSection ต้องใช้ display_name คุณอัปเดตหมวดที่กำหนดเองได้โดยใช้ UpdateSection และลบได้โดยใช้ DeleteSection

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของส่วน

สำหรับส่วนของระบบ รหัสส่วนจะเป็นสตริงคงที่ ดังนี้

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

รูปแบบ: users/{user}/sections/{section}
display_name

string

ไม่บังคับ ชื่อที่แสดงของส่วน จะป้อนข้อมูลสำหรับส่วนของประเภท CUSTOM_SECTION เท่านั้น รองรับอักขระได้สูงสุด 80 ตัว ต้องระบุเมื่อสร้าง CUSTOM_SECTION
sort_order

int32

เอาต์พุตเท่านั้น ลำดับของส่วนที่เกี่ยวข้องกับส่วนอื่นๆ ส่วนที่มีค่า sort_order ต่ำกว่าจะปรากฏก่อนส่วนที่มีค่าสูงกว่า
type

SectionType

ต้องระบุ ประเภทของส่วน

SectionType

ประเภทส่วน

Enum
SECTION_TYPE_UNSPECIFIED ประเภทส่วนที่ไม่ได้ระบุ
CUSTOM_SECTION หมวดที่กำหนดเอง
DEFAULT_DIRECT_MESSAGES ส่วนเริ่มต้นที่มี DIRECT_MESSAGE ระหว่างผู้ใช้ที่เป็นมนุษย์ 2 คนหรือพื้นที่ทำงาน GROUP_CHAT ที่ไม่ได้อยู่ในหมวดที่กำหนดเอง
DEFAULT_SPACES พื้นที่ทำงานเริ่มต้นที่ไม่ได้อยู่ในหมวดที่กำหนดเอง
DEFAULT_APPS ส่วนเริ่มต้นที่มีแอปที่ติดตั้งของผู้ใช้

SectionItem

รายการส่วนที่ผู้ใช้กำหนด ซึ่งใช้เพื่อแสดงรายการในส่วน เช่น พื้นที่ทำงาน ที่จัดกลุ่มไว้ใต้ส่วน

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของรายการในส่วน

รูปแบบ: users/{user}/sections/{section}/items/{item}
ฟิลด์ Union item ต้องระบุ รายการในส่วน item ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
space

string

ไม่บังคับ ชื่อทรัพยากรของพื้นที่ทำงาน

รูปแบบ: spaces/{space}

SetUpSpaceRequest

ส่งคำขอสร้างพื้นที่ทำงานและเพิ่มผู้ใช้ที่ระบุลงในพื้นที่ทำงาน

ช่อง
space

Space

ต้องระบุ ต้องระบุข้อมูลในช่อง Space.spaceType

หากต้องการสร้างพื้นที่ทำงาน ให้ตั้งค่า Space.spaceType เป็น SPACE และตั้งค่า Space.displayName หากได้รับข้อความแสดงข้อผิดพลาด ALREADY_EXISTS เมื่อตั้งค่าพื้นที่ทำงาน ให้ลองใช้ displayName อื่น พื้นที่ทำงานที่มีอยู่ภายในองค์กร Google Workspace อาจใช้ชื่อที่แสดงนี้อยู่แล้ว

หากต้องการสร้างแชทเป็นกลุ่ม ให้ตั้งค่า Space.spaceType เป็น GROUP_CHAT ไม่ต้องตั้งค่า Space.displayName

หากต้องการสร้างการสนทนาแบบ 1:1 ระหว่างมนุษย์ ให้ตั้งค่า Space.spaceType เป็น DIRECT_MESSAGE และตั้งค่า Space.singleUserBotDm เป็น false อย่าตั้งค่า Space.displayName หรือ Space.spaceDetails

หากต้องการสร้างการสนทนาแบบ 1:1 ระหว่างมนุษย์กับแอปใน Chat ที่โทร ให้ตั้งค่า Space.spaceType เป็น DIRECT_MESSAGE และ Space.singleUserBotDm เป็น true อย่าตั้งค่า Space.displayName หรือ Space.spaceDetails

หากมีพื้นที่ทำงาน DIRECT_MESSAGE อยู่แล้ว ระบบจะแสดงพื้นที่ทำงานนั้นแทนการสร้างพื้นที่ทำงานใหม่
request_id

string

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

วิธีใช้ช่องนี้อย่างมีประสิทธิภาพ

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

Membership

ไม่บังคับ ผู้ใช้หรือกลุ่ม Google Chat ที่จะเชิญให้เข้าร่วมพื้นที่ทำงาน ไม่ต้องระบุผู้ใช้ที่โทร เนื่องจากระบบจะเพิ่มผู้ใช้ดังกล่าวโดยอัตโนมัติ

ปัจจุบันชุดนี้อนุญาตให้มีสมาชิกได้สูงสุด 49 คน (นอกเหนือจากผู้โทร)

สำหรับการเป็นสมาชิกของบุคคล ช่อง Membership.member ต้องมี user ที่มี name ป้อนอยู่ (รูปแบบ: users/{user}) และตั้งค่า type เป็น User.Type.HUMAN คุณจะเพิ่มได้เฉพาะผู้ใช้ที่เป็นมนุษย์เมื่อตั้งค่าพื้นที่ทำงาน (ระบบรองรับการเพิ่มแอปใน Chat สำหรับการตั้งค่าข้อความส่วนตัวด้วยแอปการโทรเท่านั้น) นอกจากนี้ คุณยังเพิ่มสมาชิกโดยใช้อีเมลของผู้ใช้เป็นอีเมลแทนสำหรับ {user} ได้ด้วย เช่น user.name อาจเป็น users/example@gmail.com หากต้องการเชิญผู้ใช้ Gmail หรือผู้ใช้จากโดเมน Google Workspace ภายนอก คุณต้องใช้อีเมลของผู้ใช้สำหรับ {user}

สำหรับการเป็นสมาชิกกลุ่ม Google ช่อง Membership.group_member ต้องมี group ที่มี name ป้อนอยู่ (รูปแบบ groups/{group}) คุณจะเพิ่มกลุ่ม Google ได้ก็ต่อเมื่อตั้งค่า Space.spaceType เป็น SPACE เท่านั้น

ไม่บังคับเมื่อตั้งค่า Space.spaceType เป็น SPACE

ต้องระบุเมื่อตั้งค่า Space.spaceType เป็น GROUP_CHAT พร้อมกับการเป็นสมาชิกอย่างน้อย 2 รายการ

ต้องระบุเมื่อตั้งค่า Space.spaceType เป็น DIRECT_MESSAGE กับผู้ใช้ที่เป็นมนุษย์ พร้อมกับการเป็นสมาชิก 1 รายการ

ต้องเว้นว่างไว้เมื่อสร้างการสนทนาแบบ 1:1 ระหว่างมนุษย์กับแอป Chat ที่โทร (เมื่อตั้งค่า Space.spaceType เป็น DIRECT_MESSAGE และ Space.singleUserBotDm เป็น true)

SlashCommand

ข้อมูลเมตาเกี่ยวกับคำสั่งเครื่องหมายทับใน Google Chat

ช่อง
command_id

int64

รหัสของคำสั่งเครื่องหมายทับ

SlashCommandMetadata

ข้อมูลเมตาของคำอธิบายประกอบสำหรับคำสั่งเครื่องหมายทับ (/)

ช่อง
bot

User

แอปใน Chat ที่มีการเรียกใช้คำสั่ง
type

Type

ประเภทของคำสั่งเครื่องหมายทับ
command_name

string

ชื่อของคำสั่งเครื่องหมายทับที่เรียกใช้
command_id

int64

รหัสคำสั่งของคำสั่งเครื่องหมายทับที่เรียกใช้
triggers_dialog

bool

ระบุว่าคำสั่งเครื่องหมายทับมีไว้สำหรับกล่องโต้ตอบหรือไม่

ประเภท

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum ไม่ใช้
ADD เพิ่มแอปใน Chat ไปยังพื้นที่ทำงาน
INVOKE เรียกใช้คำสั่งเครื่องหมายทับในพื้นที่ทำงาน

Space

พื้นที่ทำงานใน Google Chat พื้นที่ทำงานคือการสนทนาระหว่างผู้ใช้ตั้งแต่ 2 คนขึ้นไป หรือข้อความแบบ 1:1 ระหว่างผู้ใช้กับแอปใน Chat

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของพื้นที่ทำงาน

รูปแบบ: spaces/{space}

โดย {space} คือรหัสที่ระบบกำหนดให้กับพื้นที่ทำงาน คุณสามารถดูรหัสพื้นที่ทำงานได้โดยเรียกใช้เมธอด spaces.list() หรือจาก URL ของพื้นที่ทำงาน เช่น หาก URL ของพื้นที่ทำงานคือ https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA รหัสพื้นที่ทำงานจะเป็น AAAAAAAAA
type
(deprecated)

Type

เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: โปรดใช้ space_type แทน ประเภทของพื้นที่ทำงาน
space_type

SpaceType

ไม่บังคับ ประเภทของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานหรืออัปเดตประเภทพื้นที่ทำงานของพื้นที่ทำงาน เอาต์พุตสำหรับการใช้งานอื่นๆ เท่านั้น
single_user_bot_dm

bool

ไม่บังคับ พื้นที่ทำงานเป็น DM ระหว่างแอปใน Chat กับมนุษย์คนเดียวหรือไม่
threaded
(deprecated)

bool

เอาต์พุตเท่านั้น เลิกใช้งานแล้ว: โปรดใช้ spaceThreadingState แทน ระบุว่าข้อความในพื้นที่ทำงานนี้แยกเป็นชุดข้อความหรือไม่
display_name

string

ไม่บังคับ ชื่อที่แสดงของพื้นที่ทำงาน ต้องระบุเมื่อสร้างพื้นที่ทำงานที่มี spaceType เป็น SPACE หากได้รับข้อความแสดงข้อผิดพลาด ALREADY_EXISTS เมื่อสร้างพื้นที่ทำงานหรืออัปเดต displayName ให้ลองใช้ displayName อื่น พื้นที่ทำงานที่มีอยู่ภายในองค์กร Google Workspace อาจใช้ชื่อที่แสดงนี้อยู่แล้ว

สำหรับข้อความส่วนตัว ช่องนี้อาจว่างเปล่า

รองรับอักขระได้สูงสุด 128 ตัว
external_user_allowed

bool

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

  • ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วใช้บัญชีผู้ใช้ทั่วไป (บัญชีผู้ใช้ที่ไม่มีการจัดการ) โดยค่าเริ่มต้น พื้นที่ทำงานที่สร้างโดยบัญชีผู้ใช้ทั่วไปจะอนุญาตผู้ใช้ Google Chat ทุกคน

สำหรับพื้นที่ทำงานที่มีอยู่ ช่องนี้จะเป็นเอาต์พุตเท่านั้น
space_threading_state

SpaceThreadingState

เอาต์พุตเท่านั้น สถานะชุดข้อความในพื้นที่ทำงานใน Chat
space_details

SpaceDetails

ไม่บังคับ รายละเอียดเกี่ยวกับพื้นที่ทำงาน รวมถึงคำอธิบายและกฎ
space_history_state

HistoryState

ไม่บังคับ สถานะประวัติข้อความสำหรับข้อความและชุดข้อความในพื้นที่ทำงานนี้
import_mode

bool

ไม่บังคับ พื้นที่ทำงานนี้สร้างขึ้นใน Import Mode โดยเป็นส่วนหนึ่งของการย้ายข้อมูลไปยัง Google Workspace หรือไม่ ขณะที่ระบบกำลังนำเข้าพื้นที่ทำงาน ผู้ใช้จะไม่เห็นพื้นที่ทำงานเหล่านั้นจนกว่าการนำเข้าจะเสร็จสมบูรณ์

การสร้างพื้นที่ทำงานใน Import Mode ต้องมีการตรวจสอบสิทธิ์ของผู้ใช้
create_time

Timestamp

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

สำหรับพื้นที่ทำงานในโหมดนำเข้า ให้ตั้งค่าช่องนี้เป็นการประทับเวลาที่ผ่านมาซึ่งมีการสร้างพื้นที่ทำงานในแหล่งที่มาเพื่อรักษาเวลาที่สร้างเดิมไว้

จะป้อนข้อมูลในเอาต์พุตเมื่อ spaceType เป็น GROUP_CHAT หรือ SPACE เท่านั้น
last_active_time

Timestamp

เอาต์พุตเท่านั้น การประทับเวลาของข้อความล่าสุดในพื้นที่ทำงาน
admin_installed

bool

เอาต์พุตเท่านั้น สำหรับพื้นที่ทำงานของข้อความส่วนตัว (DM) ที่มีแอปใน Chat ให้ระบุว่าผู้ดูแลระบบ Google Workspace เป็นผู้สร้างพื้นที่ทำงานหรือไม่ ผู้ดูแลระบบสามารถติดตั้งและตั้งค่าข้อความส่วนตัวด้วยแอปใน Chat ในนามของผู้ใช้ในองค์กรได้

แอปใน Chat ต้องมีฟีเจอร์การรับส่งข้อความส่วนตัวเพื่อรองรับการติดตั้งโดยผู้ดูแลระบบ
membership_count

MembershipCount

เอาต์พุตเท่านั้น จำนวนการเป็นสมาชิกที่เข้าร่วมซึ่งจัดกลุ่มตามประเภทสมาชิก ระบบจะป้อนข้อมูลเมื่อ space_type เป็น SPACE, DIRECT_MESSAGE หรือ GROUP_CHAT
access_settings

AccessSettings

ไม่บังคับ ระบุการตั้งค่าการเข้าถึงของพื้นที่ทำงาน จะป้อนข้อมูลเมื่อ space_type เป็น SPACE เท่านั้น
space_uri

string

เอาต์พุตเท่านั้น URI สำหรับให้ผู้ใช้เข้าถึงพื้นที่ทำงาน
import_mode_expire_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่ระบบจะลบพื้นที่ทำงานโดยอัตโนมัติหากยังคงอยู่ในโหมดการนำเข้า

พื้นที่ทำงานแต่ละรายการที่สร้างในโหมดการนำเข้าต้องออกจากโหมดนี้ก่อนเวลาหมดอายุโดยใช้ spaces.completeImport

ระบบจะป้อนข้อมูลในช่องนี้สำหรับพื้นที่ทำงานที่สร้างด้วยโหมดการนำเข้าเท่านั้น
customer

string

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

ในรูปแบบ customers/{customer} โดยที่ customer คือ id จากทรัพยากรลูกค้า Admin SDK แอปส่วนตัวยังสามารถใช้นามแฝง customers/my_customer เพื่อสร้างพื้นที่ทำงานในองค์กร Google Workspace เดียวกันกับแอปได้ด้วย

ระบบจะไม่ป้อนข้อมูลในช่องนี้สำหรับข้อความส่วนตัว (DM) หรือเมื่อผู้ใช้ที่ไม่ได้ใช้ Google Workspace เป็นผู้สร้างพื้นที่ทำงาน
ฟิลด์ Union space_permission_settings แสดงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน จะป้อนข้อมูลเมื่อ space_type เป็น SPACE เท่านั้น space_permission_settings ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
predefined_permission_settings

PredefinedPermissionSettings

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

การตั้งค่ากลุ่มสิทธิ์ที่กำหนดไว้ล่วงหน้าจะรองรับสิ่งต่อไปนี้
permission_settings

PermissionSettings

ไม่บังคับ การตั้งค่าสิทธิ์ของพื้นที่ทำงานสำหรับพื้นที่ทำงานที่มีอยู่ ข้อมูลสำหรับการอัปเดตการตั้งค่าสิทธิ์ของพื้นที่ทำงานที่แน่นอน ซึ่งจะแทนที่การตั้งค่าสิทธิ์ที่มีอยู่ เอาต์พุตจะแสดงการตั้งค่าสิทธิ์ปัจจุบัน

การอ่านและการอัปเดตการตั้งค่าสิทธิ์รองรับสิ่งต่อไปนี้

AccessPermissionSetting

การตั้งค่าสิทธิ์การเข้าถึง

ช่อง
principals[]

Principal

ไม่บังคับ รายการที่ไม่เรียงลำดับ ผู้ใช้ที่ได้รับอนุญาตสำหรับสิทธิ์นี้

AccessPermissionSettings

การตั้งค่าสิทธิ์การเข้าถึงสำหรับพื้นที่ทำงาน

ช่อง
discover_space_setting

AccessPermissionSetting

ไม่บังคับ การตั้งค่าสิทธิ์เข้าถึงสำหรับการค้นพบพื้นที่ทำงาน
join_space_setting

AccessPermissionSetting

ไม่บังคับ การตั้งค่าสิทธิ์เข้าถึงสำหรับการเข้าร่วมพื้นที่ทำงาน
view_space_membership_setting

AccessPermissionSetting

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

AccessSettings

แสดงการตั้งค่าการเข้าถึงของพื้นที่ทำงาน

ช่อง
access_state

AccessState

เอาต์พุตเท่านั้น ระบุสถานะการเข้าถึงของพื้นที่ทำงาน
audience

string

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

รูปแบบ: audiences/{audience}

หากต้องการใช้กลุ่มเป้าหมายเริ่มต้นสำหรับองค์กร Google Workspace ให้ตั้งค่าเป็น audiences/default

การอ่านการรองรับกลุ่มเป้าหมาย:

ระบบจะไม่ป้อนข้อมูลในช่องนี้เมื่อใช้ขอบเขต chat.bot กับการตรวจสอบสิทธิ์แอป

การตั้งค่ากลุ่มเป้าหมายต้องมีการตรวจสอบสิทธิ์ของผู้ใช้
access_permission_settings

AccessPermissionSettings

ไม่บังคับ การตั้งค่าสิทธิ์เข้าถึงสำหรับพื้นที่ทำงาน

หากต้องการตั้งค่ากลุ่มเป้าหมายเมื่อสร้างพื้นที่ทำงาน ให้ระบุช่อง accessSettings.audience ในคำขอ

AccessState

แสดงสถานะการเข้าถึงของพื้นที่ทำงาน

Enum
ACCESS_STATE_UNSPECIFIED ไม่ทราบสถานะการเข้าถึงหรือไม่รองรับใน API นี้
PRIVATE เฉพาะผู้ใช้หรือ Google Groups ที่ได้รับการเพิ่มหรือเชิญโดยผู้ใช้รายอื่นหรือผู้ดูแลระบบ Google Workspace เป็นรายบุคคลเท่านั้นที่จะค้นพบและเข้าถึงพื้นที่ทำงานได้
DISCOVERABLE

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

การสร้างพื้นที่ทำงานที่ค้นพบได้ต้องมีการตรวจสอบสิทธิ์ผู้ใช้

MembershipCount

แสดงจำนวนการเป็นสมาชิกของพื้นที่ทำงาน โดยแบ่งออกเป็นหมวดหมู่ต่างๆ

ช่อง
joined_direct_human_user_count

int32

เอาต์พุตเท่านั้น จำนวนผู้ใช้ที่เป็นมนุษย์ซึ่งเข้าร่วมพื้นที่ทำงานโดยตรง โดยไม่นับผู้ใช้ที่เข้าร่วมโดยการเป็นสมาชิกในกลุ่มที่เข้าร่วม
joined_group_count

int32

เอาต์พุตเท่านั้น จำนวนกลุ่มทั้งหมดที่เข้าร่วมพื้นที่ทำงานโดยตรง

PermissionSetting

แสดงการตั้งค่ากลุ่มสิทธิ์ของพื้นที่ทำงาน

ช่อง
managers_allowed

bool

ไม่บังคับ เจ้าของพื้นที่ทำงาน (ROLE_MANAGER) มีสิทธิ์นี้หรือไม่
members_allowed

bool

ไม่บังคับ สมาชิกพื้นที่ทำงานขั้นพื้นฐาน (ROLE_MEMBER) มีสิทธิ์นี้หรือไม่
assistant_managers_allowed

bool

ไม่บังคับ ผู้จัดการพื้นที่ทำงาน ROLE_ASSISTANT_MANAGER) มีสิทธิ์นี้หรือไม่

PermissionSettings

การตั้งค่าสิทธิ์ที่คุณระบุได้เมื่ออัปเดตพื้นที่ทำงานที่มีชื่ออยู่แล้ว

หากต้องการตั้งค่าสิทธิ์เมื่อสร้างพื้นที่ทำงาน ให้ระบุช่อง PredefinedPermissionSettings ในคำขอ

ช่อง
manage_members_and_groups

PermissionSetting

ไม่บังคับ การตั้งค่าสำหรับการจัดการสมาชิกและกลุ่มในพื้นที่ทำงาน
modify_space_details

PermissionSetting

ไม่บังคับ การตั้งค่าสำหรับการอัปเดตชื่อ รูปโปรไฟล์ คำอธิบาย และหลักเกณฑ์ของพื้นที่ทำงาน
toggle_history

PermissionSetting

ไม่บังคับ การตั้งค่าสำหรับการเปิดและปิดประวัติพื้นที่ทำงาน
use_at_mention_all

PermissionSetting

ไม่บังคับ การตั้งค่าสำหรับการใช้ @ทั้งหมด ในพื้นที่ทำงาน
manage_apps

PermissionSetting

ไม่บังคับ การตั้งค่าสำหรับการจัดการแอปในพื้นที่ทำงาน
manage_webhooks

PermissionSetting

ไม่บังคับ การตั้งค่าสำหรับการจัดการเว็บฮุคในพื้นที่ทำงาน
post_messages

PermissionSetting

เอาต์พุตเท่านั้น การตั้งค่าสำหรับการโพสต์ข้อความในพื้นที่ทำงาน
reply_messages

PermissionSetting

ไม่บังคับ การตั้งค่าสำหรับการตอบกลับข้อความในพื้นที่ทำงาน
view_space_membership

PermissionSetting

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

PredefinedPermissionSettings

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

Enum
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED ไม่ระบุ ไม่ใช้
COLLABORATION_SPACE การตั้งค่าเพื่อทำให้พื้นที่ทำงานเป็นพื้นที่สำหรับการทำงานร่วมกันซึ่งสมาชิกทุกคนสามารถโพสต์ข้อความได้
ANNOUNCEMENT_SPACE การตั้งค่าเพื่อทำให้พื้นที่ทำงานเป็นพื้นที่ประกาศซึ่งมีเพียงผู้จัดการพื้นที่ทำงานเท่านั้นที่โพสต์ข้อความได้

ผู้ใช้หลัก

ผู้ใช้หลักที่แสดงถึงเอนทิตีที่ได้รับสิทธิ์เข้าถึง

ช่อง
ฟิลด์ Union principal_type ประเภทของ Principal principal_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
audience

Audience

กลุ่มเป้าหมาย

SpaceDetails

รายละเอียดเกี่ยวกับพื้นที่ทำงาน รวมถึงคำอธิบายและกฎ

ช่อง
description

string

ไม่บังคับ คำอธิบายพื้นที่ทำงาน เช่น อธิบายหัวข้อการสนทนา วัตถุประสงค์การใช้งาน หรือผู้เข้าร่วมของพื้นที่ทำงาน

รองรับอักขระได้สูงสุด 4,096 ตัว
guidelines

string

ไม่บังคับ กฎ ความคาดหวัง และมารยาทของพื้นที่ทำงาน

รองรับอักขระได้สูงสุด 5,000 ตัว

SpaceThreadingState

ระบุประเภทสถานะชุดข้อความในพื้นที่ใน Chat

Enum
SPACE_THREADING_STATE_UNSPECIFIED Reserved.
THREADED_MESSAGES พื้นที่ทำงานที่รองรับชุดข้อความ เมื่อผู้ใช้ตอบกลับข้อความ ผู้ใช้สามารถตอบกลับในชุดข้อความ ซึ่งจะทำให้คำตอบอยู่ในบริบทของข้อความต้นฉบับ
GROUPED_MESSAGES พื้นที่ทำงานที่มีชื่อซึ่งจัดระเบียบการสนทนาตามหัวข้อ ระบบจะจัดกลุ่มหัวข้อและการตอบกลับไว้ด้วยกัน
UNTHREADED_MESSAGES

พื้นที่ทำงานที่ไม่รองรับชุดข้อความ สถานะชุดข้อความในพื้นที่ทำงานนี้ใช้สำหรับกรณีพิเศษเท่านั้น ซึ่งรวมถึงกรณีต่อไปนี้

  • แชทในการประชุมแบบต่อเนื่องที่ปิดชุดข้อความไว้โดยเจตนา
  • การสนทนากลุ่มแบบเดิมที่สร้างขึ้นก่อนปี 2022

SpaceType

ประเภทของพื้นที่ทำงาน ต้องระบุเมื่อสร้างหรืออัปเดตพื้นที่ทำงาน เอาต์พุตสำหรับการใช้งานอื่นๆ เท่านั้น

Enum
SPACE_TYPE_UNSPECIFIED Reserved.
SPACE พื้นที่ที่ผู้คนส่งข้อความ แชร์ไฟล์ และทำงานร่วมกัน SPACE สามารถมีแอปใน Chat ได้
GROUP_CHAT การสนทนากลุ่มระหว่างผู้คน 3 คนขึ้นไป GROUP_CHAT สามารถมีแอปใน Chat ได้
DIRECT_MESSAGE ข้อความแบบ 1:1 ระหว่างบุคคล 2 คน หรือระหว่างบุคคลกับแอปใน Chat

ประเภท

เลิกใช้งานแล้ว: โปรดใช้ SpaceType แทน

Enum
TYPE_UNSPECIFIED Reserved.
ROOM การสนทนาระหว่างมนุษย์ 2 คนขึ้นไป
DM ข้อความส่วนตัวแบบ 1:1 ระหว่างบุคคลกับแอปใน Chat ซึ่งข้อความทั้งหมดจะไม่มีการแยกชุดข้อความ โปรดทราบว่าการดำเนินการนี้ไม่รวมข้อความส่วนตัวระหว่างมนุษย์ 2 คน

SpaceBatchUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับการอัปเดตหลายรายการในพื้นที่ทำงาน

ประเภทเหตุการณ์: google.workspace.chat.space.v1.batchUpdated

ช่อง
spaces[]

SpaceUpdatedEventData

รายการพื้นที่ทำงานที่อัปเดต

SpaceEvent

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

ช่อง
name

string

ชื่อทรัพยากรของเหตุการณ์ในพื้นที่ทำงาน

รูปแบบ: spaces/{space}/spaceEvents/{spaceEvent}
event_time

Timestamp

เวลาที่เกิดเหตุการณ์
event_type

string

ประเภทเหตุการณ์ในพื้นที่ทำงาน เหตุการณ์แต่ละประเภทมีเวอร์ชันกลุ่ม ซึ่งแสดงอินสแตนซ์หลายรายการของประเภทเหตุการณ์ที่เกิดขึ้นในช่วงเวลาสั้นๆ สำหรับคำขอ spaceEvents.list() ให้ละเว้นประเภทเหตุการณ์แบบกลุ่มในตัวกรองการค้นหา โดยค่าเริ่มต้น เซิร์ฟเวอร์จะแสดงทั้งประเภทเหตุการณ์และเวอร์ชันกลุ่ม

ประเภทเหตุการณ์ที่รองรับสำหรับข้อความมีดังนี้

  • ข้อความใหม่: google.workspace.chat.message.v1.created
  • ข้อความที่อัปเดต: google.workspace.chat.message.v1.updated
  • ข้อความที่ลบ: google.workspace.chat.message.v1.deleted
  • ข้อความใหม่หลายรายการ: google.workspace.chat.message.v1.batchCreated
  • ข้อความที่อัปเดตหลายรายการ: google.workspace.chat.message.v1.batchUpdated
  • ข้อความที่ลบหลายรายการ: google.workspace.chat.message.v1.batchDeleted

ประเภทกิจกรรมที่รองรับสำหรับการเป็นสมาชิกมีดังนี้

  • การเป็นสมาชิกใหม่: google.workspace.chat.membership.v1.created
  • การเป็นสมาชิกที่อัปเดต: google.workspace.chat.membership.v1.updated
  • การเป็นสมาชิกที่ถูกลบ: google.workspace.chat.membership.v1.deleted
  • การเป็นสมาชิกใหม่หลายรายการ: google.workspace.chat.membership.v1.batchCreated
  • การเป็นสมาชิกที่อัปเดตหลายรายการ: google.workspace.chat.membership.v1.batchUpdated
  • การเป็นสมาชิกที่ถูกลบหลายรายการ: google.workspace.chat.membership.v1.batchDeleted

ประเภทเหตุการณ์ที่รองรับสำหรับรีแอ็กชันมีดังนี้

  • รีแอ็กชันใหม่: google.workspace.chat.reaction.v1.created
  • ลบรีแอ็กชันแล้ว: google.workspace.chat.reaction.v1.deleted
  • รีแอ็กชันใหม่หลายรายการ: google.workspace.chat.reaction.v1.batchCreated
  • รีแอ็กชันที่ลบหลายรายการ: google.workspace.chat.reaction.v1.batchDeleted

ประเภทเหตุการณ์ที่รองรับเกี่ยวกับพื้นที่ทำงานมีดังนี้

  • พื้นที่ทำงานที่อัปเดต: google.workspace.chat.space.v1.updated
  • การอัปเดตพื้นที่ทำงานหลายรายการ: google.workspace.chat.space.v1.batchUpdated

ฟิลด์ Union payload

payload ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
message_created_event_data

MessageCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความใหม่

ประเภทเหตุการณ์: google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดต

ประเภทเหตุการณ์: google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความที่ลบ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดตหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความที่ถูกลบหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับการอัปเดตพื้นที่ทำงาน

ประเภทเหตุการณ์: google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับการอัปเดตหลายรายการในพื้นที่ทำงาน

ประเภทเหตุการณ์: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกใหม่

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตแล้ว

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่อัปเดตหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับการเป็นสมาชิกที่ถูกลบหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับรีแอ็กชันใหม่

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ลบไปแล้ว

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data

ReactionBatchCreatedEventData

เพย์โหลดของเหตุการณ์สำหรับรีแอ็กชันใหม่หลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

เพย์โหลดของเหตุการณ์สำหรับรีแอ็กชันที่ถูกลบหลายรายการ

ประเภทเหตุการณ์: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

การตั้งค่าการแจ้งเตือนของผู้ใช้ในพื้นที่ทำงาน

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน รูปแบบ: users/{user}/spaces/{space}/spaceNotificationSetting
notification_setting

NotificationSetting

การตั้งค่าการแจ้งเตือน
mute_setting

MuteSetting

การตั้งค่าการปิดเสียงการแจ้งเตือนของพื้นที่ทำงาน

MuteSetting

ประเภทการตั้งค่าการปิดเสียงการแจ้งเตือนของพื้นที่ทำงาน

Enum
MUTE_SETTING_UNSPECIFIED Reserved.
UNMUTED ผู้ใช้จะได้รับการแจ้งเตือนสำหรับพื้นที่ทำงานตามการตั้งค่าการแจ้งเตือน
MUTED ผู้ใช้จะไม่ได้รับการแจ้งเตือนใดๆ สำหรับพื้นที่ทำงาน ไม่ว่าจะตั้งค่าการแจ้งเตือนไว้อย่างไรก็ตาม

NotificationSetting

ประเภทการตั้งค่าการแจ้งเตือน เราอาจรองรับประเภทอื่นๆ ในอนาคต

Enum
NOTIFICATION_SETTING_UNSPECIFIED Reserved.
ALL การแจ้งเตือนจะทริกเกอร์โดยการ @พูดถึง, ชุดข้อความที่ติดตาม, ข้อความแรกของชุดข้อความใหม่ ระบบจะติดตามชุดข้อความใหม่ทั้งหมดโดยอัตโนมัติ เว้นแต่ผู้ใช้จะเลิกติดตามด้วยตนเอง
MAIN_CONVERSATIONS การแจ้งเตือนจะทริกเกอร์โดยการ @พูดถึง, ชุดข้อความที่ติดตาม, ข้อความแรกของชุดข้อความใหม่ ใช้ไม่ได้กับข้อความส่วนตัวแบบ 1:1
FOR_YOU การแจ้งเตือนจะทริกเกอร์โดยการ @พูดถึง และชุดข้อความที่ติดตาม ใช้ไม่ได้กับข้อความส่วนตัวแบบ 1:1
OFF การแจ้งเตือนปิดอยู่

SpaceReadState

สถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงาน ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน

ช่อง
name

string

ชื่อทรัพยากรของสถานะการอ่านพื้นที่ทำงาน

รูปแบบ: users/{user}/spaces/{space}/spaceReadState
last_read_time

Timestamp

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

SpaceUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับพื้นที่ทำงานที่อัปเดตแล้ว

ประเภทเหตุการณ์: google.workspace.chat.space.v1.updated

ช่อง
space

Space

พื้นที่ทำงานที่อัปเดต

SpaceView

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

Enum
SPACE_VIEW_UNSPECIFIED ค่าเริ่มต้น / ค่าที่ไม่ได้ตั้งค่า
SPACE_VIEW_RESOURCE_NAME_ONLY ป้อนข้อมูลเฉพาะชื่อทรัพยากรของพื้นที่ทำงาน
SPACE_VIEW_EXPANDED ป้อนข้อมูลในช่องทรัพยากรพื้นที่ทำงาน หมายเหตุ: ระบบจะไม่ป้อนข้อมูลในช่อง permissionSettings คำขอที่ระบุ SPACE_VIEW_EXPANDED ต้องมีขอบเขตที่อนุญาตให้อ่านข้อมูลพื้นที่ทำงาน เช่น https://www.googleapis.com/auth/chat.spaces หรือ https://www.googleapis.com/auth/chat.spaces.readonly

ชุดข้อความ

ชุดข้อความในพื้นที่ทำงานใน Google Chat ดูตัวอย่างการใช้งานได้ที่หัวข้อเริ่มหรือตอบกลับชุดข้อความ

หากระบุชุดข้อความเมื่อสร้างข้อความ คุณจะตั้งค่าช่อง messageReplyOption เพื่อกำหนดสิ่งที่จะเกิดขึ้นหากไม่พบชุดข้อความที่ตรงกันได้

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของชุดข้อความ

ตัวอย่าง: spaces/{space}/threads/{thread}
thread_key

string

ไม่บังคับ อินพุตสำหรับการสร้างหรืออัปเดตชุดข้อความ ไม่เช่นนั้นจะเป็นเอาต์พุตเท่านั้น รหัสสำหรับชุดข้อความ รองรับอักขระสูงสุด 4,000 ตัว

รหัสนี้จะไม่ซ้ำกันสำหรับแอปใน Chat ที่ตั้งค่าไว้ เช่น หากแอปใน Chat หลายแอปสร้างข้อความโดยใช้คีย์ชุดข้อความเดียวกัน ระบบจะโพสต์ข้อความในชุดข้อความที่ต่างกัน หากต้องการตอบกลับในชุดข้อความที่สร้างโดยบุคคลหรือแอป Chat อื่น ให้ระบุช่อง name ของชุดข้อความแทน

ThreadReadState

สถานะการอ่านของผู้ใช้ภายในชุดข้อความ ซึ่งใช้เพื่อระบุข้อความที่อ่านแล้วและยังไม่อ่าน

ช่อง
name

string

ชื่อทรัพยากรของสถานะการอ่านชุดข้อความ

รูปแบบ: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time

Timestamp

เวลาที่มีการอัปเดตสถานะการอ่านชุดข้อความของผู้ใช้ โดยปกติแล้ว การประทับเวลานี้จะสอดคล้องกับการประทับเวลาของข้อความที่อ่านล่าสุดในชุดข้อความ

UpdateAvailabilityRequest

ข้อความคำขอสำหรับเมธอด UpdateAvailability

ช่อง
availability

Availability

ต้องระบุ ความพร้อมจำหน่ายสินค้าที่จะอัปเดต
update_mask

FieldMask

ต้องระบุ รายการช่องที่จะอัปเดต ช่องเดียวที่อัปเดตได้คือ custom_status

UpdateMembershipRequest

ข้อความคำขอสำหรับการอัปเดตการเป็นสมาชิก

ช่อง
membership

Membership

ต้องระบุ การเป็นสมาชิกที่จะอัปเดต ระบบจะอัปเดตเฉพาะช่องที่ระบุโดย update_mask เท่านั้น
update_mask

FieldMask

ต้องระบุ เส้นทางของช่องที่จะอัปเดต คั่นหลายค่าด้วยคอมมา หรือใช้ * เพื่ออัปเดตเส้นทางของช่องทั้งหมด

เส้นทางฟิลด์ที่รองรับในปัจจุบันมีดังนี้

  • role
use_admin_access

bool

ไม่บังคับ เมื่อ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการการสนทนาในแชทและพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.memberships

UpdateMessageRequest

ส่งคำขออัปเดตข้อความ

ช่อง
message

Message

ต้องระบุ ข้อความที่มีช่องที่อัปเดตแล้ว
update_mask

FieldMask

ต้องระบุ เส้นทางของช่องที่จะอัปเดต คั่นหลายค่าด้วยคอมมา หรือใช้ * เพื่ออัปเดตเส้นทางของช่องทั้งหมด

เส้นทางฟิลด์ที่รองรับในปัจจุบันมีดังนี้
allow_missing

bool

ไม่บังคับ หาก true และไม่พบข้อความ ระบบจะสร้างข้อความใหม่และละเว้น updateMask รหัสข้อความที่ระบุต้องเป็นรหัสที่ไคลเอ็นต์กำหนด ไม่เช่นนั้นคำขอจะดำเนินการไม่สำเร็จ

UpdateSectionRequest

ข้อความคำขอสำหรับการอัปเดตส่วน

ช่อง
section

Section

ต้องระบุ ส่วนที่จะอัปเดต
update_mask

FieldMask

ต้องระบุ มาสก์เพื่อระบุช่องที่จะอัปเดต

เส้นทางฟิลด์ที่รองรับในปัจจุบันมีดังนี้

  • display_name

UpdateSpaceNotificationSettingRequest

คำขออัปเดตการตั้งค่าการแจ้งเตือนของพื้นที่ทำงาน รองรับเฉพาะการอัปเดตการตั้งค่าการแจ้งเตือนสำหรับผู้ใช้ที่โทรเท่านั้น

ช่อง
space_notification_setting

SpaceNotificationSetting

ต้องระบุ ต้องป้อนชื่อทรัพยากรสำหรับการตั้งค่าการแจ้งเตือนของพื้นที่ทำงานในรูปแบบ users/{user}/spaces/{space}/spaceNotificationSetting ระบบจะอัปเดตเฉพาะช่องที่ระบุโดย update_mask
update_mask

FieldMask

ต้องระบุ เส้นทางฟิลด์ที่รองรับมีดังนี้

  • notification_setting

  • mute_setting

UpdateSpaceReadStateRequest

ข้อความคำขอสำหรับ UpdateSpaceReadState API

ช่อง
space_read_state

SpaceReadState

ต้องระบุ สถานะการอ่านพื้นที่ทำงานและช่องที่จะอัปเดต

รองรับเฉพาะการอัปเดตสถานะการอ่านสำหรับผู้ใช้ที่โทรเท่านั้น

หากต้องการอ้างอิงถึงผู้ใช้ที่โทร ให้ตั้งค่าอย่างใดอย่างหนึ่งต่อไปนี้

  • ชื่อแทน me เช่น users/me/spaces/{space}/spaceReadState

  • อีเมล Workspace ของบุคคลดังกล่าว เช่น users/user@example.com/spaces/{space}/spaceReadState

  • รหัสผู้ใช้ เช่น users/123456789/spaces/{space}/spaceReadState

รูปแบบ: users/{user}/spaces/{space}/spaceReadState
update_mask

FieldMask

ต้องระบุ เส้นทางของช่องที่จะอัปเดต เส้นทางฟิลด์ที่รองรับในปัจจุบันมีดังนี้

  • last_read_time

เมื่อ last_read_time อยู่ก่อนเวลาสร้างข้อความล่าสุด พื้นที่ทำงานจะปรากฏเป็นยังไม่อ่านใน UI

หากต้องการทำเครื่องหมายพื้นที่ทำงานเป็นอ่านแล้ว ให้ตั้งค่า last_read_time เป็นค่าใดก็ได้ที่ใหม่กว่า (มากกว่า) เวลาสร้างข้อความล่าสุด ระบบจะบังคับให้ last_read_time ตรงกับเวลาสร้างข้อความล่าสุด โปรดทราบว่าสถานะการอ่านของพื้นที่ทำงานจะส่งผลต่อสถานะการอ่านของข้อความที่ปรากฏในการสนทนาระดับบนสุดของพื้นที่ทำงานเท่านั้น การตอบกลับในชุดข้อความจะไม่ได้รับผลกระทบจากการประทับเวลานี้ แต่จะอิงตามสถานะการอ่านชุดข้อความแทน

UpdateSpaceRequest

คำขออัปเดตพื้นที่ทำงานเดียว

ช่อง
space

Space

ต้องระบุ พื้นที่ทำงานที่มีช่องที่ต้องอัปเดต Space.name ต้องระบุในรูปแบบ spaces/{space} ระบบจะอัปเดตเฉพาะช่องที่ระบุโดย update_mask เท่านั้น
update_mask

FieldMask

ต้องระบุ เส้นทางของช่องที่อัปเดต โดยคั่นด้วยคอมมาหากมีหลายรายการ

คุณสามารถอัปเดตช่องต่อไปนี้สำหรับพื้นที่ทำงานได้

space_details: อัปเดตรายละเอียดและหลักเกณฑ์ของพื้นที่ทำงาน คุณต้องส่งทั้งคำอธิบายและหลักเกณฑ์ในคำขออัปเดตเป็น SpaceDetails หากต้องการอัปเดตเพียงช่องเดียว ให้ส่งค่าที่มีอยู่สำหรับอีกช่องหนึ่ง

display_name: รองรับเฉพาะการอัปเดตชื่อที่แสดงสำหรับพื้นที่ทำงานที่ช่อง spaceType มีค่าเป็น SPACE หากได้รับข้อความแสดงข้อผิดพลาด ALREADY_EXISTS ให้ลองใช้ค่าอื่น พื้นที่ทำงานที่มีอยู่ภายในองค์กร Google Workspace อาจใช้ชื่อที่แสดงนี้อยู่แล้ว

space_type: รองรับเฉพาะการเปลี่ยนประเภทพื้นที่ทำงาน GROUP_CHAT เป็น SPACE รวม display_name ไว้กับ space_type ในมาสก์การอัปเดต และตรวจสอบว่าพื้นที่ทำงานที่ระบุมีชื่อที่แสดงที่ไม่ใช่ค่าว่างและมีประเภทพื้นที่ทำงานเป็น SPACE คุณจะใส่มาสก์ space_type และประเภท SPACE ในพื้นที่ทำงานที่ระบุเมื่ออัปเดตชื่อที่แสดงหรือไม่ก็ได้ หากพื้นที่ทำงานที่มีอยู่มีประเภท SPACE อยู่แล้ว การพยายามอัปเดตประเภทพื้นที่ทำงานด้วยวิธีอื่นๆ จะส่งผลให้เกิดข้อผิดพลาดอาร์กิวเมนต์ไม่ถูกต้อง space_type ไม่รองรับ useAdminAccess

space_history_state: อัปเดตการตั้งค่าประวัติพื้นที่ทำงานโดยเปิดหรือปิดประวัติสำหรับพื้นที่ทำงาน รองรับเฉพาะเมื่อเปิดใช้การตั้งค่าประวัติสำหรับองค์กร Google Workspace หากต้องการอัปเดตสถานะประวัติของพื้นที่ทำงาน คุณต้องละเว้นมาสก์ช่องอื่นๆ ทั้งหมดในคำขอ space_history_state ไม่รองรับ useAdminAccess

access_settings.audience: อัปเดตการตั้งค่าการเข้าถึงว่าใครสามารถค้นพบพื้นที่ทำงาน เข้าร่วมพื้นที่ทำงาน และดูตัวอย่างข้อความในพื้นที่ทำงานที่มีชื่อซึ่งช่อง spaceType มีค่าเป็น SPACE หากพื้นที่ทำงานที่มีอยู่มีกลุ่มเป้าหมาย คุณสามารถนำกลุ่มเป้าหมายออกและจำกัดการเข้าถึงพื้นที่ทำงานได้โดยละเว้นค่าสำหรับมาสก์ฟิลด์นี้ หากต้องการอัปเดตการตั้งค่าการเข้าถึงสำหรับพื้นที่ทำงาน ผู้ใช้ที่ตรวจสอบสิทธิ์ต้องเป็นผู้จัดการพื้นที่ทำงานและละเว้นมาสก์ช่องอื่นๆ ทั้งหมดในคำขอ คุณจะอัปเดตช่องนี้ไม่ได้หากพื้นที่ทำงานอยู่ในโหมดนำเข้า ดูข้อมูลเพิ่มเติมได้ที่หัวข้อทำให้ผู้ใช้บางรายค้นพบพื้นที่ทำงานได้ access_settings.audience ไม่รองรับ useAdminAccess

access_settings.access_permission_settings: อัปเดตการตั้งค่าสิทธิ์การเข้าถึงของผู้ที่สามารถค้นพบและเข้าร่วมพื้นที่ทำงานได้ โดยที่ฟิลด์ spaceType มีค่าเป็น SPACE ผู้ใช้หลักที่ได้รับอนุญาตให้เข้าร่วมพื้นที่ทำงานต้องได้รับอนุญาตให้ค้นพบพื้นที่ทำงานด้วย หากต้องการอัปเดตการตั้งค่าสิทธิ์เข้าถึงสำหรับพื้นที่ทำงาน ผู้ใช้ที่ตรวจสอบสิทธิ์ต้องเป็นผู้จัดการพื้นที่ทำงานหรือผู้ช่วยผู้จัดการ และละเว้นมาสก์ช่องอื่นๆ ทั้งหมดในคำขอ คุณจะอัปเดตช่องนี้ไม่ได้หากพื้นที่ทำงานอยู่ในโหมดนำเข้า ดูข้อมูลเพิ่มเติมได้ที่หัวข้อทำให้ผู้ใช้บางรายค้นพบพื้นที่ทำงานได้ access_settings.access_permission_settings ไม่รองรับ useAdminAccess มาสก์ฟิลด์ที่รองรับมีดังนี้

  • access_settings.access_permission_settings.discoverSpaceSetting
  • access_settings.access_permission_settings.joinSpaceSetting
  • access_settings.access_permission_settings.viewSpaceMembershipSetting

permission_settings: รองรับการเปลี่ยนการตั้งค่าสิทธิ์ของพื้นที่ทำงาน เมื่ออัปเดตการตั้งค่าสิทธิ์ คุณจะระบุได้เฉพาะมาสก์ฟิลด์ permissionSettings เท่านั้น และจะอัปเดตมาสก์ฟิลด์อื่นๆ พร้อมกันไม่ได้ มาสก์ของช่องที่รองรับ ได้แก่

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
  • permission_settings.viewSpaceMembership
use_admin_access

bool

ไม่บังคับ เมื่อ true เมธอดจะทำงานโดยใช้สิทธิ์ของผู้ดูแลระบบ Google Workspace ของผู้ใช้

ผู้ใช้ที่โทรต้องเป็นผู้ดูแลระบบ Google Workspace ที่มีสิทธิ์จัดการการสนทนาในแชทและพื้นที่ทำงาน

ต้องใช้ขอบเขต OAuth 2.0 chat.admin.spaces

ระบบไม่รองรับค่า FieldMask บางค่าเมื่อใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ โปรดดูรายละเอียดในคำอธิบายของ update_mask

ผู้ใช้

ผู้ใช้ใน Google Chat

เมื่อแสดงผลเป็นเอาต์พุตจากคำขอ หากแอปใน Chat ตรวจสอบสิทธิ์เป็นผู้ใช้ เอาต์พุตสำหรับทรัพยากร User (เช่น ใน Messages API และ Memberships API) จะป้อนข้อมูลเฉพาะในช่อง name และ type สำหรับทั้งผู้ใช้ภายในและภายนอก เว้นแต่ว่าผู้ใช้เหล่านั้นจะเป็นสมาชิกของพื้นที่ทำงานหรือมีความเกี่ยวข้องกับผู้ใช้ที่โทรมาก่อนหน้านี้

ช่อง
name

string

ชื่อทรัพยากรสำหรับ user ของ Google Chat

รูปแบบ: users/{user} users/app สามารถใช้เป็นชื่อแทนสำหรับผู้ใช้แอปการโทร bot ได้

สำหรับ human users {user} เป็นตัวระบุผู้ใช้เดียวกันกับ:

  • id สำหรับบุคคลใน People API เช่น users/123456789 ใน Chat API จะแสดงบุคคลเดียวกันกับรหัสโปรไฟล์บุคคล 123456789 ใน People API

  • idสำหรับผู้ใช้ใน Admin SDK Directory API

  • คุณสามารถใช้อีเมลของผู้ใช้เป็นชื่อแทนสำหรับ {user} ในคำขอ API ได้ ตัวอย่างเช่น หากรหัสโปรไฟล์ส่วนตัวใน People API สำหรับ user@example.com คือ 123456789 คุณสามารถใช้ users/user@example.com เป็นชื่อแทนเพื่ออ้างอิง users/123456789 ได้ API จะแสดงผลเฉพาะชื่อทรัพยากร Canonical (เช่น users/123456789) เท่านั้น
display_name

string

เอาต์พุตเท่านั้น ชื่อที่แสดงของผู้ใช้

ป้อนข้อมูลทั้งสำหรับการตรวจสอบสิทธิ์แอปและการตรวจสอบสิทธิ์ผู้ใช้ ระบบจะป้อนข้อมูลในช่องนี้เสมอสำหรับคำขอที่ทำด้วยการตรวจสอบสิทธิ์แอป เมื่อเรียกใช้ Messages API และ Memberships API ด้วยการตรวจสอบสิทธิ์ผู้ใช้ ระบบจะป้อนข้อมูลในช่องนี้สำหรับทั้งผู้ใช้ภายในและภายนอกสำหรับ sender ของข้อความ ผู้ใช้ภายใน annotations (เช่น การพูดถึงผู้ใช้) และภายในทรัพยากร Membership โดยมีเงื่อนไขว่าผู้ใช้ต้องเป็นสมาชิกของพื้นที่ทำงานหรือมีความเกี่ยวข้องกับผู้ใช้ที่เรียกใช้ก่อนหน้านี้
avatar_url

string

เอาต์พุตเท่านั้น URL รูปโปรไฟล์ของผู้ใช้

เมื่อเรียกใช้ Messages API และ Memberships API ด้วยการตรวจสอบสิทธิ์ผู้ใช้ ระบบจะป้อนข้อมูลในช่องนี้สำหรับทั้งผู้ใช้ภายในและภายนอกสำหรับ sender ของข้อความ ผู้ใช้ภายใน annotations (เช่น การพูดถึงผู้ใช้) และภายในทรัพยากร Membership โดยมีเงื่อนไขว่าผู้ใช้ต้องเป็นสมาชิกของพื้นที่ทำงานหรือมีความเกี่ยวข้องกับผู้ใช้ที่เรียกใช้ก่อนหน้านี้
email

string

เอาต์พุตเท่านั้น อีเมลของผู้ใช้

เมื่อเรียกใช้ Messages API และ Memberships API ด้วยการตรวจสอบสิทธิ์ผู้ใช้ ระบบจะป้อนข้อมูลในช่องนี้สำหรับทั้งผู้ใช้ภายในและภายนอกสำหรับ sender ของข้อความ ผู้ใช้ภายใน annotations (เช่น การพูดถึงผู้ใช้) และภายในทรัพยากร Membership โดยมีเงื่อนไขว่าผู้ใช้ต้องเป็นสมาชิกของพื้นที่ทำงานหรือมีความเกี่ยวข้องกับผู้ใช้ที่เรียกใช้ก่อนหน้านี้
domain_id

string

ตัวระบุที่ไม่ซ้ำกันของโดเมน Google Workspace ของผู้ใช้
type

Type

ประเภทผู้ใช้
is_anonymous

bool

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

ประเภท

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum DO NOT USE.
HUMAN ผู้ใช้ที่เป็นมนุษย์
BOT ผู้ใช้แอป Chat

UserMentionMetadata

ข้อมูลเมตาของคำอธิบายประกอบสำหรับการพูดถึงผู้ใช้ (@)

ช่อง
user

User

ผู้ใช้ที่พูดถึง
type

Type

ประเภทการพูดถึงผู้ใช้

ประเภท

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ enum ไม่ใช้
ADD เพิ่มผู้ใช้ไปยังพื้นที่ทำงาน
MENTION พูดถึงผู้ใช้ในพื้นที่ทำงาน

WidgetMarkup

วิดเจ็ตคือองค์ประกอบ UI ที่แสดงข้อความและรูปภาพ

ช่อง
buttons[]

Button

รายการปุ่ม ปุ่มยังเป็น oneof data ด้วย และควรตั้งค่าช่องเหล่านี้เพียงช่องเดียว
ฟิลด์ Union data WidgetMarkup มีได้เพียงรายการใดรายการหนึ่งต่อไปนี้เท่านั้น คุณสามารถใช้ช่อง WidgetMarkup หลายช่องเพื่อแสดงรายการเพิ่มเติมได้ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
text_paragraph

TextParagraph

แสดงย่อหน้าข้อความในวิดเจ็ตนี้
image

Image

แสดงรูปภาพในวิดเจ็ตนี้
key_value

KeyValue

แสดงรายการคีย์-ค่าในวิดเจ็ตนี้

ปุ่ม

ปุ่ม A อาจเป็นปุ่มข้อความหรือปุ่มรูปภาพ

ช่อง

ฟิลด์ Union type

type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
text_button

TextButton

ปุ่มที่มีข้อความและการดำเนินการ onclick
image_button

ImageButton

ปุ่มที่มีรูปภาพและการดำเนินการ onclick

FormAction

การดำเนินการของแบบฟอร์มจะอธิบายลักษณะการทำงานเมื่อมีการส่งแบบฟอร์ม เช่น คุณสามารถเรียกใช้ Apps Script เพื่อจัดการแบบฟอร์มได้

ช่อง
action_method_name

string

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

ActionParameter

รายการพารามิเตอร์การดำเนินการ

ActionParameter

รายการพารามิเตอร์สตริงที่จะระบุเมื่อมีการเรียกใช้เมธอดการดำเนินการ ตัวอย่างเช่น ลองพิจารณาปุ่มเลื่อนการแจ้งเตือน 3 ปุ่ม ได้แก่ เลื่อนการแจ้งเตือนตอนนี้ เลื่อนการแจ้งเตือน 1 วัน เลื่อนการแจ้งเตือนเป็นสัปดาห์หน้า คุณอาจใช้ action method = snooze() โดยส่งประเภทการเลื่อนการปลุกและเวลาเลื่อนการปลุกในรายการพารามิเตอร์สตริง

ช่อง
key

string

ชื่อพารามิเตอร์สำหรับสคริปต์การดำเนินการ
value

string

ค่าของพารามิเตอร์

ไอคอน

ชุดไอคอนที่รองรับ

Enum
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

รูปภาพ

รูปภาพที่ระบุโดย URL และมีการดำเนินการ onclick ได้

ช่อง
image_url

string

URL ของรูปภาพ
on_click

OnClick

การดำเนินการ onclick
aspect_ratio

double

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

ImageButton

ปุ่มรูปภาพที่มีการดำเนินการ onclick

ช่อง
on_click

OnClick

การดำเนินการ onclick
name

string

ชื่อของ image_button นี้ที่ใช้สำหรับการช่วยเหลือพิเศษ ระบบจะระบุค่าเริ่มต้นหากไม่ได้ระบุชื่อนี้
ฟิลด์ Union icons คุณสามารถระบุไอคอนได้โดยใช้ Icon enum หรือ URL icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
icon

Icon

ไอคอนที่ระบุโดย enum ซึ่งจัดทำดัชนีเป็นไอคอนที่ Chat API มีให้
icon_url

string

ไอคอนที่ระบุโดย URL

KeyValue

องค์ประกอบ UI ประกอบด้วยคีย์ (ป้ายกำกับ) และค่า (เนื้อหา) องค์ประกอบนี้ยังมีการดำเนินการบางอย่างได้ด้วย เช่น ปุ่ม onclick

ช่อง
top_label

string

ข้อความของป้ายกำกับด้านบน รองรับข้อความที่จัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace
content

string

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

bool

เนื้อหาควรมีหลายบรรทัดหรือไม่
bottom_label

string

ข้อความของป้ายกำกับด้านล่าง รองรับข้อความที่จัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace
on_click

OnClick

การดำเนินการ onclick โดยจะคลิกได้เฉพาะป้ายกำกับด้านบน ป้ายกำกับด้านล่าง และขอบเขตเนื้อหาเท่านั้น
ฟิลด์ Union icons ต้องกำหนดไอคอน, top_label และ bottom_label อย่างน้อย 1 รายการ icons ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
icon

Icon

ค่า enum ที่ Chat API แทนที่ด้วยรูปภาพไอคอนที่เกี่ยวข้อง
icon_url

string

ไอคอนที่ระบุโดย URL
ฟิลด์ Union control วิดเจ็ตควบคุม คุณตั้งค่า button หรือ switch_widget ได้ แต่จะตั้งค่าทั้ง 2 อย่างไม่ได้ control ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
button

Button

ปุ่มที่คลิกได้เพื่อเรียกให้แสดงการดำเนินการ

OnClick

การดำเนินการ onclick (เช่น เปิดลิงก์)

ช่อง

ฟิลด์ Union data

data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
action

FormAction

การดำเนินการของแบบฟอร์มจะทริกเกอร์โดยการดำเนินการ onclick นี้ หากระบุไว้

TextButton

ปุ่มที่มีข้อความและการดำเนินการ onclick

ช่อง
text

string

ข้อความของปุ่ม
on_click

OnClick

การดำเนินการ onclick ของปุ่ม

TextParagraph

ย่อหน้าของข้อความ รองรับข้อความที่จัดรูปแบบ ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความได้ที่หัวข้อการจัดรูปแบบข้อความในแอป Google Chat และการจัดรูปแบบข้อความในส่วนเสริมของ Google Workspace

ช่อง
text

string