REST Resource: spaces.messages

Kaynak: Mesaj

Google Chat alanındaki bir mesaj.

JSON gösterimi 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "silent": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ],
  "elements": {
    object (Elements)
  },
  "markupSyntax": enum (MarkupSyntax)
}
Alanlar
name

string

Tanımlayıcı. İletinin kaynak adı.

Biçim: spaces/{space}/messages/{message}

Burada {space}, mesajın yayınlandığı alanın kimliği, {message} ise mesaj için sisteme atanmış bir kimliktir. Örneğin, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

İleti oluştururken özel bir kimlik ayarlarsanız {message} alanındaki değeri clientAssignedMessageId alanındaki değerle değiştirerek isteğinizde iletiyi belirtmek için bu kimliği kullanabilirsiniz. Örneğin, spaces/AAAAAAAAAAA/messages/client-custom-name. Ayrıntılar için Mesaj adlandırma başlıklı makaleyi inceleyin.
sender

object (User)

Yalnızca çıkış. Mesajı oluşturan kullanıcı. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa, alanın üyesi olmadıkları veya arayan kullanıcıyla doğrudan mesaj (DM) görüşmesi gibi önceden bir yakınlıkları olmadığı sürece hem kuruluş içi hem de kuruluş dışı kullanıcılar için çıkış yalnızca user name ve type alanlarını doldurur.
createTime

string (Timestamp format)

İsteğe bağlıdır. Değiştirilemez. Chat'te oluşturulan alanlarda, mesajın oluşturulduğu 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ı, iletinin kaynakta oluşturulduğu geçmiş zaman damgası olarak ayarlayın.
lastUpdateTime

string (Timestamp format)

Yalnızca çıkış. İletinin en son bir kullanıcı tarafından düzenlendiği zaman. İleti hiç düzenlenmediyse bu alan boştur.
deleteTime

string (Timestamp format)

Yalnızca çıkış. Mesajın Google Chat'te silindiği zaman. İleti hiçbir zaman silinmezse bu alan boştur.
text

string

İsteğe bağlıdır. İletinin düz metin gövdesi. Resim, video veya web sayfasına yönelik ilk bağlantı önizleme çipi oluşturur. Ayrıca Google Chat kullanıcısından veya alandaki herkesten@bahsedebilirsiniz.

Kısa mesaj oluşturma hakkında bilgi edinmek için Mesaj gönderme başlıklı makaleyi inceleyin.
formattedText

string

Yalnızca çıkış. Biçimlendirmeyi iletmek için eklenen işaretlemelerle birlikte text mesajını içerir. Bu alan, kullanıcı arayüzünde görünen tüm biçimlendirmeyi yakalamayabilir ancak aşağıdakileri içerir:

  • Kalın, italik, üstü çizili, sabit genişlikli, sabit genişlikli blok, madde işaretli liste ve blok alıntı için biçimlendirme söz dizimi.

  • <users/{user}> biçiminde kullanıcı bahsetmeleri.

  • Biçimi <{url}|{rendered_text}> olan özel köprüler. Burada ilk dize URL, ikinci dize ise oluşturulan metindir (örneğin, <http://example.com|custom text>).

  • :{emojiName}: biçiminde özel emoji (ör. :smile:) Bu durum, Unicode emojileri (ör. U+1F600) için geçerli değildir.

  • Madde işaretli liste öğeleri için yıldız işareti (*) kullanın. Örneğin, * item.

Daha fazla bilgi için İletide gönderilen metin biçimlendirmesini görüntüleme başlıklı makaleyi inceleyin.
cards[]
(deprecated)

object (Card)

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

Biçimlendirilmiş metinler, düğmeler ve tıklanabilir resimler gibi kullanıcı arayüzü öğelerini göstermek için kullanabileceğiniz zengin, biçimlendirilmiş ve etkileşimli kartlar. Kartlar genellikle iletinin düz metin gövdesinin altında gösterilir. cards ve cardsV2 en fazla 32 KB boyutunda olabilir.
cardsV2[]

object (CardWithId)

İsteğe bağlıdır. Kartlar dizisi.

Chat uygulamaları, uygulama kimlik doğrulaması ile kart oluşturabilir. Geliştirici Önizleme Programı kapsamında, Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa kart mesajları oluşturabilir. Chat uygulamanız Geliştirici Önizleme Programı'nın bir parçası değilse kullanıcı kimlik doğrulaması içeren kartlar oluşturamaz.

Kart içeren bir mesaj oluşturmayı öğrenmek için Mesaj gönderme başlıklı makaleyi inceleyin.

Kart Oluşturucu ile kart tasarlama ve önizleme

Kart Oluşturucu'yu açma
annotations[]

object (Annotation)

Yalnızca çıkış. Açıklamalar, iletinin düz metin gövdesiyle veya startIndex ve length ile 0'ın Google Dokümanlar ya da E-Tablolar gibi Google Workspace kaynaklarına bağlanan çipleriyle ilişkilendirilebilir.
thread

object (Thread)

İletinin ait olduğu ileti dizisi. Kullanım örneği için Mesaj dizisi başlatma veya yanıtlama başlıklı makaleyi inceleyin.
space

object (Space)

Yalnızca çıkış. Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa çıkış yalnızca alanı name doldurur.
fallbackText

string

İsteğe bağlıdır. Gerçek kartlar görüntülenemediğinde (ör. mobil bildirimler) kullanılan, mesajın kartlarının düz metin açıklaması.
actionResponse

object (ActionResponse)

Yalnızca giriş. Chat uygulamasının yanıtının nasıl yayınlanacağını yapılandırmak için kullanabileceği parametreler.
argumentText

string

Yalnızca çıkış. Tüm Chat uygulaması bahsetmelerinin kaldırıldığı, iletinin düz metin gövdesi.
slashCommand

object (SlashCommand)

Yalnızca çıkış. Varsa eğik çizgi komutu bilgileri.
attachment[]

object (Attachment)

İsteğe bağlıdır. Kullanıcı tarafından yüklenen ek.
matchedUrl

object (MatchedUrl)

Yalnızca çıkış. Bağlantı önizleme kalıbıyla eşleşen bir URL, Sohbet mesajı text alanında olmalıdır. Daha fazla bilgi için Bağlantıları önizleme başlıklı makaleyi inceleyin.
threadReply

boolean

Yalnızca çıkış. true olduğunda ileti, yanıt dizisindeki bir yanıttır. false olduğunda mesaj, alanın üst düzey görüşmesinde bir mesaj dizisinin ilk mesajı veya mesaj dizili yanıt içermeyen bir mesaj olarak görünür.

Alan, ileti dizilerinde yanıtlamayı desteklemiyorsa bu alan her zaman false olur.
silent

boolean

Yalnızca çıkış. Bunun sessiz mesaj olup olmadığı. Sessiz mesajlar, Chat'in alıcılar için push bildirimlerini bastırdığı mesajlardır.
clientAssignedMessageId

string

İsteğe bağlıdır. İleti için özel bir kimlik. Bir iletiyi tanımlamak veya ileti almak, silmek ya da güncellemek için alanı kullanabilirsiniz. Özel bir kimlik ayarlamak için mesajı oluştururken messageId alanını belirtin. Ayrıntılar için Mesaj adlandırma başlıklı makaleyi inceleyin.
emojiReactionSummaries[]

object (EmojiReactionSummary)

Yalnızca çıkış. Mesajdaki emoji tepkisi özetlerinin listesi.
privateMessageViewer

object (User)

İsteğe bağlıdır. Değiştirilemez. Mesaj oluşturmak için giriş, aksi takdirde yalnızca çıkış. Mesajı görüntüleyebilen kullanıcı. Bu alan ayarlandığında mesaj gizli olur ve yalnızca belirtilen kullanıcı ile Chat uygulaması tarafından görülebilir. Bu alanı isteğinize eklemek için Chat API'yi uygulama kimlik doğrulaması kullanarak çağırmanız ve aşağıdakileri atlamanız gerekir:

Ayrıntılı bilgi için Özel mesaj gönderme başlıklı makaleyi inceleyin.
deletionMetadata

object (DeletionMetadata)

Yalnızca çıkış. Silinen bir iletiyle ilgili bilgiler. deleteTime ayarlandığında mesaj silinir.
quotedMessageMetadata

object (QuotedMessageMetadata)

İsteğe bağlıdır. Başka bir iletinin alıntıladığı iletiyle ilgili bilgiler.

Bir mesaj oluşturduğunuzda aynı ileti dizisindeki mesajları veya yeni bir kök mesaj oluşturmak için bir kök mesajı alıntılayabilirsiniz. Ancak farklı bir ileti dizisindeki mesaj yanıtlarını alıntılayamazsınız.

Bir mesajı güncellediğinizde quotedMessageMetadata alanını ekleyemez veya değiştiremezsiniz ancak kaldırabilirsiniz.

Kullanım örneği için Başka bir iletiyi alıntı yapma başlıklı makaleyi inceleyin.
attachedGifs[]

object (AttachedGif)

Yalnızca çıkış. İletiye eklenen GIF resimleri
accessoryWidgets[]

object (AccessoryWidget)

İsteğe bağlıdır. İletinin en altında görünen bir veya daha fazla etkileşimli widget. Metin, kart veya hem metin hem de kart içeren mesajlara aksesuar widget'ları ekleyebilirsiniz. Diyalog içeren iletilerde desteklenmez. Ayrıntılı bilgi için Mesajın en altına etkileşimli widget'lar ekleme başlıklı makaleyi inceleyin.

Aksesuar widget'ları içeren bir mesaj oluşturmak için uygulama kimlik doğrulaması gerekir.
elements

object (Elements)

İsteğe bağlıdır. Öğeler, ileti oluşturma sırasında sağlanan ve ileti metninin belirli bölümleriyle ilişkili olabilen veya olmayabilen ek bileşenlerdir. Bunlar, yalnızca çıktı olarak sunulan ve ileti parçaları ya da iletinin tamamıyla ilgili ek bilgiler sağlayan açıklamalardan farklıdır.

markupSyntax

enum (MarkupSyntax)

İsteğe bağlıdır. Sunucunun text alan içeriğini nasıl yorumlayacağını belirtir.

CardWithId

Google Chat sohbet mesajındaki kart.

Chat uygulamaları, uygulama kimlik doğrulaması ile kart oluşturabilir. Geliştirici Önizleme Programı kapsamında, Chat uygulamanız kullanıcı olarak kimlik doğrulaması yapıyorsa kart mesajları oluşturabilir. Chat uygulamanız Geliştirici Önizleme Programı'nın bir parçası değilse kullanıcı kimlik doğrulaması içeren kartlar oluşturamaz.

Kart içeren bir mesaj oluşturmayı öğrenmek için Mesaj gönderme başlıklı makaleyi inceleyin.

Kart Oluşturucu ile kart tasarlama ve önizleme

Kart Oluşturucu'yu açma

JSON gösterimi 
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
Alanlar
cardId

string

İleti birden fazla kart içeriyorsa zorunludur. İletideki bir kartın benzersiz tanımlayıcısı.
card

object (Card)

Kart. Maksimum boyut 32 KB'tır.

Ek açıklama

Açıklamalar, iletinin düz metin gövdesiyle veya startIndex ve length ile 0'ın Google Dokümanlar ya da E-Tablolar gibi Google Workspace kaynaklarına bağlanan çipleriyle ilişkilendirilebilir. Kısa mesajlara temel biçimlendirme eklemek için Kısa mesajları biçimlendirme başlıklı makaleyi inceleyin.

Örnek düz metin e-posta mesajı:

Hello @FooBot how are you!"

İlgili not meta verileri:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
JSON gösterimi 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
Alanlar
type

enum (AnnotationType)

Bu notun türü.
length

integer

Bu açıklamanın karşılık geldiği düz metin e-posta mesajı gövdesindeki alt dizenin uzunluğu. Yoksa uzunluğun 0 olduğunu gösterir.
startIndex

integer

Bu açıklamanın karşılık geldiği düz metin e-posta mesajı gövdesindeki başlangıç dizini (0 tabanlı, dahil).
Ek açıklama hakkında ek meta veriler. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
userMention

object (UserMentionMetadata)

Kullanıcı bahsetme meta verileri.
slashCommand

object (SlashCommandMetadata)

Eğik çizgi komutunun meta verileri.
customEmojiMetadata

object (CustomEmojiMetadata)

Özel emojinin meta verileri.
Birbirini dışlayan alanların sonu.

AnnotationType

Ek açıklamanın türü.

Sıralamalar
ANNOTATION_TYPE_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
USER_MENTION Bir kullanıcıdan bahsedildiğinde
SLASH_COMMAND Eğik çizgi komutu çağrıldığında
CUSTOM_EMOJI Özel emoji ek açıklaması.

UserMentionMetadata

Kullanıcı bahsetmeleri (@) için ek açıklama meta verileri.

JSON gösterimi 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
Alanlar
user

object (User)

Bahsedilen kullanıcı.
type

enum (Type)

Kullanıcı bahsetme türü.

Tür

Sıralamalar
TYPE_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
ADD Kullanıcıyı alana ekleyin.
MENTION Alanda kullanıcıdan bahsetme

SlashCommandMetadata

Eğik çizgi komutları (/) için ek açıklama meta verileri.

JSON gösterimi 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
Alanlar
bot

object (User)

Komutu çağrılan Chat uygulaması.
type

enum (Type)

Eğik çizgi komutunun türü.
commandName

string

Çağrılan eğik çizgi komutunun adı.
commandId

string (int64 format)

Çağrılan eğik çizgi komutunun komut kimliği.
triggersDialog

boolean

Eğik çizgi komutunun iletişim kutusu için olup olmadığını gösterir.

Tür

Sıralamalar
TYPE_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
ADD Chat uygulamasını alana ekleyin.
INVOKE Alanda eğik çizgi komutunu çağırma

RichLinkMetadata

Bir kaynağın zengin bağlantısı. Zengin bağlantılar, iletinin düz metin gövdesiyle ilişkilendirilebilir veya startIndex ve length değeri 0 olan Google Dokümanlar ya da E-Tablolar gibi Google Workspace kaynaklarına bağlantı veren çipleri temsil edebilir.

JSON gösterimi 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
Alanlar
uri

string

Bu bağlantının URI'si.
Bağlı kaynağın verileri. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
Birbirini dışlayan alanların sonu.

RichLinkType

Zengin bağlantı türü. Gelecekte daha fazla tür eklenebilir.

Sıralamalar
DRIVE_FILE Google Drive zengin bağlantı türü.
CHAT_SPACE Chat alanı zengin bağlantı türü. Örneğin, alan akıllı çipi.
GMAIL_MESSAGE Gmail iletisi zengin bağlantı türü. Özellikle Chat'te paylaş'tan gelen bir Gmail çipi. API yalnızca GMAIL_MESSAGE rich link'leri içeren iletilerin okunmasını destekler.
MEET_SPACE Meet mesajı zengin bağlantı türü. Örneğin, Meet çipi.
CALENDAR_EVENT Takvim mesajı zengin bağlantı türü. Örneğin, takvim çipi.

DriveLinkData

Google Drive bağlantılarıyla ilgili veriler.

JSON gösterimi 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
Alanlar
driveDataRef

object (DriveDataRef)

Google Drive dosyasına referans veren bir DriveDataRef.
mimeType

string

Bağlı Google Drive kaynağının MIME türü.

ChatSpaceLinkData

Chat alanı bağlantılarıyla ilgili veriler.

JSON gösterimi 
{
  "space": string,
  "thread": string,
  "message": string
}
Alanlar
space

string

Bağlı Chat alanı kaynağının alanı.

Biçim: spaces/{space}
thread

string

Bağlı Chat alanı kaynağının mesaj dizisi.

Biçim: spaces/{space}/threads/{thread}
message

string

Bağlı Chat alanı kaynağının mesajı.

Biçim: spaces/{space}/messages/{message}

MeetSpaceLinkData

Meet alanı bağlantılarıyla ilgili veriler.

JSON gösterimi 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
Alanlar
meetingCode

string

Bağlı Meet alanının toplantı kodu.
type

enum (Type)

Meet alanının türünü belirtir.
huddleStatus

enum (HuddleStatus)

İsteğe bağlıdır. Yalnızca çıkış. Meet görüşmesi bir sohbet odasıysa sohbet odasının durumunu gösterir. Aksi takdirde bu ayar kaldırılır.

Tür

Meet alanının türü.

Sıralamalar
TYPE_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
MEETING Meet alanı bir toplantıdır.
HUDDLE Meet alanı bir sohbet odasıdır.

HuddleStatus

Toplantının durumu

Sıralamalar
HUDDLE_STATUS_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
STARTED Hızlı toplantı başladı.
ENDED Huddle sona erdi. Bu durumda Meet alanı URI'si ve tanımlayıcıları artık geçerli olmaz.
MISSED Huddle sohbetine yetişemediniz. Bu durumda Meet alanı URI'si ve tanımlayıcıları artık geçerli olmaz.

CalendarEventLinkData

Takvim etkinliği bağlantılarıyla ilgili veriler.

JSON gösterimi 
{
  "calendarId": string,
  "eventId": string
}
Alanlar
calendarId

string

Bağlı takvimin takvim tanımlayıcısı.
eventId

string

Bağlı Takvim etkinliğinin etkinlik tanımlayıcısı.

CustomEmojiMetadata

Özel emoji için açıklama meta verileri.

JSON gösterimi 
{
  "customEmoji": {
    object (CustomEmoji)
  }
}
Alanlar
customEmoji

object (CustomEmoji)

Özel emoji

İplik

Google Chat alanındaki bir ileti dizisi. Kullanım örneği için Mesaj dizisi başlatma veya yanıtlama başlıklı makaleyi inceleyin.

İleti oluştururken bir ileti dizisi belirtirseniz eşleşen bir ileti dizisi bulunmaması durumunda ne olacağını belirlemek için messageReplyOption alanını ayarlayabilirsiniz.

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

string

Tanımlayıcı. İş parçacığının kaynak adı.

Örnek: spaces/{space}/threads/{thread}
threadKey

string

İsteğe bağlıdır. İş parçacığı oluşturmak veya güncellemek için giriş. Aksi takdirde yalnızca çıkış. İleti dizisinin kimliği. 4.000 karaktere kadar destekler.

Bu kimlik, onu ayarlayan Chat uygulamasına özgüdür. Örneğin, birden fazla Chat uygulaması aynı ileti dizisi anahtarını kullanarak ileti oluşturursa iletiler farklı ileti dizilerinde yayınlanır. Bir kişi veya başka bir Chat uygulaması tarafından oluşturulan bir ileti dizisinde yanıtlamak için bunun yerine ileti dizisi name alanını belirtin.

ActionResponse

Chat uygulamasının yanıtının nasıl yayınlanacağını yapılandırmak için kullanabileceği parametreler.

JSON gösterimi 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
Alanlar
type

enum (ResponseType)

Yalnızca giriş. Chat uygulaması yanıtının türü.
url

string

Yalnızca giriş. Kullanıcıların kimlik doğrulaması yapacağı veya yapılandıracağı URL. (Yalnızca REQUEST_CONFIG yanıt türleri için geçerlidir.)
dialogAction

object (DialogAction)

Yalnızca giriş. Diyalog ile ilgili bir etkileşim etkinliğine verilen yanıt. ResponseType.Dialog ile birlikte gönderilmelidir.
updatedWidget

object (UpdatedWidget)

Yalnızca giriş. Güncellenen widget'ın yanıtı.

ResponseType

Chat uygulaması yanıtının türü.

Sıralamalar
TYPE_UNSPECIFIED NEW_MESSAGE olarak işlenen varsayılan tür.
NEW_MESSAGE Konuda yeni bir mesaj olarak yayınlama
UPDATE_MESSAGE Chat uygulamasının mesajını güncelleyin. Bu yalnızca mesaj gönderen türünün BOT olduğu CARD_CLICKED etkinliğinde izin verilir.
UPDATE_USER_MESSAGE_CARDS Kullanıcının iletisindeki kartları güncelleyin. Bu yalnızca eşleşen URL'ye sahip bir MESSAGE etkinliğine veya mesaj gönderen türünün HUMAN olduğu bir CARD_CLICKED etkinliğine yanıt olarak izin verilir. Metin yoksayılır.
REQUEST_CONFIG Kullanıcıdan ek kimlik doğrulama veya yapılandırma yapmasını özel olarak isteyin.
DIALOG İletişim kutusu gösterir.
UPDATE_WIDGET Widget metni otomatik tamamlama seçenekleri sorgusu.

DialogAction

İletişim kutusu ve istek durum kodunu içerir.

JSON gösterimi 
{
  "actionStatus": {
    object (ActionStatus)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dialog": {
    object (Dialog)
  }
}
Alanlar
actionStatus

object (ActionStatus)

Yalnızca giriş. Diyalog başlatma veya gönderme isteğinin durumu. Gerekirse kullanıcılara bir durum ve mesaj gösterir. Örneğin, hata veya başarı durumunda.
Gerçekleştirilecek işlem. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
dialog

object (Dialog)

Yalnızca giriş. İstekle ilgili iletişim kutusu.
Birbirini dışlayan alanların sonu.

Dialog

İletişim kutusunun kart gövdesini saran sarmalayıcı.

JSON gösterimi 
{
  "body": {
    object (Card)
  }
}
Alanlar
body

object (Card)

Yalnızca giriş. İletişim kutusunun gövdesi, kalıcı pencerede oluşturulur. Google Chat uygulamaları şu kart öğelerini desteklemez: DateTimePicker, OnChangeAction.

ActionStatus

Bir diyalog çağırma veya gönderme isteğinin durumunu gösterir.

JSON gösterimi 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
Alanlar
statusCode

enum (Code)

Durum kodu.
userFacingMessage

string

Kullanıcılara isteklerinin durumu hakkında gönderilecek ileti. Ayarlanmamışsa statusCode temel alınarak genel bir mesaj gönderilir.

Kod

gRPC API'leri için standart hata kodları.

Bazen birden fazla hata kodu geçerli olabilir. Hizmetler, geçerli olan en spesifik hata kodunu döndürmelidir. Örneğin, her iki kod da geçerliyse FAILED_PRECONDITION yerine OUT_OF_RANGE kodunu tercih edin. Benzer şekilde, FAILED_PRECONDITION yerine NOT_FOUND veya ALREADY_EXISTS tercih edin.

Sıralamalar
OK

Hata değildir; başarıyla tamamlandığında döndürülür.

HTTP Eşleme: 200 OK
CANCELLED

İşlem iptal edildi (genellikle arayan tarafından).

HTTP Eşleme: 499 Client Closed Request
UNKNOWN

Bilinmeyen hata. Örneğin, başka bir adres alanından alınan bir Status değeri, bu adres alanında bilinmeyen bir hata alanına ait olduğunda bu hata döndürülebilir. Ayrıca, yeterli hata bilgisi döndürmeyen API'lerin oluşturduğu hatalar da bu hataya dönüştürülebilir.

HTTP Eşleme: 500 Dahili Sunucu Hatası
INVALID_ARGUMENT

İstemci geçersiz bir bağımsız değişken belirtti. Bunun FAILED_PRECONDITION özelliğinden farklı olduğunu unutmayın. INVALID_ARGUMENT, sistemin durumundan bağımsız olarak sorunlu olan bağımsız değişkenleri (ör. hatalı biçimlendirilmiş bir dosya adı) gösterir.

HTTP Eşleme: 400 Hatalı İstek
DEADLINE_EXCEEDED

İşlem tamamlanmadan son tarih geçti. Sistemin durumunu değiştiren işlemler için, işlem başarıyla tamamlanmış olsa bile bu hata döndürülebilir. Örneğin, bir sunucudan gelen başarılı yanıt, son kullanma tarihinin geçmesine yetecek kadar uzun süre gecikmiş olabilir.

HTTP eşleme: 504 Ağ Geçidi Zaman Aşımı
NOT_FOUND

İstenen bazı varlıklar (ör. dosya veya dizin) bulunamadı.

Sunucu geliştiricilerine not: Bir istek, kademeli özellik kullanıma sunma veya belgelenmemiş izin verilenler listesi gibi tüm kullanıcı sınıfı için reddedilirse NOT_FOUND kullanılabilir. Kullanıcı tabanlı erişim denetimi gibi bir kullanıcı sınıfındaki bazı kullanıcılar için istek reddedilirse PERMISSION_DENIED kullanılmalıdır.

HTTP Eşleme: 404 Bulunamadı
ALREADY_EXISTS

İstemcinin oluşturmaya çalıştığı öğe (ör. dosya veya dizin) zaten mevcut.

HTTP Eşleme: 409 Çakışma
PERMISSION_DENIED

Arayanın, belirtilen işlemi yürütme izni yok. Bazı kaynakların tükenmesinden kaynaklanan retler için PERMISSION_DENIED kullanılmamalıdır (bu tür hatalar için bunun yerine RESOURCE_EXHAUSTED kullanılmalıdır). Arayan tanımlanamıyorsa PERMISSION_DENIED kullanılmamalıdır (bu tür hatalar için bunun yerine UNAUTHENTICATED kullanılmalıdır). Bu hata kodu, isteğin geçerli olduğunu veya istenen öğenin mevcut olduğunu ya da diğer ön koşulları karşıladığını göstermez.

HTTP Eşleme: 403 Yasak
UNAUTHENTICATED

İstekte işlemle ilgili geçerli kimlik doğrulama bilgileri bulunmuyor.

HTTP eşlemesi: 401 Yetkisiz
RESOURCE_EXHAUSTED

Kullanıcı başına kota veya dosya sisteminin tamamında yer kalmaması gibi bir kaynak tükenmiş olabilir.

HTTP Eşleme: 429 Too Many Requests
FAILED_PRECONDITION

Sistem, işlemin yürütülmesi için gerekli durumda olmadığından işlem reddedildi. Örneğin, silinecek dizin boş değil, dizin olmayan bir öğeye rmdir işlemi uygulanıyor vb.

Hizmet uygulayıcıları, FAILED_PRECONDITION, ABORTED ve UNAVAILABLE arasında karar vermek için aşağıdaki yönergeleri kullanabilir: (a) İstemci yalnızca başarısız olan aramayı yeniden deneyebiliyorsa UNAVAILABLE kullanın. (b) İstemcinin daha yüksek bir düzeyde yeniden denemesi gerekiyorsa ABORTED kullanın. Örneğin, istemci tarafından belirtilen bir test ve ayarlama işlemi başarısız olduğunda istemcinin bir okuma-değiştirme-yazma dizisini yeniden başlatması gerektiğini belirtir. (c) Sistem durumu açıkça düzeltilene kadar istemcinin yeniden denememesi gerekiyorsa FAILED_PRECONDITION kullanın. Örneğin, bir "rmdir" komutu dizin boş olmadığı için başarısız olursa istemci, dosyalar dizinden silinmediği sürece yeniden denememelidir. Bu nedenle FAILED_PRECONDITION döndürülmelidir.

HTTP Eşleme: 400 Hatalı İstek
ABORTED

İşlem, genellikle sıralayıcı kontrolü hatası veya işlem iptali gibi eşzamanlılık sorunu nedeniyle iptal edildi.

FAILED_PRECONDITION, ABORTED ve UNAVAILABLE arasında karar vermek için yukarıdaki yönergeleri inceleyin.

HTTP Eşleme: 409 Çakışma
OUT_OF_RANGE

İşlem, geçerli aralığın dışında denenmiştir. Örneğin, dosya sonunun ötesinde arama yapma veya okuma.

INVALID_ARGUMENT hatasının aksine bu hata, sistem durumu değiştiğinde düzeltilebilecek bir sorunu gösterir. Örneğin, [0,2^32-1] aralığında olmayan bir ofsetten okuması istendiğinde 32 bitlik bir dosya sistemi INVALID_ARGUMENT oluşturur ancak geçerli dosya boyutunu aşan bir ofsetten okuması istendiğinde OUT_OF_RANGE oluşturur.

FAILED_PRECONDITION ile OUT_OF_RANGE arasında önemli bir örtüşme var. Bir alanda yineleme yapan arayanların, işleri bittiğinde OUT_OF_RANGE hatasını kolayca bulabilmeleri için geçerli olduğunda OUT_OF_RANGE (daha spesifik hata) kullanılmasını öneririz.

HTTP Eşleme: 400 Hatalı İstek
UNIMPLEMENTED

İşlem uygulanmamış veya bu hizmette desteklenmiyor/etkinleştirilmemiş.

HTTP Eşleme: 501 Not Implemented
INTERNAL

Dahili hatalar. Bu, temel sistemin beklediği bazı değişmezlerin bozulduğu anlamına gelir. Bu hata kodu, ciddi hatalar için ayrılmıştır.

HTTP Eşleme: 500 Dahili Sunucu Hatası
UNAVAILABLE

Hizmet şu anda kullanılamıyor. Bu durum büyük olasılıkla geçicidir ve geri yükleme aralığı ile yeniden denenerek düzeltilebilir. İdempotent olmayan işlemlerin her zaman güvenli bir şekilde yeniden denenemeyeceğini unutmayın.

FAILED_PRECONDITION, ABORTED ve UNAVAILABLE arasında karar vermek için yukarıdaki yönergeleri inceleyin.

HTTP Eşleme: 503 Hizmet Kullanılamıyor
DATA_LOSS

Kurtarılamayan veri kaybı veya bozulması

HTTP Eşleme: 500 Dahili Sunucu Hatası

UpdatedWidget

selectionInput widget'ları için çoklu seçim menüsüyle ilgili otomatik tamamlama önerileri döndürür.

JSON gösterimi 
{
  "widget": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "suggestions": {
    object (SelectionItems)
  }
}
Alanlar
widget

string

Güncellenen widget'ın kimliği. Kimlik, güncelleme isteğini tetikleyen widget'ın kimliğiyle eşleşmelidir.
Widget, kullanıcı işlemine yanıt olarak güncellendi. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
suggestions

object (SelectionItems)

Widget otomatik tamamlama sonuçlarının listesi
Birbirini dışlayan alanların sonu.

SelectionItems

Widget otomatik tamamlama sonuçlarının listesi.

JSON gösterimi 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
Alanlar
items[]

object (SelectionItem)

SelectionItem nesneleri dizisi.

SlashCommand

Google Chat'teki eğik çizgi komutu hakkında meta veriler.

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

string (int64 format)

Eğik çizgi komutunun kimliği.

MatchedUrl

Sohbet mesajında eşleşen bir URL. Chat uygulamaları, eşleşen URL'leri önizleyebilir. Daha fazla bilgi için Bağlantıları önizleme başlıklı makaleyi inceleyin.

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

string

Yalnızca çıkış. Eşleşen URL.

EmojiReactionSummary

Bir mesaja belirli bir emoji ile tepki veren kullanıcıların sayısı.

JSON gösterimi 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
Alanlar
emoji

object (Emoji)

Yalnızca çıkış. Tepkilerle ilişkili emoji.
reactionCount

integer

Yalnızca çıkış. İlişkili emoji kullanılarak verilen toplam tepki sayısı.

DeletionMetadata

Silinen bir iletiyle ilgili bilgiler. deleteTime ayarlandığında mesaj silinir.

JSON gösterimi 
{
  "deletionType": enum (DeletionType)
}
Alanlar
deletionType

enum (DeletionType)

Mesajı kimin sildiğini gösterir.

DeletionType

Mesajı kimin ve nasıl sildiği Gelecekte daha fazla değer eklenebilir. Mesajların ne zaman silinebileceği hakkında ayrıntılı bilgi için Google Chat'te mesaj düzenleme veya silme başlıklı makaleyi inceleyin.

Sıralamalar
DELETION_TYPE_UNSPECIFIED Bu değer kullanılmıyor.
CREATOR Kullanıcı kendi mesajını sildi.
SPACE_OWNER Mesaj, bir sahip veya yönetici tarafından silindi.
ADMIN Bir Google Workspace yöneticisi mesajı sildi. Yöneticiler, alan üyeleri veya Chat uygulaması tarafından gönderilenler de dahil olmak üzere alandaki tüm mesajları silebilir.
APP_MESSAGE_EXPIRY Bir Chat uygulaması, süresi dolduğunda kendi mesajını sildi.
CREATOR_VIA_APP Bir Chat uygulaması, mesajı içerik üretici adına (kullanıcı kimlik doğrulamasını kullanarak) sildi.
SPACE_OWNER_VIA_APP Bir Chat uygulaması, alan yöneticisi adına (kullanıcı kimlik doğrulaması kullanarak) mesajı sildi.
SPACE_MEMBER Mesaj, alanın bir üyesi tarafından silindi. Kullanıcılar, uygulamalar tarafından gönderilen mesajları silebilir.

QuotedMessageMetadata

Başka bir iletinin alıntıladığı iletiyle ilgili bilgiler.

Bir mesajı güncellediğinizde quotedMessageMetadata alanını ekleyemez veya değiştiremezsiniz ancak kaldırabilirsiniz.

Kullanım örneği için Başka bir iletiyi alıntı yapma başlıklı makaleyi inceleyin.

JSON gösterimi 
{
  "name": string,
  "lastUpdateTime": string,
  "quoteType": enum (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
Alanlar
name

string

Zorunlu. Alıntılanan mesajın kaynak adı.

Biçim: spaces/{space}/messages/{message}
lastUpdateTime

string (Timestamp format)

Zorunlu. Alıntılanan mesajın oluşturulduğu veya son güncellendiği zaman damgası.

Mesaj düzenlendiyse bu alanı (lastUpdateTime) kullanın. Mesaj hiç düzenlenmediyse createTime simgesini kullanın.

lastUpdateTime, alıntılanan mesajın en son sürümüyle eşleşmezse istek başarısız olur.
quoteType

enum (QuoteType)

İsteğe bağlıdır. Alıntı türünü belirtir. Ayarlanmamışsa geriye dönük uyumluluk için ileti okuma/yazma yolunda varsayılan olarak YANIT kullanılır.
quotedMessageSnapshot

object (QuotedMessageSnapshot)

Yalnızca çıkış. Alıntılanan mesajın içeriğinin anlık görüntüsü.
forwardedMetadata

object (ForwardedMetadata)

Yalnızca çıkış. Alıntılanan mesajın kaynak alanı hakkındaki meta veriler. Yalnızca FORWARD teklif türü için doldurulur.

QuoteType

Alıntılanan iletinin alıntı türü.

Sıralamalar
QUOTE_TYPE_UNSPECIFIED Ayrılmış. Bu değer kullanılmıyor.
REPLY

quoteType REPLY olduğunda şunları yapabilirsiniz:

  • Bir ileti dizisinde yanıt veriyorsanız bu ileti dizisindeki başka bir iletiyi alıntılayabilirsiniz.

  • Kök mesaj oluşturuyorsanız söz konusu alandaki başka bir kök mesajı alıntılayabilirsiniz.
FORWARD

quoteType, FORWARD olduğunda şunları alıntılayabilirsiniz:

  • Farklı bir alandan gelen mesajlar

  • Aynı alandaki farklı bir mesaj dizisinden gelen ileti yanıtı.

QuotedMessageSnapshot

Alıntılanan veya yönlendirilen iletinin içeriğinin alıntı veya yönlendirme sırasındaki anlık görüntüsünü sağlar.

JSON gösterimi 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
Alanlar
sender

string

Yalnızca çıkış. Alıntılanan iletinin yazarının adı. YANITLA ve YÖNLENDİRME alıntı türleri için doldurulur.
text

string

Yalnızca çıkış. Alıntılanan iletinin metin içeriğinin anlık görüntüsü.
formattedText

string

Yalnızca çıkış. Köprüler, özel emojiler, işaretleme vb. gibi zengin biçimlendirmeyi desteklemek için eklenen işaretlemelerle birlikte alıntılanan mesajı text içerir. Yalnızca YÖNLENDİRME alıntı türü için doldurulur.
annotations[]

object (Annotation)

Yalnızca çıkış. Alıntılanan iletinin metin gövdesinden ayrıştırılan ek açıklamalar. Yalnızca FORWARD teklif türü için doldurulur.
attachments[]

object (Attachment)

Yalnızca çıkış. Alıntı yapılan iletinin ekleri Bunlar, alıntılanan iletinin ek meta verilerinin kopyalarıdır. Yalnızca FORWARD teklif türü için doldurulur.

ForwardedMetadata

Bir iletinin yönlendirildiği kaynak alanla ilgili meta veriler.

JSON gösterimi 
{
  "space": string,
  "spaceDisplayName": string
}
Alanlar
space

string

Yalnızca çıkış. Kaynak alanın kaynak adı. Biçim: spaces/{space}
spaceDisplayName

string

Yalnızca çıkış. Yönlendirme sırasında kaynak alanın veya doğrudan mesajın görünen adı. SPACE için bu, alan adıdır. DIRECT_MESSAGE için bu, diğer katılımcının adıdır (ör. "A Kullanıcısı"). GROUP_CHAT için, üyelerin adlarına göre oluşturulan ve içerik üretici dahil en fazla 5 ad içeren bir addır (ör. "Kullanıcı A, Kullanıcı B").

AttachedGif

URL ile belirtilen bir GIF resmi.

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

string

Yalnızca çıkış. GIF resmini barındıran URL.

AccessoryWidget

İletinin en altında görünen bir veya daha fazla etkileşimli widget. Ayrıntılı bilgi için Mesajın en altına etkileşimli widget'lar ekleme başlıklı makaleyi inceleyin.

JSON gösterimi 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "buttonList": {
    object (ButtonList)
  }
}
Alanlar
İşlemin türü. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
buttonList

object (ButtonList)

Düğme listesi.
Birbirini dışlayan alanların sonu.

Öğeler

Öğeler, ileti oluşturma sırasında sağlanan ileti metniyle ilişkili olabilen veya olmayan ek bileşenlerdir.

JSON gösterimi 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ]
}
Alanlar
citedSources[]

object (CitedSource)

İletinin altında altbilgi bağlantıları olarak gösterilecek kaynakların listesi. Bunlara satır içi referans verilmez. Satır içi referanslar için citations kullanın.
citations[]

object (Citation)

Mesaj metninde referans verilen satır içi alıntıların (<chat-citation> etiketleri aracılığıyla) listesi. Bu alıntılar, etkileşimli fareyle üzerine gelme kartları olarak oluşturulur.

CitedSource

Bilgi kaynağına yapılan referans.

JSON gösterimi 
{
  "title": string,
  "uri": string,
  "snippet": {
    object (Snippet)
  },
  "footer": {
    object (Footer)
  }
}
Alanlar
title

string

Zorunlu. CitedSource öğesinin düz metin başlığı. Bu alan biçimlendirmeyi desteklemiyor.
uri

string

Zorunlu. Bu CitedSource tarafından referans verilen kaynağı gösteren URI.
snippet

object (Snippet)

İsteğe bağlıdır. Doğrudan kaynaktan alınan bilgileri içeren snippet.
footer

object (Footer)

İsteğe bağlıdır. Snippet'in yanında altbilgi olarak gösterilecek ek bilgiler.

Snippet

Daha büyük bir derlemeden alıntıyı temsil eden bir snippet nesnesi.

JSON gösterimi 
{
  "text": string,
  "imagePreview": {
    object (ElementsImage)
  }
}
Alanlar
text

string

İsteğe bağlıdır. Doğrudan Chat'te oluşturulabilecek, derlemden alınmış kısa bir düz metin alıntısı. Markdown biçimi desteklenmez.
imagePreview

object (ElementsImage)

İsteğe bağlıdır. Alıntı oluşturulurken giriş olarak sağlanan snippet'in resim önizlemesi.

ElementsImage

Bir görüntüyü temsil etmenin farklı yollarını kapsayan bir nesne. Şu anda desteklenen temsiller: - Bir URI'den alınan resim. Gelecekte ek temsiller desteklenebilir.

JSON gösterimi 
{

  "imageUri": string
}
Alanlar
Zorunlu. Desteklenen resim gösterimlerinden biri. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
imageUri

string

Zorunlu. Bir resmin herkese açık URI'si.
Birbirini dışlayan alanların sonu.

Kaynak için bir altbilgi, ilişkilendirme için kullanılır.

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

string

İsteğe bağlıdır. Altbilgide gösterilecek metin.

Alıntı

Alıntılar, satır içi referanslar olup kullanıcılara satır içi referans hakkında daha ayrıntılı bilgi verebilir. İlgili satır içi alıntılar, ileti metninde <chat-citation data-id="{id}">{text}</chat-citation> biçiminde bir işaretleme biçiminde yer almalıdır. Alıntılar yalnızca iletinin markupSyntax değeri MARKDOWN olarak ayarlandığında desteklenir.

Elements.citations içindeki referans verilmeyen alıntılar (ileti metninde eşleşen bir <chat-citation> etiketi olmayanlar) yok sayılır ve iletinin reddedilmesine neden olmaz.

JSON gösterimi 
{
  "id": string,
  "citedSources": [
    {
      object (CitedSource)
    }
  ]
}
Alanlar
id

string

Zorunlu. Uygulama tarafından tanımlanan kimlik. Yalnızca ASCII harf ve rakamları içermeli ve 63 karakterden kısa olmalıdır.
citedSources[]

object (CitedSource)

İsteğe bağlıdır. Alıntıyla alakalı kaynakların listesi. Kaynaklar, alıntı fareyle üzerine gelme kartında gösterilir.

MarkupSyntax

Sohbet mesajı metnini biçimlendirmek için kullanılan biçimlendirme söz dizimini belirtir. Message kaynağının text alanı için geçerlidir.

Sıralamalar
MARKUP_SYNTAX_UNSPECIFIED Belirtilmemiş değeri gösterir.
MARKUP_SYNTAX_CHAT Google Chat'in işaretleme söz dizimini kullanır. Daha fazla bilgi için https://developers.google.com/workspace/chat/format-messages#format-texts adresini ziyaret edin.
MARKUP_SYNTAX_MARKDOWN Markdown söz dizimini kullanır. Bu söz dizimi, ek uzantılarla birlikte CommonMark spesifikasyonuna dayanır. Daha fazla bilgi için https://developers.google.com/workspace/chat/format-messages#format-texts adresini ziyaret edin.

Yöntemler

create

 Google Chat alanında mesaj oluşturur.

delete

 Mesajı siler.

get

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

list

 Arayanın üyesi olduğu bir alandaki mesajları (engellenen üyelerden ve alanlardan gelen mesajlar dahil) listeler.

patch

 Mesajı günceller.

replaceCards

 İletideki kartların yerini alır.
Arayan kullanıcının erişimi olan Google Chat mesajlarını arar.

update

 Mesajı günceller.