สร้างพื้นที่ใน Google Chat และเพิ่มสมาชิก

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

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

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

คุณใช้วิธี setUp() เพื่อทำสิ่งต่างๆ ต่อไปนี้ได้

  • สร้างพื้นที่ทำงานที่มีชื่อพร้อมสมาชิกเริ่มต้น
  • สร้างข้อความส่วนตัว (DM) ระหว่างบุคคล 2 คน
  • ตั้งค่าข้อความกลุ่มระหว่างบุคคลหลายคน

เมื่อตั้งค่าพื้นที่ทำงาน ให้พิจารณาสิ่งต่อไปนี้

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

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

Node.js

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

Python

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

Java

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

Apps Script

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

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

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

  • ระบุขอบเขตการให้สิทธิ์ chat.spaces.create หรือ chat.spaces
  • เรียกใช้เมธอด SetUpSpace()
  • ส่ง space เป็นอินสแตนซ์ของ Space พร้อมฟิลด์ที่จำเป็นทั้งหมด เช่น displayName หรือ spaceType
  • ส่ง memberships เป็นอาร์เรย์ของอินสแตนซ์ Membership สำหรับแต่ละอินสแตนซ์ ให้ทำดังนี้
    • ระบุ 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 รายการใน พื้นที่ทำงานสำหรับผู้ใช้ที่เป็นบุคคล 2 ราย (ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์และผู้ใช้รายอื่น)

Node.js

chat/client-libraries/cloud/set-up-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces.create'];

// This sample shows how to set up a named space with one initial member
// with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    space: {
      spaceType: 'SPACE',
      // Replace DISPLAY_NAME here.
      displayName: 'DISPLAY_NAME'
    },
    memberships: [{
      member: {
        // Replace USER_NAME here.
        name: 'users/USER_NAME',
        type: 'HUMAN'
      }
    }]
  };

  // Make the request
  const response = await chatClient.setUpSpace(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/set_up_space_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.spaces.create"]

def set_up_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.SetUpSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        },
        memberships = [{
            "member": {
                # Replace USER_NAME here.
                "name": 'users/USER_NAME',
                "type_": 'HUMAN'
            }
        }]
    )

    # Make the request
    response = client.set_up_space(request)

    # Handle the response
    print(response)

set_up_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/SetUpSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SetUpSpaceRequest;
import com.google.chat.v1.Space;
import com.google.chat.v1.User;

// This sample shows how to set up a named space with one initial member with
// user credential.
public class SetUpSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces.create";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      SetUpSpaceRequest.Builder request = SetUpSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"))
        .addAllMemberships(ImmutableList.of(Membership.newBuilder()
          .setMember(User.newBuilder()
            // Replace USER_NAME here.
            .setName("users/USER_NAME")
            .setType(User.Type.HUMAN)).build()));
      Space response = chatServiceClient.setUpSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to set up a named space with one initial member with
 * user credential.
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.create'
 * referenced in the manifest file (appsscript.json).
 */
function setUpSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };
  const memberships = [{
    member: {
      // TODO(developer): Replace USER_NAME here
      name: 'users/USER_NAME',
      // User type for the membership
      type: 'HUMAN'
    }
  }];

  // Make the request
  const response = Chat.Spaces.setup({ space: space, memberships: memberships });

  // Handle the response
  console.log(response);
}

หากต้องการเรียกใช้ตัวอย่าง ให้แทนที่ค่าต่อไปนี้

  • DISPLAY_NAME: ชื่อที่แสดงของพื้นที่ทำงานใหม่
  • USER_NAME: รหัสของผู้ใช้รายอื่นที่จะรวมการเป็นสมาชิกด้วย

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