Method: spaces.setup

Alan oluşturur ve belirtilen kullanıcıları alana ekler. Arayan kullanıcı otomatik olarak alana eklenir ve istekte üyelik olarak belirtilmemelidir. Örnek için İlk üyelerin bulunduğu alan oluşturma başlıklı makaleyi inceleyin.

Eklenecek gerçek kişilerden oluşan üyeleri belirtmek için üyelikleri uygun membership.member.name öğesine ekleyin. Gerçek 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 için {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.

Eklenecek Google gruplarını belirtmek için üyelikleri uygun membership.group_member.name ile ekleyin. Bir Google grubu eklemek veya davet etmek için groups/{group} kullanın. Burada {group}, grubun Cloud Identity Groups API'sinden id değeridir. Örneğin, group@example.com grup e-postasının 123456789 kimliğini almak için Cloud Identity Groups arama API'sini kullanabilir, ardından membership.group_member.name öğesini groups/123456789 olarak ayarlayarak grubu alana ekleyebilirsiniz. Grup e-posta adresleri desteklenmez ve Google grupları yalnızca adlandırılmış alanlara üye olarak eklenebilir.

Adlandırılmış bir alan veya grup sohbetinde, arayan kişiyi bazı üyeler engelliyorsa, engelliyorsa veya bazı üyeleri ekleme iznine sahip değilse 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 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ı ile arama uygulaması arasında DM oluşturmak için Space.singleUserBotDm öğesini true olarak ayarlayın ve üyelik belirtmeyin. Bu yöntemi yalnızca arama uygulamasıyla bir DM ayarlamak için kullanabilirsiniz. Görüşme uygulamasını bir alanın üyesi olarak eklemek veya iki kullanıcı arasındaki mevcut bir DM'yi eklemek için Alana kullanıcı veya uygulama davet etme ya da ekleme başlıklı makaleyi inceleyin.

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

Mesaj dizisi halinde 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 alanda bu görünen ad zaten kullanılıyor olabilir.

Kullanıcı kimlik doğrulaması gerekir.

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ıya sahip verileri içerir:

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

object (Space)

Zorunlu. Space.spaceType alanının doldurulması zorunludur.

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

Grup sohbeti oluşturmak için Space.spaceType öğesini GROUP_CHAT olarak ayarlayın. Space.displayName özelliğini ayarlamayın.

İnsanlar arasında 1:1 sohbet oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm değerini ise false olarak ayarlayın. Space.displayName veya Space.spaceDetails özelliğini ayarlamayın.

Gerçek kişi ile arayan Chat uygulaması arasında 1:1 görüşme oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm uygulamasını ise true olarak ayarlayın. Space.displayName veya Space.spaceDetails özelliğini ayarlamayın.

Halihazırda DIRECT_MESSAGE alanı varsa yeni alan oluşturulması yerine bu alan döndürülür.
requestId

string

İsteğe bağlı. Bu isteğin benzersiz bir tanımlayıcısı. Rastgele bir UUID önerilir. Mevcut bir istek kimliğinin belirtilmesi, yeni bir alan oluşturmak yerine bu kimlikle oluşturulan alanı döndürür. Kimliği doğrulanmış farklı bir kullanıcıyla aynı Chat uygulamasından gelen mevcut bir istek kimliğinin belirtilmesi hata döndürür.
memberships[]

object (Membership)

İsteğe bağlı. Alana katılmak üzere davet edilecek Google Chat kullanıcıları veya grupları. Arayan kullanıcıyı otomatik olarak ekleyeceği için bu kullanıcıyı dahil etmeyin.

Grup şu anda arayana ek olarak 20 üyeye izin vermektedir.

Gerçek kişi üyeliği için Membership.member alanı, name alanının doldurulduğu bir user içermelidir (biçim: users/{user}) ve type, User.Type.HUMAN olarak ayarlanmış olmalıdır. Yalnızca alan oluştururken gerçek kullanıcı ekleyebilirsiniz (Chat uygulamalarının eklenmesi yalnızca görüşme uygulamasında doğrudan mesaj kurulumu için desteklenir). Üyeleri, kullanıcının e-posta adresini {user} için takma ad olarak kullanarak da ekleyebilirsiniz. Örneğin, user.name, users/example@gmail.com olabilir. Gmail kullanıcılarını veya harici Google Workspace alanlarındaki kullanıcıları davet etmek için {user} için kullanıcının e-posta adresi kullanılmalıdır.

Google grup üyeliği için Membership.group_member alanı, name ile doldurulmuş bir group içermelidir (groups/{group} biçiminde). Yalnızca Space.spaceType değerini SPACE olarak ayarlarken Google gruplarını ekleyebilirsiniz.

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

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

Space.spaceType, tam olarak bir üyelikle birlikte gerçek bir kullanıcıyla DIRECT_MESSAGE olarak ayarlanır.

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

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ılavuzunu inceleyin.