Method: spaces.setup

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

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

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

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

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

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

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

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

คำขอ 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}

สำหรับการเป็นสมาชิกกลุ่มของ Google ช่อง Membership.group_member ต้องมี group ที่ป้อนข้อมูลname (รูปแบบ groups/{group}) คุณจะเพิ่ม Google Groups ได้เมื่อตั้งค่า 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)

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

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

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

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

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

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