Tworzy pokój i dodaje do niego określonych użytkowników. Użytkownik wywołujący jest automatycznie dodawany do pokoju i nie powinien być określony w żądaniu. Przykład: Konfigurowanie pokoju z początkowymi użytkownikami.
Aby wskazać użytkowników do dodania, dodaj członkostwo z odpowiednim atrybutem member.name
w elemencie SetUpSpaceRequest
. Aby dodać użytkownika, użyj funkcji users/{user}
, gdzie {user}
może być adresem e-mail tego użytkownika. W przypadku użytkowników w tej samej organizacji Workspace {user}
może też być id
dla osoby z interfejsu People API lub id
dla użytkownika w interfejsie Directory API. Jeśli na przykład identyfikator profilu osoby interfejsu People API dla interfejsu user@example.com
to 123456789
, możesz dodać użytkownika do pokoju, ustawiając właściwość membership.member.name
na users/user@example.com
lub users/123456789
.
W przypadku pokoju lub czatu grupowego, jeśli rozmówca blokuje lub jest zablokowany przez niektórych użytkowników, nie zostaną oni dodani do utworzonego pokoju.
Aby utworzyć czat między użytkownikiem dzwoniącym a innym użytkownikiem, określ dokładnie jedną subskrypcję reprezentującą tego użytkownika. Jeśli jeden z użytkowników zablokuje drugiego, żądanie nie zostanie zrealizowane i czat nie zostanie utworzony.
Aby utworzyć czat między użytkownikiem dzwoniącym a aplikacją do rozmów, ustaw Space.singleUserBotDm
na true
i nie podawaj żadnych informacji o członkostwie. Tej metody możesz użyć tylko do skonfigurowania czatu z aplikacją wywołującą. Informacje o tym, jak dodać aplikację do rozmów jako osobę w pokoju lub rozmowę na czacie między 2 użytkownikami, znajdziesz w artykule Zapraszanie i dodawanie użytkowników lub aplikacji do pokoju.
Jeśli czat jest już między 2 użytkownikami – nawet jeśli jeden z nich zablokuje drugiego w momencie wysyłania żądania, istniejący czat zostanie zwrócony.
Pokoje z odpowiedziami w wątkach nie są obsługiwane. Jeśli podczas konfigurowania pokoju zobaczysz komunikat o błędzie ALREADY_EXISTS
, spróbuj użyć innej metody displayName
. Ta wyświetlana nazwa może już być używana w istniejącym pokoju w organizacji Google Workspace.
Wymaga uwierzytelniania użytkownika.
Żądanie HTTP
POST https://chat.googleapis.com/v1/spaces:setup
Adres URL używa składni transkodowania gRPC.
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "space": { object ( |
Pola | |
---|---|
space |
To pole jest wymagane. Pole Aby utworzyć pokój, ustaw Aby utworzyć czat grupowy, ustaw Aby utworzyć rozmowę 1:1 między osobami, ustaw Aby utworzyć rozmowę 1:1 między osobą a aplikacją Google Chat, ustaw Jeśli pokój |
requestId |
Opcjonalnie. Unikalny identyfikator danego żądania. Zalecany jest losowy identyfikator UUID. Jeśli określisz identyfikator istniejącego żądania, zamiast utworzyć nowy pokój, zostanie zwrócony pokój utworzony przy użyciu tego identyfikatora. Określenie identyfikatora istniejącego żądania z tej samej aplikacji do obsługi czatu w przypadku innego uwierzytelnionego użytkownika spowoduje zwrócenie błędu. |
memberships[] |
Opcjonalnie. użytkowników Google Chat do zaproszenia do pokoju; Pomiń użytkownika dzwoniącego, ponieważ zostanie on dodany automatycznie. Obecnie w zestawie może być przypisanych do 20 członków (oprócz osoby dzwoniącej). Pole Opcjonalne przy ustawieniu Wymagany, gdy ustawiasz wartość Wymagane, gdy w przypadku ustawienia Pole musi być puste w przypadku tworzenia rozmowy 1:1 między użytkownikiem a aplikacją Google Chat (gdy w ustawieniach |
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Space
.
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.create
Więcej informacji znajdziesz w przewodniku po autoryzacji.