스페이스 나열

이 가이드에서는 Google Chat API의 Space 리소스에서 list 리소스를 사용하여 스페이스를 나열하는 방법을 설명합니다. 스페이스를 나열하면 페이지로 나눈 필터링 가능한 스페이스 목록이 반환됩니다.

Space 리소스는 사용자와 채팅 앱이 메시지를 보내고 파일을 공유하며 공동작업할 수 있는 위치를 나타냅니다. 스페이스에는 다음과 같은 여러 유형이 있습니다.

• 채팅 메시지 (DM)는 두 사용자 또는 사용자와 채팅 앱 간의 대화입니다.
• 그룹 채팅은 3명 이상의 사용자와 채팅 앱 간의 대화입니다.
• 이름이 지정된 스페이스는 사용자가 계속해서 메시지를 보내고 파일을 공유하며 공동작업할 수 있는 공간입니다.

앱 인증이 포함된 스페이스를 나열하면 채팅 앱이 액세스할 수 있는 스페이스가 나열됩니다. 사용자 인증으로 스페이스를 나열하면 인증된 사용자가 액세스할 수 있는 스페이스가 나열됩니다.

기본 요건

Python

• Python 3.6 이상
• pip 패키지 관리 도구

• 최신 Python용 Google 클라이언트 라이브러리입니다. 이를 설치하거나 업데이트하려면 명령줄 인터페이스에서 다음 명령어를 실행합니다.

  pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
  

• Google Chat API가 사용 설정 및 구성된 Google Cloud 프로젝트 단계는 Google Chat 앱 빌드를 참고하세요.

• 채팅 앱에 구성된 승인입니다. 등록정보 스페이스는 다음 두 가지 인증 방법을 모두 지원합니다.

  • chat.spaces.readonly 또는 chat.spaces 승인 범위를 사용한 사용자 인증
  • chat.bot 승인 범위를 사용한 앱 인증

Node.js

• Node.js 및 npm

• Node.js용 최신 Google 클라이언트 라이브러리입니다. 설치하려면 명령줄 인터페이스에서 다음 명령어를 실행하세요.

  npm install @google-cloud/local-auth @googleapis/chat
  

• Google Chat API가 사용 설정 및 구성된 Google Cloud 프로젝트 단계는 Google Chat 앱 빌드를 참고하세요.

• 채팅 앱에 구성된 승인입니다. 등록정보 스페이스는 다음 두 가지 인증 방법을 모두 지원합니다.

  • chat.spaces.readonly 또는 chat.spaces 승인 범위를 사용한 사용자 인증
  • chat.bot 승인 범위를 사용한 앱 인증

사용자 인증을 사용하여 스페이스 나열

Google Chat의 스페이스를 나열하려면 요청에 다음을 전달합니다.

• 사용자 인증을 사용하여 chat.spaces.readonly 또는 chat.spaces 승인 범위를 지정합니다.
• Space 리소스에서 list 메서드를 호출합니다.

다음 예시에서는 인증된 사용자에게 표시되는 이름이 지정된 스페이스와 그룹 채팅 (필터링된 채팅 메시지는 제외)을 나열합니다.

Python

1. 작업 디렉터리에서 chat_space_list.py라는 파일을 만듭니다.

2. chat_space_list.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.readonly"]
   
   def main():
       '''
       Authenticates with Chat API via user credentials,
       then lists named spaces and group chats (but not direct messages)
       visible to the authenticated user.
       '''
   
       # 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().list(
   
             # An optional filter that returns named spaces or unnamed group chats,
             # but not direct messages (DMs).
             filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
   
         ).execute()
   
       # Prints the returned list of spaces.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. 작업 디렉터리에서 샘플을 빌드하고 실행합니다.

   python3 chat_space_list.py
   

Node.js

1. 작업 디렉터리에서 list-spaces.js라는 파일을 만듭니다.

2. list-spaces.js에 다음 코드를 포함합니다.

   const chat = require('@googleapis/chat');
   const {authenticate} = require('@google-cloud/local-auth');
   
   /**
   * List Chat spaces.
   * @return {!Promise<!Object>}
   */
   async function listSpaces() {
     const scopes = [
       'https://www.googleapis.com/auth/chat.spaces.readonly',
     ];
   
     const authClient =
         await authenticate({scopes, keyfilePath: 'client_secrets.json'});
   
     const chatClient = await chat.chat({version: 'v1', auth: authClient});
   
     return await chatClient.spaces.list({
       filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
     });
   }
   
   listSpaces().then(console.log);
   

3. 작업 디렉터리에서 샘플을 실행합니다.

   node list-spaces.js
   

Chat API는 이름이 지정된 스페이스 및 그룹 채팅의 페이지로 나눈 배열을 반환합니다.

앱 인증이 있는 스페이스 나열

Google Chat의 스페이스를 나열하려면 요청에 다음을 전달합니다.

• 앱 인증을 사용하여 chat.bot 승인 범위를 지정합니다.
• Space 리소스에서 list 메서드를 호출합니다.

다음 예시에서는 채팅 앱에 표시되는 이름이 지정된 스페이스와 그룹 채팅 (채팅 메시지 제외)을 나열합니다.

Python

1. 작업 디렉터리에서 chat_space_list_app.py라는 파일을 만듭니다.

2. chat_space_list_app.py에 다음 코드를 포함합니다.

   from google.oauth2 import service_account
   from apiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = ['https://www.googleapis.com/auth/chat.bot']
   
   # Specify service account details.
   CREDENTIALS = (
       service_account.Credentials.from_service_account_file('credentials.json')
       .with_scopes(SCOPES)
   )
   
   # Build the URI and authenticate with the service account.
   chat = build('chat', 'v1', credentials=CREDENTIALS)
   
   # Use the service endpoint to call Chat API.
   result = chat.spaces().list(
   
           # An optional filter that returns named spaces or unnamed
           # group chats, but not direct messages (DMs).
           filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
   
       ).execute()
   
   print(result)
   

3. 작업 디렉터리에서 샘플을 빌드하고 실행합니다.

   python3 chat_space_list_app.py
   

Node.js

1. 작업 디렉터리에서 app-list-spaces.js라는 파일을 만듭니다.

2. app-list-spaces.js에 다음 코드를 포함합니다.

   const chat = require('@googleapis/chat');
   
   /**
   * List Chat spaces.
   * @return {!Promise<!Object>}
   */
   async function listSpaces() {
     const scopes = [
       'https://www.googleapis.com/auth/chat.bot',
     ];
   
     const auth = new chat.auth.GoogleAuth({
       scopes,
       keyFilename: 'credentials.json',
     });
   
     const authClient = await auth.getClient();
   
     const chatClient = await chat.chat({version: 'v1', auth: authClient});
   
     return await chatClient.spaces.list({
       filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
     });
   }
   
   listSpaces().then(console.log);
   

3. 작업 디렉터리에서 샘플을 실행합니다.

   node app-list-spaces.js
   

Chat API는 페이지로 나눈 스페이스 배열을 반환합니다.

페이지로 나누기 맞춤설정 또는 목록 필터링

Google Chat의 스페이스를 나열하려면 다음 쿼리 매개변수(선택사항)를 전달하여 나열된 스페이스의 페이지로 나누기를 맞춤설정하거나 필터링합니다.

• pageSize: 반환할 최대 공백 수입니다. 서비스가 이 값보다 더 적게 반환할 수도 있습니다. 지정하지 않으면 최대 100개의 공백이 반환됩니다. 최댓값은 1,000이며, 1,000 이상의 값은 자동으로 1,000으로 변경됩니다.
• pageToken: 이전 목록 공간 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이 토큰을 제공하세요. 페이지로 나눌 때 필터 값은 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.
• filter: 쿼리 필터입니다. 지원되는 쿼리에 대한 자세한 내용은 spaces.list 메서드를 참조하세요.

관련 주제

• 스페이스 만들기
• 스페이스를 설정합니다.
• 스페이스 세부정보 확인하기
• 스페이스 업데이트하기
• 스페이스 삭제하기
• 채팅 메시지 스페이스를 찾습니다.