Method: spaces.search

관리자의 검색어를 기반으로 Google Workspace 조직의 스페이스 목록을 반환합니다.

관리자 권한이 있는 사용자 인증이 필요합니다. 요청에서 useAdminAccess를 true로 설정합니다.

HTTP 요청

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

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

쿼리 매개변수

매개변수
useAdminAccess

boolean

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

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

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

이 메서드는 현재 관리자 액세스만 지원하므로 이 필드에는 true만 허용됩니다.
pageSize

integer

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

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

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

string

이전 검색 공간 호출에서 수신된 토큰입니다. 후속 페이지를 검색하려면 이 매개변수를 제공합니다.

페이지로 나눌 때 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다. 다른 매개변수에 다른 값을 전달하면 예기치 않은 결과가 발생할 수 있습니다.
query

string

필수 항목입니다. 검색어

다음 매개변수를 사용하여 검색할 수 있습니다.

  • createTime
  • customer
  • displayName
  • externalUserAllowed
  • lastActiveTime
  • spaceHistoryState
  • spaceType

createTime 및 lastActiveTime는 RFC-3339 형식의 타임스탬프를 허용하며 지원되는 비교 연산자는 =, <, >, <=, >=입니다.

customer는 필수 항목이며 스페이스를 가져올 고객을 나타내는 데 사용됩니다. 유일하게 지원되는 값은 customers/my_customer입니다.

displayName는 HAS(:) 연산자만 허용합니다. 일치할 텍스트는 먼저 토큰으로 토큰화되고 각 토큰은 스페이스의 displayName 어디서나 하위 문자열로 대소문자 구분 없이 독립적으로 접두사 일치됩니다. 예를 들어 Fun Eve는 Fun event 또는 The evening was fun과 일치하지만 notFun event 또는 even과는 일치하지 않습니다.

externalUserAllowed는 true 또는 false를 허용합니다.

spaceHistoryState는 space 리소스의 historyState 필드의 값만 허용합니다.

spaceType는 필수이며 SPACE 값만 유효합니다.

여러 필드에서 AND 연산자만 지원됩니다. 유효한 예는 spaceType = "SPACE" AND displayName:"Hello"이고 잘못된 예는 spaceType = "SPACE" OR displayName:"Hello"입니다.

동일한 필드에서 spaceType는 AND 또는 OR 연산자를 지원하지 않습니다. displayName, 'spaceHistoryState', 'externalUserAllowed'는 OR 연산자만 지원합니다. lastActiveTime 및 createTime는 AND 및 OR 연산자를 모두 지원합니다. AND는 lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00"와 같은 간격을 나타내는 데만 사용할 수 있습니다.

다음은 유효한 쿼리 예시입니다.

customer = "customers/my_customer" AND spaceType = "SPACE"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")
orderBy

string

선택사항입니다. 스페이스 목록의 순서입니다.

정렬에 사용할 수 있는 지원되는 속성은 다음과 같습니다.

  • membershipCount.joined_direct_human_user_count: 스페이스에 직접 참여한 사람 사용자 수를 나타냅니다.
  • lastActiveTime: 이 스페이스의 주제에 자격요건을 충족하는 항목이 마지막으로 추가된 시간을 나타냅니다.
  • createTime: 스페이스 생성 시간을 나타냅니다.

유효한 순서 지정 작업 값은 다음과 같습니다.

  • ASC: 오름차순 기본값

  • 내림차순의 경우 DESC

지원되는 구문은 다음과 같습니다.

  • membershipCount.joined_direct_human_user_count DESC
  • membershipCount.joined_direct_human_user_count ASC
  • lastActiveTime DESC
  • lastActiveTime ASC
  • createTime DESC
  • createTime ASC

요청 본문

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

응답 본문

검색 스페이스 요청에 해당하는 스페이스 목록이 포함된 응답입니다.

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

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

object (Space)

요청된 스페이스의 페이지입니다.
nextPageToken

string

다음 페이지를 검색하는 데 사용할 수 있는 토큰입니다. 이 필드가 비어 있으면 후속 페이지가 없습니다.
totalSize

integer

모든 페이지에서 쿼리와 일치하는 스페이스의 총 개수입니다. 결과가 10,000개가 넘는 공백인 경우 이 값은 추정치입니다.

승인 범위

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

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

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