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 precisa ser especificado como participante na solicitação. Para conferir um exemplo, consulte Configurar um espaço com os primeiros participantes.
Para especificar os membros humanos a serem adicionados, adicione as assinaturas com o membership.member.name
apropriado. 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 da API People ou o id
do usuário na API Directory. Por exemplo, se o ID do perfil de pessoa da API People para user@example.com
for 123456789
, defina membership.member.name
como users/user@example.com
ou users/123456789
para adicionar o usuário ao espaço.
Para especificar os Grupos do Google a serem adicionados, adicione associações com o membership.group_member.name
apropriado. Para adicionar ou convidar um grupo do Google, use groups/{group}
, em que {group}
é o id
do grupo da API Cloud Identity Groups. Por exemplo, é possível usar a API de pesquisa de grupos da Cloud Identity para extrair o ID 123456789
do e-mail do grupo group@example.com
e, em seguida, adicionar o grupo ao espaço definindo membership.group_member.name
como groups/123456789
. Não é possível usar e-mails de grupo, e os grupos do Google só podem ser adicionados como membros em espaços nomeados.
Em um espaço nomeado ou um chat em grupo, se o autor da chamada bloquear, ser bloqueado por alguns participantes ou não tiver permissão para adicionar alguns participantes, eles não serão adicionados ao espaço criado.
Para criar uma mensagem direta (DM) entre o usuário que fez 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 o DM não será criado.
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 nenhuma associação. Só é possível usar esse método para configurar uma DM com o app de chamada. Para adicionar o app de chamada como membro de um espaço ou de uma DM entre dois usuários humanos, consulte Convidar ou adicionar um usuário ou app a um espaço.
Se já houver um tomador de decisão entre dois usuários, mesmo que um deles bloqueie o outro no momento em que uma solicitação for feita, a mensagem direta atual será retornada.
Os espaços com respostas agrupadas não estão disponíveis. Se você receber a mensagem de erro ALREADY_EXISTS
ao configurar um espaço, tente usar outra displayName
. Talvez um espaço na organização do Google Workspace já esteja usando esse nome de exibição.
Requer 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 humanos, defina Para criar uma conversa individual entre uma pessoa e o app de chamada do Chat, defina Se um espaço |
request |
Opcional. Um identificador exclusivo para essa 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. Especificar um ID de solicitação para o mesmo app do Chat com um usuário autenticado diferente retorna um erro. |
memberships[] |
Opcional. Os usuários ou grupos do Google Chat que você quer convidar para participar do espaço. Omita o usuário que faz a chamada, porque ele é adicionado automaticamente. No momento, o conjunto permite até 20 assinaturas (além do autor da chamada). Para a associação de pessoas, o campo Para a associação a grupos do Google, 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 de chat que está ligando (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.