Method: spaces.list

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

발신자가 속한 스페이스를 나열합니다. 인증이 필요합니다. 서비스 계정 인증을 완벽하게 지원합니다.

특정 기능에 사전 체험판을 제공하는 Google Workspace 개발자 프리뷰 프로그램의 일환으로 사용자 인증이 지원됩니다. 사용자 인증에는 chat.spaces 또는 chat.spaces.readonly 승인 범위가 필요합니다.

호출자 또는 인증된 사용자에게 표시되는 스페이스를 나열합니다. 그룹 채팅 및 채팅 메시지는 첫 번째 메시지가 전송될 때까지 표시되지 않습니다.

HTTP 요청

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

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

쿼리 매개변수

매개변수
pageSize

integer

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

지정하지 않으면 최대 100개의 공백이 반환됩니다.

최댓값은 1,000이며 1,000 이상의 값은 1,000으로 강제 변환됩니다.

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

string

선택사항. 이전 목록 공간 호출에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

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

string

선택사항. 쿼리 필터

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

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

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

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

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

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

서비스 계정 인증을 사용하면 이 필드는 무시되며, 쿼리가 항상 모든 공백을 반환합니다. 하지만 Chat API는 여전히 서비스 계정으로 쿼리 구문을 검사하므로 잘못된 쿼리는 계속 거부됩니다.

요청 본문

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

응답 본문

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

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

object (Space)

요청된 (또는 첫 번째) 페이지의 스페이스 목록입니다.
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

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