REST Resource: spaces

Kaynak: Alan

Google Chat alanları. Alanlar, iki veya daha fazla kullanıcı arasındaki görüşmeler ya da bir kullanıcı ile 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,
  "sessionState": enum (SpaceSessionState),
  "sessionEnableTime": string,
  "importModeExpireTime": string,
  "customer": string,

  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
}
Alanlar
name

string

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

Biçim: spaces/{space}

{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 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 kullanın. Alan türü.
spaceType

enum (SpaceType)

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

boolean

İsteğe bağlıdır. Alanın, bir Chat uygulaması ile tek bir kişi arasındaki DM olup olmadığı.
threaded
(deprecated)

boolean

Yalnızca çıkış. Desteği sonlandırıldı: Bunun yerine spaceThreadingState kullanın. Bu alandaki mesajların ileti dizisi halinde olup olmadığı.
displayName

string

İsteğe bağlıdır. Alanı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ı zaten kullanıyor olabilir.

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

En fazla 128 karakter desteklenir.
externalUserAllowed

boolean

İsteğe bağlıdır. Değiştirilemez. Bu alanın herhangi bir Google Chat kullanıcısına üye olarak izin verip vermediği. Google Workspace kuruluşunda alan oluştururken girilir. 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ıyorsa Tüketici hesabı tarafından oluşturulan bir alan, varsayılan olarak tüm Google Chat kullanıcılarına izin verir.

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

enum (SpaceThreadingState)

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

object (SpaceDetails)

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

enum (HistoryState)

İsteğe bağlıdır. Bu alandaki mesajların ve mesaj dizilerinin mesaj geçmişi durumu.
importMode

boolean

İsteğe bağlıdır. 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ılar tarafından görülemez.

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

string (Timestamp format)

İsteğe bağlıdır. Değiştirilemez. Chat'te oluşturulan alanlar için alanın oluşturulduğu zaman. Bu alan, içe aktarma modundaki alanlarda kullanıldığı durumlar dışında salt çıkışlıdır.

İçe aktarma modu alanları için bu alanı, alanın kaynakta oluşturulduğu geçmiş zaman damgasına ayarlayarak orijinal oluşturma zamanını koruyun.

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ış. Chat uygulaması bulunan 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 bir Chat uygulaması yükleyebilir ve bu uygulamayla doğrudan mesaj oluşturabilir.

Yönetici tarafından yüklemeyi 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ıdır. 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şmek için kullanacağı URI.
sessionState

enum (SpaceSessionState)

Yalnızca çıkış. Alan oturumunun durumu.
sessionEnableTime

string (Timestamp format)

Yalnızca çıkış. Alan oturumunun desteklenme durumunun "destekleniyor" olarak değiştiği zaman damgası. Alanda oturum desteği etkinleştirilmemişse ayarlanmaz.
importModeExpireTime

string (Timestamp format)

Yalnızca çıkış. İçe aktarma modunda kalırsa alanın 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ıdır. Değiştirilemez. Alanın alan adının müşteri kimliği. Yalnızca uygulama kimlik doğrulaması ile alan oluştururken ve SpaceType, SPACE olduğunda gereklidir. Diğer durumlarda ayarlanmamalıdır.

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

Bu alan, doğrudan mesajlar (DM'ler) için veya alan Google Workspace kullanıcısı olmayan kişiler tarafından oluşturulduğunda doldurulmaz.
Bir alanın izin ayarlarını temsil eder. Yalnızca space_type, SPACE olduğunda doldurulur. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

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

Önceden tanımlanmış izin ayarlarını belirlemek şunları destekler:
permissionSettings

object (PermissionSettings)

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

İzin ayarlarını okuma ve güncelleme şu durumlarda desteklenir:
Birbirini hariç tutan alanların sonu.

Tür

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

Sıralamalar
TYPE_UNSPECIFIED Rezervasyon yapıldı.
ROOM İki veya daha fazla kişi arasındaki görüşmeler.
DM Bir kullanıcı ile Chat uygulaması arasında, tüm mesajların düz olduğu bire bir doğrudan mesaj. İki kişi arasındaki doğrudan mesajların buna dahil olmadığını unutmayın.

SpaceType

Alanın türü. Alan oluştururken veya güncellerken gereklidir. Yalnızca diğer kullanımlar için çı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ığı bir yerdir. SPACE, Chat uygulamaları içerebilir.
GROUP_CHAT 3 veya daha fazla kişiyle yapılan grup görüşmeleri. GROUP_CHAT, Chat uygulamaları içerebilir.
DIRECT_MESSAGE İki kişi veya bir kişi ile Chat uygulaması arasındaki bire bir mesajlar.

SpaceThreadingState

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

Sıralamalar
SPACE_THREADING_STATE_UNSPECIFIED Rezervasyon yapıldı.
THREADED_MESSAGES Mesaj dizilerini destekleyen alanlar. Kullanıcılar bir mesaja yanıt verirken ileti dizisi içinde yanıt verebilir. Bu sayede yanıtları, orijinal mesajın 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

Mesaj dizilerini desteklemeyen alanlar. Bu alan mesaj dizisi oluşturma durumu yalnızca aşağıdaki gibi özel durumlarda kullanılır:

  • Mesaj dizilerinin kasıtlı olarak devre dışı bırakıldığı kesintisiz toplantı sohbeti.
  • 2022'den önce oluşturulan eski 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ıdır. Alanın açıklaması. Örneğin, alanın tartışma konusunu, işlevsel amacını veya katılımcılarını açıklayın.

En fazla 4.096 karakter desteklenir.
guidelines

string

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

En fazla 5.000 karakter desteklenir.

HistoryState

Mesajlar ve alanlar için 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 mesaj dizileri 24 saat boyunca saklanır.
HISTORY_ON Geçmiş açık. Kuruluşun Apps Kasası saklama kuralları, mesajların ve ileti dizilerinin ne kadar süreyle saklanacağını belirtir.

MembershipCount

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

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

integer

Yalnızca çıkış. Alana doğrudan katılan gerçek kullanıcıların sayısı. Katılan bir gruba üye olarak katılan kullanıcılar sayılmaz.
joinedGroupCount

integer

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

AccessSettings

Alanın erişim ayarını temsil eder.

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

enum (AccessState)

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

string

İsteğe bağlıdır. Alanı keşfedebilen, alana katılabilen ve alandaki mesajları önizleyebilen hedef kitlenin kaynak adı. Bu ayar yapılmazsa alana yalnızca tek tek davet edilen veya eklenen kullanıcılar ya da Google Grupları erişebilir. Ayrıntılı bilgi için Alanları hedef kitleler 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 şunları destekler:

Uygulama kimlik doğrulaması ile chat.bot kapsamı kullanılırken bu alan doldurulmaz.

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

object (AccessPermissionSettings)

İsteğe bağlıdır. Alan için erişim izni ayarları.

Alan oluştururken hedef kitleyi ayarlamak için isteğinizde accessSettings.audience alanını belirtin.

AccessState

Alanın erişim durumunu temsil eder.

Sıralamalar
ACCESS_STATE_UNSPECIFIED Erişim durumu bilinmiyor veya bu API'de desteklenmiyor.
PRIVATE Alanı 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ı bulabilir ve alana erişebilir.
DISCOVERABLE

Alan yöneticisi, hedef kitleye alana erişim izni verdiğinde. Alana tek tek eklenen veya davet edilen kullanıcılar ya da Google Grupları da alanı bulabilir ve alana erişebilir. Daha fazla bilgi edinmek için Alanları belirli kullanıcılar tarafından bulunabilir hale getirme başlıklı makaleyi inceleyin.

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

AccessPermissionSettings

Bir alanın izin ayarlarına erişme

JSON gösterimi 
{
  "discoverSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "joinSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "viewSpaceMembershipSetting": {
    object (AccessPermissionSetting)
  }
}
Alanlar
discoverSpaceSetting

object (AccessPermissionSetting)

İsteğe bağlıdır. Alanı keşfetmek için erişim izni ayarı.
joinSpaceSetting

object (AccessPermissionSetting)

İsteğe bağlıdır. Alana katılmak için erişim izni ayarı.
viewSpaceMembershipSetting

object (AccessPermissionSetting)

İsteğe bağlıdır. Alan üyeliğini görüntülemek için erişim izni ayarı. Alan üyeliğini kimlerin görüntüleyebileceği güncellenirken güncelleme maskesinde ve istek gövdesinde PermissionSettings.view_space_membership ile birlikte belirtilmelidir. Bir hedef kitleye görüntüleme erişimi verirken aynı istekte tüm üyelere PermissionSettings.view_space_membership de vermeniz gerekir. Mevcut bir hedef kitleyi kaldırmak için (ör. görüntüleme erişimini yalnızca alan yöneticileri veya yönetici yardımcılarıyla kısıtlamak için) boş bir AccessPermissionSetting (principals olmadan) belirtin.

AccessPermissionSetting

Erişim izin seti ayarı.

JSON gösterimi 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Alanlar
principals[]

object (Principal)

İsteğe bağlıdır. Sırasız liste. Bu izin için izin verilenler.

Ana hesap

Erişim izni verilen bir tüzel kişiyi temsil eden bir ana hesap.

JSON gösterimi 
{

  "audience": {
    object (Audience)
  }
}
Alanlar
Yetki verilen kişinin türü. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır:
audience

object (Audience)

Kitle.
Birbirini hariç tutan alanların sonu.

Kitle

Google Chat'teki bir hedef kitle. Hedef kitle, bir Google Workspace kuruluşunda yönetici tarafından tanımlanan bir kullanıcı grubunu temsil eder. Hedef kitleler, kaynakların erişim ve görünürlük ayarlarını yapılandırmak için kullanılır. Örneğin, bir alanı belirli bir kullanıcı grubu tarafından keşfedilebilir hale getirmek için hedef kitlelerden yararlanabilirsiniz.

Daha fazla bilgi için Hedef kitleler ve Alanları hedef kitleler tarafından bulunabilir hale getirme başlıklı makaleleri inceleyin.

JSON gösterimi 
{
  "name": string
}
Alanlar
name

string

Alanı bulabilen veya alana katılabilen hedef kitlenin kaynak adı. Ayrıntılı bilgi için Alanları hedef kitleler 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.

PredefinedPermissionSettings

Yalnızca adlandırılmış alan oluştururken belirtebileceğ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 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 getirme ayarı.

PermissionSettings

Mevcut bir adlandırılmış alanı güncellerken belirtebileceğiniz izin ayarları.

Alan oluştururken izin seti 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)
  },
  "viewSpaceMembership": {
    object (PermissionSetting)
  }
}
Alanlar
manageMembersAndGroups

object (PermissionSetting)

İsteğe bağlıdır. Alandaki üyeleri ve grupları yönetme ayarı.
modifySpaceDetails

object (PermissionSetting)

İsteğe bağlıdır. Alan adını, avatarını, açıklamasını ve kurallarını güncelleme ayarı.
toggleHistory

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

İsteğe bağlıdır. Alan üyeliğini görüntüleme ayarı. Alan üyeliğini kimlerin görüntüleyebileceği güncellenirken güncelleme maskesinde ve istek gövdesinde AccessPermissionSettings.view_space_membership_setting ile birlikte belirtilmelidir. Görüntüleme erişimini belirli rollerle (ör. yalnızca alan yöneticileri veya yönetici yardımcıları) kısıtlarken, istediğiniz rol izinlerini burada belirtin ve aynı istekte boş bir AccessPermissionSettings.view_space_membership_setting sağlayın. AccessPermissionSettings.view_space_membership_setting içinde bir hedef kitle yapılandırılmışsa bu ayar tüm üyelere verilmelidir.

PermissionSetting

Bir alan izin ayarını temsil eder.

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

boolean

İsteğe bağlıdır. Alan sahiplerinin (ROLE_MANAGER) bu izne sahip olup olmadığı.
membersAllowed

boolean

İsteğe bağlıdır. Temel alan üyelerinin (ROLE_MEMBER) bu izne sahip olup olmadığı.
assistantManagersAllowed

boolean

İsteğe bağlıdır. Alan yöneticilerinin ROLE_ASSISTANT_MANAGER) bu izne sahip olup olmadığı.

SpaceSessionState

Alan oturumunun durumu.

Sıralamalar
SPACE_SESSION_STATE_UNSPECIFIED Belirtilmedi. Kullanmayın.
NOT_SUPPORTED Alan, oturum desteğine sahip değil.
THREAD Alan, mesaj dizilerine dayalı oturumları destekler.

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

 Alan oluşturur.

delete

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

findDirectMessage

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

findGroupChats

 spaceType == GROUP_CHAT içeren, gerçek kişi üyelikleri tam olarak çağrıyı yapan kullanıcıyı ve FindGroupChatsRequest.users içinde belirtilen kullanıcıları içeren tüm alanları 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 Google Workspace kuruluşundaki alanların listesini döndürür.

setup

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