Web uygulamalarında Firebase Cloud Messaging'i kullanmaya başlama

Bu kılavuzda, mesajları güvenilir bir şekilde gönderebilmeniz için Firebase Cloud Messaging'yı web istemci uygulamalarınızda kullanmaya nasıl başlayacağınız açıklanmaktadır.

FCM JavaScript API'si, Push API'yi destekleyen tarayıcılarda çalışan web uygulamalarında bildirim mesajları almanıza olanak tanır. Bu kapsamda, bu destek matrisinde listelenen tarayıcı sürümleri ve Push API'yi kullanan Chrome uzantıları yer alır.

FCM SDK yalnızca HTTPS üzerinden sunulan sayfalarda desteklenir. Bunun nedeni, yalnızca HTTPS sitelerinde kullanılabilen hizmet çalışanlarının kullanılmasıdır. Bir sağlayıcıya ihtiyacınız varsa Firebase App Hosting önerilir ve kendi alanınızda HTTPS barındırma için ücretsiz bir katman sunar.

FCM JavaScript API'yi kullanmaya başlamak için web uygulamanıza Firebase'i eklemeniz ve Firebase yükleme kimliklerine erişmek için mantık eklemeniz gerekir. Bu sayede bildirimlerinizin alıcısını belirleyebilirsiniz.

FCM SDK'sını ekleme ve başlatma

1. Henüz yapmadıysanız Firebase JS SDK'yı yükleyin ve Firebase'i başlatın.

2. Firebase Cloud Messaging JS SDK'sını ekleyin ve Firebase Cloud Messaging başlatın:

import { initializeApp } from "firebase/app";
import { getMessaging } from "firebase/messaging";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Firebase Cloud Messaging and get a reference to the service
const messaging = getMessaging(app);

import firebase from "firebase/compat/app";
import "firebase/compat/messaging";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);


// Initialize Firebase Cloud Messaging and get a reference to the service
const messaging = firebase.messaging();

Web için FCM kullanıyorsanız ve SDK 6.7.0 veya sonraki bir sürüme yükseltmek istiyorsanız Google Cloud konsolunda projeniz için FCM Registration API'yi etkinleştirmeniz gerekir. API'yi etkinleştirirken Firebase için kullandığınız Google Hesabı ile Google Cloud konsolunda oturum açtığınızdan ve doğru projeyi seçtiğinizden emin olun. FCM SDK'sını ekleyen yeni projelerde bu API varsayılan olarak etkindir.

Web kimlik bilgilerini FCM ile yapılandırma

FCM Web arayüzü, desteklenen web push hizmetlerine gönderme isteklerini yetkilendirmek için Voluntary Application Server Identification (Gönüllü Uygulama Sunucusu Tanımlama) veya VAPID anahtarları adı verilen web kimlik bilgilerini kullanır. Uygulamanızı push bildirimlerine abone etmek için Firebase projenizle bir anahtar çifti ilişkilendirmeniz gerekir. Firebase konsolu aracılığıyla yeni bir anahtar çifti oluşturabilir veya mevcut anahtar çiftinizi içe aktarabilirsiniz.

Yeni bir anahtar çifti oluşturma

1. Firebase konsolunda settings Ayarlar > Genel'e gidin. Ardından Cloud Messaging sekmesini tıklayın.

2. Web yapılandırması bölümüne gidin.

3. Web Push certificates (Web Push sertifikaları) sekmesinde Generate Key Pair'ı (Anahtar çifti oluştur) tıklayın.

   Konsolda, anahtar çiftinin oluşturulduğuyla ilgili bir bildirim gösterilir. Ayrıca, ortak anahtar dizesi ve eklenme tarihi de gösterilir.

Mevcut bir anahtar çiftini içe aktarma

Web uygulamanızla zaten kullandığınız mevcut bir anahtar çiftiniz varsa FCM API'leri aracılığıyla mevcut web uygulaması örneklerinize ulaşabilmek için bu anahtar çiftini FCM'ye aktarabilirsiniz. Anahtarları içe aktarmak için Firebase projesine sahip düzeyinde erişiminiz olmalıdır. Mevcut ortak ve özel anahtarınızı Base64 URL güvenli kodlu biçimde içe aktarın:

1. Firebase konsolunda settings Ayarlar > Genel'e gidin. Ardından Cloud Messaging sekmesini tıklayın.

2. Web yapılandırması bölümüne gidin.

3. Web Push certificates (Web Push sertifikaları) sekmesinde bağlantı metnini bulun ve seçin: import an existing key pair (Mevcut bir anahtar çiftini içe aktar).

4. Anahtar çiftini içe aktar iletişim kutusunda, ortak ve özel anahtarlarınızı ilgili alanlara girip İçe aktar'ı tıklayın.

   Konsolda ortak anahtar dizesi ve eklenme tarihi gösterilir.

Anahtarı uygulamanıza ekleme talimatları için Uygulamanızda web kimlik bilgilerini yapılandırma başlıklı makaleyi inceleyin. Anahtarların biçimi ve nasıl oluşturulacağı hakkında daha fazla bilgi için Uygulama sunucusu anahtarları başlıklı makaleyi inceleyin.

Uygulamanızda web kimlik bilgilerini yapılandırma

register(): Promise<void> yöntemi, FCM'nin farklı push hizmetlerine mesaj istekleri gönderirken VAPID anahtarı kimlik bilgisini kullanmasına olanak tanır. Web Kimlik Bilgilerini FCM ile Yapılandırma bölümündeki talimatlara göre oluşturduğunuz veya içe aktardığınız anahtarı kullanarak mesajlaşma nesnesi alındıktan sonra kodunuza ekleyin:

import { getMessaging, register } from "firebase/messaging";

const messaging = getMessaging();
// Add the public key generated from the Firebase console here.
register(messaging, {vapidKey: "BKagOny0KF_2pCJQ3m....moL0ewzQ8rZu"});

Bildirim izni isteyin ve hizmet çalışanını yapılandırın

FCM ile bir uygulama örneğini hedeflemeniz gerektiğinde, önce Notification.requestPermission() ile kullanıcıdan bildirim izinleri isteyin. Aşağıdaki gibi çağrıldığında, izin verildiyse izin durumunu döndürür:

function requestPermission() {
  console.log('Requesting permission...');
  Notification.requestPermission().then((permission) => {
    if (permission === 'granted') {
      console.log('Notification permission granted.');
    }
  });
}

FCM için firebase-messaging-sw.js dosyası gerekir. Halihazırda bir firebase-messaging-sw.js dosyanız yoksa bu adla boş bir dosya oluşturun ve kaydolmadan önce alanınızın kök dizinine yerleştirin. Daha sonra istemci kurulumu sürecinde dosyaya anlamlı içerikler ekleyebilirsiniz.

Firebase kurulum kimliğine erişme

Uygulama örneğini kaydetmek ve mesaj hedefleme için Firebase kurulum kimliğini (FID) almak üzere:

import { getMessaging, onRegistered, register } from "firebase/messaging";

const messaging = getMessaging();

// 1. Implement callback to receive the Firebase installation ID upon registration.
// This is triggered every time a manual register() finishes, a FID change
// is detected, or a pushsubscriptionchange event is fired.
onRegistered(messaging, (installationId) => {
  console.log('Registered installation ID:', installationId);

  // Send the Firebase Installation ID to your app server and update the UI if needed.
  sendRegistrationToServer(installationId);
});

// 2. You can also manually trigger registration (recommended on app startup)
register(messaging, {
  vapidKey: '<YOUR_PUBLIC_VAPID_KEY_HERE>'
}).then(() => {
  // Success! The Firebase Installation ID can be used to target messages to this app
  // instance and will be delivered asynchronously to your onRegistered() callback.
}).catch((err) => {
  console.error('An error occurred while registering', err);
});
messaging_register.js

onRegistered geri çağırma işlemi üç senaryoda tetiklenir:

1. Her manuel register() görüşme register() sona erdiğinde.
2. Firebase kurulum kimliği değişikliği algılandığında
3. Bir pushsubscriptionchange etkinliği tetiklenir.

Firebase Kurulum Kimliği'ni aldıktan sonra, tercih ettiğiniz yöntemi kullanarak uygulama sunucunuza gönderin ve saklayın.

Kayıt jetonuna erişme (kullanımdan kaldırıldı)

Mevcut jetonu almak için:

import { getMessaging, getToken } from "firebase/messaging";

// Get registration token. Initially this makes a network call, once retrieved
// subsequent calls to getToken will return from cache.
const messaging = getMessaging();
getToken(messaging, { vapidKey: '<YOUR_PUBLIC_VAPID_KEY_HERE>' }).then((currentToken) => {
  if (currentToken) {
    // Send the token to your server and update the UI if necessary
    // ...
  } else {
    // Show permission request UI
    console.log('No registration token available. Request permission to generate one.');
    // ...
  }
}).catch((err) => {
  console.log('An error occurred while retrieving token. ', err);
  // ...
});
messaging_get_token.js

// Get registration token. Initially this makes a network call, once retrieved
// subsequent calls to getToken will return from cache.
messaging.getToken({ vapidKey: '<YOUR_PUBLIC_VAPID_KEY_HERE>' }).then((currentToken) => {
  if (currentToken) {
    // Send the token to your server and update the UI if necessary
    // ...
  } else {
    // Show permission request UI
    console.log('No registration token available. Request permission to generate one.');
    // ...
  }
}).catch((err) => {
  console.log('An error occurred while retrieving token. ', err);
  // ...
});
index.js

Jetonu aldıktan sonra uygulama sunucunuza gönderin ve tercih ettiğiniz yöntemi kullanarak saklayın.

Test bildirim mesajı gönderme

1. Uygulamayı hedef cihaza yükleyip çalıştırın. Apple cihazlarda, uzaktan bildirim alma izni isteğini kabul etmeniz gerekir.

2. Uygulamanın cihazda arka planda çalıştığından emin olun.

3. Firebase konsolunda DevOps & Engagement (DevOps ve Etkileşim) > Messaging'e (Mesajlaşma) gidin.

4. Kampanya oluşturun.

   • Bu ilk mesajınızsa:

     1. İlk kampanyanızı oluşturun'u seçin.

     2. Firebase Notification mesajları'nı ve Oluştur'u seçin.

   • Daha önce kampanya oluşturduysanız:

     1. Kampanyalar sekmesinde Yeni kampanya'yı seçin.

     2. Bildirimler'i tıklayın.

5. Mesaj metnini girin.

6. Sağ bölmeden Test mesajı gönder'i seçin.

7. Add an FCM registration token (FCM kayıt jetonu ekle) etiketli alana kayıt jetonunuzu girin.

8. Test et'i seçin.

Test'i seçtikten sonra, uygulama arka plandayken hedeflenen istemci cihaz bildirimi almalıdır.

Sonraki adımlar

Kurulum adımlarını tamamladıktan sonra FCM for Web (JavaScript) ile ilerlemek için kullanabileceğiniz birkaç seçenek aşağıda verilmiştir:

• Cihazlara mesaj gönderme
• JavaScript istemcisinde mesaj alma
• Konulara mesaj gönderme