Web SDK referansı

​

Kurulum ve hata ayıklama

​

init()

window.OneSignalDeferred = window.OneSignalDeferred || [];
OneSignalDeferred.push(async function(OneSignal) {
  await OneSignal.init({
    appId: "ONESIGNAL_APP_ID",
  });
});

​

promptOptions parametreleri

​

notifyButton parametreleri

​

welcomeNotification parametreleri

<script src="https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.page.js" defer></script>
<script>
window.OneSignalDeferred = window.OneSignalDeferred || [];
OneSignalDeferred.push(async function(OneSignal) {
  await OneSignal.init({
    appId: "YOUR_APP_ID",
    notifyButton: {
      enable: true,
    },
    promptOptions: {
      slidedown: {
        prompts: [{
            type: "smsAndEmail",
            autoPrompt: false,
            text: {
              emailLabel: "Insert Email Address",
              smsLabel: "Insert Phone Number",
              acceptButton: "Submit",
              cancelButton: "No Thanks",
              actionMessage: "Receive the latest news, updates and offers as they happen.",
              updateMessage: "Update your push notification subscription preferences.",
              confirmMessage: "Thank You!",
              positiveUpdateButton: "Save Preferences",
              negativeUpdateButton: "Cancel",
            },
            delay: {
              pageViews: 1,
              timeDelay: 20
            },
          },
          {
            type: "category",
            autoPrompt: true,
            text: {
              actionMessage: "We'd like to show you notifications for the latest news and updates.",
              acceptButton: "Allow",
              cancelButton: "Cancel",

              /* CATEGORY SLIDEDOWN SPECIFIC TEXT */
              negativeUpdateButton: "Cancel",
              positiveUpdateButton: "Save Preferences",
              updateMessage: "Update your push notification subscription preferences.",
            },
            delay: {
              pageViews: 3,
              timeDelay: 20
            },
            categories: [{
                tag: "politics",
                label: "Politics"
              },
              {
                tag: "local_news",
                label: "Local News"
              },
              {
                tag: "world_news",
                label: "World News",
              },
              {
                tag: "culture",
                label: "Culture"
              },
            ]
          }
        ]
      }
    }
  });
});
</script>

​

setLogLevel()

  OneSignal.Debug.setLogLevel("trace");

• 'trace'
• 'debug'
• 'info'
• 'warn'
• 'error'

​

Kullanıcı kimliği ve özellikleri

​

login(external_id)

• SDK, o mevcut kullanıcıya geçer.
  • Tarayıcı ağ günlüğünde veya konsolunda bir 409 Conflict görebilirsiniz. Bu, External ID’nin uygulamada zaten var olduğu anlamına gelir; bu yolda beklenen bir durumdur ve genellikle ele almanız gereken bir promise reddi değildir.
• Mevcut onesignal_id atılır ve o kullanıcıya ait mevcut onesignal_id yüklenir.
• Mevcut cihaz (web push Aboneliği), mevcut kullanıcıya bağlanır.
• Giriş öncesi toplanan anonim veriler birleştirilmez ve atılır. Buna etiketler, oturum verileri, e-posta/SMS Abonelikleri ve diğer yerel kullanıcı özellikleri dahildir.

• Mevcut onesignal_id kullanılarak yeni bir kullanıcı oluşturulur.
• Kullanıcı anonimken toplanan tüm veriler saklanır.
• Cihaz (web push Aboneliği), bu yeni kullanıcıya bağlanır.

• SDK, ağ hataları veya sunucu hatalarında login isteğini otomatik olarak yeniden dener.
• Kendi yeniden deneme mantığınızı uygulamanıza gerek yoktur.

• Kullanıcının ID’sini öğrendiğinizde (örneğin, oturum açtıktan veya oturum geri yüklendikten sonra) login(external_id)’yi her sayfa yüklemesinde çağırın.
• Oturum açmış kullanıcı her değiştiğinde (hesap değişimi) tekrar çağırın.
• Sabit, bilinen bir kullanıcı tanımlayıcınız olmadan login çağırmayın.

OneSignalDeferred.push(async function(OneSignal) {
  await OneSignal.login("external_id");
});

​

logout()

• Mevcut web push Aboneliğinden external_id’yi kaldırır. external_id’yi diğer Aboneliklerden kaldırmaz.
• onesignal_id’yi yeni bir anonim kullanıcıya sıfırlar.
• Yeni veriler (örneğin etiketler, Abonelikler, oturum verileri vb.), login yöntemiyle tanımlanana kadar artık yeni anonim kullanıcı üzerinde ayarlanır.

OneSignalDeferred.push(async function(OneSignal) {
  await OneSignal.logout();
});

​

OneSignal.User.onesignalId

• OneSignal SDK başlatmayı tamamladıktan sonra
• Bir kullanıcı login(external_id) ile tanımlandıktan sonra
• Kullanıcı değiştirdikten veya bir oturumu geri yükledikten sonra

• Bir External ID ayarlanmadan önce anonim kullanıcıları takip etme
• Destek veya hata ayıklama için OneSignal ID’yi backend’inizde saklama
• OneSignal kullanıcılarını dahili loglarla ilişkilendirme
• Sorun giderme veya QA için ID’yi görüntüleme

const onesignalId = OneSignal.User.onesignalId;

​

OneSignal.User.externalId

  const externalId = OneSignal.User.externalId;

​

addEventListener() Kullanıcı Durumu

  OneSignalDeferred.push(function(OneSignal) {
    OneSignal.User.addEventListener('change', function (event) {
      console.log('change', { event });
    });
  });

​

addAlias(), addAliases(), removeAlias(), removeAliases()

• Takma ad eklemeden önce login() ile external_id ayarlayın. external_id olmadan aboneliklere eklenen takma adlar birden fazla abonelik arasında senkronize olmaz.
• Ayrıntılar için Takma Adlar’a bakın.

  // Tek bir takma ad ekle
  OneSignal.User.addAlias("ALIAS_LABEL", "ALIAS_ID");

  // Birden fazla takma ad ekle
  OneSignal.User.addAliases({
    ALIAS_LABEL_01: "ALIAS_ID_01",
    ALIAS_LABEL_02: "ALIAS_ID_02",
    ALIAS_LABEL_03: "ALIAS_ID_03",
  });

  // Tek bir takma adı kaldır
  OneSignal.User.removeAlias("ALIAS_LABEL");

  // Birden fazla takma adı kaldır
  OneSignal.User.removeAliases(["ALIAS_LABEL_01", "ALIAS_LABEL_02", "ALIAS_LABEL_03"]);

​

getLanguage(), setLanguage()

  // Şu anda giriş yapmış kullanıcının dilini al
  OneSignal.User.getLanguage();

  // Şu anda giriş yapmış kullanıcının dilini ayarla
  OneSignal.User.setLanguage("en");

​

Özel olaylar

• name - Gerekli. Dize olarak olayın adı.
• properties - İsteğe bağlı. Olaya eklenecek anahtar-değer çiftleri. Properties sözlüğü veya haritası geçerli bir JSON Nesnesine serileştirilebilir olmalıdır. İç içe değerleri destekler.

{ 
  "os_sdk": {
    "device_os": "138",
    "type": "ChromePush",
    "device_model": "MacIntel",
    "sdk": "160500"
  }
}

​

trackEvent()

OneSignalDeferred.push(async function (OneSignal) {
  await OneSignal.init({ appId: "ONESIGNAL_APP_ID" });

  const properties = {
    promo_code: "NEW50",
    membership_details: {
      vip: true,
      products_viewed_count: 15,
    },
  };
  OneSignal.User.trackEvent("started_free_trial", properties);

  // Yalnızca olay adı (properties olmadan)
  OneSignal.User.trackEvent("my_event_name");
});

​

Etiketler

​

addTag(), addTags()

• Anahtar zaten varsa değerler değiştirilir.
• Planınızın etiket limitini aşmak, işlemlerin sessizce başarısız olmasına neden olur.

  // Tek bir etiket ekle
  OneSignal.User.addTag('tag_key', 'tag_value');

  // Birden fazla etiket ekle
  OneSignal.User.addTags({
   KEY_01: "VALUE_01",
   KEY_02: "VALUE_02",
   KEY_03: "VALUE_03"
  });

​

removeTag(), removeTags()

  // Tek bir etiketi sil
  OneSignal.User.removeTag("KEY");

  OneSignal.User.removeTags(['KEY_01', 'KEY_02', 'KEY_03']);

​

getTags()

  const tags = OneSignal.User.getTags()

​

Gizlilik

​

setConsentRequired()

  OneSignal.setConsentRequired(true);

​

setConsentGiven()

• setConsentRequired() veya requiresUserPrivacyConsent true olarak ayarlanırsa, SDK’mız setConsentGiven true ile çağrılana kadar tamamen etkinleştirilmez.
• setConsentGiven true olarak ayarlanır ve bir Abonelik oluşturulursa, daha sonra false olarak ayarlanırsa, o Abonelik artık güncelleme almaz. O Abonelik için mevcut veriler, setConsentGiven tekrar true olarak ayarlanana kadar değişmeden kalır.
• Kullanıcı ve/veya Abonelik verilerini silmek istiyorsanız, Kullanıcıyı sil veya Aboneliği sil API’lerimizi kullanın.

  OneSignal.setConsentGiven(true);

​

Abonelikler

​

User.PushSubscription.id

  const subscription_id = OneSignal.User.PushSubscription.id;

​

User.PushSubscription.token

  OneSignal.User.PushSubscription.token;

​

addEventListener() Push Abonelik Değişiklikleri

• Cihaz Google (FCM) veya Apple (APNs)‘tan yeni bir push token alır
• OneSignal bir abonelik ID’si atar
• optedIn değeri değişir (örneğin optIn() veya optOut() çağrıldı)
• Kullanıcı tarayıcı veya işletim sistemi ayarlarında push iznini değiştirir, ardından sitenize geri döner

  function pushSubscriptionChangeListener(event) {
    console.log("event.previous.id", event.previous.id);
    console.log("event.current.id", event.current.id);
    console.log("event.previous.token", event.previous.token);
    console.log("event.current.token", event.current.token);
    console.log("event.previous.optedIn", event.previous.optedIn);
    console.log("event.current.optedIn", event.current.optedIn);
  }

  OneSignalDeferred.push(function(OneSignal) {
    OneSignal.User.PushSubscription.addEventListener("change", pushSubscriptionChangeListener);
  });

  function pushSubscriptionChangeListener(event) {
    if (!event.current.token || event.previous.token) {
      return;
    }
    window.dataLayer = window.dataLayer || [];
    window.dataLayer.push({
      event: "onesignal_push_subscribed",
      onesignal_subscription_id: event.current.id,
    });
  }

  OneSignalDeferred.push(function(OneSignal) {
    OneSignal.User.PushSubscription.addEventListener("change", pushSubscriptionChangeListener);
  });

​

optOut(), optIn(), optedIn

• optOut(): Mevcut push abonelik durumunu abonelikten çıkarılmış olarak ayarlar (kullanıcının geçerli bir push token’ı olsa bile).
• optIn(): Şunlardan birini yapar:
  1. Aboneliğin geçerli bir push token’ı varsa, mevcut push abonelik durumunu subscribed olarak ayarlar.
  2. Aboneliğin geçerli bir push token’ı yoksa, push izin istemini görüntülemeye çalışır.
• optedIn: Mevcut push abonelik durumu abone ise true, aksi takdirde false döndürür. Push token geçerliyse ancak optOut() çağrıldıysa, bu false döndürür.

  OneSignal.User.PushSubscription.optOut();

  OneSignal.User.PushSubscription.optIn();

  var optedIn = OneSignal.User.PushSubscription.optedIn;

​

addEmail(), removeEmail()

• E-posta adresi, mevcut kullanıcı için bir e-posta Aboneliği haline gelir.
• E-posta oluşturulabilir veya yeniden atanabilir.
• Aynı e-posta adresi, aynı OneSignal uygulamasında birden fazla kez var olamaz. Yinelenen e-posta adresleri görüyorsanız, REST API isteklerinizi kontrol edin ve gerekirse destekle iletişime geçin.

• E-posta Aboneliği, mevcut kullanıcıdan kaldırılır.
• Mevcut External ID, e-posta Aboneliğinden kaldırılır.
• E-posta Aboneliğine yeni bir OneSignal ID atanır.
• Diğer Abonelikler (push, SMS, diğer e-postalar) etkilenmez.

• Önce login() çağırın, sonra addEmail() çağırın. Aksi takdirde, e-posta anonim bir kullanıcıya bağlanabilir.
• Sabit, doğrulanmış bir e-posta adresi kullanın.
• E-posta itibarı en iyi uygulamalarını takip edin.

  OneSignal.User.addEmail("example@email.com");

  OneSignal.User.removeEmail("example@email.com");

​

addSms(), removeSms()

• Telefon numarası, mevcut kullanıcı için bir SMS Aboneliği haline gelir.
• Numara oluşturulabilir veya yeniden atanabilir.
• Aynı telefon numarası, aynı OneSignal uygulamasında birden fazla kez var olamaz. Yinelenen telefon numaraları görüyorsanız, REST API isteklerinizi kontrol edin ve gerekirse destekle iletişime geçin.

• SMS Aboneliği, mevcut kullanıcıdan kaldırılır.
• Mevcut External ID, SMS Aboneliğinden kaldırılır.
• SMS Aboneliğine yeni bir OneSignal ID atanır.
• Diğer Abonelikler (push, e-posta, diğer SMS’ler) etkilenmez.

• Önce login() çağırın, sonra addSms() çağırın. Aksi takdirde, SMS Aboneliği anonim bir kullanıcıya bağlanabilir.
• Göndermeden önce telefon numaralarını her zaman doğrulayın ve E.164 formatına normalize edin.
• SMS Kayıt Gereksinimlerini takip edin.

  OneSignal.User.addSms("+15558675309");

  OneSignal.User.removeSms("+15558675309");

​

Slidedown istemleri

• Reddedilirse, gelecekteki çağrılar en az üç gün boyunca yok sayılır. Daha fazla reddetme, kullanıcıya tekrar sorulmadan önce geçmesi gereken süreyi uzatır.
• Geri çekilme davranışını geçersiz kılmak için yönteme {force: true} geçirin. Ancak, iyi bir kullanıcı deneyimi sağlamak için eylemi düğme tıklaması gibi UI başlatımlı bir olaya bağlayın.

​

promptPush()

• Kategoriler kullanıyorsanız, bunun yerine promptPushCategories() çağırın.
• OneSignal tarafından ayarlanan geri çekilme mantığına tabidir. Daha fazla ayrıntı için Web izin istemleri’ne bakın.

  OneSignal.Slidedown.promptPush();
  // Test sırasında geri çekilme mantığını atlamak için {force: true} geçirin
  //OneSignal.Slidedown.promptPush({force: true});

​

promptPushCategories()

• Kategoriler kullanmıyorsanız, bunun yerine promptPush() çağırın.
• OneSignal tarafından ayarlanan geri çekilme mantığına tabidir. Daha fazla ayrıntı için Web izin istemleri’ne bakın.

  OneSignal.Slidedown.promptPushCategories();
  // Test sırasında geri çekilme mantığını atlamak için {force: true} geçirin
  //OneSignal.Slidedown.promptPushCategories({force: true});

​

promptSms()

• OneSignal tarafından ayarlanan geri çekilme mantığına tabidir. Daha fazla ayrıntı için Web izin istemleri’ne bakın.

  OneSignal.Slidedown.promptSms();
  // Test sırasında geri çekilme mantığını atlamak için {force: true} geçirin
  //OneSignal.Slidedown.promptSms({force: true});

​

promptEmail()

• OneSignal tarafından ayarlanan geri çekilme mantığına tabidir. Daha fazla ayrıntı için Web izin istemleri’ne bakın.

  OneSignal.Slidedown.promptEmail();
  // Test sırasında geri çekilme mantığını atlamak için {force: true} geçirin
  //OneSignal.Slidedown.promptEmail({force: true});

​

promptSmsAndEmail()

• OneSignal tarafından ayarlanan geri çekilme mantığına tabidir. Daha fazla ayrıntı için Web izin istemleri’ne bakın.

  OneSignal.Slidedown.promptSmsAndEmail();
  // Test sırasında geri çekilme mantığını atlamak için {force: true} geçirin
  //OneSignal.Slidedown.promptSmsAndEmail({force: true});

​

addEventListener() Slidedown

  OneSignalDeferred.push(function(OneSignal) {

    OneSignal.Slidedown.addEventListener('slidedownShown', function (event) {
      console.log('slidedownShown', { event });
    });

  });

​

Push bildirimleri

​

requestPermission()

  OneSignal.Notifications.requestPermission();

​

isPushSupported()

  const isSupported = OneSignal.Notifications.isPushSupported();

​

OneSignal.Notifications.permission

• true: Kullanıcı bildirimleri görüntüleme iznini vermiştir.
• false: Kullanıcı bildirimleri görüntüleme iznini reddetmiş veya henüz vermemiştir.

  let permission = OneSignal.Notifications.permission;

​

addEventListener() Bildirimler

  function onClick(event) {
    console.log("click", event);
  }

  OneSignal.Notifications.addEventListener("click", onClick);
  OneSignal.Notifications.removeEventListener("click", onClick);

​

permissionChange

  function permissionChangeListener(permission) {
    if (permission) {
      console.log(`permission accepted!`);
    }
  }

  OneSignal.Notifications.addEventListener("permissionChange", permissionChangeListener);

​

permissionPromptDisplay

  function promptListener(event) {
    console.log("permission prompt displayed", event);
  }

  OneSignal.Notifications.addEventListener("permissionPromptDisplay", promptListener);

​

click

  function clickEventListener(event) {
    console.log(`click event: ${event}`);
  }

  OneSignal.Notifications.addEventListener("click", clickEventListener);

​

foregroundWillDisplay

  function foregroundWillDisplayListener(event) {
    console.log("notification will display", event);
  }

  OneSignal.Notifications.addEventListener("foregroundWillDisplay", foregroundWillDisplayListener);

​

dismiss

• Bir kullanıcı bildirim gövdesine veya eylem düğmelerine tıklamadan bildirimi kasıtlı olarak kapatır
• Android’de Chrome’da, bir kullanıcı tüm web push bildirimlerini kapatır (bu olay gösterdiğimiz her web push bildirimi için tetiklenir)
• Bir bildirim kendi kendine sona erer ve kaybolur

  function notificationDismissedListener(event) {
    console.log(`dismiss event: ${event}`);
  }

  OneSignal.Notifications.addEventListener("dismiss", notificationDismissedListener);

​

setDefaultUrl()

  OneSignal.Notifications.setDefaultUrl("https://onesignal.com");

​

setDefaultTitle()

  OneSignal.Notifications.setDefaultTitle("Powered by OneSignal!");

​

Sonuçlar

​

sendOutcome()

  OneSignal.Session.sendOutcome('outcome name', 19.84);

​

sendUniqueOutcome()

  OneSignal.Session.sendUniqueOutcome('outcome name');