Method: spaces.setup

Cria um espaço e adiciona usuários especificados a ele. O usuário que fez a chamada é adicionado automaticamente ao espaço e não deve ser especificado como participante na solicitação. Por exemplo, consulte Configurar um espaço.

Para especificar os membros humanos que serão adicionados, adicione associações com o member.name adequado no SetUpSpaceRequest. Para adicionar um usuário humano, use users/{user}, em que {user} pode ser o endereço de e-mail do usuário. Para usuários na mesma organização do Workspace, {user} também pode ser o id da pessoa na API People ou o id do usuário na API Directory. Por exemplo, se o ID do perfil de pessoa da API People de user@example.com for 123456789, você poderá adicionar o usuário ao espaço definindo membership.member.name como users/user@example.com ou users/123456789.

Em um espaço ou chat em grupo, se o autor da chamada bloquear ou for bloqueado por alguns participantes, eles não vão ser adicionados ao espaço criado.

Para criar uma mensagem direta (DM) entre o usuário que faz a chamada e outro usuário humano, especifique exatamente uma associação para representar o usuário humano. Se um usuário bloquear o outro, a solicitação falhará e a mensagem direta não será criada.

Para criar uma mensagem direta entre o usuário que fez a chamada e o app de chamada, defina Space.singleUserBotDm como true e não especifique associações. Só é possível usar esse método para configurar uma mensagem direta com o app de chamada. Para adicionar esse app como participante de um espaço ou entre dois usuários humanos, consulte Criar uma associação.

Se já houver uma mensagem direta entre dois usuários, mesmo quando um usuário bloquear o outro no momento da solicitação, a mensagem direta vai ser retornada.

Os espaços com respostas agrupadas não são compatíveis. Se você receber a mensagem de erro ALREADY_EXISTS ao configurar um espaço, tente usar outro displayName. Talvez um espaço da organização do Google Workspace já use esse nome de exibição.

Requer a autenticação do usuário.

Solicitação HTTP

POST https://chat.googleapis.com/v1/spaces:setup

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

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Campos
space

object (Space)

Obrigatório. O campo Space.spaceType é obrigatório.

Para criar um espaço, defina Space.spaceType como SPACE e Space.displayName. Se você receber a mensagem de erro ALREADY_EXISTS ao configurar um espaço, tente usar outro displayName. Talvez um espaço da organização do Google Workspace já use esse nome de exibição.

Para criar um chat em grupo, defina Space.spaceType como GROUP_CHAT. Não defina Space.displayName.

Para criar uma conversa individual entre pessoas, defina Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como false. Não defina Space.displayName ou Space.spaceDetails.

Para criar uma conversa individual entre uma pessoa e o app do Chat de chamada, defina Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true. Não defina Space.displayName ou Space.spaceDetails.

Se já houver um espaço DIRECT_MESSAGE, ele vai ser retornado em vez de criar um novo.

requestId

string

Opcional. Identificador exclusivo da solicitação. Um UUID aleatório é recomendado. Especificar um ID de solicitação existente retorna o espaço criado com esse ID em vez de criar um novo. Especificar um ID de solicitação do mesmo app do Chat com um usuário autenticado diferente retorna um erro.

memberships[]

object (Membership)

Opcional. Os usuários do Google Chat que serão convidados para participar do espaço. Omita o usuário que fez a chamada, já que ele é adicionado automaticamente.

No momento, o conjunto permite até 20 associações (além do autor da chamada).

O campo Membership.member precisa conter um user com name preenchido (formato: users/{user}) e type definido como User.Type.HUMAN. Só é possível adicionar usuários humanos ao configurar um espaço. A adição de apps do Chat só é compatível com a configuração de mensagens diretas no app de chamada. Também é possível adicionar participantes usando o e-mail do usuário como um alias para {user}. Por exemplo, user.name pode ser users/example@gmail.com." Para convidar usuários do Gmail ou de domínios externos do Google Workspace, use o e-mail do usuário {user}.

Opcional ao configurar Space.spaceType como SPACE.

Obrigatório ao definir Space.spaceType como GROUP_CHAT, com pelo menos duas assinaturas.

Obrigatório ao definir Space.spaceType como DIRECT_MESSAGE com um usuário humano, além de exatamente uma assinatura.

Precisa estar em branco ao criar uma conversa individual entre uma pessoa e o app do Chat de chamada (ao definir Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true).

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Space.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

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