Event Stream veri referansı

Liquid sözdizimi kullanarak event stream verilerine erişin. Herhangi bir alanı Event Stream gövdesine dahil etmek için {{ }} içine sarın. Örneklere bakın.

Journey’ler ve API gönderimleri için mesaj verileri 30 gün boyunca saklanır. 30 günden sonra gerçekleşen etkileşim olayları (tıklamalar, açılmalar, abonelik iptalleri) boş mesaj özelliklerine sahip olabilir. Verileri kurtarmak için etkileşim olayındaki message.id’yi tam mesaj verilerini içeren orijinal sent olayıyla ilişkilendirin.

`event` özellikleri

Her olay aşağıdaki temel alanları içerir. event.data.* altındaki kanala özgü alanlar yalnızca uygulanabilir olduğunda eklenir — Kanala özgü alanlar bölümüne bakın.

string

Kanal ve eylemi birleştiren olay türü (örn. message.push.clicked, message.email.bounced). Değerlerin tam listesi için aşağıdaki olay türü referansı bölümüne bakın. Liquid: {{ event.kind }}

UUID

UUID v4 formatında her bir olay için OneSignal tarafından oluşturulan benzersiz tanımlayıcı. Bu ID’yi idempotent teslimat takibi için kullanın. Mesaj veya şablon tanımlayıcısı için message.id veya message.template_id kullanın. Liquid: {{ event.id }}

integer

Olayın UNIX zaman damgası. Liquid: {{ event.timestamp }}

string

ISO 8601 dizesi olarak UTC’de olayın okunabilir zamanı (örn. “2024-02-21T23:45:15.228Z”). Liquid: {{ event.datetime }}

UUID

OneSignal App ID. Liquid: {{ event.app_id }}

string

Abonelik türü (örn. iOS, Android, Chrome, Email, SMS). Liquid: {{ event.subscription_device_type }}

UUID

OneSignal Subscription ID. Liquid: {{ event.subscription_id }}

UUID

OneSignal User ID. Liquid: {{ event.onesignal_id }}

string

OneSignal External ID takma adı olarak ayarlanan Kullanıcı ID’niz. Ayarlanmamışsa boş olabilir. Liquid: {{ event.external_id }}

Kanala özgü alanlar

Bu event.data.* alanları yalnızca belirli olay türleri için mevcuttur.

Uygulama içi mesaj olayları

message.iam.* olaylarıyla eklenir. Ayrıntılar için Uygulama içi mesaj Event Streams bölümüne bakın.

string

Görüntülenen uygulama içi mesaj sayfasının veya kartının adı. Liquid: {{ event.data.page_name }}

string

Görüntülenen uygulama içi mesaj sayfası veya kartı için benzersiz tanımlayıcı. Liquid: {{ event.data.page_id }}

string

Tıklanan düğme veya görüntü blok öğesinin adı. Öğe bir uygulama içi tıklama eylemi içermelidir. Liquid: {{ event.data.target_name }}

string

Tıklanan düğme veya görüntü blok öğesi için benzersiz tanımlayıcı. Liquid: {{ event.data.target_id }}

Live Activity olayları

message.live_activity.* olaylarıyla eklenir.

string

Belirli bir Live Activity için benzersiz tanımlayıcı (örn. “Knicks vs Cavs - Oct 22 7PM”). Liquid: {{ event.data.live_activity_id }}

string

Live Activity kategorileri için gruplama etiketi (örn. “Knicks_games”). Liquid: {{ event.data.live_activity_type }}

Başarısız olaylar

message.push.failed ve message.email.failed olaylarıyla eklenir.

string

Mesajın gönderilememe nedeni. Yaygın nedenler için Push Mesaj Raporları veya E-posta Mesaj Raporları bölümüne bakın. Liquid: {{ event.data.failure_reason }}

Olay türü referansı

Her metriğin ayrıntılı tanımları için Metrik Sözlüğü bölümüne bakın.

Mesaj Olay Türü (OneSignal)	Olay adı (veri setinde)	Olay Açıklaması
Push Gönderildi	`message.push.sent`	Push bildirimi push hizmetlerine (FCM, APNS, vb.) başarıyla gönderildi.
Push Alındı	`message.push.received`	Push bildirimi alıcı tarafından alındı. Tüm platformlarda mevcut değildir. Daha fazla ayrıntı için Onaylanmış Teslimat bölümüne bakın.
Push Tıklandı	`message.push.clicked`	Kullanıcı cihazda uygulamayı açmak için push bildirimine dokundu.
Push Başarısız	`message.push.failed`	Push gönderilemedi. Ayrıntılar için Push Mesaj Raporları bölümüne bakın.
Push Abonelikten Çıkıldı	`message.push.unsubscribed`	Kullanıcı push aboneliğinden çıktı. Push abonelik durumları ne zaman güncellenir? bölümüne bakın.
Uygulama İçi Gösterim	`message.iam.impression`	Uygulama İçi Mesaj cihazda başarıyla görüntülendi.
Uygulama İçi Tıklandı	`message.iam.clicked`	Kullanıcı Uygulama İçi Mesaj’daki bir öğeye dokundu.
Uygulama İçi Sayfa Görüntülendi	`message.iam.page_displayed`	Uygulama İçi Mesaj sayfası görüntülendi. Karusel takibi için yararlıdır.
E-posta Gönderildi	`message.email.sent`	E-posta başarıyla gönderildi.
E-posta Alındı	`message.email.received`	E-posta alıcı tarafından alındı.
E-posta Açıldı	`message.email.opened`	E-posta alıcı tarafından açıldı. Ayrıntılar için E-posta Mesaj Raporları bölümüne bakın.
E-posta Bağlantısı Tıklandı	`message.email.clicked`	Kullanıcı e-postadaki bir bağlantıya dokundu.
E-postadan Abonelik İptal Edildi	`message.email.unsubscribed`	Kullanıcı abonelikten çıkma bağlantısı aracılığıyla e-postadan aboneliğini iptal etti.
E-posta Spam Olarak Bildirildi	`message.email.reported_as_spam`	Kullanıcı e-postayı spam olarak bildirdi. Gmail izlemek için Google Postmaster Tools gerektirir. Daha fazla ayrıntı için E-posta teslim edilebilirliği bölümüne bakın.
E-posta Geri Döndü	`message.email.bounced`	E-posta kalıcı hata nedeniyle gönderene döndü. Ayrıntılar için E-posta Mesaj Raporları bölümüne bakın.
E-posta Başarısız	`message.email.failed`	E-posta teslim edilemedi. Ayrıntılar için E-posta Mesaj Raporları bölümüne bakın.
E-posta Bastırıldı	`message.email.suppressed`	E-posta adresi Bastırma listesinde olduğu için e-posta gönderilemedi.
SMS Gönderildi	`message.sms.sent`	SMS alıcıya gönderildi.
SMS Başarısız	`message.sms.failed`	SMS gönderilemedi. Ayrıntılar için SMS Mesaj Raporları bölümüne bakın.
SMS Teslim Edildi	`message.sms.delivered`	SMS başarıyla teslim edildi.
SMS Teslim Edilemedi	`message.sms.undelivered`	SMS gönderilemedi. Ayrıntılar için SMS Mesaj Raporları bölümüne bakın.
Live Activity Gönderildi	`message.live_activity.sent`	Live Activity FCM/APNS’ye başarıyla gönderildi.
Live Activity Teslim Edildi	`message.live_activity.delivered`	Live Activity alıcı tarafından alındı.
Live Activity Abonelik İptali	`message.live_activity.unsubscribed`	Kullanıcı Live Activities aboneliğini iptal etti.
Live Activity Başarısız	`message.live_activity.failed`	Live Activity gönderilemedi.
Live Activity Tıklandı	`message.live_activity.clicked`	Live Activity kullanıcı tarafından tıklandı.

Örnek olay nesnesi

Tüm olay alanlarını yakalamak için bu Liquid şablonunu Event Stream gövdenize kopyalayın:

JSON

{
  "event.kind": "{{ event.kind }}",
  "event.id": "{{ event.id }}",
  "event.timestamp": "{{ event.timestamp }}",
  "event.datetime": "{{ event.datetime }}",
  "event.app_id": "{{ event.app_id }}",
  "event.subscription_device_type": "{{ event.subscription_device_type }}",
  "event.subscription_id": "{{ event.subscription_id }}",
  "event.onesignal_id": "{{ event.onesignal_id }}",
  "event.external_id": "{{ event.external_id }}",
  "event.data.page_name": "{{ event.data.page_name }}",
  "event.data.page_id": "{{ event.data.page_id }}",
  "event.data.target_name": "{{ event.data.target_name }}",
  "event.data.target_id": "{{ event.data.target_id }}",
  "event.data.failure_reason": "{{ event.data.failure_reason }}"
}

Örnek oluşturulmuş çıktı

Liquid oluşturma sonrası bir push tıklama olayının görünümü:

JSON

{
  "event.kind": "message.push.clicked",
  "event.id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "event.timestamp": 1708559115,
  "event.datetime": "2024-02-21T23:45:15.228Z",
  "event.app_id": "your-onesignal-app-id",
  "event.subscription_device_type": "iOS",
  "event.subscription_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "event.onesignal_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "event.external_id": "user_12345",
  "event.data.page_name": "",
  "event.data.page_id": "",
  "event.data.target_name": "",
  "event.data.target_id": "",
  "event.data.failure_reason": ""
}

event.data.page_name gibi kanala özgü alanlar, bunları içermeyen olay türleri için boştur.

`message` özellikleri

message nesnesi, son kullanıcıya gönderilen mesajı (ID, şablon, içerik ve URL’ler dahil) açıklar.

UUID

OneSignal tarafından oluşturulan mesaj ID’si. Liquid: {{ message.id }}

string

Gösterge panosunda veya API name özelliği kullanılarak ayarlanan mesajın adı. Liquid: {{ message.name }}

object

Push mesajı başlığı veya e-posta konusu. Push için {'en':'Your title'} gibi yerelleştirilmiş bir nesne döndürür. E-posta için konu satırını düz dize olarak döndürür. Gösterge panosu veya API headings / email_subject özellikleriyle ayarlanır. Liquid: {{ message.title }}

object

Push veya SMS mesaj içeriği (50 karakterde kesilir). E-posta içerikleri (email_body) sağlanmaz. Gösterge panosu veya API contents özelliğiyle ayarlanır. Liquid: {{ message.contents }}

UUID

Journey’ler veya API template_id özelliği aracılığıyla gönderilen bir mesaj için şablon ID’si. Liquid: {{ message.template_id }}

string

Web ve uygulama bağımsız tek bir URL kullanırken mesajın başlatma URL’si. Bkz. URL’ler, Bağlantılar ve Derin Bağlantılar. Liquid: {{ message.url }}

string

Ayrı web ve uygulama URL’leri kullanırken uygulamaya özgü başlatma URL’si. Bkz. URL’ler, Bağlantılar ve Derin Bağlantılar. Liquid: {{ message.app_url }}

string

Ayrı web ve uygulama URL’leri kullanırken web’e özgü başlatma URL’si. Bkz. URL’ler, Bağlantılar ve Derin Bağlantılar. Liquid: {{ message.web_url }}

string

Live Activity eylem türü: start, update veya end. Yalnızca message.live_activity.* olayları için mevcuttur. Liquid: {{ message.live_activity_event_kind }}

Örnek mesaj nesnesi

Tüm mesaj alanlarını yakalamak için bu Liquid şablonunu Event Stream gövdenize kopyalayın:

JSON

{
  "message.id": "{{ message.id }}",
  "message.name": "{{ message.name }}",
  "message.title": "{{ message.title }}",
  "message.contents": "{{ message.contents }}",
  "message.template_id": "{{ message.template_id }}",
  "message.url": "{{ message.url }}",
  "message.app_url": "{{ message.app_url }}",
  "message.web_url": "{{ message.web_url }}"
}

Örnek oluşturulmuş çıktı

Bir push bildirimi mesajı:

JSON

{
  "message.id": "f3c9cd09-10d7-4f59-b9bc-66e16607f1d5",
  "message.name": "weekly-promo-push",
  "message.title": "{'en':'Flash Sale: 50% Off Today'}",
  "message.contents": "{'en':'Shop now and save on select items'}",
  "message.template_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message.url": "https://example.com/sale",
  "message.app_url": "",
  "message.web_url": ""
}

Bir e-posta mesajı — message.title konu satırının düz dizesidir ve message.contents e-posta gövdesi içeriği Event Stream verilerine dahil edilmediğinden boştur:

JSON

{
  "message.id": "e2d3c4b5-a6f7-8901-bcde-f12345678901",
  "message.name": "onboarding-welcome-email",
  "message.title": "Welcome to Acme — here's how to get started",
  "message.contents": "",
  "message.template_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "message.url": "",
  "message.app_url": "",
  "message.web_url": ""
}

`user` özellikleri

user nesnesi, mesajı alan kullanıcıya ait profil düzeyindeki verileri içerir.

string

Kullanıcının OneSignal ID’si. Liquid: {{ user.onesignal_id }}

string

Kullanıcının External ID’si. Liquid: {{ user.external_id }}

object

Kullanıcının etiketleri. Tüm nesneye {{ user.tags }} ile veya belirli bir etikete {{ user.tags.your_tag }} ile erişin. Eksik etiketleri işlemek için varsayılan değer kullanın: {{ user.tags.your_tag | default: '' }}.

string

Kullanıcının dil kodu. Liquid: {{ user.language }}

`subscription` özellikleri

Bu özellikler mesajı alan aboneliği açıklar.

string

Aboneliğin OneSignal ID’si. Liquid: {{ user.subscription.id }}

string

OneSignal App ID. Liquid: {{ user.subscription.app_id }}

string

Aboneliğin platforma özgü tokeni. E-posta için e-posta adresi. SMS için E.164 formatında telefon numarası. Push için push token. Liquid: {{ user.subscription.subscription_token }}

number

Bu abonelik için kaydedilen toplam oturum sayısı. Liquid: {{ user.subscription.session_count }}

string

Abonelikte ayarlanan dil kodu. Liquid: {{ user.subscription.language }}

string

Abonelik tarafından bildirilen uygulama veya oyun sürümü. Liquid: {{ user.subscription.game_version }}

number

Aboneliğin en son oturumunun UNIX zaman damgası. Liquid: {{ user.subscription.last_active }}

number

Bu abonelik için kaydedilen toplam oyun süresi (saniye cinsinden). Liquid: {{ user.subscription.play_time }}

number

Bu abonelik için kaydedilen toplam uygulama içi satın alma tutarı. Liquid: {{ user.subscription.amount_spent }}

number

Aboneliğin oluşturulduğu zamanın UNIX zaman damgası. Liquid: {{ user.subscription.created_at }}

boolean

Aboneliğin şu anda etkin olup olmadığı. Liquid: {{ user.subscription.subscribed }}

string

Aboneliğin cihazındaki OneSignal SDK sürümü. Liquid: {{ user.subscription.sdk }}

string

Cihaz donanım modeli (örn. “iPhone14,2”, “Pixel 7”). Liquid: {{ user.subscription.device_model }}

string

Cihaz işletim sistemi ve sürümü (örn. “iOS 17.2”, “Android 14”). Liquid: {{ user.subscription.device_os }}

İlgili sayfalar

Event Streams

Kurulum, gövde şablonları ve hata ayıklama dahil Event Streams’i kurun ve yapılandırın.

Liquid sözdizimi kullanımı

Event Stream gövdelerini kişiselleştirmek için kullanılan Liquid sözdizimi referansı.

Uygulama içi mesaj Event Streams

Uygulama içi mesaj olay verileri ve karusel takibi hakkında ayrıntılar.

Metrik Sözlüğü

Kanallar genelinde tüm mesaj olay metriklerinin tanımları.

SSS

Neden bazı olay verileri eksik veya boş?

Journey’ler ve API gönderimleri için mesaj verileri 30 gün boyunca saklanır. Bir kullanıcı mesaj gönderildikten 30 günden fazla sonra etkileşimde bulunursa (tıklama, açma, abonelik iptali), ilgili mesaj özellikleri boş olabilir. Bunu çözmek için etkileşim olayındaki message.id’yi tam mesaj verilerini içeren orijinal sent olayıyla ilişkilendirin.

`event.id` ile `message.id` arasındaki fark nedir?

event.id bireysel olay için benzersiz bir tanımlayıcıdır (örn. belirli bir tıklama). message.id gönderilen mesajın tanımlayıcısıdır — birden fazla olay aynı message.id’yi paylaşabilir (örneğin, aynı push bildirimi için bir sent olayı ve bir clicked olayı).

Push ve e-posta için `message.title` formatı nedir?

Push bildirimleri için message.title, {'en':'Your title'} gibi yerelleştirilmiş bir nesne döndürür. E-posta için konu satırını düz dize olarak döndürür. Format kanala göre değişir.

Özel Olaylar Event Streams’e dahil midir?

Hayır. Event Streams mesaj olaylarını (gönderildi, tıklandı, açıldı, geri döndü vb.) içerir — Özel Olayları değil. Özel Olaylar, OneSignal’a gönderdiğiniz kullanıcı eylemleridir. Event Streams, mesaj teslimi ve etkileşim verilerini OneSignal’dan dışa aktarır.

Event Stream gövdemde belirli bir etikete nasıl başvurabilirim?

Tam etiket anahtarıyla {{ user.tags.your_tag_key }} kullanın. Bir etiket ayarlanmadığında hataları önlemek için varsayılan değer ekleyin: {{ user.tags.your_tag_key | default: '' }}. Daha fazla ayrıntı için Liquid sözdizimi kullanımı bölümüne bakın.

İlk adımlar & ayarlar

Mesaj kanalları

Journey'ler

Hedeflenen & özel olaylar

Analitik ve Entegrasyonlar

Gizlilik & Güvenlik

Event Stream veri referansı

`event` özellikleri

Kanala özgü alanlar

Uygulama içi mesaj olayları

Live Activity olayları

Başarısız olaylar

Olay türü referansı

Örnek olay nesnesi

`message` özellikleri

Örnek mesaj nesnesi

`user` özellikleri

`subscription` özellikleri

İlgili sayfalar

Event Streams

Liquid sözdizimi kullanımı

Uygulama içi mesaj Event Streams

Metrik Sözlüğü

SSS

Neden bazı olay verileri eksik veya boş?

`event.id` ile `message.id` arasındaki fark nedir?

Push ve e-posta için `message.title` formatı nedir?

Özel Olaylar Event Streams’e dahil midir?

Event Stream gövdemde belirli bir etikete nasıl başvurabilirim?

​event özellikleri

​Kanala özgü alanlar

​Uygulama içi mesaj olayları

​Live Activity olayları

​Başarısız olaylar

​Olay türü referansı

​Örnek olay nesnesi

​message özellikleri

​Örnek mesaj nesnesi

​user özellikleri

​subscription özellikleri

​İlgili sayfalar

Event Streams

Liquid sözdizimi kullanımı

Uygulama içi mesaj Event Streams

Metrik Sözlüğü

​SSS

​Neden bazı olay verileri eksik veya boş?

​event.id ile message.id arasındaki fark nedir?

​Push ve e-posta için message.title formatı nedir?

​Özel Olaylar Event Streams’e dahil midir?

​Event Stream gövdemde belirli bir etikete nasıl başvurabilirim?

`event` özellikleri

Kanala özgü alanlar

Uygulama içi mesaj olayları

Live Activity olayları

Başarısız olaylar

Olay türü referansı

Örnek olay nesnesi

`message` özellikleri

Örnek mesaj nesnesi

`user` özellikleri

`subscription` özellikleri

İlgili sayfalar

SSS

Neden bazı olay verileri eksik veya boş?

`event.id` ile `message.id` arasındaki fark nedir?

Push ve e-posta için `message.title` formatı nedir?

Özel Olaylar Event Streams’e dahil midir?

Event Stream gövdemde belirli bir etikete nasıl başvurabilirim?