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,
  "importModeExpireTime": string,
  "customer": 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

Tanımlayıcı. Alan kaynak adı.

Biçim: spaces/{space}

Burada {space}, alana sistem tarafından atanan kimliği temsil eder. Alan kimliğini spaces.list() yöntemini çağırarak veya alan URL'sinden alabilirsiniz. Ö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 politikasını kullanın. Alan türü.
spaceType

enum (SpaceType)

İsteğe bağlı. Alan türü. Alan oluştururken veya alan türünü güncellerken gereklidir. Diğer kullanımlar için yalnızca çıkış.
singleUserBotDm

boolean

İsteğe bağlı. Alan, bir Chat uygulaması ile tek bir kullanıcı arasındaki doğrudan mesajlaşma mı?
threaded
(deprecated)

boolean

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceThreadingState politikasını kullanın. Bu alanda mesajların ileti dizisi hâlinde olup olmadığı.
displayName

string

İsteğe bağlı. Alanının görünen adı. SPACE spaceType ile alan oluştururken gereklidir. Alan oluştururken veya displayName güncellerken ALREADY_EXISTS hata mesajını alırsanız farklı bir displayName deneyin. Google Workspace kuruluşundaki mevcut bir alan bu görünen adı kullanıyor olabilir.

Doğrudan mesajlarda bu alan boş olabilir.

En fazla 128 karakter desteklenir.
externalUserAllowed

boolean

İsteğe bağlı. Değişmez. Bu alanın herhangi bir Google Chat kullanıcısını üye olarak kabul edip etmediği. Google Workspace kuruluşunda alan oluştururken girilen girişler. Aşağıdaki koşullarda alan oluştururken bu alanı atlayın:

  • Kimliği doğrulanmış kullanıcı, tüketici hesabı (yönetilmeyen kullanıcı hesabı) kullanıyor. Tüketici hesabı tarafından oluşturulan alanlar varsayılan olarak tüm Google Chat kullanıcılarına izin verir.

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

enum (SpaceThreadingState)

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

object (SpaceDetails)

İsteğe bağlı. Açıklama ve kurallar da dahil olmak üzere alanla ilgili ayrıntılar.
spaceHistoryState

enum (HistoryState)

İsteğe bağlı. Bu alandaki iletiler ve ileti dizileri için mesaj geçmişi durumu.
importMode

boolean

İsteğe bağlı. Bu alanın, Google Workspace'e veri taşıma işleminin bir parçası olarak Import Mode içinde oluşturulup oluşturulmadığı. Alanlar içe aktarılırken, içe aktarma işlemi tamamlanana kadar kullanıcılara görünmez.

Import Mode içinde alan oluşturmak için kullanıcı kimlik doğrulaması gerekir.
createTime

string (Timestamp format)

İsteğe bağlı. Değişmez. Chat'te oluşturulan alanlar için alanın oluşturulma zamanı. Bu alan, içe aktarma modundaki alanlarda kullanılması dışında yalnızca çıkış olarak kullanılır.

İçe aktarma modu alanlarında, orijinal oluşturma zamanını korumak için bu alanı, alanın kaynakta oluşturulduğu geçmiş zaman damgası olarak ayarlayın.

Yalnızca spaceType, GROUP_CHAT veya SPACE olduğunda çıkışta doldurulur.
lastActiveTime

string (Timestamp format)

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

boolean

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

Yönetici yüklemesini desteklemek 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ış, katılan üyeliklerin sayısı. spaceType, SPACE, DIRECT_MESSAGE veya GROUP_CHAT olduğunda doldurulur.
accessSettings

object (AccessSettings)

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

string

Yalnızca çıkış. Kullanıcının alana erişmek için kullanacağı URI.
importModeExpireTime

string (Timestamp format)

Yalnızca çıkış. Alan, içe aktarma modunda kalırsa sistem tarafından otomatik olarak silineceği zaman.

İçe aktarma modunda oluşturulan her alan, spaces.completeImport kullanılarak bu süre dolmadan önce bu moddan çıkmalıdır.

Bu alan yalnızca içe aktarma moduyla oluşturulan alanlar için doldurulur.
customer

string

İsteğe bağlı. Değişmez. Alanının müşteri kimliği. Yalnızca uygulama kimlik doğrulaması ile alan oluşturulurken ve SpaceType SPACE olduğunda gereklidir. Aksi takdirde ayarlanmamalıdır.

customers/{customer} biçiminde. Burada customer, Admin SDK müşteri kaynağındaki id değeridir. Özel uygulamalar, uygulama ile aynı Google Workspace kuruluşunda alan oluşturmak için customers/my_customer takma adını da kullanabilir.

DM'ler için bu alan doldurulmaz.
Birleştirme alanı space_permission_settings. Bir alanın izin ayarlarını gösterir. Yalnızca space_type SPACE olduğunda doldurulur. space_permission_settings yalnızca aşağıdakilerden biri olabilir:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

İsteğe bağlı. Yalnızca giriş. Önceden tanımlanmış alan izni ayarları, yalnızca alan oluşturulurken girilir. Alan ayarlanmamışsa bir ortak çalışma alanı oluşturulur. Alanı oluşturduktan sonra ayarlar PermissionSettings alanına doldurulur.

Önceden tanımlanmış izin ayarlarını belirleme şu özellikleri destekler:
permissionSettings

object (PermissionSettings)

İsteğe bağlı. Mevcut alanlar için alan izni ayarları. Mevcut izin ayarlarının değiştirildiği, tam alan izin ayarlarını güncelleme girişi. Çıkış, mevcut izin ayarlarını listeler.

İzin ayarlarını okuma ve güncelleme şu durumlarda desteklenir:

Tür

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

Sıralamalar
TYPE_UNSPECIFIED Rezervasyon yapıldı.
ROOM İki veya daha fazla insan arasındaki sohbetler.
DM Bir insan ile bir Chat uygulaması arasındaki bire bir doğrudan mesajlaşma. Tüm mesajlar düzdür. Bu durumun, iki kullanıcı arasındaki doğrudan mesajları kapsamadığını unutmayın.

SpaceType

Alan türü. Alan oluştururken veya güncellerken gerekir. Diğer kullanımlar için yalnızca çıkış.

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

SpaceThreadingState

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

Sıralamalar
SPACE_THREADING_STATE_UNSPECIFIED Rezervasyon yapıldı.
THREADED_MESSAGES İleti dizilerini destekleyen adlandırılmış alanlar. Kullanıcılar bir iletiye yanıt verirken ileti dizisi içinde yanıtlayabilir. Bu sayede yanıtları orijinal iletinin bağlamında kalır.
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 da dahil olmak üzere alanla ilgili ayrıntılar.

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

string

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

En fazla 150 karakter desteklenir.
guidelines

string

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

5.000 karaktere kadar destekler.

HistoryState

Mesajlar ve alanlar için geçmiş durumu. İletilerin ve ileti dizilerinin oluşturulduktan sonra ne kadar süreyle saklanacağını belirtir.

Sıralamalar
HISTORY_STATE_UNSPECIFIED Varsayılan değer. Kullanmayın.
HISTORY_OFF Geçmişe kayıt kapalı. İletiler ve ileti dizileri 24 saat boyunca saklanır.
HISTORY_ON Geçmişe kayıt açık. İletilerin ve ileti dizilerinin ne kadar süreyle saklanacağını kuruluşun Apps Kasası saklama kuralları belirler.

MembershipCount

Bir alanın üyelik sayısını kategorilere göre gruplandırılmış olarak gösterir.

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

integer

Yalnızca çıkış. Katılan bir grupta üyeliği olan kullanıcılar hariç, alana doğrudan katılan gerçek kullanıcıların sayısı.
joinedGroupCount

integer

Yalnızca çıkış. Alana doğrudan katılan tüm grupların sayısı.

AccessSettings

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

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

enum (AccessState)

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

string

İsteğe bağlı. Alanı keşfedebilen, alana katılabilen ve alandaki mesajları önizleyebilen hedef kitlenin kaynak adı. Ayarlanmamışsa yalnızca alana tek tek davet edilen veya eklenen 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şu için varsayılan hedef kitleyi kullanmak istiyorsanız audiences/default olarak ayarlayın.

Hedef kitleyi okuma şu özellikleri destekler:

Bu alan, uygulama kimlik doğrulaması ile chat.bot kapsamı kullanılırken doldurulmaz.

Hedef kitleyi ayarlamak için kullanıcı kimlik doğrulaması gerekir.

AccessState

Alan 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 tek tek eklenen ya da davet edilen kullanıcılar veya Google Grupları alanı keşfedip alana erişebilir.
DISCOVERABLE

Bir alan yöneticisi, hedef kitleye alana erişim izni vermişse Alana tek tek eklenen veya davet edilen kullanıcılar ya da Google Grupları da alanı keşfedip erişebilir. Daha fazla bilgi edinmek için Belirli kullanıcıların alanları bulmasını sağlama başlıklı makaleyi inceleyin.

Herkese açık alan oluşturmak için kullanıcı kimlik doğrulaması gerekir.

PredefinedPermissionSettings

Yalnızca adlandırılmış bir alan oluştururken belirleyebileceğiniz önceden tanımlanmış izin ayarları. Gelecekte daha fazla ayar eklenebilir. Adlandırılmış alanların izin ayarları hakkında ayrıntılı bilgi için Alanlar hakkında 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 işbirliği alanı yapma ayarı.
ANNOUNCEMENT_SPACE Alanı, yalnızca alan yöneticilerinin ileti yayınlayabileceği bir duyuru alanı yapma ayarı.

PermissionSettings

Mevcut bir adlandırılmış alanı güncellerken belirtebileceğiniz 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)

İsteğe bağlı. Alanın üyelerini ve gruplarını yönetme ayarı.
modifySpaceDetails

object (PermissionSetting)

İsteğe bağlı. Alan adını, avatarını, açıklamasını ve yönergelerini güncelleme ayarı.
toggleHistory

object (PermissionSetting)

İsteğe bağlı. Alan geçmişini açıp kapatma ayarı.
useAtMentionAll

object (PermissionSetting)

İsteğe bağlı. Bir alanda @tümü ifadesini kullanma ayarı.
manageApps

object (PermissionSetting)

İsteğe bağlı. Alandaki uygulamaları yönetme ayarı.
manageWebhooks

object (PermissionSetting)

İsteğe bağlı. Alandaki webhook'ları yönetme ayarı.
postMessages

object (PermissionSetting)

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

object (PermissionSetting)

İsteğe bağlı. Alandaki mesajları yanıtlama ayarı.

PermissionSetting

Alan izni ayarını gösterir.

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

boolean

İsteğe bağlı. Alan yöneticilerinin bu izne sahip olup olmadığı.
membersAllowed

boolean

İsteğe bağlı. 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 hâle getirir.

create

 Alan oluşturur.

delete

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

findDirectMessage

 Belirtilen kullanıcıyla 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.
Bir yöneticinin aramasına göre Google Workspace kuruluşundaki alanların listesini döndürür.

setup

 Bir alan oluşturur ve belirtilen kullanıcıları bu alana ekler.