Method: spaces.members.list

스페이스의 멤버십을 나열합니다. 예를 보려면 스페이스에 사용자 및 Google Chat 앱 표시를 참고하세요. 앱 인증을 사용하여 멤버십을 나열하면 채팅 앱에서 액세스할 수 있는 스페이스의 멤버십이 표시되지만 자체 채팅 앱 멤버십은 제외됩니다. 사용자 인증으로 멤버십을 표시하면 인증된 사용자가 액세스할 수 있는 스페이스의 멤버십이 표시됩니다.

다음 유형의 인증을 지원합니다.

  • 앱 인증

  • 사용자 인증 요청에 useAdminAccess 필드를 설정하여 관리자 권한으로 이 메서드를 인증하고 승인할 수 있습니다.

HTTP 요청

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 항목입니다. 멤버십 목록을 가져올 스페이스의 리소스 이름입니다.

형식: spaces/{space}

쿼리 매개변수

매개변수
pageSize

integer

선택사항입니다. 반환할 최대 멤버십 수입니다. 서비스는 이 값보다 더 적은 수의 값을 반환할 수 있습니다.

지정하지 않으면 최대 100개의 멤버십이 반환됩니다.

최대값은 1,000입니다. 1,000을 초과하는 값을 사용하면 1,000으로 자동 변경됩니다.

음수 값은 INVALID_ARGUMENT 오류를 반환합니다.
pageToken

string

선택사항입니다. 이전에 멤버십을 나열하기 위해 호출한 때 받은 페이지 토큰입니다. 후속 페이지를 가져오려면 이 매개변수를 제공합니다.

페이지로 나누는 경우, 제공하는 다른 모든 매개변수가 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예상치 못한 결과가 발생할 수 있습니다.
filter

string

선택사항입니다. 쿼리 필터입니다.

구성원의 역할(role) 및 유형(member.type)을 기준으로 멤버십을 필터링할 수 있습니다.

역할별로 필터링하려면 role를 ROLE_MEMBER 또는 ROLE_MANAGER로 설정합니다.

유형별로 필터링하려면 member.type를 HUMAN 또는 BOT로 설정합니다. != 연산자를 사용하여 member.type를 필터링할 수도 있습니다.

역할과 유형을 모두 기준으로 필터링하려면 AND 연산자를 사용하세요. 역할 또는 유형별로 필터링하려면 OR 연산자를 사용합니다.

useAdminAccess가 true로 설정된 경우 member.type = "HUMAN" 또는 member.type != "BOT"가 필요합니다. 다른 회원 유형 필터는 거부됩니다.

예를 들어 유효한 쿼리는 다음과 같습니다.

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

다음 쿼리가 잘못되었습니다.

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

잘못된 쿼리는 INVALID_ARGUMENT 오류와 함께 서버에서 거부됩니다.
showGroups

boolean

선택사항입니다. true인 경우 다른 유형의 멤버십 외에도 Google Group와 연결된 멤버십도 반환합니다. filter가 설정된 경우 필터 기준과 일치하지 않는 Google Group 멤버십은 반환되지 않습니다.
showInvited

boolean

선택사항입니다. true인 경우 다른 유형의 멤버십 외에도 invited 회원과 연결된 멤버십도 반환합니다. 필터가 설정된 경우 필터 기준과 일치하지 않는 invited 멤버십은 반환되지 않습니다.

현재 사용자 인증이 필요합니다.
useAdminAccess

boolean

선택사항입니다. true인 경우 메서드는 사용자의 Google Workspace 관리자 권한을 사용하여 실행됩니다.

호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.

chat.admin.memberships.readonly 또는 chat.admin.memberships OAuth 2.0 범위가 필요합니다.

관리 액세스 권한을 사용하는 경우 스페이스에 앱 멤버십을 나열할 수 없습니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

스페이스 멤버십을 나열하는 응답입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
필드
memberships[]

object (Membership)

순서가 지정되지 않은 목록 요청된 페이지(또는 첫 번째 페이지)의 멤버십 목록입니다.
nextPageToken

string

결과의 다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다. 비어 있으면 후속 페이지가 없습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

자세한 내용은 승인 가이드를 참고하세요.