Method: spaces.list

호출자가 속한 스페이스를 나열합니다. 그룹 채팅 및 채팅 메시지는 첫 번째 메시지가 전송될 때까지 표시되지 않습니다. 예를 보려면 스페이스 목록을 참고하세요.

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

  • 승인 범위가 있는 앱 인증:

    • https://www.googleapis.com/auth/chat.bot

  • 다음 승인 범위 중 하나를 사용하여 사용자 인증:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces

Google Workspace 조직의 이름이 지정된 모든 스페이스를 나열하려면 Workspace 관리자 권한을 사용하는 spaces.search() 메서드를 대신 사용하세요.

HTTP 요청

GET https://chat.googleapis.com/v1/spaces

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

쿼리 매개변수

매개변수
pageSize

integer

선택사항입니다. 반환할 최대 스페이스 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다.

지정하지 않으면 최대 100개의 스페이스가 반환됩니다.

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

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

string

선택사항입니다. 이전 list spaces 호출에서 받은 페이지 토큰입니다. 후속 페이지를 가져오려면 이 매개변수를 제공합니다.

페이지로 나누는 경우 필터 값이 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.
filter

string

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

스페이스 유형 (spaceType)을 기준으로 스페이스를 필터링할 수 있습니다.

스페이스 유형으로 필터링하려면 SPACE 또는 GROUP_CHAT와 같은 유효한 enum 값을 지정해야 합니다 (spaceType는 SPACE_TYPE_UNSPECIFIED이 될 수 없음). 여러 스페이스 유형을 쿼리하려면 OR 연산자를 사용하세요.

예를 들어 다음 쿼리는 유효합니다.

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

요청 본문

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

응답 본문

스페이스 목록 요청에 대한 응답입니다.

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

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

object (Space)

요청된 페이지 (또는 첫 번째 페이지)의 스페이스 목록입니다. 참고: 목록 요청의 경우 스페이스 객체에 permissionSettings 필드가 반환되지 않습니다.
nextPageToken

string

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

승인 범위

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

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

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