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 อื่นๆ เมื่อสร้างการเป็นสมาชิก หากสมาชิกที่ระบุปิดนโยบายยอมรับอัตโนมัติไว้ ระบบจะเชิญสมาชิกรายนั้น และสมาชิกจะต้องยอมรับคำเชิญเข้าร่วมพื้นที่ก่อนจึงจะเข้าร่วมได้ มิเช่นนั้น การสร้างการเป็นสมาชิกจะเพิ่มสมาชิกไปยังพื้นที่ที่ระบุโดยตรง

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

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

    • 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 ดูตัวอย่างได้ที่ส่งข้อความ

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

  • การตรวจสอบสิทธิ์แอปที่มีขอบเขตการให้สิทธิ์ต่อไปนี้
    • https://www.googleapis.com/auth/chat.bot
  • การตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์อย่างใดอย่างหนึ่งต่อไปนี้
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (เฉพาะพื้นที่ทำงานโหมดการนำเข้า)

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
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 ออกจากพื้นที่ทำงาน

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

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

    • 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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
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

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

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

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

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

    • 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

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

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

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
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)

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

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

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

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

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

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.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 ของข้อมูลเหตุการณ์ในพื้นที่สำหรับคำขอนี้

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

  • 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.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 รวมถึงการเป็นสมาชิกของแอป 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

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

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

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

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

  • 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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
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

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

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

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

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

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

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

แสดงรายการพื้นที่ในองค์กร Google Workspace ตามการค้นหาของผู้ดูแลระบบ

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

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

ในคำขอ ให้ตั้งค่า use_admin_access เป็น true

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

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

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

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

หากต้องการสร้างข้อความส่วนตัว (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

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

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

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

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

    • 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

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

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

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

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

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

    • 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

หมายเหตุ

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

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

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

ความยาวของสตริงย่อยในเนื้อความของข้อความแบบข้อความธรรมดาที่คำอธิบายประกอบนี้สอดคล้องด้วย
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 คำสั่งเครื่องหมายทับ ผู้ใช้ส่งคำสั่งในข้อความ Chat
QUICK_COMMAND คำสั่งด่วน ผู้ใช้เลือกคำสั่งจากเมนู 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 ของภาพขนาดย่อที่ควรใช้เพื่อแสดงตัวอย่างไฟล์แนบต่อผู้ใช้ที่เป็นมนุษย์ แอปแชทไม่ควรใช้ URL นี้เพื่อดาวน์โหลดเนื้อหาไฟล์แนบ
download_uri

string

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

Source

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

AttachmentDataRef

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

DriveDataRef

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

แหล่งที่มา

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

Enum
SOURCE_UNSPECIFIED สงวนสิทธิ์
DRIVE_FILE ไฟล์เป็นไฟล์ใน Google ไดรฟ์
UPLOADED_CONTENT ระบบจะอัปโหลดไฟล์ไปยัง Chat

AttachmentDataRef

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

ช่อง
resource_name

string

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

string

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

CardWithId

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

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

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

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

ช่อง
card_id

string

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

Card

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

ChatSpaceLinkData

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

ช่อง
space

string

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

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

string

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

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

string

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

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

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 เส้นขอบวงกลม

ส่วน

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

ช่อง
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 ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

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

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

CreateMessageRequest

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

ช่อง
parent

string

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

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

Message

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

string

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

string

ไม่บังคับ รหัสคำขอที่ไม่ซ้ำกันสำหรับข้อความนี้ การระบุรหัสคำขอที่มีอยู่จะแสดงข้อความที่สร้างด้วยรหัสนั้นแทนที่จะสร้างข้อความใหม่
message_reply_option

MessageReplyOption

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

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

string

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

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

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

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

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

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

CreateSpaceRequest

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

ช่อง
space

Space

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

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

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

string

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

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

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

DeleteCustomEmojiRequest

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

ช่อง
name

string

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

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

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

DeleteMembershipRequest

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

ช่อง
name

string

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

เมื่อลบการเป็นสมาชิกของบุคคล จะต้องมีขอบเขต 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 ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

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

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

DeleteMessageRequest

ขอให้ลบข้อความ

ช่อง
name

string

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

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

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

bool

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

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

DeleteReactionRequest

ลบรีแอ็กชันต่อข้อความ

ช่อง
name

string

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

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

DeleteSpaceRequest

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

ช่อง
name

string

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

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

bool

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

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

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

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

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

DriveDataRef

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

ช่อง
drive_file_id

string

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

DriveLinkData

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

ช่อง
drive_data_ref

DriveDataRef

DriveDataRef ที่อ้างอิงไฟล์ใน Google ไดรฟ์
mime_type

string

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

อีโมจิ

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

ช่อง
ฟิลด์ 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

GetAttachmentRequest

ขอรับไฟล์แนบ

ช่อง
name

string

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

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 ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

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

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

GetMessageRequest

ขอรับข้อความ

ช่อง
name

string

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

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

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

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 ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

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

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

แสดงกลุ่มใน 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

ไม่บังคับ (หากกลับมาทำงานต่อจากคำค้นหาก่อนหน้า)

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

เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด
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 รายการ

ค่าสูงสุดคือ 1000 หากใช้ค่ามากกว่า 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 ที่มีสิทธิ์จัดการแชทและการสนทนาในพื้นที่ทำงาน

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

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

ListMembershipsResponse

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

ช่อง
memberships[]

Membership

รายการที่ไม่เรียงลำดับ รายการการเป็นสมาชิกในหน้าที่ขอ (หรือหน้าแรก)
next_page_token

string

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

ListMessagesRequest

แสดงข้อความในพื้นที่ทำงานที่ระบุซึ่งผู้ใช้เป็นสมาชิก

ช่อง
parent

string

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

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

int32

ไม่บังคับ จำนวนข้อความสูงสุดที่แสดง บริการอาจแสดงข้อความน้อยกว่าค่านี้

หากไม่ระบุ ระบบจะแสดงผลอย่างมาก 25 รายการ

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

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

string

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

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

ไม่บังคับ จะรวมข้อความที่ถูกลบหรือไม่ ข้อความที่ถูกลบจะมีเวลาที่ถูกลบและข้อมูลเมตาเกี่ยวกับการลบ แต่เนื้อหาของข้อความจะไม่พร้อมใช้งาน

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

ไม่บังคับ (หากกลับมาทำงานต่อจากคำค้นหาก่อนหน้า)

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

เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด
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

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

ListSpaceEventsRequest

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

ช่อง
parent

string

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

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

int32

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

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

string

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

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

string

ต้องระบุ ตัวกรองการค้นหา

คุณต้องระบุประเภทเหตุการณ์อย่างน้อย 1 ประเภท (event_type) โดยใช้ตัวดำเนินการ 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 ในออบเจ็กต์พื้นที่ทำงานสำหรับคำขอรายการ
next_page_token

string

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

ListSpacesRequest

คำขอแสดงรายการพื้นที่ทำงานที่ผู้โทรเป็นสมาชิก

ช่อง
page_size

int32

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

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

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

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

string

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

เมื่อแบ่งหน้า ค่าตัวกรองควรตรงกับการเรียกที่ให้โทเค็นหน้าเว็บ การส่งค่าอื่นอาจทำให้เกิดผลลัพธ์ที่ไม่คาดคิด
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 ในออบเจ็กต์พื้นที่ทำงานสำหรับคำขอรายการ
next_page_token

string

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

MatchedUrl

URL ที่ตรงกันในข้อความ Chat แอปแชทสามารถแสดงตัวอย่าง URL ที่ตรงกันได้ ดูข้อมูลเพิ่มเติมได้ที่แสดงตัวอย่างลิงก์

ช่อง
url

string

เอาต์พุตเท่านั้น URL ที่ตรงกัน

การเป็นสมาชิก

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

ช่อง
name

string

ตัวระบุ ชื่อทรัพยากรของการเป็นสมาชิกที่เซิร์ฟเวอร์กำหนด

รูปแบบ: spaces/{space}/members/{member}
state

MembershipState

เอาต์พุตเท่านั้น สถานะของการเป็นสมาชิก
role

MembershipRole

ไม่บังคับ บทบาทของผู้ใช้ภายในพื้นที่ใน Chat ซึ่งกำหนดการดำเนินการที่ได้รับอนุญาตในพื้นที่

ฟิลด์นี้ใช้เป็นอินพุตได้เฉพาะใน UpdateMembership
create_time

Timestamp

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

Timestamp

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

User

ไม่บังคับ ผู้ใช้หรือแอป Google Chat ที่การเป็นสมาชิกสอดคล้องกัน หากแอป Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะแสดงใน user name และ type
group_member

Group

ไม่บังคับ กลุ่ม Google ที่การเป็นสมาชิกสอดคล้องกัน

การอ่านหรือการเปลี่ยนแปลงการเป็นสมาชิก Google Groups ต้องใช้การตรวจสอบสิทธิ์ผู้ใช้

MembershipRole

แสดงการดำเนินการที่ผู้ใช้ได้รับอนุญาตในพื้นที่ใน Chat อาจมีการเพิ่มค่า Enum อื่นๆ ในอนาคต

Enum
MEMBERSHIP_ROLE_UNSPECIFIED ค่าเริ่มต้น สำหรับ users: ผู้ใช้ไม่ได้เป็นสมาชิกของพื้นที่ทำงาน แต่สามารถได้รับเชิญ สำหรับ Google Groups ระบบจะกำหนดบทบาทนี้ให้เสมอ (อาจใช้ค่า Enum อื่นๆ ในอนาคต)
ROLE_MEMBER สมาชิกของพื้นที่ทำงาน ผู้ใช้มีสิทธิ์พื้นฐาน เช่น การส่งข้อความไปยังพื้นที่ ในการสนทนาแบบตัวต่อตัวและการสนทนากลุ่มที่ไม่มีชื่อ ทุกคนจะมีบทบาทนี้
ROLE_MANAGER เป็นผู้จัดการพื้นที่ทำงาน ผู้ใช้มีสิทธิ์พื้นฐานทั้งหมด รวมถึงสิทธิ์ของผู้ดูแลระบบที่ช่วยให้จัดการพื้นที่ทำงานได้ เช่น การเพิ่มหรือนำสมาชิกออก ใช้ได้ใน 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
create_time

Timestamp

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

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

Timestamp

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

Timestamp

เอาต์พุตเท่านั้น เวลาที่ลบข้อความใน Google Chat หากไม่มีการลบข้อความ ช่องนี้จะว่างเปล่า
text

string

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

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

string

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

  • ไวยากรณ์มาร์กอัปสำหรับตัวหนา ตัวเอียง ขีดทับ โมโนสเปซ บล็อกโมโนสเปซ และรายการสัญลักษณ์หัวข้อย่อย

  • การกล่าวถึงผู้ใช้โดยใช้รูปแบบ <users/{user}>

  • ไฮเปอร์ลิงก์ที่กำหนดเองโดยใช้รูปแบบ <{url}|{rendered_text}> ซึ่งสตริงแรกคือ URL และสตริงที่สองคือข้อความที่แสดง เช่น <http://example.com|custom text>

  • อีโมจิที่กำหนดเองโดยใช้รูปแบบ :{emoji_name}: เช่น :smile: โดยจะไม่มีผลกับอีโมจิ Unicode เช่น U+1F600 สำหรับอีโมจิหน้ายิ้ม

ดูข้อมูลเพิ่มเติมได้ที่ดูการจัดรูปแบบข้อความที่ส่งในข้อความ
cards[]
(deprecated)

Card

เลิกใช้งานแล้ว: โปรดใช้ cards_v2 แทน

การ์ดแบบอินเทอร์แอกทีฟที่จัดรูปแบบแล้วและมีเนื้อหาหลากหลาย ซึ่งคุณใช้เพื่อแสดงองค์ประกอบ UI ได้ เช่น ข้อความที่จัดรูปแบบ ปุ่ม และรูปภาพที่คลิกได้ โดยปกติแล้ว การ์ดจะแสดงอยู่ใต้เนื้อหาข้อความแบบข้อความธรรมดา cards และ cards_v2 มีขนาดสูงสุดได้ 32 KB
cards_v2[]

CardWithId

ไม่บังคับ อาร์เรย์ของการ์ด

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

ดูวิธีสร้างข้อความที่มีการ์ดได้ที่ส่งข้อความ

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

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

Annotation

เอาต์พุตเท่านั้น คำอธิบายประกอบที่เชื่อมโยงกับ text ในข้อความนี้
thread

Thread

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

Space

เอาต์พุตเท่านั้น หากแอปใน Chat ตรวจสอบสิทธิ์ในฐานะผู้ใช้ เอาต์พุตจะแสดงเฉพาะในพื้นที่ทำงาน name
fallback_text

string

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

ActionResponse

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

string

เอาต์พุตเท่านั้น เนื้อหาข้อความแบบข้อความธรรมดาโดยไม่มีการกล่าวถึงแอป Chat ทั้งหมด
slash_command

SlashCommand

เอาต์พุตเท่านั้น ข้อมูลคำสั่งเครื่องหมายทับ (หากมี)
attachment[]

Attachment

ไม่บังคับ ไฟล์แนบที่ผู้ใช้อัปโหลด
matched_url

MatchedUrl

เอาต์พุตเท่านั้น URL ใน spaces.messages.text ที่ตรงกับรูปแบบตัวอย่างลิงก์ ดูข้อมูลเพิ่มเติมได้ที่แสดงตัวอย่างลิงก์
thread_reply

bool

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

หากพื้นที่ทำงานไม่รองรับการตอบกลับในชุดข้อความ ช่องนี้จะเป็น false เสมอ
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

เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับข้อความที่ผู้ใช้ Google Chat อ้างอิงในพื้นที่ ผู้ใช้ Google Chat สามารถอ้างอิงข้อความเพื่อตอบกลับได้
attached_gifs[]

AttachedGif

เอาต์พุตเท่านั้น รูปภาพ GIF ที่แนบมากับข้อความ
accessory_widgets[]

AccessoryWidget

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

การสร้างข้อความด้วยวิดเจ็ตอุปกรณ์เสริมต้องใช้การตรวจสอบสิทธิ์แอป

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, deleteTime และ deletionMetadata

MessageUpdatedEventData

เพย์โหลดของเหตุการณ์สำหรับข้อความที่อัปเดต

ประเภทกิจกรรม: google.workspace.chat.message.v1.updated

ช่อง
message

Message

ข้อความที่อัปเดต

QuotedMessageMetadata

ข้อมูลเกี่ยวกับข้อความที่อ้างอิง

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของข้อความที่อ้างอิง

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

Timestamp

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

รีแอ็กชัน

รีแอ็กชันต่อข้อความ

ช่อง
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

รีแอ็กชันที่ถูกลบ

RichLinkMetadata

ลิงก์ที่สมบูรณ์ไปยังแหล่งข้อมูล

ช่อง
uri

string

URI ของลิงก์นี้
ฟิลด์ Union data ข้อมูลสำหรับแหล่งข้อมูลที่ลิงก์ data ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น

RichLinkType

ประเภทริชลิงก์ และอาจมีการเพิ่มประเภทอื่นๆ ในอนาคต

Enum
DRIVE_FILE ประเภทลิงก์สมบูรณ์ของ Google ไดรฟ์
CHAT_SPACE ประเภทริชลิงก์ของพื้นที่ใน Chat เช่น ชิปอัจฉริยะของพื้นที่ทำงาน

SearchSpacesRequest

คำขอค้นหารายการพื้นที่ทำงานตามคำค้นหา

ช่อง
use_admin_access

bool

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

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

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

ปัจจุบันวิธีนี้รองรับเฉพาะสิทธิ์เข้าถึงระดับผู้ดูแลระบบ ดังนั้นจึงยอมรับเฉพาะ true สำหรับช่องนี้
page_size

int32

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

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

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

string

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

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

string

ต้องระบุ คำค้นหา

คุณค้นหาได้โดยใช้พารามิเตอร์ต่อไปนี้

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time และ last_active_time ยอมรับการประทับเวลาในรูปแบบ RFC-3339 และตัวดำเนินการเปรียบเทียบที่รองรับคือ =, <, >, <=, >=

customer เป็นพารามิเตอร์ที่จำเป็นและใช้เพื่อระบุลูกค้าที่จะดึงข้อมูลพื้นที่ทำงาน customers/my_customer เป็นค่าเดียวที่รองรับ

display_name ยอมรับเฉพาะโอเปอเรเตอร์ HAS (:) ระบบจะแปลงข้อความที่จะจับคู่เป็นโทเค็นก่อน จากนั้นจะจับคู่คำนำหน้าของแต่ละโทเค็นโดยไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ และแยกกันเป็นสตริงย่อยที่ใดก็ได้ใน display_name ของพื้นที่ เช่น Fun Eve จะตรงกับ Fun event หรือ The evening was fun แต่ไม่ตรงกับ notFun event หรือ even

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"

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

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")
order_by

string

ไม่บังคับ วิธีจัดเรียงรายการพื้นที่ทำงาน

แอตทริบิวต์ที่รองรับสำหรับการจัดเรียงมีดังนี้

  • membership_count.joined_direct_human_user_count — แสดงจำนวนผู้ใช้ที่เป็นบุคคลซึ่งเข้าร่วมพื้นที่ทำงานโดยตรง
  • last_active_time — ระบุเวลาที่มีการเพิ่มรายการสุดท้ายที่มีสิทธิ์ลงในหัวข้อใดก็ตามของพื้นที่นี้
  • create_time — ระบุเวลาที่สร้างพื้นที่ทำงาน

ค่าการดำเนินการเรียงลำดับที่ใช้ได้มีดังนี้

  • ASC สำหรับการขึ้น ค่าเริ่มต้น

  • DESC สำหรับการเรียงจากมากไปน้อย

ไวยากรณ์ที่รองรับมีดังนี้

  • 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

SearchSpacesResponse

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

ช่อง
spaces[]

Space

หน้าของพื้นที่ทำงานที่ขอ
next_page_token

string

โทเค็นที่ใช้เพื่อดึงข้อมูลหน้าถัดไปได้ หากช่องนี้ว่างเปล่า แสดงว่าไม่มีหน้าถัดไป
total_size

int32

จำนวนพื้นที่ทั้งหมดที่ตรงกับคำค้นหาในทุกหน้า หากผลลัพธ์มีจำนวนมากกว่า 10,000 ช่อง ค่านี้จะเป็นค่าประมาณ

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

ชื่อของคำสั่ง Slash ที่เรียกใช้
command_id

int64

รหัสคำสั่งของคำสั่ง Slash ที่เรียกใช้
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

ไม่บังคับ ไม่ว่าจะเป็นข้อความส่วนตัวระหว่างแอป 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 customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) แอปส่วนตัวยังใช้customers/my_customerแทนชื่อจริงเพื่อสร้างพื้นที่ทำงานในองค์กร Google Workspace เดียวกันกับแอปได้ด้วย

สำหรับ DM ระบบจะไม่ป้อนข้อมูลในช่องนี้

ฟิลด์ Union space_permission_settings แสดงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน จะมีการป้อนข้อมูลเมื่อ space_type เป็น SPACE เท่านั้น space_permission_settings ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
predefined_permission_settings

PredefinedPermissionSettings

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

การตั้งค่าสิทธิ์ที่กำหนดไว้ล่วงหน้าจะรองรับสิ่งต่อไปนี้
permission_settings

PermissionSettings

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

การอ่านและการอัปเดตการตั้งค่าสิทธิ์รองรับสิ่งต่อไปนี้

AccessSettings

แสดงการตั้งค่าการเข้าถึงของพื้นที่ทำงาน

ช่อง
access_state

AccessState

เอาต์พุตเท่านั้น ระบุสถานะการเข้าถึงของพื้นที่ทำงาน
audience

string

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

รูปแบบ: audiences/{audience}

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

การอ่านกลุ่มเป้าหมายช่วยให้คุณทำสิ่งต่อไปนี้ได้

ช่องนี้จะไม่มีข้อมูลเมื่อใช้ขอบเขต chat.bot กับการตรวจสอบสิทธิ์แอป

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

AccessState

แสดงสถานะการเข้าถึงของพื้นที่ทำงาน

Enum
ACCESS_STATE_UNSPECIFIED ไม่รู้จักสถานะการเข้าถึงหรือไม่รองรับใน API นี้
PRIVATE เฉพาะผู้ใช้หรือ Google Groups ที่ได้รับการเพิ่มหรือเชิญจากผู้ใช้รายอื่นหรือผู้ดูแลระบบ Google Workspace เท่านั้นที่จะค้นพบและเข้าถึงพื้นที่ทำงานได้
DISCOVERABLE

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

การสร้างพื้นที่ทำงานที่ค้นพบได้ต้องใช้การตรวจสอบสิทธิ์ผู้ใช้

MembershipCount

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

ช่อง
joined_direct_human_user_count

int32

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

int32

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

PermissionSetting

แสดงการตั้งค่าสิทธิ์ของพื้นที่ทำงาน

ช่อง
managers_allowed

bool

ไม่บังคับ ผู้จัดการพื้นที่ทำงานมีสิทธิ์นี้หรือไม่
members_allowed

bool

ไม่บังคับ สมาชิกที่ไม่ใช่ผู้จัดการมีสิทธิ์นี้หรือไม่

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

ไม่บังคับ การตั้งค่าสำหรับการตอบกลับข้อความในพื้นที่ทำงาน

PredefinedPermissionSettings

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

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

SpaceDetails

รายละเอียดเกี่ยวกับพื้นที่ทำงาน รวมถึงคำอธิบายและกฎ

ช่อง
description

string

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

รองรับอักขระสูงสุด 150 ตัว
guidelines

string

ไม่บังคับ กฎ ความคาดหวัง และมารยาทของพื้นที่ทำงาน

รองรับอักขระสูงสุด 5,000 ตัว

SpaceThreadingState

ระบุประเภทสถานะการแยกชุดข้อความในพื้นที่ Chat

Enum
SPACE_THREADING_STATE_UNSPECIFIED สงวนสิทธิ์
THREADED_MESSAGES พื้นที่ทำงานที่มีชื่อซึ่งรองรับชุดข้อความ เมื่อผู้ใช้ตอบกลับข้อความ ผู้ใช้จะตอบกลับในเธรดได้ ซึ่งจะทำให้การตอบกลับอยู่ในบริบทของข้อความต้นฉบับ
GROUPED_MESSAGES พื้นที่ทำงานที่มีชื่อซึ่งจัดระเบียบการสนทนาตามหัวข้อ ระบบจะจัดกลุ่มหัวข้อและการตอบกลับไว้ด้วยกัน
UNTHREADED_MESSAGES ข้อความส่วนตัว (DM) ระหว่างบุคคล 2 คนและการสนทนากลุ่มระหว่างบุคคลตั้งแต่ 3 คนขึ้นไป

SpaceType

ประเภทพื้นที่ทำงาน ต้องระบุเมื่อสร้างหรืออัปเดตพื้นที่ทำงาน เอาต์พุตเท่านั้นสำหรับการใช้งานอื่นๆ

Enum
SPACE_TYPE_UNSPECIFIED สงวนสิทธิ์
SPACE พื้นที่ที่ผู้คนส่งข้อความ แชร์ไฟล์ และทำงานร่วมกัน SPACE สามารถมีแอป Chat ได้
GROUP_CHAT การสนทนากลุ่มที่มีผู้เข้าร่วมตั้งแต่ 3 คนขึ้นไป GROUP_CHAT สามารถมีแอป Chat ได้
DIRECT_MESSAGE ข้อความแบบ 1:1 ระหว่างมนุษย์ 2 คนหรือระหว่างมนุษย์กับแอป Chat

ประเภท

เลิกใช้งานแล้ว: โปรดใช้ SpaceType แทน

Enum
TYPE_UNSPECIFIED สงวนสิทธิ์
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 สงวนสิทธิ์
UNMUTED ผู้ใช้จะได้รับการแจ้งเตือนสำหรับพื้นที่ตามการตั้งค่าการแจ้งเตือน
MUTED ผู้ใช้จะไม่ได้รับการแจ้งเตือนใดๆ สำหรับพื้นที่ทำงาน ไม่ว่าการตั้งค่าการแจ้งเตือนจะเป็นอย่างไร

NotificationSetting

ประเภทการตั้งค่าการแจ้งเตือน และอาจรองรับประเภทอื่นๆ ในอนาคต

Enum
NOTIFICATION_SETTING_UNSPECIFIED สงวนสิทธิ์
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

พื้นที่ทำงานที่อัปเดต

ชุดข้อความ

ชุดข้อความในพื้นที่ใน 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

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

UpdateMembershipRequest

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

ช่อง
membership

Membership

ต้องระบุ การเป็นสมาชิกที่จะอัปเดต ระบบจะอัปเดตเฉพาะฟิลด์ที่ระบุโดย update_mask
update_mask

FieldMask

ต้องระบุ เส้นทางฟิลด์ที่จะอัปเดต คั่นหลายค่าด้วยคอมมาหรือใช้ * เพื่ออัปเดตเส้นทางฟิลด์ทั้งหมด

เส้นทางฟิลด์ที่รองรับในปัจจุบันมีดังนี้

  • role
use_admin_access

bool

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

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

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

UpdateMessageRequest

ขออัปเดตข้อความ

ช่อง
message

Message

ต้องระบุ ข้อความที่มีช่องที่อัปเดตแล้ว
update_mask

FieldMask

ต้องระบุ เส้นทางฟิลด์ที่จะอัปเดต คั่นหลายค่าด้วยคอมมาหรือใช้ * เพื่ออัปเดตเส้นทางฟิลด์ทั้งหมด

เส้นทางฟิลด์ที่รองรับในปัจจุบันมีดังนี้
allow_missing

bool

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

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: อัปเดตคำอธิบายของพื้นที่ทำงาน รองรับอักขระสูงสุด 150 ตัว

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

space_type: รองรับเฉพาะการเปลี่ยนประเภทพื้นที่ทำงานจาก GROUP_CHAT เป็น SPACE ใส่ display_name พร้อมกับ space_type ในมาสก์การอัปเดต และตรวจสอบว่าพื้นที่ที่ระบุมีชื่อที่แสดงที่ไม่ว่างเปล่าและประเภทพื้นที่ SPACE คุณจะใส่space_typeมาสก์และประเภทSPACEในพื้นที่ที่ระบุเมื่ออัปเดตชื่อที่แสดงหรือไม่ก็ได้ หากพื้นที่ที่มีอยู่มีประเภทSPACEอยู่แล้ว การพยายามอัปเดตประเภทพื้นที่ทำงานด้วยวิธีอื่นๆ จะทำให้เกิดข้อผิดพลาดเกี่ยวกับอาร์กิวเมนต์ที่ไม่ถูกต้อง useAdminAccess ไม่รองรับ space_type

space_history_state: อัปเดตการตั้งค่าประวัติของพื้นที่ทำงานโดยการเปิดหรือปิดประวัติสำหรับพื้นที่ทำงาน รองรับเฉพาะในกรณีที่เปิดใช้การตั้งค่าประวัติสำหรับองค์กร Google Workspace หากต้องการอัปเดตสถานะประวัติพื้นที่ทำงาน คุณต้องละเว้นมาสก์ฟิลด์อื่นๆ ทั้งหมดในคำขอ useAdminAccess ไม่รองรับ space_history_state

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

permission_settings: รองรับการเปลี่ยนการตั้งค่าสิทธิ์ของพื้นที่ทำงาน เมื่ออัปเดตการตั้งค่าสิทธิ์ คุณจะระบุได้เฉพาะมาสก์ของฟิลด์ permissionSettings เท่านั้น และจะอัปเดตมาสก์ของฟิลด์อื่นๆ พร้อมกันไม่ได้ useAdminAccess ไม่รองรับ permissionSettings ฟิลด์มาสก์ที่รองรับมีดังนี้

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_admin_access

bool

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

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

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

ระบบไม่รองรับค่า FieldMask บางค่าเมื่อใช้สิทธิ์เข้าถึงระดับผู้ดูแลระบบ ดูรายละเอียดได้ที่คำอธิบายของ update_mask

ผู้ใช้

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

ช่อง
name

string

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

รูปแบบ: users/{user} users/app สามารถใช้เป็นชื่อแทนสำหรับผู้ใช้แอปโทร bot ได้

สำหรับ human users {user} คือตัวระบุผู้ใช้เดียวกันกับ

  • id สำหรับ Person ใน 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 จะแสดงเฉพาะชื่อทรัพยากรที่แน่นอน (เช่น users/123456789)
display_name

string

เอาต์พุตเท่านั้น ชื่อที่แสดงของผู้ใช้
domain_id

string

ตัวระบุที่ไม่ซ้ำของโดเมน Google Workspace ของผู้ใช้
type

Type

ประเภทผู้ใช้
is_anonymous

bool

เอาต์พุตเท่านั้น เมื่อ true ระบบจะลบผู้ใช้หรือซ่อนโปรไฟล์ของผู้ใช้

ประเภท

Enum
TYPE_UNSPECIFIED ค่าเริ่มต้นสำหรับ Enum ห้ามใช้
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

แสดงรายการคีย์-ค่าในวิดเจ็ตนี้

ปุ่ม

ปุ่ม อาจเป็นปุ่มข้อความหรือปุ่มรูปภาพ

ช่อง

ฟิลด์ 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

ค่าของพารามิเตอร์

Icon

ชุดไอคอนที่รองรับ

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 ซึ่งอ้างอิงถึงไอคอนที่ API ของ Chat ระบุ
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