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} é o {person_id} para a pessoa da API People ou o id para o usuário na API Directory do SDK Admin. Por exemplo, se a API People Person resourceName for people/123456789, você poderá adicionar o usuário ao espaço incluindo uma assinatura com users/123456789 como member.name.

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.

Espaços com respostas agrupadas ou acesso para convidados não são compatíveis.

Requer autenticação de usuário e o escopo chat.spaces.create ou chat.spaces.

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.

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. O conjunto inicial de usuários no domínio convidados a participar do espaço. O usuário que faz a chamada é adicionado automaticamente ao espaço e não pode ser especificado como uma associação.

No momento, o conjunto permite até 20 assinaturas (além do autor da chamada).

O campo Membership.member precisa conter um usuário com name preenchido e User.Type.HUMAN. Todos os outros campos são ignorados.

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).

Incompatível: convidar usuários convidados ou adicionar outros apps do Chat.

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.