Method: spaces.setup

Bir alan oluşturur ve belirtilen kullanıcıları alana ekler. Arayan kullanıcı alana otomatik olarak eklenir ve istekte üyelik olarak belirtilmemelidir. Örneğin, Alan oluşturma bölümünü inceleyin.

Eklenecek insan üyelerini belirtmek için SetUpSpaceRequest içinde uygun member.name ile üyelik ekleyin. Gerçek bir kullanıcı eklemek için users/{user} kullanın. Burada {user}, kullanıcının e-posta adresi olabilir. Aynı Workspace kuruluşundaki kullanıcılar ({user}), People API'deki kişi için id veya Directory API'deki kullanıcı için id olabilir. Örneğin, user@example.com için People API Kişi profili kimliği 123456789 ise membership.member.name değerini users/user@example.com veya users/123456789 olarak ayarlayarak kullanıcıyı alana ekleyebilirsiniz.

Bir alanda veya grup sohbetinde, arayan kişi bazı üyeleri engellerse ya da bazı üyeler tarafından engellenirse söz konusu üyeler oluşturulan alana eklenmez.

Arayan kullanıcı ile başka bir gerçek kullanıcı arasında doğrudan mesaj (DM) oluşturmak için gerçek kullanıcıyı temsil edecek tam olarak bir üyelik belirtin. Bir kullanıcı diğerini engellerse istek başarısız olur ve DM oluşturulmaz.

Arayan kullanıcıyla çağrı yapan uygulama arasında bir DM oluşturmak için Space.singleUserBotDm öğesini true olarak ayarlayın ve herhangi bir üyelik belirtmeyin. Bu yöntemi yalnızca arama uygulamasıyla bir DM ayarlamak için kullanabilirsiniz. Görüşmeyi bir alanın üyesi veya iki gerçek kullanıcı arasındaki mevcut bir DM olarak eklemek için üyelik oluşturma bölümüne bakın.

İki kullanıcı arasında zaten bir DM varsa, istek yapıldığında bir kullanıcı diğerini engellese bile mevcut DM döndürülür.

Mesaj dizili yanıtların olduğu alanlar desteklenmez. Alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki mevcut bir alan, bu görünen adı zaten kullanıyor olabilir.

Kullanıcı kimlik doğrulaması gerektirir.

HTTP isteği

POST https://chat.googleapis.com/v1/spaces:setup

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek içeriği

İstek gövdesi, aşağıdaki yapıyla veriler içerir:

JSON gösterimi
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Alanlar
space

object (Space)

Zorunlu. Space.spaceType alanı zorunludur.

Alan oluşturmak için Space.spaceType öğesini SPACE olarak ayarlayın ve Space.displayName olarak ayarlayın. Alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki mevcut bir alan, bu görünen adı zaten kullanıyor olabilir.

Grup sohbeti oluşturmak için Space.spaceType değerini GROUP_CHAT olarak ayarlayın. Space.displayName olarak ayarlamayın.

Kullanıcılar arasında bire bir görüşme oluşturmak için Space.spaceType ayarını DIRECT_MESSAGE, Space.singleUserBotDm ayarını da false yapın. Space.displayName veya Space.spaceDetails olarak ayarlamayın.

Gerçek kişi ile arama yapan Chat uygulaması arasında bire bir görüşme oluşturmak için Space.spaceType ayarını DIRECT_MESSAGE, Space.singleUserBotDm ayarını da true yapın. Space.displayName veya Space.spaceDetails olarak ayarlamayın.

DIRECT_MESSAGE alanı zaten varsa yeni bir alan oluşturmak yerine bu alan döndürülür.

requestId

string

İsteğe bağlı. Bu isteğin benzersiz tanımlayıcısı. Rastgele bir UUID önerilir. Mevcut bir istek kimliği belirtildiğinde, yeni bir alan oluşturmak yerine bu kimlikle oluşturulan alan döndürülür. Aynı Chat uygulamasından, kimliği doğrulanmış farklı bir kullanıcıyla kullanılabilen mevcut bir istek kimliği belirtilirse hata döndürülür.

memberships[]

object (Membership)

İsteğe bağlı. Alana katılmaya davet edilecek Google Chat kullanıcıları. Arayan kullanıcıyı, otomatik olarak eklendiği için atlayın.

Grupta şu anda en fazla 20 üyelik (arayana ek olarak) izin verilir.

Membership.member alanı, name doldurulmuş (biçim: users/{user}) ve type değeri User.Type.HUMAN olarak ayarlanmış bir user içermelidir. Yalnızca alan ayarlarken gerçek kullanıcı ekleyebilirsiniz (Chat uygulaması ekleme özelliği yalnızca arama uygulamasıyla doğrudan mesaj kurulumu için desteklenir). Ayrıca, {kullanıcı} için takma ad olarak kullanıcının e-posta adresini kullanarak üye ekleyebilirsiniz. Örneğin, user.name, users/example@gmail.com olabilir." Gmail kullanıcılarını veya harici Google Workspace alanlarını davet etmek üzere kullanıcının e-posta adresi {user} için kullanılmalıdır.

Space.spaceType değeri SPACE olarak ayarlanırken isteğe bağlıdır.

Space.spaceType, en az iki üyelikle birlikte GROUP_CHAT olarak ayarlanırken zorunludur.

Tam olarak bir üyelikle birlikte Space.spaceType, gerçek bir kullanıcı ile DIRECT_MESSAGE olarak ayarlanırken gereklidir.

Gerçek kişi ile arayan Chat uygulaması arasında 1:1 görüşme oluşturulurken boş olmalıdır (Space.spaceType değeri DIRECT_MESSAGE, Space.singleUserBotDm olarak true olarak ayarlandığında).

Yanıt gövdesi

Başarılıysa yanıt metni, Space öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.