Method: spaces.setup

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

หากต้องการระบุสมาชิกที่เป็นบุคคลที่จะเพิ่ม ให้เพิ่มการเป็นสมาชิกด้วย membership.member.name ที่เหมาะสม หากต้องการเพิ่มผู้ใช้ที่เป็นบุคคล ให้ใช้ users/{user} โดยที่ {user} อาจเป็นอีเมลของผู้ใช้ สําหรับผู้ใช้ในองค์กร Workspace เดียวกัน {user} อาจเป็น id ของบุคคลจาก People API หรือ id ของผู้ใช้ใน Directory API ก็ได้ ตัวอย่างเช่น หากรหัสโปรไฟล์บุคคลของ user@example.com ใน People API คือ 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 Groups ได้เป็นสมาชิกในพื้นที่ทำงานที่มีชื่อเท่านั้น

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

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

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

หากผู้ใช้ 2 รายมี DM อยู่แล้ว แม้ว่าผู้ใช้รายหนึ่งจะบล็อกอีกรายหนึ่งในขณะที่ส่งคำขอ ระบบก็จะแสดง 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 ได้เมื่อตั้งค่า 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

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