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ı. Mesajın kaynak adı.

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

{space}, mesajın yayınlandığı alanın kimliği, {message} ise mesaj için sistem tarafından atanan kimliktir. Örneğin, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Mesaj oluştururken özel bir kimlik ayarlarsanız {message} değerini clientAssignedMessageId alanındaki değerle değiştirerek bu kimliği bir istekte mesajı belirtmek için 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 çıkış, yalnızca alanın üyesi olan veya arayan kullanıcıyla önceden bir yakınlığı (ör. doğrudan mesaj (DM) görüşmesi) olan hem dahili hem de harici kullanıcılar için user name ve type alanlarını doldurur.
createTime

string (Timestamp format)

İsteğe bağlı. Değiştirilemez. Chat'te oluşturulan alanlar için mesajı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ı, mesajın kaynakta oluşturulduğu geçmiş zaman damgasına ayarlayarak orijinal oluşturma zamanını koruyun.
lastUpdateTime

string (Timestamp format)

Yalnızca çıkış. Mesajın bir kullanıcı tarafından en son düzenlendiği zaman. Mesaj hiç düzenlenmemişse bu alan boş olur.
deleteTime

string (Timestamp format)

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

string

İsteğe bağlı. İletinin düz metin gövdesi. Bir resim, video veya web sayfasının ilk bağlantısı, önizleme çipi oluşturur. Ayrıca bir 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 belirtmek için işaretlemeler eklenmiş text mesajını içerir. Bu alan, kullanıcı arayüzünde görünen tüm biçimlendirmeleri yakalamayabilir ancak aşağıdakileri içerir:

  • Kalın, italik, üstü çizili, sabit boşluklu, sabit boşluklu blok, madde işaretli liste ve blok alıntı için işaretleme söz dizimi.

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

  • İlk dizenin URL, ikincisinin ise oluşturulan metin olduğu <{url}|{rendered_text}> biçimini kullanan özel köprüler (ör. <http://example.com|custom text>).

  • :{emojiName}: biçimini kullanan özel emoji (ör. :smile:). Bu durum, sırıtan yüz emojisi için U+1F600 gibi Unicode emojilerde geçerli değildir.

  • Yıldız işareti (*) kullanarak liste öğelerine madde işareti ekleyin (ör. * item).

Daha fazla bilgi için Mesajda 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örüntülemek için kullanabileceğiniz zengin, biçimlendirilmiş ve etkileşimli kartlar. Kartlar normalde 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ı. Kart 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ı'na dahil değilse kullanıcı kimlik doğrulaması içeren kartlar oluşturamaz.

Kart içeren bir mesajın nasıl oluşturulacağını öğ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ış. Ek açıklamalar, mesajın düz metin gövdesiyle veya startIndex ve length değeri 0 olan Google Dokümanlar ya da E-Tablolar gibi Google Workspace kaynaklarına bağlantı veren çiplerle ilişkilendirilebilir.
thread

object (Thread)

İletinin ait olduğu ileti dizisi. Örnek kullanım için Mesaj dizisi başlatma veya mesaj dizisini 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ı. Mesaj kartlarının düz metin açıklaması. Gerçek kartlar gösterilemediğinde (ör. mobil bildirimler) kullanılır.
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 çıkarıldığı, iletinin düz metin gövdesi.
slashCommand

object (SlashCommand)

Yalnızca çıkış. Eğik çizgi komutu bilgileri (varsa)
attachment[]

object (Attachment)

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

object (MatchedUrl)

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

boolean

Yalnızca çıkış. true olduğunda mesaj, yanıt ileti 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ıtları olmayan bir mesaj olarak görünür.

Alan, mesaj dizilerinde yanıt vermeyi desteklemiyorsa bu alan her zaman false olur.
silent

boolean

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

string

İsteğe bağlı. Mesaj için özel bir kimlik. Bu alanı bir mesajı tanımlamak veya bir mesajı almak, silmek ya da güncellemek için kullanabilirsiniz. Özel Kimlik ayarlamak için mesajı oluştururken messageId alanını belirtin. Ayrıntılar için Mesajlara ad verme başlıklı makaleyi inceleyin.
emojiReactionSummaries[]

object (EmojiReactionSummary)

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

object (User)

İsteğe bağlı. 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 dahil etmek için uygulama kimlik doğrulamasını kullanarak Chat API'yi çağırmanız ve aşağıdakileri atlamanız gerekir:

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

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

İsteğe bağlı. Başka bir mesajın alıntı yaptığı mesajla ilgili bilgiler.

Mesaj oluştururken aynı ileti dizisindeki mesajlardan alıntı yapabilir veya yeni bir kök mesaj oluşturmak için kök mesajdan alıntı yapabilirsiniz. Ancak farklı bir mesaj dizisindeki mesaj yanıtını alıntılayamazsınız.

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

Örnek kullanım için Başka bir mesajdan alıntı yapma bölümüne bakın.
attachedGifs[]

object (AttachedGif)

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

object (AccessoryWidget)

İsteğe bağlı. Mesajın alt kısmı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. İletişim kutusu içeren mesajlarda desteklenmez. Ayrıntılı bilgi için Mesajın alt kısmına etkileşimli widget'lar ekleme başlıklı makaleyi inceleyin.

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

object (Elements)

İsteğe bağlı. Öğeler, mesaj oluşturma sırasında sağlanan ve mesaj metninin belirli bölümleriyle ilişkili olabilen veya olmayabilen ek bileşenlerdir. Bunlar, yalnızca çıkış amaçlı olan ve mesaj parçalarına veya mesaj metninin tamamına bağlı ek bilgiler sunan ek açıklamalardan farklıdır.

markupSyntax

enum (MarkupSyntax)

İsteğe bağlı. Sunucunun, mesaj oluştururken veya bir mesajın text alanını güncellerken mesajın text alan içeriğini nasıl yorumlayacağını belirtir.

UpdateMessage yöntemini çağırırken Message kaynağında markupSyntax ve text değerlerini ayarlayın ve updateMask alanına text değerini (markupSyntax değil) ekleyin.

Ek açıklama

Ek açıklamalar, mesajın düz metin gövdesiyle veya startIndex ve length değeri 0 olan Google Dokümanlar ya da E-Tablolar gibi Google Workspace kaynaklarına bağlantı veren çiplerle ilişkilendirilebilir. Kısa mesajlara temel biçimlendirme eklemek için Kısa mesajları biçimlendirme başlıklı makaleyi inceleyin.

Düz metin e-posta mesajı örneği:

Hello @FooBot how are you!"

İlgili ek açıklama 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,

  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
Alanlar
type

enum (AnnotationType)

Bu notun türü.
length

integer

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

integer

Bu ek açıklamanın karşılık geldiği düz metin e-posta mesajındaki başlangıç dizini (0 tabanlı, dahil).
Notla ilgili ek meta veriler. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır:
userMention

object (UserMentionMetadata)

Kullanıcıdan bahsetmenin meta verileri.
slashCommand

object (SlashCommandMetadata)

Eğik çizgi komutunun meta verileri.
customEmojiMetadata

object (CustomEmojiMetadata)

Özel emojinin meta verileri.
Birbirini hariç tutan 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ıdan bahsetmeler (@) için ek açıklama meta verileri.

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

object (User)

Kullanıcı bahsetti.
type

enum (Type)

Kullanıcıdan bahsetme türü.

Tür

Sıralamalar
TYPE_UNSPECIFIED Enum için varsayılan değer. Kullanmayın.
ADD Kullanıcıyı alana ekleme
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 bir 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ğırın.

RichLinkMetadata

Bir kaynağa yönlendiren zengin bağlantı. Zengin bağlantılar, mesajın 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),

  "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, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır:
Birbirini hariç tutan 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 bir Gmail çipi. API, yalnızca GMAIL_MESSAGE zengin bağlantıları içeren mesajların 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)

Bir Google Drive dosyasına referans veren 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ı. Yalnızca çıkış. Meet bir Hızlı Toplantı ise hızlı toplantı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 hızlı toplantıdır.

HuddleStatus

Hızlı 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 Hızlı toplantı sona erdi. Bu durumda Meet alan URI'si ve tanımlayıcıları artık geçerli olmaz.
MISSED Hızlı toplantı kaçırıldı. 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ı Takvim'in Takvim tanımlayıcısı.
eventId

string

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

CustomEmojiMetadata

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

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

object (CustomEmoji)

Özel emoji.

Mesaj dizisi

Google Chat alanındaki bir mesaj dizisi. Örnek kullanım için Mesaj dizisi başlatma veya mesaj dizisini yanıtlama başlıklı makaleyi inceleyin.

Mesaj oluştururken bir ileti dizisi belirtirseniz eşleşen ileti dizisi bulunamadığında ne olacağını belirlemek için messageReplyOption alanını ayarlayabilirsiniz.

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

string

Tanımlayıcı. Mesaj dizisinin kaynak adı.

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

string

İsteğe bağlı. Mesaj dizisi oluşturmak veya güncellemek için giriş. Aksi takdirde, yalnızca çıkış. İleti dizisinin kimliği. En fazla 4.000 karakter desteklenir.

Bu kimlik, kimliği ayarlayan Chat uygulamasına özeldir. Örneğin, birden fazla Chat uygulaması aynı mesaj dizisi anahtarını kullanarak mesaj oluşturursa mesajlar farklı mesaj dizilerinde yayınlanır. Bir kişi veya başka bir Chat uygulaması tarafından oluşturulan mesaj dizisini yanıtlamak için 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ı veya yapılandırma yapması için URL. (Yalnızca REQUEST_CONFIG yanıt türleri için.)
dialogAction

object (DialogAction)

Yalnızca giriş. İletişim kutusuyla ilgili bir etkileşim etkinliğine verilen yanıt. ResponseType.Dialog ile birlikte kullanılmalıdır.
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 işleme yalnızca ileti gönderen türünün BOT olduğu CARD_CLICKED etkinliklerinde izin verilir.
UPDATE_USER_MESSAGE_CARDS Kullanıcı mesajındaki kartları güncelleme Buna yalnızca eşleşen bir URL'ye sahip 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 gizli olarak ek kimlik doğrulama veya yapılandırma isteyin.
DIALOG İletişim kutusu gösterir.
UPDATE_WIDGET Widget metni otomatik tamamlama seçenekleri sorgusu.

DialogAction

Bir iletişim kutusu ve istek durum kodu içerir.

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

  "dialog": {
    object (Dialog)
  }
}
Alanlar
actionStatus

object (ActionStatus)

Yalnızca giriş. Bir iletişim kutusunu çağırma veya gönderme isteğinin durumu. Gerekirse kullanıcılara bir durum ve mesaj gösterir. Örneğin, bir hata veya başarı durumunda.
Gerçekleştirilecek işlem. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır:
dialog

object (Dialog)

Yalnızca giriş. İstek için iletişim kutusu.
Birbirini hariç tutan alanların sonu.

Dialog

İletişim kutusunun kart gövdesini çevreleyen 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 desteklemiyor: DateTimePicker, OnChangeAction.

ActionStatus

Bir iletişim kutusunu çağırma veya gönderme isteğinin durumunu temsil eder.

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 mesaj. Ayarlanmazsa 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ğil; başarılı olduğunda döndürülür.

HTTP Eşlemesi: 200 OK
CANCELLED

İşlem, genellikle arayan tarafından iptal edildi.

HTTP Eşleme: 499 İstemci İsteği Kapattı
UNKNOWN

Bilinmeyen hata. Örneğin, başka bir adres alanından alınan 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şlemesi: 400 Hatalı İstek
DEADLINE_EXCEEDED

İşlem tamamlanmadan önce 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ı bir yanıt, son tarihin dolmasına yetecek kadar gecikmiş olabilir.

HTTP Eşlemesi: 504 Ağ Geçidi Zaman Aşımı
NOT_FOUND

İstenen bazı öğeler (ör. dosya veya dizin) bulunamadı.

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

HTTP Eşlemesi: 404 Bulunamadı Hatası
ALREADY_EXISTS

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

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

Arayanın, belirtilen işlemi yürütme izni yok. PERMISSION_DENIED, bir kaynağın tükenmesinden kaynaklanan retler için kullanılmamalıdır (bu hatalar için RESOURCE_EXHAUSTED kullanın). Arayan tanımlanamıyorsa PERMISSION_DENIED kullanılmamalıdır (bu hatalar için UNAUTHENTICATED kullanın). Bu hata kodu, isteğin geçerli olduğu veya istenen varlığın mevcut olduğu ya da diğer ön koşulları karşıladığı anlamına gelmez.

HTTP Eşlemesi: 403 Yasak
UNAUTHENTICATED

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

HTTP Eşlemesi: 401 Yetkisiz
RESOURCE_EXHAUSTED

Bir kaynak tükenmiş olabilir. Örneğin, kullanıcı başına kota dolmuş veya dosya sisteminin tamamında yer kalmamış olabilir.

HTTP Eşlemesi: 429 Çok Fazla İstek
FAILED_PRECONDITION

Sistem, işlemin yürütülmesi için gereken durumda olmadığından işlem reddedildi. Örneğin, silinecek dizinin boş olmaması, rmdir işleminin dizin olmayan bir öğeye uygulanması 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 çağrıyı 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 sırasını 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, dizin boş olmadığı için "rmdir" başarısız olursa FAILED_PRECONDITION döndürülmelidir. Çünkü istemci, dosyalar dizinden silinmediği sürece işlemi yeniden denememelidir.

HTTP Eşlemesi: 400 Hatalı İstek
ABORTED

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

FAILED_PRECONDITION, ABORTED ve UNAVAILABLE arasında karar vermek için yukarıdaki yönergelere bakın.

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

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

INVALID_ARGUMENT hatasından farklı olarak bu hata, sistem durumu değişirse düzeltilebilecek bir sorunu gösterir. Örneğin, 32 bitlik bir dosya sistemi, [0,2^32-1] aralığında olmayan bir ofsette okuma yapması istendiğinde INVALID_ARGUMENT hatası verir ancak mevcut dosya boyutunu aşan bir ofsetten okuma yapması istendiğinde OUT_OF_RANGE hatası verir.

FAILED_PRECONDITION ve OUT_OF_RANGE arasında oldukça fazla örtüşme var. Geçerli olduğunda OUT_OF_RANGE (daha spesifik hata) kullanmanızı öneririz. Böylece, bir alanda iterasyon yapan çağrı yapanlar, işleri bittiğinde bunu algılamak için kolayca OUT_OF_RANGE hatası arayabilir.

HTTP Eşlemesi: 400 Hatalı İstek
UNIMPLEMENTED

İşlem uygulanmadı veya bu hizmette desteklenmiyor/etkinleştirilmedi.

HTTP Eşlemesi: 501 Uygulanmadı
INTERNAL

Dahili hatalar. Bu, temel sistem tarafından beklenen bazı sabitlerin 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 bekleme süresiyle yeniden denenerek düzeltilebilir. Eş kuvvetli olmayan işlemleri yeniden denemenin her zaman güvenli olmadığını unutmayın.

FAILED_PRECONDITION, ABORTED ve UNAVAILABLE arasında karar vermek için yukarıdaki yönergelere bakın.

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üne yönelik otomatik tamamlama önerileri döndürür.

JSON gösterimi 
{
  "widget": string,

  "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, bir kullanıcı işlemine yanıt olarak güncellendi. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır:
suggestions

object (SelectionItems)

Widget otomatik tamamlama sonuçlarının listesi
Birbirini hariç tutan 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 bir eğik çizgi komutu ile ilgili 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 emojiyle 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 tepkilerin toplam sayısı.

DeletionMetadata

Silinen bir mesajla ilgili bilgiler. deleteTime ayarlandığında mesajlar 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ğiyle ilgili ayrıntılar 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, alandaki herhangi bir mesajı silebilir. Buna, alan üyeleri veya Chat uygulamaları tarafından gönderilen mesajlar da dahildir.
APP_MESSAGE_EXPIRY Bir Chat uygulaması, süresi dolduğunda kendi mesajını sildi.
CREATOR_VIA_APP Bir Chat uygulaması, mesajı oluşturan kişi adına (kullanıcı kimlik doğrulamasını kullanarak) mesajı sildi.
SPACE_OWNER_VIA_APP Bir Chat uygulaması, alan yöneticisi adına mesajı sildi (kullanıcı kimlik doğrulaması kullanılarak).
SPACE_MEMBER Alandaki bir üye mesajı sildi. Kullanıcılar, uygulamalar tarafından gönderilen mesajları silebilir.

QuotedMessageMetadata

Başka bir mesajın alıntı yaptığı mesajla ilgili bilgiler.

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

Örnek kullanım için Başka bir mesajdan alıntı yapma bölümüne bakın.

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 en son güncellendiği zaman damgası.

Mesaj düzenlendiyse lastUpdateTime alanını kullanın. Mesaj hiç düzenlenmediyse createTime değerini kullanın.

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

enum (QuoteType)

İsteğe bağlı. Teklif türünü belirtir. Ayarlanmazsa geriye dönük uyumluluk için mesaj okuma/yazma yolunda varsayılan olarak REPLY 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ıyla ilgili meta veriler. Yalnızca FORWARD fiyat teklifi türü için doldurulur.

QuoteType

Alıntılanan mesajın alıntı türü.

Sıralamalar
QUOTE_TYPE_UNSPECIFIED Rezervasyon yapıldı. Bu değer kullanılmıyor.
REPLY

quoteType, REPLY olduğunda şunları yapabilirsiniz:

  • Bir mesaj dizisinde yanıt veriyorsanız o mesaj dizisindeki başka bir mesajı alıntılayabilirsiniz.

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

quoteType, FORWARD olduğunda şunlardan alıntı yapabilirsiniz:

  • Farklı bir alandan gelen mesaj.

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

QuotedMessageSnapshot

Alıntılama veya yönlendirme sırasında alıntılanan mesajın içeriğinin 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 mesajın yazarının adı. Hem YANITLA hem de YÖNLENDİR alıntı türleri için doldurulur.
text

string

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

string

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

object (Annotation)

Yalnızca çıkış. Alıntılanan mesajın 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ılanan mesajın parçası olan ekler. Bunlar, alıntılanan mesajın ek meta verilerinin kopyalarıdır. Yalnızca FORWARD teklif türü için doldurulur.

ForwardedMetadata

Mesajın 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 DM'nin 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. "Kullanıcı A"). GROUP_CHAT için bu, üyelerin adlarına göre oluşturulan bir addır ve içerik üretici dahil 5 kişiyle sınırlıdı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.

Öğeler

Öğeler, mesaj oluşturma sırasında sağlanan mesaj metniyle ilişkili olabilecek veya olmayabilecek ek bileşenlerdir.

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

object (CitedSource)

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

object (Citation)

Mesaj metninde (<chat-citation> etiketleri aracılığıyla) referans verilen ve etkileşimli bilgi kartları olarak oluşturulan satır içi alıntıların listesi.

Yöntemler

create

 Google Chat alanında mesaj oluşturur.

delete

 Mesajları siler.

get

 Bir mesajla 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

 Mesajda yer alan kartları değiştirir.
Google Chat'te, arayan kullanıcının erişebildiği mesajları arar.

update

 Mesajı günceller.