Method: spaces.findGroupChats

Retorna todos os espaços com spaceType == GROUP_CHAT, cujas associações humanas contêm exatamente o usuário que fez a chamada e os usuários especificados em FindGroupChatsRequest.users. Somente os membros que participaram da conversa são aceitos. Para conferir um exemplo, consulte Encontrar chats em grupo.

Se o usuário que fez a chamada bloquear ou for bloqueado por alguns usuários e nenhum espaço com o conjunto especificado de usuários for encontrado, esse método retornará espaços que não incluem os usuários bloqueados ou que fizeram o bloqueio.

O conjunto especificado de usuários precisa conter apenas associações humanas (não de apps). Uma solicitação que contém usuários não humanos não retorna nenhum espaço.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
users[]

string

Opcional. Nomes de recursos de todos os usuários humanos no grupo de chat com o usuário que fez a chamada. Os apps de chat não podem ser incluídos na solicitação.

O número máximo de usuários que podem ser especificados em uma única solicitação é 49.

Formato: users/{user}, em que {user} é o id da pessoa na API People ou o id do usuário na API Directory. Por exemplo, para encontrar todos os chats em grupo com o usuário que fez a chamada e outros dois usuários, com IDs de perfil da API People 123456789 e 987654321, você pode usar users/123456789 e users/987654321. Você também pode usar o e-mail como um alias para {user}. Por exemplo, users/example@gmail.com, em que example@gmail.com é o e-mail do usuário do Google Chat.
pageSize

integer

Opcional. O número máximo de espaços a serem retornados. O serviço pode retornar um valor menor do que esse.

Se não for especificado, no máximo 10 espaços serão retornados.

O valor máximo é 30. Se você usar um valor maior que 30, ele será alterado automaticamente para 30.

Valores negativos retornam um erro INVALID_ARGUMENT.
pageToken

string

Opcional. Um token de página recebido de uma chamada anterior para encontrar chats em grupo. Forneça esse parâmetro para recuperar a página subsequente.

Ao fazer a paginação, todos os outros parâmetros fornecidos precisam corresponder à chamada que forneceu o token. A transmissão de valores diferentes pode levar a resultados inesperados.
spaceView

enum (SpaceView)

Tipo de visualização de espaço solicitado. Se não for definido, o padrão será SPACE_VIEW_RESOURCE_NAME_ONLY. As solicitações que especificam SPACE_VIEW_EXPANDED precisam incluir escopos que permitam a leitura de dados de espaço, por exemplo, https://www.googleapis.com/auth/chat.spaces ou https://www.googleapis.com/auth/chat.spaces.readonly.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Uma resposta que contém espaços de chat em grupo com exatamente o usuário que fez a chamada e os usuários solicitados.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
Campos
spaces[]

object (Space)

Lista de espaços na página solicitada (ou primeira).
nextPageToken

string

Um token que pode ser enviado como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Para mais informações, consulte o guia de autorização.

SpaceView

Uma visualização que especifica quais campos precisam ser preenchidos no recurso Space. Para garantir a compatibilidade com versões futuras, recomendamos que seu código considere valores adicionais.

Tipos enumerados
SPACE_VIEW_UNSPECIFIED O valor padrão / não definido.
SPACE_VIEW_RESOURCE_NAME_ONLY Preenche apenas o nome do recurso do espaço.
SPACE_VIEW_EXPANDED Preenche os campos de recursos do espaço. Observação: o campo permissionSettings não será preenchido. As solicitações que especificam SPACE_VIEW_EXPANDED precisam incluir escopos que permitam a leitura de dados de espaço, por exemplo, https://www.googleapis.com/auth/chat.spaces ou https://www.googleapis.com/auth/chat.spaces.readonly.