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 participante na solicitação. Confira um exemplo em Configurar um espaço com os participantes iniciais.
Para especificar os participantes humanos a serem adicionados, adicione as assinaturas com o membership.member.name
adequado. 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, o {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 nomeado ou um chat em grupo, se o autor da chamada bloquear, bloquear ou não tiver permissão para adicionar participantes, eles não serão adicionados ao espaço criado.
Para criar uma mensagem direta (DM) entre o usuário que faz a chamada e outro 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. Você só pode usar esse método para configurar uma mensagem direta com o app de chamada. Para adicionar o app de chamada como participante de um espaço ou como uma mensagem direta entre dois usuários humanos, consulte Convidar ou adicionar um usuário ou app a um espaço.
Se já houver uma mensagem direta entre dois usuários, mesmo quando um usuário bloquear o outro no momento em que uma solicitação for feita, 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 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 ( |
Campos | |
---|---|
space |
Obrigatório. O campo Para criar um espaço, defina Para criar um chat em grupo, defina Para criar uma conversa individual entre pessoas, defina Para criar uma conversa individual entre uma pessoa e o app de chamada do Chat, defina Se já houver um espaço |
requestId |
Opcional. Um identificador exclusivo para a solicitação. Um UUID aleatório é recomendado. Especificar um ID de solicitação já existente retorna o espaço criado com esse ID em vez de criar um novo espaço. Especificar um ID da solicitação do mesmo app do Chat com um usuário autenticado diferente retorna um erro. |
memberships[] |
Opcional. Os usuários do Google Chat que serão convidados para o espaço. Omita o usuário que faz a chamada, porque ele é adicionado automaticamente. No momento, o conjunto permite até 20 associações (além do autor da chamada). Para associação humana, o campo Opcional ao definir Obrigatório ao definir Obrigatório ao definir Precisa estar vazio ao criar uma conversa individual entre uma pessoa e o app do Chat de chamada (ao definir |
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 do 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.