chat.admin.spaces.readonly 또는 chat.admin.spacesOAuth 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: 이 스페이스의 주제에 자격요건을 충족하는 항목이 마지막으로 추가된 시간을 나타냅니다.
[[["이해하기 쉬움","easyToUnderstand","thumb-up"],["문제가 해결됨","solvedMyProblem","thumb-up"],["기타","otherUp","thumb-up"]],[["필요한 정보가 없음","missingTheInformationINeed","thumb-down"],["너무 복잡함/단계 수가 너무 많음","tooComplicatedTooManySteps","thumb-down"],["오래됨","outOfDate","thumb-down"],["번역 문제","translationIssue","thumb-down"],["샘플/코드 문제","samplesCodeIssue","thumb-down"],["기타","otherDown","thumb-down"]],["최종 업데이트: 2024-11-08(UTC)"],[[["Returns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType."],["Requires administrator privileges and the `useAdminAccess` parameter set to `true` in the request."],["Utilizes the `GET https://chat.googleapis.com/v1/spaces:search` HTTP request with query parameters for customization."],["Needs authorization with either the `chat.admin.spaces` or `chat.admin.spaces.readonly` OAuth scope."],["Response body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces."]]],["To search for Google Workspace spaces, send a `GET` request to `https://chat.googleapis.com/v1/spaces:search`, ensuring admin privileges and setting `useAdminAccess` to `true`. Define the search using query parameters, including a required `query` to filter spaces (by `customer`, `displayName`, etc.), optional `pageSize` and `pageToken` for pagination, and optional `orderBy` for sorting. You must have one of the authorization scopes: `chat.admin.spaces` or `chat.admin.spaces.readonly`. The response will list spaces matching the query.\n"]]
