Method: spaces.setup

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

หากต้องการระบุสมาชิกที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย member.name ที่เหมาะสมใน SetUpSpaceRequest หากต้องการเพิ่มผู้ใช้ที่เป็นมนุษย์ ให้ใช้ 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

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

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

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

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

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

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

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

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

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

การแสดง 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

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