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

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

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

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

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

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

สิ่งที่ต้องดำเนินการก่อน

Python

  • Python 3.6 ขึ้นไป
  • เครื่องมือจัดการแพ็กเกจ pip
  • ไลบรารีของไคลเอ็นต์ Google ล่าสุดสำหรับ Python หากต้องการติดตั้งหรืออัปเดต ให้เรียกใช้คำสั่งต่อไปนี้ในอินเทอร์เฟซบรรทัดคำสั่ง

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    
  • โปรเจ็กต์ Google Cloud ที่เปิดใช้และกำหนดค่า Google Chat API โปรดดูขั้นตอนในหัวข้อสร้างแอป Google Chat
  • การกำหนดค่าการให้สิทธิ์สำหรับแอป Chat การตั้งค่าพื้นที่ทำงานต้องมีการตรวจสอบสิทธิ์ผู้ใช้ด้วยขอบเขตการให้สิทธิ์ chat.spaces.create หรือ chat.spaces

Node.js

  • Node.js และ NPM
  • ไลบรารีของไคลเอ็นต์ Google ล่าสุดสำหรับ Node.js หากต้องการติดตั้ง ให้เรียกใช้คำสั่งต่อไปนี้ในอินเทอร์เฟซบรรทัดคำสั่ง

    npm install @google-cloud/local-auth @googleapis/chat
    
  • โปรเจ็กต์ Google Cloud ที่เปิดใช้และกำหนดค่า Google Chat API โปรดดูขั้นตอนในหัวข้อสร้างแอป Google Chat
  • กำหนดค่าการให้สิทธิ์สำหรับแอป Chat แล้ว การสร้างพื้นที่ทำงานต้องมีการตรวจสอบสิทธิ์ผู้ใช้ที่มีขอบเขตการให้สิทธิ์ chat.spaces.create หรือ chat.spaces

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

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

  • ระบุขอบเขตการให้สิทธิ์ chat.spaces.create หรือ chat.spaces
  • เรียกใช้เมธอด setup ในทรัพยากร Space
  • หากต้องการเพิ่มผู้ใช้ที่เป็นมนุษย์เป็นสมาชิกพื้นที่ทำงาน ให้ระบุ users/{user} โดยที่ {user} เป็น {person_id} สำหรับ person จาก People API หรือรหัสของ user ใน Directory API ตัวอย่างเช่น หากบุคคล resourceName ของ People API คือ 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