Method: spaces.setup

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

Eklenecek insan üyeleri belirtmek için uygun membership.member.name ile üyelikler ekleyin. İnsan kullanıcı eklemek için users/{user} ifadesini 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şinin id veya Directory API'deki kullanıcının id de 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 uygun membership.group_member.name ile üyelikler ekleyin. Google grubu eklemek veya davet etmek için groups/{group} ifadesini kullanın. Burada {group}, Cloud Identity Groups API'den alınan grup için id değeridir. Örneğin, group@example.com grup e-posta adresinin kimliğini 123456789 almak için Cloud Identity Groups lookup API'yi kullanabilirsiniz. Ardından, membership.group_member.name değerini groups/123456789 olarak ayarlayarak grubu alana ekleyebilirsiniz. Grup e-postası desteklenmez ve Google Grupları yalnızca adlandırılmış alanlara üye olarak eklenebilir.

Adlandırılmış bir alan veya grup sohbetinde, arayan bazı üyeler tarafından engellenirse ya da bazı üyeleri engellerse veya bazı üyeleri ekleme izni yoksa bu üyeler oluşturulan alana eklenmez.

Arayan kullanıcı ile başka bir insan kullanıcı arasında doğrudan mesaj (DM) oluşturmak için insan kullanıcıyı temsil eden 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 arayan uygulama arasında bir DM oluşturmak için Space.singleUserBotDm değerini true olarak ayarlayın ve herhangi bir üyelik belirtmeyin. Bu yöntemi yalnızca arama uygulamasıyla DM oluşturmak için kullanabilirsiniz. Arama uygulamasını bir alanın üyesi olarak veya iki kullanıcı arasındaki mevcut bir DM'ye eklemek için Alana kullanıcı veya uygulama davet etme ya da ekleme başlıklı makaleyi inceleyin.

İki kullanıcı arasında zaten bir DM varsa, istek oluşturulduğu sırada bir kullanıcı diğerini engellemiş olsa bile mevcut DM döndürülür.

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

Aşağıdaki yetkilendirme kapsamlarından biriyle kullanıcı kimlik doğrulaması gerektirir:

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

HTTP isteği

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

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

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri 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 değerini SPACE olarak, Space.displayName değerini ise ayarlayın. Alan oluştururken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName kullanmayı deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

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

İnsanlar arasında bire bir görüşme oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm değerini ise false olarak ayarlayın. Space.displayName veya Space.spaceDetails ayarlamayın.

Bir insan ile arayan Chat uygulaması arasında bire bir görüşme oluşturmak için Space.spaceType değerini DIRECT_MESSAGE, Space.singleUserBotDm değerini ise true olarak ayarlayın. Space.displayName veya Space.spaceDetails ayarlamayın.

DIRECT_MESSAGE alanı zaten varsa yeni bir alan oluşturulmaz ve bu alan döndürülür.
requestId

string

İsteğe bağlı. Bu isteğin benzersiz kimliği. Rastgele bir UUID önerilir. İstek kimliği belirtmek, isteği idempotent yapar. Bu da aynı istek kimliğine sahip birden fazla özdeş isteğin yalnızca tek bir alan oluşturmasına neden olur. Aynı istek kimliğine sahip sonraki istekler, istenen ayrıntılar mevcut durumdan farklı olsa bile mevcut alanı döndürür ve alanı güncellemez.

Bu alanı etkili bir şekilde kullanmak için:

  • Sonraki isteklerin aynı olduğundan ve orijinal istekteki kimlik doğrulama bilgilerinin kullanıldığından emin olun.
  • Belirtilen istek kimliğiyle daha önce bir alan oluşturulduysa istek, bu alanı döndürür. Döndürülen alanın tam olarak doldurulmayabileceğini unutmayın. API, isteğinizdeki alanı sistem tarafından atanan kaynak adıyla doldurulmuş şekilde yansıtır. Alanla ilgili en son meta verileri almak için spaces.get işlevini çağırın.
  • Mevcut bir istek kimliğinin farklı bir kimliği doğrulanmış kullanıcıyla yeniden kullanılması hataya neden olur.
memberships[]

object (Membership)

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

Set şu anda arayan kişi dışında en fazla 49 üyeliğe izin veriyor.

İnsan üyeliği için Membership.member alanı, name alanının doldurulduğu (biçim: users/{user}) bir user içermeli ve type alanı User.Type.HUMAN olarak ayarlanmalıdır. Yalnızca alan oluştururken kullanıcı ekleyebilirsiniz (Chat uygulamaları ekleme yalnızca arama uygulamasıyla doğrudan mesaj kurulumunda desteklenir). Ayrıca, kullanıcının e-posta adresini {user} için takma ad olarak kullanarak da üye 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 kullanıcının e-posta adresi {user} için kullanılmalıdır.

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

Space.spaceType, SPACE olarak ayarlandığında isteğe bağlıdır.

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

Space.spaceType, bir kullanıcıyla birlikte tam olarak bir üyelik olacak şekilde DIRECT_MESSAGE olarak ayarlanırken gereklidir.

Bir kullanıcı ile arama yapılan Chat uygulaması arasında bire bir görüşme oluşturulurken boş olmalıdır (Space.spaceType, DIRECT_MESSAGE ve Space.singleUserBotDm, true olarak ayarlanırken).

Yanıt metni

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ılavuzu'na bakın.