채팅 메시지 (DM) 스페이스 찾기

이 가이드에서는 Google Chat API의 Space 리소스에서 findDirectMessage 메서드를 사용하여 채팅 메시지 (DM) 스페이스에 관한 세부정보를 가져오는 방법을 설명합니다.

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

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

앱 인증으로 인증하면 채팅 앱이 Google Chat에서 액세스할 수 있는 DM(예: 앱이 속한 DM)을 채팅 앱이 받을 수 있습니다. 사용자 인증으로 인증하면 인증된 사용자가 액세스할 수 있는 DM이 반환됩니다.

기본 요건

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.bot 승인 범위를 지정합니다. 사용자 인증을 사용하여 chat.spaces.readonly 또는 chat.spaces 승인 범위를 지정합니다.
  • User 리소스에서 findDirectMessage 메서드를 호출하여 반환할 DM에 있는 다른 사용자의 name를 전달합니다. 사용자 인증을 사용하면 이 메서드는 호출하는 사용자와 지정된 사용자 간의 DM을 반환합니다. 앱 인증을 사용하면 이 메서드가 호출 앱과 지정된 사용자 간에 DM을 반환합니다.
  • 실제 사용자를 스페이스 구성원으로 추가하려면 users/{user}를 지정합니다. 여기서 {user}는 People API의 person {person_id} 또는 Directory API의 user ID입니다. 예를 들어 People API 사용자 resourceName가 people/123456789이면 users/123456789 멤버십을 member.name로 포함하여 스페이스에 사용자를 추가할 수 있습니다.

사용자 인증이 포함된 채팅 메시지 찾기

사용자 인증을 사용하여 채팅 메시지를 찾는 방법은 다음과 같습니다.

Python

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

  2. chat_space_find_dm_user.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 returns details about a specified DM.
    '''

    # 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().findDirectMessage(

          # The other user in the direct message (DM) to return.
          #
          # Replace USER with a user name.
          name='users/USER'

      ).execute()

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

if __name__ == '__main__':
    main()

  3. 코드에서 USER를 Google Chat의 User의 name로 바꿉니다.

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

    python3 chat_space_find_dm_user.py

Node.js

  1. 작업 디렉터리에서 이름이 find-direct-message-space.js인 파일을 만듭니다.

  2. find-direct-message-space.js에 다음 코드를 포함합니다.

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

/**
* Find a direct message Chat space for a user.
* @return {!Promise<!Object>}
*/
async function findDirectMessageSpace() {
  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.findDirectMessage(
      {name: 'users/USER'});
}

findDirectMessageSpace().then(console.log);

  3. 코드에서 USER를 Google Chat의 User의 name로 바꿉니다.

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

    node find-direct-message-space.js

Chat API는 지정된 DM을 자세히 설명하는 Space 인스턴스를 반환합니다.

앱 인증이 포함된 채팅 메시지 찾기

앱 인증으로 채팅 메시지를 찾는 방법은 다음과 같습니다.

Python

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

  2. chat_space_find_dm_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().findDirectMessage(

    # The other user in the direct message (DM) to return.
    #
    # Replace USER with a user name.
    name='users/USER'

).execute()

print(result)

  3. 코드에서 USER를 Google Chat의 User의 name로 바꿉니다.

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

    python3 chat_space_find_dm_app.py

Node.js

  1. 작업 디렉터리에서 이름이 app-find-direct-message-space.js인 파일을 만듭니다.

  2. app-find-direct-message-space.js에 다음 코드를 포함합니다.

    const chat = require('@googleapis/chat');

/**
* Find a direct message Chat space for a user.
* @return {!Promise<!Object>}
*/
async function findDirectMessageSpace() {
  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.findDirectMessage(
      {name: 'users/USER'});
}

findDirectMessageSpace().then(console.log);

  3. 코드에서 USER를 Google Chat의 User의 name로 바꿉니다.

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

    node app-find-direct-message-space.js

Chat API는 지정된 DM을 자세히 설명하는 Space 인스턴스를 반환합니다.