스페이스에 사용자 및 Google Chat 앱 나열하기

이 가이드에서는 Google Chat API의 membership 리소스에서 list 메서드를 사용하여 스페이스의 사용자와 Chat 앱을 스페이스에서 페이지로 나눈 필터링 가능한 멤버십 목록으로 나열하는 방법을 설명합니다. 앱 인증을 사용하여 멤버십을 나열하면 채팅 앱이 액세스할 수 있는 스페이스의 멤버십이 나열되지만 채팅 앱 멤버십(자체 멤버십 포함)은 제외됩니다. 사용자 인증으로 멤버십을 나열하면 인증된 사용자가 액세스할 수 있는 스페이스의 멤버십이 나열됩니다.

Membership 리소스는 실제 사용자 또는 Google Chat 앱이 스페이스에 초대되었는지, 스페이스의 일부인지, 또는 스페이스에 없는지를 나타냅니다.

기본 요건

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.memberships.readonly 또는 chat.memberships 승인 범위를 사용한 사용자 인증
    • chat.bot 승인 범위를 사용한 앱 인증

사용자 인증을 사용하여 스페이스에 사용자 및 채팅 앱 나열

인증된 사용자가 액세스할 수 있는 스페이스의 사용자와 채팅 앱을 나열하려면 요청에 다음을 전달합니다.

다음 예는 filter가 ROLE_Member로 설정되어 있으므로 인증된 사용자에게 표시되는 인간 스페이스 구성원 (스페이스 관리자가 아님)을 나열합니다.

Python

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

  2. chat_member_list_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.memberships.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists human space members (but not space managers) in a
    specified space.
    '''

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

        # The space for which to list memberships.
        parent = 'spaces/SPACE',

        # An optional filter that returns only human space members.
        filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"'

    ).execute()

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

if __name__ == '__main__':
    main()

  3. 코드에서 SPACE을 스페이스 이름으로 바꿉니다. 이 이름은 Chat API의 spaces.list 메서드 또는 스페이스의 URL에서 가져올 수 있습니다.

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

    python3 chat_member_list_user.py

Google Chat API는 지정된 스페이스에서 실제 스페이스 구성원(스페이스 관리자 제외) 및 앱 구성원 목록을 반환합니다.

앱 인증을 사용하여 스페이스에 사용자 및 채팅 앱 나열

인증된 앱이 액세스할 수 있는 스페이스의 사용자와 채팅 앱을 나열하려면 요청에 다음을 전달합니다.

다음 예는 채팅 앱에 표시되는 실제 스페이스 구성원 (스페이스 관리자가 아님)을 나열합니다.

Python

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

  2. chat_member_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().members().list(

        # The space for which to list memberships.
        parent = 'spaces/SPACE',

        # An optional filter that returns only human space members.
        filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"'

    ).execute()

print(result)

  3. 코드에서 SPACE을 스페이스 이름으로 바꿉니다. 이 이름은 Chat API의 spaces.list 메서드 또는 스페이스의 URL에서 가져올 수 있습니다.

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

    python3 chat_member_list_app.py

Google Chat API는 지정된 스페이스에서 인간 스페이스 구성원 (스페이스 관리자 제외) 목록을 반환합니다.

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

멤버십을 나열하려면 다음 쿼리 매개변수를 전달하여 나열된 멤버십의 페이지로 나누기 또는 필터링을 맞춤설정합니다.

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