REST Resource: spaces

Kaynak: Alan

Google Chat'te bir alan. Alanlar, iki veya daha fazla kullanıcı arasındaki görüşmeler ya da bir kullanıcı ile bir Chat uygulaması arasındaki bire bir mesajlardır.

JSON gösterimi 
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
Alanlar
name

string

Alanın kaynak adı.

Biçim: spaces/{space}

Burada {space}, alan için sistem tarafından atanan kimliği temsil eder. Alan kimliğini, spaces.list() yöntemini çağırarak veya alan URL'sinden bulabilirsiniz. Örneğin, alan URL'si https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA ise alan kimliği AAAAAAAAA olur.
type
(deprecated)

enum (Type)

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceType kullanın. Alanın türüdür.
spaceType

enum (SpaceType)

Alanın türü. Alan oluştururken veya alanın alan türünü güncellerken gereklidir. Yalnızca diğer kullanımlar için çıkış yap.
singleUserBotDm

boolean

İsteğe bağlı. Alanın bir Chat uygulaması ile tek bir insan arasında bir DM olup olmadığı.
threaded
(deprecated)

boolean

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceThreadingState kullanın. Mesajların bu alanda mesaj dizisi olup olmadığı.
displayName

string

Alanın görünen adı. SPACE değerindeki spaceType ile alan oluştururken gereklidir. Alan oluştururken veya displayName öğesini güncellerken 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.

Doğrudan mesajlar için bu alan boş olabilir.

En fazla 128 karakter desteklenir.
externalUserAllowed

boolean

Sabit. Bu alanın herhangi bir Google Chat kullanıcısına üye olarak izin verip vermediği. Google Workspace kuruluşunda alan oluştururken giriş Aşağıdaki koşullarda alan oluştururken bu alanı atlayın:

  • Kimliği doğrulanan kullanıcı bir tüketici hesabı (yönetilmeyen kullanıcı hesabı) kullanıyor. Varsayılan olarak, tüketici hesabı tarafından oluşturulan bir alanda tüm Google Chat kullanıcılarına izin verilir.

Mevcut alanlar için bu alan yalnızca çıkıştır.
spaceThreadingState

enum (SpaceThreadingState)

Yalnızca çıkış. Chat alanındaki mesaj dizisi durumu.
spaceDetails

object (SpaceDetails)

Açıklama ve kurallar dahil olmak üzere alanla ilgili ayrıntılar.
spaceHistoryState

enum (HistoryState)

Bu alandaki mesaj ve mesaj dizilerinin mesaj geçmişi durumu.
importMode

boolean

İsteğe bağlı. Bu alanın Google Workspace'e veri taşıma işlemi kapsamında Import Mode konumunda oluşturulup oluşturulmadığı. Alanlar içe aktarılırken, içe aktarma işlemi tamamlanana kadar bu alanlar kullanıcılara gösterilmez.
createTime

string (Timestamp format)

İsteğe bağlı. Sabit. Chat'te oluşturulan alanlar için alanın oluşturulduğu zaman. Bu alan, içe aktarma modundaki alanlarda kullanılmadığı durumlar dışında yalnızca çıkış olarak oluşturulur.

İçe aktarma modundaki alanlarda, orijinal oluşturma zamanını korumak için bu alanı, alanın kaynakta oluşturulduğu geçmiş zaman damgasına ayarlayın.

Çıkış yalnızca spaceType, GROUP_CHAT veya SPACE olduğunda doldurulur.
lastActiveTime

string (Timestamp format)

Yalnızca çıkış. Alandaki son mesajın zaman damgası.

adminInstalled

boolean

Yalnızca çıkış. Bir Chat uygulaması bulunan doğrudan mesaj (DM) alanları için, alanın bir Google Workspace yöneticisi tarafından oluşturulup oluşturulmadığı bilgisi. Yöneticiler, kuruluşlarındaki kullanıcılar adına bir Chat uygulaması ile doğrudan mesaj yükleyip oluşturabilir.

Yönetici tarafından yükleme özelliğinin desteklenmesi için Chat uygulamanızda doğrudan mesajlaşma özelliği bulunmalıdır.
membershipCount

object (MembershipCount)

Yalnızca çıkış. Üye türüne göre gruplandırılmış birleştirilen üyeliklerin sayısı. spaceType SPACE, DIRECT_MESSAGE veya GROUP_CHAT olduğunda doldurulur.

accessSettings

object (AccessSettings)

İsteğe bağlı. Alanın erişim ayarını belirtir. Yalnızca spaceType, SPACE olduğunda doldurulur.
spaceUri

string

Yalnızca çıkış. Kullanıcının alana erişmesini sağlayacak URI.
Birleştirme alanı space_permission_settings. Bir alanın izin ayarlarını temsil eder. Yalnızca space_type, SPACE olduğunda doldurulur. space_permission_settings şunlardan yalnızca biri olabilir:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

İsteğe bağlı. Yalnızca giriş. Alan izni ayarları. Alan oluşturma girişi. Bu alan ayarlanmazsa ortak çalışma alanı oluşturulur. Alanı oluşturduktan sonra ayarlar PermissionSettings alanında doldurulur.

permissionSettings

object (PermissionSettings)

İsteğe bağlı. Alanı güncellemek için ayarlanabilecek tam izin ayarları. Bir alanı güncellemek için giriş. Aksi takdirde yalnızca çıkış kullanılır. Alan oluşturmak için bunun yerine predefinedPermissionSettings kullanın.

Tür

Desteği sonlandırıldı: Bunun yerine SpaceType kullanın.

Sıralamalar
TYPE_UNSPECIFIED Ayrıldı.
ROOM İki veya daha fazla insan arasındaki sohbetler.
DM İnsan ile Chat uygulaması arasında 1:1 doğrudan mesaj (tüm mesajların düz olduğu) Bunun, iki kişi arasındaki doğrudan mesajları içermediğini unutmayın.

SpaceType

Alanın türü. Alan oluştururken veya güncellerken gereklidir. Yalnızca diğer kullanımlar için çıkış yap.

Sıralamalar
SPACE_TYPE_UNSPECIFIED Ayrıldı.
SPACE Kullanıcıların ileti gönderdiği, dosya paylaştığı ve ortak çalışma yaptığı bir yer. SPACE, Chat uygulamaları içerebilir.
GROUP_CHAT 3 veya daha fazla kişi arasındaki grup görüşmeleri. GROUP_CHAT, Chat uygulamaları içerebilir.
DIRECT_MESSAGE İki insan veya bir insan ile bir Chat uygulaması arasındaki 1:1 mesajlar.

SpaceThreadingState

Chat alanındaki mesaj dizisi durumunun türünü belirtir.

Sıralamalar
SPACE_THREADING_STATE_UNSPECIFIED Ayrıldı.
THREADED_MESSAGES Mesaj dizilerini destekleyen adlandırılmış alanlar. Kullanıcılar bir iletiye yanıt verdiklerinde, ileti dizisi içinde yanıt verebilirler. Böylece, yanıtları orijinal iletinin bağlamında tutulur.
GROUPED_MESSAGES Görüşmenin konuya göre düzenlendiği adlandırılmış alanlar. Konular ve yanıtları birlikte gruplandırılır.
UNTHREADED_MESSAGES İki kişi arasındaki doğrudan mesajlar (DM'ler) ve 3 veya daha fazla kişi arasındaki grup görüşmeleri.

SpaceDetails

Açıklama ve kurallar dahil olmak üzere alanla ilgili ayrıntılar.

JSON gösterimi 
{
  "description": string,
  "guidelines": string
}
Alanlar
description

string

İsteğe bağlı. Alanın açıklaması. Örneğin, alanın tartışma konusunu, işlevsel amacını veya katılımcıları açıklayın.

En fazla 150 karakteri destekler.
guidelines

string

İsteğe bağlı. Alanın kuralları, beklentileri ve görgü kuralları.

5.000 karaktere kadar destekler.

HistoryState

Mesajların ve alanların geçmiş durumu. Mesajların ve görüşme dizilerinin oluşturulduktan sonra ne kadar süre saklanacağını belirtir.

Sıralamalar
HISTORY_STATE_UNSPECIFIED Varsayılan değer. Kullanmayın.
HISTORY_OFF Geçmişe kayıt kapalı. Mesajlar ve ileti dizileri 24 saat saklanır.
HISTORY_ON Geçmişe kayıt açık. Kuruluşun Apps Kasası saklama kuralları, iletilerin ve ileti dizilerinin ne kadar süre saklanacağını belirtir.

MembershipCount

Bir alanın üyelik sayısını kategoriler halinde gruplanmış şekilde gösterir.

JSON gösterimi 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
Alanlar
joinedDirectHumanUserCount

integer

Alana doğrudan katılan gerçek kullanıcıların sayısı (birleştirilmiş bir gruba üye olarak katılan kullanıcılar hariç).
joinedGroupCount

integer

Alana doğrudan katılan tüm grupların sayısı.

AccessSettings

Alanın erişim ayarını gösterir.

JSON gösterimi 
{
  "accessState": enum (AccessState),
  "audience": string
}
Alanlar
accessState

enum (AccessState)

Yalnızca çıkış. Alanın erişim durumunu gösterir.
audience

string

İsteğe bağlı. Alanı keşfedebilecek, alana katılabilecek ve alandaki mesajları önizleyebilecek hedef kitlenin kaynak adı. Politika ayarlanmadan bırakılırsa yalnızca alana ayrı ayrı davet edilmiş veya alana eklenmiş kullanıcılar ya da Google Grupları alana erişebilir. Ayrıntılı bilgi için Bir alanı hedef kitle tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin.

Biçim: audiences/{audience}

Google Workspace kuruluşunun varsayılan hedef kitlesini kullanmak için ayarı audiences/default olarak ayarlayın.

AccessState

Alanın erişim durumunu gösterir.

Sıralamalar
ACCESS_STATE_UNSPECIFIED Erişim durumu bilinmiyor veya bu API'de desteklenmiyor.
PRIVATE Yalnızca diğer kullanıcılar veya Google Workspace yöneticileri tarafından ayrı ayrı eklenen ya da davet edilen kullanıcılar veya Google Grupları alanı keşfedebilir ve erişebilir.
DISCOVERABLE Bir alan yöneticisi, bir hedef kitleye alan için erişim izni verdi. Alana ayrıca eklenen veya davet edilen kullanıcılar ya da Google Grupları da alanı keşfedebilir ve erişebilir. Daha fazla bilgi edinmek için Bir alanı belirli kullanıcılar tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin.

PredefinedPermissionSettings

Adlandırılmış alan oluştururken belirtebileceğiniz alan izni ayarları. Gelecekte daha fazla ayar eklenebilir. Adlandırılmış alanların izin ayarlarıyla ilgili ayrıntılar için Alanlar hakkında bilgi başlıklı makaleyi inceleyin.

Sıralamalar
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Belirtilmedi. Kullanmayın.
COLLABORATION_SPACE Alanı, tüm üyelerin mesaj gönderebileceği bir ortak çalışma alanı haline getirme ayarı.
ANNOUNCEMENT_SPACE Alanı, yalnızca alan yöneticilerinin mesaj yayınlayabileceği bir duyuru alanı haline getirmek için yapılan ayar.

PermissionSettings

Adlandırılmış alanın izin ayarları. Alan oluştururken izin ayarlarını belirlemek için isteğinizde PredefinedPermissionSettings alanını belirtin.

JSON gösterimi 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
Alanlar
manageMembersAndGroups

object (PermissionSetting)

Bir alandaki üyeleri ve grupları yönetme ayarı.
modifySpaceDetails

object (PermissionSetting)

Alan adı, avatar, açıklama ve kuralları güncelleme ayarı.
toggleHistory

object (PermissionSetting)

Alan geçmişini açma ve kapatma ayarı.
useAtMentionAll

object (PermissionSetting)

Alanda @tümü kullanma ayarı.
manageApps

object (PermissionSetting)

Bir alandaki uygulamaları yönetme ayarı.
manageWebhooks

object (PermissionSetting)

Bir alandaki webhook'ları yönetme ayarı.
postMessages

object (PermissionSetting)

Yalnızca çıkış. Alanda mesaj yayınlama ayarı.
replyMessages

object (PermissionSetting)

Alandaki mesajları yanıtlama ayarı.

PermissionSetting

Alan izni ayarını temsil eder.

JSON gösterimi 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
Alanlar
managersAllowed

boolean

Alan yöneticilerinin bu izne sahip olup olmadığı.
membersAllowed

boolean

Yönetici olmayan üyelerin bu izne sahip olup olmadığı.

Yöntemler

completeImport

 Belirtilen alan için içe aktarma işlemini tamamlar ve alanı kullanıcılara görünür hale getirir.

create

 Üyesi olmayan bir alan oluşturur.

delete

 Adlandırılmış bir alanı siler.

findDirectMessage

 Belirtilen kullanıcıyla olan mevcut doğrudan mesajı döndürür.

get

 Bir alanla ilgili ayrıntıları döndürür.

list

 Arayanın üyesi olduğu alanları listeler.

patch

 Bir alanı günceller.

setup

 Alan oluşturur ve belirtilen kullanıcıları alana ekler.