Method: spaces.setup

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

Para especificar os membros humanos a serem adicionados, adicione assinaturas com o member.name apropriado 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 {person_id} para a pessoa da API People ou o id para o usuário na API Directory. Por exemplo, se a pessoa da API People resourceName para user@example.com for people/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 um chat em grupo, se o autor da chamada bloquear ou for bloqueado por alguns participantes, eles não serão adicionados ao espaço criado.

Para criar uma mensagem direta 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 faz a chamada e o app de chamada, defina Space.singleUserBotDm como true e não especifique assinaturas. Só é possível usar este método para configurar uma mensagem direta no app de chamada. Para adicionar o app de chamada como participante de um espaço ou de uma mensagem direta entre dois usuários humanos, consulte Criar uma assinatura.

Se uma mensagem direta já existir entre dois usuários, mesmo quando um usuário bloquear o outro no momento da solicitação, a mensagem direta 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 existente na 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 defina Space.displayName. Se você receber a mensagem de erro ALREADY_EXISTS ao configurar um espaço, tente usar outro displayName. Talvez um espaço existente na organização do Google Workspace já use esse nome de exibição.

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

Para criar uma conversa individual entre os usuários, 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 um ser humano e o app de chat, defina Space.spaceType como DIRECT_MESSAGE e Space.singleUserBotDm como true. Não defina Space.displayName ou Space.spaceDetails.

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

string

Opcional. Um identificador exclusivo para esta solicitação. É recomendável usar um UUID aleatório. Especificar um ID de solicitação existente retorna o espaço criado com esse ID em vez de criar um novo espaço. A especificação de um ID de solicitação do mesmo app Chat com outro usuário autenticado retorna um erro.
memberships[]

object (Membership)

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

No momento, o conjunto permite até 20 assinaturas (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. Só é possível adicionar apps de chat para mensagens diretas com o app de chamada. Você também pode adicionar membros usando o e-mail do usuário como um alias de {user}. Por exemplo, o user.name pode ser users/example@gmail.com." Para convidar usuários do Gmail ou de domínios externos do Google Workspace, o e-mail do usuário precisa ser usado para {user}.

Opcional ao definir Space.spaceType como SPACE.

Obrigatório ao definir Space.spaceType como GROUP_CHAT, além de 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 vazio ao criar uma conversa individual entre um ser humano e o app 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.