Method: spaces.messages.create

Google Chat alanında mesaj oluşturur. Örnek için Mesaj gönderme bölümüne bakın.

Aşağıdaki kimlik doğrulama türlerini destekler:

  • Uygulama kimlik doğrulaması, yetkilendirme kapsamı:
    • https://www.googleapis.com/auth/chat.bot
  • Aşağıdaki yetkilendirme kapsamlarından birini içeren kullanıcı kimlik doğrulaması:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (yalnızca içe aktarma modundaki alanlar)

Chat, isteğinizde kullandığınız kimlik doğrulama türüne bağlı olarak mesaj göndereni farklı şekilde ilişkilendirir.

Aşağıdaki resimde, uygulama kimlik doğrulamasını kullandığınızda Chat'in bir mesajı nasıl ilişkilendirdiği gösterilmektedir. Chat, mesaj gönderen olarak Chat uygulamasını gösterir. Mesajın içeriğinde metin (text), kartlar (cardsV2) ve aksesuar widget'ları (accessoryWidgets) bulunabilir.

Uygulama kimlik doğrulamasıyla gönderilen mesaj

Aşağıdaki resimde, kullanıcı kimlik doğrulaması kullandığınızda Chat'in bir mesajı nasıl ilişkilendirdiği gösterilmektedir. Chat, kullanıcıyı mesajı gönderen kişi olarak gösterir ve adını göstererek Chat uygulamasını mesajla ilişkilendirir. Mesajın içeriği yalnızca metin (text) içerebilir.

Kullanıcı kimlik doğrulamasıyla gönderilen mesaj

İleti içeriği dahil olmak üzere maksimum ileti boyutu 32.000 bayttır.

Webhook isteklerinde yanıt, mesajın tamamını içermez. Yanıtta, istekte bulunan bilgilere ek olarak yalnızca name ve thread.name alanları doldurulur.

HTTP isteği

POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
parent

string

Zorunlu. Mesajın oluşturulacağı alanın kaynak adı.

Biçim: spaces/{space}

Sorgu parametreleri

Parametreler
threadKey
(deprecated)

string

İsteğe bağlıdır. Desteği sonlandırıldı: Bunun yerine thread.thread_key kullanın. İleti dizisinin kimliği. En fazla 4.000 karakter desteklenir. Bir ileti dizisi başlatmak veya ileti dizisine ekleme yapmak için bir mesaj oluşturun ve threadKey ya da thread.name değerini belirtin. Örnek kullanım için İleti dizisi görünümü başlatma veya yanıtlama başlıklı makaleyi inceleyin.

requestId

string

İsteğe bağlıdır. Bu istek için benzersiz bir kimlik. Rastgele bir UUID önerilir. İstek kimliği belirtildiğinde istek, idempotent hale gelir. Bu sayede, aynı istek kimliğine sahip birden fazla aynı istek, yalnızca tek bir mesajın oluşturulmasını sağlar. Aynı istek kimliğine sahip sonraki istekler, mevcut mesajı döndürür ve istenen ayrıntılar mevcut durumdan farklı olsa bile mesajı güncellemez.

Bu alanı etkili bir şekilde kullanmak için:

  • Sonraki isteklerin aynı olduğundan ve orijinal istekle aynı kimlik doğrulama bilgilerini kullandığından emin olun.
  • Sağlanan istek kimliğiyle daha önce bir mesaj oluşturulmuşsa istek bu mesajı döndürür. Döndürülen mesajın tam olarak doldurulmayabileceğini unutmayın. API, isteğinizdeki mesajı sistem tarafından atanan kaynak adları doldurulmuş şekilde yansıtır. Mesajın en son meta verilerini almak için messages.get yöntemini çağırın.
  • Mevcut bir istek kimliğinin farklı bir kimliği doğrulanmış kullanıcıyla yeniden kullanılması hataya neden olur.
messageReplyOption

enum (MessageReplyOption)

İsteğe bağlıdır. Bir mesajın yeni bir mesaj dizisi mi başlattığını yoksa mevcut bir mesaj dizisini mi yanıtladığını belirtir. Yalnızca adlandırılmış alanlarda desteklenir.

Kullanıcı etkileşimlerine yanıt verirken bu alan yok sayılır. Bir mesaj dizisindeki etkileşimler için yanıt aynı mesaj dizisinde oluşturulur. Aksi takdirde yanıt, yeni bir mesaj dizisi olarak oluşturulur.

messageId

string

İsteğe bağlıdır. Mesaj için özel kimlik. Chat uygulamalarının, sistem tarafından atanan kimliği mesajın kaynak adında (mesaj name alanında gösterilir) depolamasına gerek kalmadan mesaj almasına, güncellemesine veya silmesine olanak tanır.

Bu alanın değeri aşağıdaki şartları karşılamalıdır:

  • client- ile başlar. Örneğin, client-custom-name geçerli bir özel kimliktir ancak custom-name geçerli değildir.
  • En fazla 63 karakterden oluşur ve yalnızca küçük harf, rakam ve kısa çizgi içerir.
  • Bir alanda benzersizdir. Chat uygulamaları, farklı mesajlar için aynı özel kimliği kullanamaz.

Ayrıntılar için Mesajlara ad verme başlıklı makaleyi inceleyin.

createMessageNotificationOptions

object (CreateMessageNotificationOptions)

İsteğe bağlıdır. Mesaj yayınlandığında bildirim davranışını kontrol eder. Daha fazla bilgi için Bildirimleri zorunlu kılma veya sessiz mesaj gönderme başlıklı makaleyi inceleyin.

İstek metni

İstek metni, Message öğesinin bir örneğini içerir.

Yanıt metni

Başarılıysa yanıt metni, yeni oluşturulan bir Message örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.

MessageReplyOption

Mesajların nasıl yanıtlanacağını belirtir. Gelecekte daha fazla eyalet eklenebilir.

Sıralamalar
MESSAGE_REPLY_OPTION_UNSPECIFIED Varsayılan. Yeni bir ileti dizisi başlatır. Bu seçenek kullanıldığında, dahil edilen thread ID veya threadKey yoksayılır.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD İletiyi, thread ID veya threadKey tarafından belirtilen ileti dizisine yanıt olarak oluşturur. Bu işlem başarısız olursa mesaj yeni bir ileti dizisi başlatır.
REPLY_MESSAGE_OR_FAIL İletiyi, thread ID veya threadKey tarafından belirtilen ileti dizisine yanıt olarak oluşturur. Yeni bir threadKey kullanılırsa yeni bir ileti dizisi oluşturulur. Mesaj oluşturma işlemi başarısız olursa bunun yerine NOT_FOUND hatası döndürülür.

CreateMessageNotificationOptions

Mesaj yayınlandığında bildirim davranışıyla ilgili seçenekler.

JSON gösterimi
{
  "notificationType": enum (NotificationType)
}
Alanlar
notificationType

enum (NotificationType)

Mesajın bildirim türü.

NotificationType

Mesajın bildirim türü seçenekleri.

Sıralamalar
NOTIFICATION_TYPE_NONE Varsayılan davranış. Bildirim davranışı, gerçek kullanıcının Chat kullanıcı arayüzünü kullanarak mesaj göndermesine benzer: Gerçek gönderene bildirim gönderilmez.
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR

Mesajı oluşturan kullanıcıya (ör. mesajı oluşturmak için kimlik doğrulaması kullanılan kullanıcı) bir bildirim (push bildirimleri, e-posta bildirimleri vb.) gönderilir ve mesaj okunmamış olarak işaretlenir.

Bu işlem, alan için mevcut kullanıcı bildirimi ayarlarını geçersiz kılmaz. Örneğin, kullanıcı bir alan için bildirim almamayı seçtiyse bu seçenek ayarlanmış olsa bile bildirim almaz.

Kullanıcı kimlik doğrulaması gerektirir.

NOTIFICATION_TYPE_FORCE_NOTIFY

Alıcılara zorunlu bildirim gönderilir. Bu işlem, kullanıcıların alan bildirim ayarlarını ve Chat Rahatsız Etmeyin ayarlarını geçersiz kılar. Bu seçenek, cihaz düzeyindeki Rahatsız Etmeyin ayarlarını atlamaz.

Uygulama kimlik doğrulaması gerektirir.

NOTIFICATION_TYPE_SILENT

Alıcılara bildirim göndermeyin ve iletiyi okunmadı olarak işaretlemeyin. Bu, kullanıcının görüşmeyi sessize almasına veya Chat'te Rahatsız Etmeyin özelliğini etkinleştirmesine benzer şekilde çalışır.

Uygulama kimlik doğrulaması gerektirir.