ตั้งค่าพื้นที่ทำงานที่มีสมาชิกเริ่มต้น

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

แหล่งข้อมูล Space รายการ แสดงถึงสถานที่ที่ผู้คนและแอป Chat ส่งข้อความได้ แชร์ไฟล์ และทำงานร่วมกัน พื้นที่ทำงานมีหลายประเภทดังนี้

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

เมื่อตั้งค่าพื้นที่ทำงาน โปรดคำนึงถึงสิ่งต่อไปนี้

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

ข้อกำหนดเบื้องต้น

Python

  • ธุรกิจหรือองค์กร บัญชี Google Workspace ที่มีสิทธิ์เข้าถึง Google Chat

Node.js

  • ธุรกิจหรือองค์กร บัญชี Google Workspace ที่มีสิทธิ์เข้าถึง Google Chat

ตั้งค่าพื้นที่ทำงาน

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

  • ระบุขอบเขตการให้สิทธิ์ chat.spaces.create หรือ chat.spaces
  • เรียกใช้ setup วิธี ในแหล่งข้อมูล Space
  • หากต้องการเพิ่มผู้ใช้ที่เป็นมนุษย์เป็นสมาชิกพื้นที่ทำงาน ให้ระบุ users/{user} โดยที่ {user} เป็น {person_id} สำหรับฟิลด์ person จาก People API หรือรหัสของ user ใน Directory API ตัวอย่างเช่น ถ้าคนที่ใช้ People API resourceName คือ people/123456789 คุณสามารถเพิ่มผู้ใช้ไปยังพื้นที่ทำงานได้โดย รวมการเป็นสมาชิกกับ users/123456789 ในฐานะ member.name ด้วย
  • หากต้องการเพิ่มกลุ่มเป็นสมาชิกพื้นที่ทำงาน ให้ระบุ groups/{group} โดยที่ {group} คือ รหัสกลุ่มที่คุณต้องการสร้างการเป็นสมาชิกให้ รหัสสำหรับกลุ่มสามารถ ให้เรียกข้อมูลได้โดยใช้ Cloud Identity API ตัวอย่างเช่น หาก Cloud Identity API แสดงผลกลุ่มชื่อ groups/123456789 จากนั้นตั้งค่า membership.groupMember.name ถึง groups/123456789 ไม่สามารถใช้ Google Groups เพิ่มลงในแชทเป็นกลุ่มหรือ DM แต่ไปยังพื้นที่ทำงานที่มีชื่อเท่านั้น
  • วิธีสร้าง DM ระหว่างผู้ใช้ที่โทรและผู้ใช้อื่น ผู้ใช้ ให้ระบุการเป็นสมาชิกของผู้ใช้ที่เป็นมนุษย์ในคำขอของคุณ
  • หากต้องการสร้าง DM ระหว่างผู้ใช้ที่โทรกับแอปการโทร ให้ตั้งค่า Space.singleUserBotDm ไปยัง true และไม่ระบุการเป็นสมาชิกใดๆ คุณสามารถ ให้ใช้วิธีการนี้เพื่อตั้งค่า DM ด้วยแอปการโทรเท่านั้น วิธีเพิ่มการโทร แอปเป็นสมาชิกของพื้นที่ทำงานหรือ DM ที่มีอยู่ระหว่างผู้ใช้ที่เป็นมนุษย์ 2 คน โปรดดูหัวข้อ สร้างการเป็นสมาชิก

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

Python

  1. สร้างไฟล์ชื่อ chat_space_setup.py ในไดเรกทอรีการทำงาน

  2. รวมรหัสต่อไปนี้ใน chat_space_setup.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.spaces.create"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then sets up a Chat space by creating a space and adding members.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().setup(

      # Details about the space to set up.
      body = {

        # Attributes of the space to set up, like space type and display name.
        'space': {

            # To set up a named space, set spaceType to SPACE.
            'spaceType': 'SPACE',

            # The user-visible name of the space
            'displayName': 'API-setup'
        },

        # The users and groups to add to the space.
        #
        # The authenticated user is automatically added to the space,
        # and doesn't need to be specified in the memberships array.
        'memberships': [
            {
              'member': {
                'name':'users/123456789',
                'type': 'HUMAN'
              }
            },
            {
              'member': {
                'name':'users/987654321',
                'type': 'HUMAN'
              }
            },
            {
              'groupMember': {
                'name': 'groups/11223344'
              }
            }
        ]
      }

      ).execute()

    # Prints details about the created space.
    print(result)

if __name__ == '__main__':
    main()

  3. ในไดเรกทอรีการทำงาน ให้สร้างและเรียกใช้ตัวอย่างด้วยคำสั่งต่อไปนี้

    python3 chat_space_setup.py

Node.js

  1. สร้างไฟล์ชื่อ setup-space.js ในไดเรกทอรีการทำงาน

  2. รวมรหัสต่อไปนี้ใน setup-space.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Sets up a new Chat space with users.
* @return {!Promise<!Object>}
*/
async function setupSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces.create',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.setup({
    requestBody: {
      space: {
        spaceType: 'SPACE',
        displayName: 'API-made',
      },
      memberships: [
        {member: {name: 'users/123456789', type: 'HUMAN'}},
        {member: {name: 'users/987654321', type: 'HUMAN'}},
        {groupMember: {name: 'groups/11223344'}},
      ]
    }
  });
}

setupSpace().then(console.log);

  3. ในไดเรกทอรีการทำงาน ให้เรียกใช้ตัวอย่าง

    node setup-space.js

พื้นที่ใน Chat ที่มีชื่อซึ่งมี 1 กลุ่มและผู้ใช้ที่เป็นมนุษย์ 3 คน รวมถึง ตั้งค่าผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

หากต้องการไปที่พื้นที่ทำงาน ให้ใช้รหัสทรัพยากรของพื้นที่ทำงานเพื่อสร้าง URL ของพื้นที่ทำงาน คุณสามารถรับรหัสทรัพยากรได้จากพื้นที่ทำงาน name ในการตอบกลับของ Google Chat เนื้อความ ตัวอย่างเช่น ถ้า name ของพื้นที่ทำงานของคุณคือ spaces/1234567 คุณสามารถ เว้นวรรคโดยใช้ URL ต่อไปนี้ https://mail.google.com/chat/u/0/#chat/space/1234567