Method: spaces.setup

Tworzy pokój i dodaje do niego określonych użytkowników. Użytkownik dzwoniący jest automatycznie dodawany do pokoju i nie musi być wymieniony jako użytkownik w żądaniu. Przykład znajdziesz w artykule Konfigurowanie pokoju z początkowymi członkami.

Aby określić osoby, które mają zostać dodane, dodaj członkostwa za pomocą odpowiedniego elementu membership.member.name. Aby dodać użytkownika, użyj wartości users/{user}, gdzie {user} może być adresem e-mail 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 użytkownika w interfejsie People API to 123456789, możesz dodać użytkownika do pokoju, ustawiając wartość membership.member.name na users/user@example.com lub users/123456789.user@example.com

Aby określić grupy dyskusyjne Google, które mają zostać dodane, dodaj członkostwa za pomocą odpowiedniego elementu membership.group_member.name. Aby dodać grupę Google lub zaprosić do niej użytkowników, użyj wartości groups/{group}, gdzie {group} to id grupy z interfejsu Cloud Identity Groups API. Możesz na przykład użyć interfejsu Cloud Identity Groups API, aby pobrać identyfikator 123456789 dla adresu e-mail grupy group@example.com, a następnie dodać grupę do pokoju, ustawiając wartość membership.group_member.name na groups/123456789. Adresy e-mail grup nie są obsługiwane, a grupy Google mogą być dodawane tylko jako członkowie w pokojach nazwanych.

W przypadku pokoju o nazwie lub czatu grupowego, jeśli osoba dzwoniąca zablokuje niektórych członków lub zostanie przez nich zablokowana albo nie będzie mieć uprawnień do dodawania niektórych osób, te osoby nie zostaną dodane do utworzonego pokoju.

Aby utworzyć wiadomość bezpośrednią (DM) między użytkownikiem wywołującym a innym użytkownikiem, określ dokładnie 1 członkostwo reprezentujące użytkownika. Jeśli jeden użytkownik zablokuje drugiego, żądanie nie zostanie wysłane, a wiadomość prywatna nie zostanie utworzona.

Aby utworzyć wiadomość DM między użytkownikiem a aplikacją, ustaw Space.singleUserBotDm na true i nie określaj żadnych grup. Z tej metody możesz korzystać tylko do konfigurowania czatu z aplikacją do połączeń. Aby dodać aplikację do połączeń jako użytkownika pokoju lub istniejącego czatu między dwoma użytkownikami, zapoznaj się z artykułem Zapraszanie użytkownika lub aplikacji do pokoju.

Jeśli między dwoma użytkownikami istnieje już czat, nawet jeśli jeden z nich zablokuje drugiego w momencie wysłania żądania, zwrócony zostanie istniejący czat.

Spacje z odpowiedziami w wątkach nie są obsługiwane. Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. Ta wyświetlana nazwa może być już używana w przypadku istniejącego 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 (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Pola
space

object (Space)

Wymagane. Pole Space.spaceType jest wymagane.

Aby utworzyć pokój, ustaw Space.spaceType na SPACE i Space.displayName. Jeśli podczas konfigurowania pokoju pojawi się komunikat o błędzie ALREADY_EXISTS, spróbuj użyć innego displayName. Ta wyświetlana nazwa może być już używana w przypadku istniejącego pokoju w organizacji Google Workspace.

Aby utworzyć czat grupowy, ustaw wartość Space.spaceType na GROUP_CHAT. Nie ustawiaj Space.displayName.

Aby utworzyć rozmowę 1:1 między ludźmi, ustaw Space.spaceType na DIRECT_MESSAGE, a Space.singleUserBotDm na false. Nie ustawiaj wartości Space.displayName ani Space.spaceDetails.

Aby utworzyć rozmowę 1:1 między człowiekiem a aplikacją Google Chat, ustaw Space.spaceType na DIRECT_MESSAGE, a Space.singleUserBotDm na true. Nie ustawiaj wartości Space.displayName ani Space.spaceDetails.

Jeśli pokój DIRECT_MESSAGE już istnieje, zamiast tworzyć nowy pokój, zwracany jest ten pokój.
requestId

string

Opcjonalnie: Unikalny identyfikator tego żądania. Zalecamy losowy identyfikator UUID. Podanie identyfikatora żądania spowoduje zwrócenie pokoju utworzonego z tym identyfikatorem, a nie utworzenie nowego pokoju. Podanie istniejącego identyfikatora prośby z tej samej aplikacji Google Chat, ale z innym uwierzytelnionym użytkownikiem spowoduje błąd.
memberships[]

object (Membership)

Opcjonalnie: Użytkownicy lub grupy Google Chat, których chcesz zaprosić do pokoju. Pomiń użytkownika dzwoniącego, ponieważ jest on dodawany automatycznie.

Obecnie zestaw pozwala na maksymalnie 49 członków (oprócz dzwoniącego).

W przypadku członkostwa osoby fizycznej pole Membership.member musi zawierać user z wypełnionym name (format: users/{user}), a type musi być ustawiony na User.Type.HUMAN. Podczas konfigurowania pokoju możesz dodawać tylko użytkowników będących ludźmi (dodawanie aplikacji Google Chat jest obsługiwane tylko w przypadku konfigurowania wiadomości bezpośrednich za pomocą aplikacji do połączeń). Możesz też dodać użytkowników, używając adresu e-mail jako aliasu dla {user}. Na przykład pole user.name może być polem users/example@gmail.com. Aby zaprosić użytkowników Gmaila lub użytkowników z zewnętrznych domen Google Workspace, musisz użyć adresu e-mail użytkownika w {user}.

W przypadku członkostwa w Grupach dyskusyjnych Google pole Membership.group_member musi zawierać group z wypełnionym name (format groups/{group}). Grupy Google możesz dodawać tylko wtedy, gdy ustawisz wartość Space.spaceType na SPACE.

Opcjonalny, gdy wartość Space.spaceType to SPACE.

Wymagane, gdy Space.spaceType ma wartość GROUP_CHAT, oraz co najmniej 2 uczestnictwa.

Jest on wymagany, jeśli ustawisz wartość Space.spaceType na DIRECT_MESSAGE dla użytkownika będącego osobą fizyczną, a także dokładnie 1 subskrypcję.

Musi być pusty podczas tworzenia rozmowy 1:1 między człowiekiem a aplikacją Google Chat (gdy Space.spaceType to DIRECT_MESSAGE, a Space.singleUserBotDm to true).

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 dotyczącym autoryzacji.