Method: spaces.search

Google Workspace 조직의 스페이스 목록을 반환합니다. 예를 보려면 스페이스 검색 및 관리를 참고하세요.

useAdminAccess이 false로 설정되면 호출하는 사용자가 가입된 구성원인 스페이스로 결과가 제한됩니다. 관리자 권한으로 검색하려면 useAdminAccess을 true로 설정하세요. useAdminAccess을 false로 설정하는 것은 개발자 프리뷰에서 사용할 수 있습니다.

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

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 범위가 필요합니다.

useAdminAccess을 false로 설정하는 것은 개발자 프리뷰에서 사용할 수 있습니다.

pageSize

integer

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

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

최댓값은 1,000입니다. 1,000보다 큰 값을 사용하면 자동으로 1,000으로 변경됩니다.
pageToken

string

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

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

string

필수 항목입니다. 검색어입니다.

useAdminAccess가 true로 설정된 경우 다음 매개변수를 사용하여 검색할 수 있습니다.

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

useAdminAccess이 false로 설정된 경우:

  • displayName
  • externalUserAllowed

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

useAdminAccess이 true로 설정된 경우 customer가 필요하며, 스페이스를 가져올 고객을 나타내는 데 사용됩니다. 유일하게 지원되는 값은 customers/my_customer입니다.

displayName은 HAS (:) 연산자만 허용합니다. 일치시킬 텍스트는 먼저 토큰으로 토큰화되고 각 토큰은 스페이스의 displayName에서 대소문자를 구분하지 않고 독립적으로 하위 문자열로 접두사 일치됩니다. 예를 들어 Fun Eve는 Fun event 또는 The evening was fun과 일치하지만 notFun event 또는 even과는 일치하지 않습니다. useAdminAccess이 false로 설정된 경우 의미 있는 결과를 검색하려면 displayName가 필요합니다. 그렇지 않으면 기본 동작은 빈 응답을 반환하는 것입니다.

externalUserAllowed은 true 또는 false을 허용합니다.

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

spaceType는 useAdminAccess가 true로 설정된 경우에 필요하며 유효한 값은 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"과 같은 간격을 나타내는 데만 사용할 수 있습니다.

useAdminAccess이 true로 설정된 경우 다음 예시 쿼리는 유효합니다.

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")

useAdminAccess이 false로 설정된 경우 다음 예시 쿼리는 유효합니다.

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

(externalUserAllowed = "true") // Returns an empty response.

(externalUserAllowed = "true" AND displayName:"Hello")
orderBy

string

선택사항입니다. 스페이스 목록이 정렬되는 방식입니다.

정렬 기준으로 지원되는 속성은 다음과 같습니다.

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

useAdminAccess가 false인 경우 createTime 및 relevance만 주문에 지원됩니다. 관리자가 아닌 사용자의 검색에서는 이러한 필드에 DESC만 지원됩니다.

유효한 정렬 작업 값은 다음과 같습니다.

  • 오름차순의 경우 ASC를 사용합니다. 기본값

  • 내림차순의 경우 DESC

useAdminAccess이 true로 설정된 경우 지원되는 구문은 다음과 같습니다.

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

useAdminAccess이 false로 설정된 경우:

  • createTime DESC
  • relevance DESC

요청 본문

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

응답 본문

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

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

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

object (Space)

지원 중단됨: 대신 새 results 필드를 사용하세요. 요청된 스페이스의 페이지입니다. 이 필드는 useAdminAccess이 true으로 설정된 경우에만 채워지며 새로운 results 필드로 대체되었습니다.
nextPageToken

string

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

integer

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

object (SearchSpaceResult)

출력 전용입니다.

쿼리와 일치하는 검색 결과 목록입니다.

승인 범위

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

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

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

SearchSpaceResult

스페이스 검색의 단일 결과 항목입니다.

JSON 표현 
{
  "space": {
    object (Space)
  }
}
필드
space

object (Space)

출력 전용입니다. 일치하는 스페이스입니다.