Method: spaces.setup

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

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

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

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

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

หากมี DM ระหว่างผู้ใช้ 2 คนอยู่แล้ว แม้ว่าผู้ใช้ 1 คนจะบล็อกผู้ใช้รายอื่นในขณะที่ส่งคําขอ ก็จะส่ง DM เดิมกลับมา

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

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

คำขอ HTTP

POST https://chat.googleapis.com/v1/spaces:setup

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

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

เนื้อหาของคําขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
ช่อง
space

object (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 อยู่แล้ว ระบบจะแสดงผลพื้นที่ทํางานดังกล่าวแทนการสร้างพื้นที่ทํางานใหม่
requestId

string

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

object (Membership)

ไม่บังคับ ผู้ใช้ Google Chat เพื่อเชิญเข้าร่วมพื้นที่ทํางาน ไม่นําผู้ใช้โทรหา เนื่องจากมีการเพิ่มผู้ใช้โดยอัตโนมัติ

ปัจจุบันชุดนี้อนุญาตให้มีการเป็นสมาชิกได้สูงสุด 20 รายการ (นอกเหนือจากผู้โทร)

ช่อง Membership.member ต้องมี user ที่มีการป้อนข้อมูล name (รูปแบบ: users/{user}) และ type เป็น User.Type.HUMAN คุณสามารถเพิ่มผู้ใช้ที่เป็นมนุษย์เมื่อตั้งค่าพื้นที่ทํางานเท่านั้น (การเพิ่มแอป Chat ใช้ได้กับการตั้งค่าข้อความส่วนตัวด้วยแอปการโทรเท่านั้น) นอกจากนี้ คุณยังสามารถเพิ่มสมาชิกโดยใช้อีเมลของผู้ใช้เป็นชื่อแทนสําหรับ {user} เช่น user.name อาจเป็น users/example@gmail.com" หากต้องการเชิญผู้ใช้ Gmail หรือผู้ใช้จากโดเมน Google Workspace ภายนอก อีเมลของผู้ใช้จะต้องใช้สําหรับ {user}

ไม่บังคับเมื่อตั้งค่า Space.spaceType เป็น SPACE

ต้องระบุเมื่อตั้งค่า Space.spaceType เป็น GROUP_CHAT รวมถึงการเป็นสมาชิกอย่างน้อย 2 รายการ

ต้องระบุเมื่อตั้งค่า Space.spaceType เป็น DIRECT_MESSAGE จากผู้ใช้ที่เป็นมนุษย์ รวมถึงการเป็นสมาชิก 1 รายการเท่านั้น

ต้องว่างเปล่าเมื่อสร้างการสนทนาแบบ 1:1 ระหว่างมนุษย์และแอป Chat ที่ใช้โทร (เมื่อตั้งค่า Space.spaceType เป็น DIRECT_MESSAGE และ Space.singleUserBotDm เป็น true)

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Space

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

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

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

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