อัปเดตการเป็นสมาชิกของผู้ใช้ในพื้นที่ของ Google Chat

คู่มือนี้อธิบายวิธีใช้เมธอด update() ในทรัพยากร Membership ของ Google Chat API เพื่อเปลี่ยนแอตทริบิวต์ เกี่ยวกับการเป็นสมาชิก เช่น การเปลี่ยนสมาชิกพื้นที่ทำงานเป็นผู้จัดการพื้นที่ทำงาน หรือการเปลี่ยน ผู้จัดการพื้นที่ทำงานเป็นสมาชิกพื้นที่ทำงาน

หากคุณเป็นผู้ดูแลระบบ Google Workspace คุณสามารถเรียกใช้เมธอด update() เพื่ออัปเดตการเป็นสมาชิกของพื้นที่ใดก็ได้ในองค์กร Google Workspace

ออบเจ็กต์ Membership แสดงว่าผู้ใช้ที่เป็นมนุษย์หรือแอป Google Chat ได้รับเชิญให้เข้าร่วม เป็นส่วนหนึ่งของ หรือไม่ได้อยู่ในพื้นที่ทำงาน

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

Node.js

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

อัปเดตการเป็นสมาชิก

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

  • ระบุขอบเขตการให้สิทธิ์ ดังนี้
  • เรียกใช้เมธอด UpdateMembership()
  • ส่ง membership เป็นอินสแตนซ์ของ Membership พร้อมข้อมูลต่อไปนี้
    • ฟิลด์ name ตั้งค่าเป็นการเป็นสมาชิกที่จะอัปเดต ซึ่งรวมถึงรหัสพื้นที่ทำงาน และรหัสสมาชิก
    • ฟิลด์การเป็นสมาชิกที่จะอัปเดตตั้งค่าเป็นค่าใหม่
  • ส่ง updateMask เพื่อระบุลักษณะของการเป็นสมาชิกที่จะอัปเดต ซึ่งรวมถึงสิ่งต่อไปนี้
    • role: บทบาทของผู้ใช้ภายในพื้นที่ใน Chat ซึ่งกำหนดการดำเนินการที่ได้รับอนุญาตในพื้นที่ ค่าที่เป็นไปได้มีดังนี้
      • ROLE_MEMBER: สมาชิกของพื้นที่ทำงาน ผู้ใช้มีสิทธิ์พื้นฐาน เช่น การส่งข้อความไปยังพื้นที่ ในการสนทนาแบบตัวต่อตัวและแบบกลุ่มที่ไม่มีชื่อ ทุกคนจะมีบทบาทนี้
      • ROLE_MANAGER: ผู้จัดการพื้นที่ทำงาน ผู้ใช้มีสิทธิ์พื้นฐานทั้งหมด รวมถึงสิทธิ์ของผู้ดูแลระบบที่อนุญาตให้จัดการพื้นที่ทำงาน เช่น เพิ่มหรือ นำสมาชิกออก ใช้ได้เฉพาะในพื้นที่ทำงานที่ spaceType เป็น SPACE (พื้นที่ทำงานที่มีชื่อ)

ตั้งสมาชิกพื้นที่ทำงานปกติเป็นผู้จัดการพื้นที่ทำงานในฐานะผู้ใช้

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

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

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

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

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

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

main().catch(console.error);

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

  • SPACE_NAME: รหัสจากnameของพื้นที่ทำงาน คุณรับรหัสได้โดยการเรียกใช้เมธอด ListSpaces() หรือจาก URL ของพื้นที่ทำงาน
  • MEMBER_NAME: รหัสจากการเป็นสมาชิกของ name คุณขอรับรหัสได้โดยการเรียกใช้เมธอด ListMemberships() หรือจากเนื้อหาการตอบสนองที่ส่งกลับมาหลังจากสร้างการเป็นสมาชิก แบบไม่พร้อมกันด้วย Chat API
  • ROLE_NAME: บทบาทที่อัปเดต ROLE_MANAGER

Google Chat API จะอัปเดตการเป็นสมาชิกที่ระบุเป็นผู้จัดการพื้นที่ทำงานและแสดงอินสแตนซ์ของ Membership

เปลี่ยนผู้จัดการพื้นที่ทำงานให้เป็นสมาชิกทั่วไปในฐานะผู้ใช้

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

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

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

// This sample shows how to update a membership with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

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

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

main().catch(console.error);

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

  • SPACE_NAME: รหัสจากnameของพื้นที่ทำงาน คุณรับรหัสได้โดยการเรียกใช้เมธอด ListSpaces() หรือจาก URL ของพื้นที่ทำงาน
  • MEMBER_NAME: รหัสจากการเป็นสมาชิกของ name คุณขอรับรหัสได้โดยการเรียกใช้เมธอด ListMemberships() หรือจากเนื้อหาการตอบสนองที่ส่งกลับมาหลังจากสร้างการเป็นสมาชิก แบบไม่พร้อมกันด้วย Chat API
  • ROLE_NAME: บทบาทที่อัปเดต ROLE_MEMBER

Google Chat API จะอัปเดตการเป็นสมาชิกที่ระบุเป็นผู้จัดการพื้นที่ทำงานและแสดงอินสแตนซ์ของ Membership

ตั้งสมาชิกพื้นที่ทำงานปกติเป็นผู้จัดการพื้นที่ทำงานในฐานะแอป Chat

การตรวจสอบสิทธิ์แอปต้องมีการอนุมัติจากผู้ดูแลระบบแบบครั้งเดียว

สร้างคีย์ API

หากต้องการเรียกเมธอด API ของรุ่นตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ คุณต้องใช้เอกสารการค้นพบ API เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ที่ไม่ใช่แบบสาธารณะ หากต้องการตรวจสอบสิทธิ์คำขอ คุณต้องส่งคีย์ API

หากต้องการสร้างคีย์ API ให้เปิดโปรเจ็กต์ Google Cloud ของแอป แล้วทำดังนี้

  1. ในคอนโซล Google Cloud ให้ไปที่เมนู > API และบริการ > ข้อมูลเข้าสู่ระบบ

    ไปที่ข้อมูลเข้าสู่ระบบ

  2. คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API
  3. ระบบจะแสดงคีย์ API ใหม่
    • คลิกคัดลอก เพื่อคัดลอกคีย์ API สำหรับใช้ในโค้ดของแอป คุณยังค้นหาคีย์ API ได้ในส่วน "คีย์ API" ของข้อมูลเข้าสู่ระบบของโปรเจ็กต์
    • คลิกจำกัดคีย์เพื่ออัปเดตการตั้งค่าขั้นสูงและจำกัดการใช้ คีย์ API ดูรายละเอียดเพิ่มเติมได้ที่การใช้ข้อจำกัดของคีย์ API

เขียนสคริปต์ที่เรียกใช้ Chat API

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

Python

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

  2. ใส่โค้ดต่อไปนี้ใน chat_membership_update_to_manager_app.py

    from google.oauth2 import service_account
from apiclient.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.app.memberships"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates a specified space member to change
    it from a regular member to a space manager.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

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

        # The membership to update, and the updated role.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MEMBERSHIP with a membership name.
        # Obtain the membership name from the membership of Chat API.
        name='spaces/SPACE/members/MEMBERSHIP',
        updateMask='role',
        body={'role': 'ROLE_MANAGER'}

      ).execute()

    # Prints details about the updated membership.
    print(result)

if __name__ == '__main__':
    main()

  3. ในโค้ด ให้แทนที่ค่าต่อไปนี้

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

    python3 chat_membership_update_to_manager_app.py

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

การตรวจสอบสิทธิ์แอปต้องมีการอนุมัติจากผู้ดูแลระบบแบบครั้งเดียว

สร้างคีย์ API

หากต้องการเรียกเมธอด API ของรุ่นตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ คุณต้องใช้เอกสารการค้นพบ API เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ที่ไม่ใช่แบบสาธารณะ หากต้องการตรวจสอบสิทธิ์คำขอ คุณต้องส่งคีย์ API

หากต้องการสร้างคีย์ API ให้เปิดโปรเจ็กต์ Google Cloud ของแอป แล้วทำดังนี้

  1. ในคอนโซล Google Cloud ให้ไปที่เมนู > API และบริการ > ข้อมูลเข้าสู่ระบบ

    ไปที่ข้อมูลเข้าสู่ระบบ

  2. คลิกสร้างข้อมูลเข้าสู่ระบบ > คีย์ API
  3. ระบบจะแสดงคีย์ API ใหม่
    • คลิกคัดลอก เพื่อคัดลอกคีย์ API สำหรับใช้ในโค้ดของแอป คุณยังค้นหาคีย์ API ได้ในส่วน "คีย์ API" ของข้อมูลเข้าสู่ระบบของโปรเจ็กต์
    • คลิกจำกัดคีย์เพื่ออัปเดตการตั้งค่าขั้นสูงและจำกัดการใช้ คีย์ API ดูรายละเอียดเพิ่มเติมได้ที่การใช้ข้อจำกัดของคีย์ API

เขียนสคริปต์ที่เรียกใช้ Chat API

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

Python

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

  2. ใส่โค้ดต่อไปนี้ใน chat_membership_update_to_member_app.py

    from google.oauth2 import service_account
from apiclient.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.app.memberships"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates a specified space member to change
    it from a regular member to a space manager.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

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

        # The membership to update, and the updated role.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MEMBERSHIP with a membership name.
        # Obtain the membership name from the membership of Chat API.
        name='spaces/SPACE/members/MEMBERSHIP',
        updateMask='role',
        body={'role': 'ROLE_MEMBER'}

      ).execute()

    # Prints details about the updated membership.
    print(result)

if __name__ == '__main__':
    main()

  3. ในโค้ด ให้แทนที่ค่าต่อไปนี้

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

    python3 chat_membership_update_to_member_app.py

อัปเดตการเป็นสมาชิกในฐานะผู้ดูแลระบบ Google Workspace

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

หากต้องการเรียกใช้เมธอดนี้ในฐานะผู้ดูแลระบบ Google Workspace ให้ทำดังนี้

ดูข้อมูลเพิ่มเติมและตัวอย่างได้ที่หัวข้อจัดการพื้นที่ใน Google Chat ในฐานะผู้ดูแลระบบ Google Workspace