Method: spaces.search

boolean

Se true, il metodo viene eseguito utilizzando i privilegi di amministratore di Google Workspace dell'utente.

L'utente chiamante deve essere un amministratore di Google Workspace con il privilegio Gestisci spazi e conversazioni di Chat.

Richiede l'ambito OAuth 2.0 chat.admin.spaces.readonly o chat.admin.spaces.

L'impostazione di useAdminAccess su false è disponibile nell'ambito dell'anteprima per gli sviluppatori.

integer

Il numero massimo di spazi da restituire. Il servizio potrebbe restituire un valore inferiore.

Se non specificato, vengono restituiti al massimo 100 spazi.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, questo viene modificato automaticamente in 1000.

string

Un token ricevuto dalla chiamata precedente per la ricerca di spazi. Fornisci questo parametro per recuperare la pagina successiva.

Quando esegui la paginazione, tutti gli altri parametri forniti devono corrispondere alla chiamata che ha fornito il token di pagina. Il passaggio di valori diversi agli altri parametri potrebbe portare a risultati imprevisti.

string

Obbligatorio. Una query di ricerca.

Puoi eseguire la ricerca utilizzando i seguenti parametri quando useAdminAccess è impostato su true:

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

Se useAdminAccess è impostato su false:

• displayName
• externalUserAllowed

createTime e lastActiveTime accettano un timestamp in formato RFC-3339 e gli operatori di confronto supportati sono: =, <, >, <=, >=.

customer è obbligatorio quando useAdminAccess è impostato su true e viene utilizzato per indicare da quale cliente recuperare gli spazi. customers/my_customer è l'unico valore supportato.

displayName accetta solo l'operatore HAS (:). Il testo da trovare viene prima suddiviso in token e ogni token viene confrontato con il prefisso senza distinzione tra maiuscole e minuscole e in modo indipendente come sottostringa ovunque nel displayName dello spazio. Ad esempio, Fun Eve corrisponde a Fun event o The evening was fun, ma non a notFun event o even. Se useAdminAccess è impostato su false, displayName è obbligatorio per recuperare risultati significativi. In caso contrario, il comportamento predefinito è restituire una risposta vuota.

externalUserAllowed accetta true o false.

spaceHistoryState accetta solo i valori del campo historyState di una risorsa space.

spaceType è obbligatorio quando useAdminAccess è impostato su true e l'unico valore valido è SPACE.

Tra campi diversi, sono supportati solo gli operatori AND. Un esempio valido è spaceType = "SPACE" AND displayName:"Hello" e un esempio non valido è spaceType = "SPACE" OR displayName:"Hello".

Nello stesso campo, spaceType non supporta gli operatori AND o OR. displayName, `spaceHistoryState` e `externalUserAllowed` supportano solo gli operatori OR. lastActiveTime e createTime supportano gli operatori AND e OR. AND può essere utilizzato solo per rappresentare un intervallo, ad esempio lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

Le seguenti query di esempio sono valide quando useAdminAccess è impostato su 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")

Le seguenti query di esempio sono valide quando useAdminAccess è impostato su false:

displayName:"Hello World"

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

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

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

string

Facoltativo. Come viene ordinato l'elenco degli spazi.

Gli attributi supportati per l'ordinamento sono:

• membershipCount.joined_direct_human_user_count: indica il numero di utenti umani che hanno aderito direttamente a uno spazio.
• lastActiveTime: indica l'ora in cui l'ultimo elemento idoneo è stato aggiunto a qualsiasi argomento di questo spazio.
• createTime: indica l'ora di creazione dello spazio.

Se useAdminAccess è false, per l'ordinamento sono supportati solo createTime e relevance. Per questi campi nelle ricerche non amministrative è supportato solo DESC.

I valori validi per l'operazione di ordinamento sono:

• ASC per l'ordine crescente. Valore predefinito.

• DESC per l'ordine decrescente.

La sintassi supportata è quando useAdminAccess è impostato su true:

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

Se useAdminAccess è impostato su false:

• createTime DESC
• relevance DESC

object (Space)

Solo output. Lo spazio corrispondente.