관리자의 검색어를 기반으로 Google Workspace 조직의 스페이스 목록을 반환합니다.
관리자 권한이 있는 사용자 인증이 필요합니다. 요청에서 useAdminAccess
를 true
로 설정합니다.
HTTP 요청
GET https://chat.googleapis.com/v1/spaces:search
URL은 gRPC 트랜스코딩 구문을 사용합니다.
쿼리 매개변수
매개변수 | |
---|---|
use |
호출하는 사용자는 채팅 및 스페이스 대화 관리 권한이 있는 Google Workspace 관리자여야 합니다.
이 메서드는 현재 관리자 액세스만 지원하므로 이 필드에는 |
page |
반환할 최대 스페이스 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 100개의 스페이스가 반환됩니다. 최대값은 1,000입니다. 1,000을 초과하는 값을 사용하면 1,000으로 자동 변경됩니다. |
page |
이전 검색 공간 호출에서 수신된 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다. 페이지로 나눌 때 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다. |
query |
필수 항목입니다. 검색어 다음 매개변수를 사용하여 검색할 수 있습니다.
여러 필드에서 동일한 필드에서 다음은 유효한 쿼리 예시입니다.
|
order |
선택사항입니다. 스페이스 목록의 순서입니다. 정렬에 사용할 수 있는 지원되는 속성은 다음과 같습니다.
유효한 순서 지정 작업 값은 다음과 같습니다.
지원되는 구문은 다음과 같습니다.
|
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
검색 스페이스 요청에 해당하는 스페이스 목록이 포함된 응답입니다.
성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.
JSON 표현 |
---|
{
"spaces": [
{
object ( |
필드 | |
---|---|
spaces[] |
요청된 스페이스의 페이지입니다. |
next |
다음 페이지를 검색하는 데 사용할 수 있는 토큰입니다. 이 필드가 비어 있으면 후속 페이지가 없습니다. |
total |
모든 페이지에서 쿼리와 일치하는 스페이스의 총 개수입니다. 결과가 10,000개가 넘는 공백인 경우 이 값은 추정치입니다. |
승인 범위
다음 OAuth 범위 중 하나가 필요합니다.
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
자세한 내용은 승인 가이드를 참고하세요.