Interfejs FCM JavaScript API pozwala otrzymywać powiadomienia w aplikacje internetowe działające w przeglądarkach, które obsługują Interfejs API Push. Dotyczy to również wersji przeglądarek wymienionych w matrix i rozszerzenia do Chrome za pomocą interfejsu Push API.
Pakiet SDK FCM jest obsługiwany tylko na stronach wyświetlanych przez HTTPS. To jest ze względu na wykorzystanie mechanizmów Service Worker, które są dostępne tylko w witrynach HTTPS. Jeśli potrzebujesz dostawcy, zalecamy Hosting Firebase, który oferuje bezpłatny poziom hostingu HTTPS w Twojej domenie.
Aby zacząć korzystać z interfejsu FCM JavaScript API, musisz dodać Firebase do swojej aplikacji internetowej i dodać logikę do uzyskiwania dostępu do tokenów rejestracji.
Dodawanie i inicjowanie pakietu SDK FCM
Dodaj pakiet SDK JS Firebase Cloud Messaging i inicjuj Firebase Cloud Messaging:
Web
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);
Web
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();
Jeśli obecnie używasz w przeglądarce pakietu SDK FCM i chcesz przejść na pakiet SDK 6.7.0 lub nowszej, należy włączyć Interfejs API FCM Registration API swojego projektu w konsoli Google Cloud. Po włączeniu interfejsu API upewnij się, korzystasz z tego samego konta Google, którego używasz do logowania się w Cloud Console. Firebase i wybierz właściwy projekt. Nowe projekty, w których dodano atrybuty FCM pakiet SDK ma ten interfejs API domyślnie włączony.
Konfigurowanie danych logowania do sieci za pomocą FCM
Interfejs internetowy FCM używa danych logowania do internetu, zwanych „identyfikatorami serwera aplikacji” lub kluczami „VAPID”, do autoryzowania wysyłania żądań do obsługiwanych usług przesyłania danych przez internet. Aby zasubskrybować powiadomienia push w aplikacji: musisz powiązać parę kluczy z projektem Firebase. Możesz wygenerować nową parę kluczy lub zaimportować istniejącą parę kluczy w Konsoli Firebase.
Generowanie nowej pary kluczy
- Otwórz Karta Komunikacja w chmurze w Ustawieniach konsoli Firebase i przewiń do sekcji Konfiguracja internetowa.
- Na karcie Certyfikaty Web Push kliknij Wygeneruj parę kluczy. wyświetli się powiadomienie o wygenerowaniu pary kluczy oraz ciągu klucza publicznego i daty dodania.
Importowanie istniejącej pary kluczy
Jeśli masz już parę kluczy, której używasz w aplikacji internetowej, możesz ją zaimportować do FCM, aby uzyskać dostęp do istniejących instancji aplikacji internetowej za pomocą interfejsów API FCM. Aby zaimportować klucze, musisz mieć dostęp do projektu Firebase na poziomie właściciela. Zaimportuj istniejący klucz publiczny i prywatny w formacie zakodowanym w standardzie base64 do bezpiecznego adresu URL:
- Otwórz Karta Komunikacja w chmurze w Ustawieniach konsoli Firebase i przewiń do sekcji Konfiguracja internetowa.
- Na karcie Certyfikaty Web Push odszukaj i kliknij tekst linku „Importuj istniejący klucz publiczny i prywatny”.
- W oknie Importuj parę kluczy wpisz klucze publiczny i prywatny w odpowiednich polach i kliknij Importuj. Konsola wyświetli się publicznie klucz i data dodania.
Instrukcje dodawania kluczyka do aplikacji znajdziesz tutaj Skonfiguruj w aplikacji dane logowania do witryny. Więcej informacji o formacie kluczy i sposobie ich generowania znajdziesz w artykule zobacz Klucze serwera aplikacji.
Konfigurowanie danych logowania do internetu w aplikacji
Metoda getToken(): Promise<string>
zezwala FCM na używanie danych uwierzytelniających klucza VAPID podczas wysyłania wiadomości
do różnych usług push. Korzystając z klucza wygenerowanego lub zaimportowanego zgodnie z instrukcjami w artykule Konfigurowanie danych logowania do usługi internetowej za pomocą FCM, dodaj go w kodzie po pobraniu obiektu wiadomości:
import { getMessaging, getToken } from "firebase/messaging";
const messaging = getMessaging();
// Add the public key generated from the console here.
getToken(messaging, {vapidKey: "BKagOny0KF_2pCJQ3m....moL0ewzQ8rZu"});
Dostęp do tokena rejestracji
Aby pobrać bieżący token rejestracji instancji aplikacji,
poproś użytkownika o zgodę na wyświetlanie powiadomień z Notification.requestPermission()
.
Gdy ta funkcja jest wywoływana, zwraca token, jeśli uprawnienie zostanie przyznane lub odrzuci obietnicę.
jeśli odmowa:
function requestPermission() { console.log('Requesting permission...'); Notification.requestPermission().then((permission) => { if (permission === 'granted') { console.log('Notification permission granted.');
FCM wymaga pliku firebase-messaging-sw.js
.
Jeśli nie masz jeszcze pliku firebase-messaging-sw.js
, utwórz pusty plik
tę nazwą i umieść go w katalogu głównym swojej domeny przed pobraniem tokena.
Przydatną zawartość możesz dodać do pliku na późniejszym etapie konfiguracji klienta.
Aby pobrać bieżący token:
Web
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); // ... });
Web
// 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); // ... });
Po uzyskaniu tokena wyślij go na serwer aplikacji i do sklepu. za pomocą preferowanej metody.
Dalsze kroki
Po zakończeniu konfiguracji masz do wyboru kilka opcji przekazuj dalej za pomocą FCM w przypadku witryn (JavaScript):
- Dodaj do aplikacji funkcję odbierania wiadomości.
- Wypróbuj jeden z naszych samouczków: Wysyłanie pierwszej wiadomości do aplikacji działającej w tle lub Wysyłanie wiadomości na wiele urządzeń.
- Zapoznaj się z pełnym przykładem na GitHubie.
- Zapoznaj się z dokumentacją JavaScript.
- Obejrzyj film instruktażowy wdrażania API.