Zgodnie z modelem publikowania/subskrypcji funkcja wiadomości w tematach w FCM umożliwia wysyłanie wiadomości na wielu urządzeniach, które angażują się w określoną tematykę. Tworzysz wiadomości w tematach jako i FCM obsługuje routing i dostarczanie wiadomości w niezawodny sposób urządzenia.
Na przykład użytkownicy przypływów lokalnych aplikacja prognostyczna może włączyć „alerty o prądach pływowych” temat i otrzymaj powiadomienia o optymalnych warunkach połowów na morzu na wybranych obszarach. Użytkownicy aplikacji sportowej mogliby zasubskrybować automatyczne aktualizacje wyników meczów ulubieńców w różnych regionach.
Oto kilka kwestii, o których warto pamiętać:
- Komunikaty tematyczne najlepiej sprawdzają się w przypadku treści takich jak pogoda i inne treści publiczne dostępnych informacji.
- Tematy wiadomości są zoptymalizowane pod kątem przepustowości, a nie opóźnień. Szybka i bezpieczna dostawa do pojedyncze urządzenia lub małe grupy urządzeń, kierować wiadomości na tokeny rejestracji, nie tematów.
- Jeśli chcesz wysyłać wiadomości na wiele urządzeń na użytkownika, weź pod uwagę wysyłanie wiadomości do grupy urządzeń dla tych zastosowań.
- Funkcja wiadomości tematycznych obsługuje nieograniczoną liczbę subskrypcji dla każdego tematu. Jednak FCM
egzekwuje ograniczenia w tych obszarach:
- Jedno wystąpienie aplikacji może subskrybować maksymalnie 2000 tematów.
- Jeśli używasz importowanie zbiorcze aby zasubskrybować instancje aplikacji, każde żądanie jest ograniczone do 1000 wystąpień aplikacji.
- Częstotliwość nowych subskrypcji jest ograniczona w przypadku każdego projektu. Jeśli wysyłasz za dużo
żądań subskrypcji w krótkim czasie, serwery FCM odpowiadają z komunikatem
429 RESOURCE_EXHAUSTED
(„Przekroczono limit”). Spróbuj ponownie: wzrastający czas do ponowienia.
Subskrybowanie tematu w aplikacji klienckiej
Aby zasubskrybować temat, zadzwoń pod numer ::firebase::messaging::Subscribe
z aplikacji. Powoduje to wysłanie żądania asynchronicznego do FCM
i subskrybuje klienta do danego tematu.
::firebase::messaging::Subscribe("example");
Jeśli początkowo prośba o subskrypcję nie powiedzie się, FCM ponawia próbę, aż może zasubskrybować temat. Przy każdym uruchomieniu aplikacji FCM sprawdza, czy wszystkie żądane tematy zostały zasubskrybowane.
Aby anulować subskrypcję, zadzwoń pod numer ::firebase::messaging::Unsubscribe
,
i FCM anuluje subskrypcję tematu w tle.
Zarządzanie subskrypcjami tematów na serwerze
Firebase Admin SDK umożliwia wykonywanie podstawowych działań, do zarządzania tematami po stronie serwera. W związku z rejestracją token(y), możesz zbiorczo subskrybować instancje aplikacji klienckich i anulować ich subskrypcję za pomocą i logikę serwera.
Możesz zasubskrybować instancje aplikacji klienckich w dowolnym istniejącym temacie lub możesz utworzyć nowy temat. Gdy subskrybujesz aplikację kliencką za pomocą interfejsu API do nowego tematu (takiego, którego jeszcze nie ma w projekcie Firebase) w FCM jest tworzony nowy temat o tej nazwie, dzięki czemu każdy klient może go zasubskrybować.
Możesz przekazać listę tokenów rejestracji do Firebase Admin SDK metody subskrypcji, aby zasubskrybować odpowiednie urządzenia w temacie:
Node.js
// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
'YOUR_REGISTRATION_TOKEN_1',
// ...
'YOUR_REGISTRATION_TOKEN_n'
];
// Subscribe the devices corresponding to the registration tokens to the
// topic.
getMessaging().subscribeToTopic(registrationTokens, topic)
.then((response) => {
// See the MessagingTopicManagementResponse reference documentation
// for the contents of response.
console.log('Successfully subscribed to topic:', response);
})
.catch((error) => {
console.log('Error subscribing to topic:', error);
});
Java
// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
"YOUR_REGISTRATION_TOKEN_1",
// ...
"YOUR_REGISTRATION_TOKEN_n"
);
// Subscribe the devices corresponding to the registration tokens to the
// topic.
TopicManagementResponse response = FirebaseMessaging.getInstance().subscribeToTopic(
registrationTokens, topic);
// See the TopicManagementResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " tokens were subscribed successfully");
Python
# These registration tokens come from the client FCM SDKs.
registration_tokens = [
'YOUR_REGISTRATION_TOKEN_1',
# ...
'YOUR_REGISTRATION_TOKEN_n',
]
# Subscribe the devices corresponding to the registration tokens to the
# topic.
response = messaging.subscribe_to_topic(registration_tokens, topic)
# See the TopicManagementResponse reference documentation
# for the contents of response.
print(response.success_count, 'tokens were subscribed successfully')
Go
// These registration tokens come from the client FCM SDKs.
registrationTokens := []string{
"YOUR_REGISTRATION_TOKEN_1",
// ...
"YOUR_REGISTRATION_TOKEN_n",
}
// Subscribe the devices corresponding to the registration tokens to the
// topic.
response, err := client.SubscribeToTopic(ctx, registrationTokens, topic)
if err != nil {
log.Fatalln(err)
}
// See the TopicManagementResponse reference documentation
// for the contents of response.
fmt.Println(response.SuccessCount, "tokens were subscribed successfully")
C#
// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
"YOUR_REGISTRATION_TOKEN_1",
// ...
"YOUR_REGISTRATION_TOKEN_n",
};
// Subscribe the devices corresponding to the registration tokens to the
// topic
var response = await FirebaseMessaging.DefaultInstance.SubscribeToTopicAsync(
registrationTokens, topic);
// See the TopicManagementResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} tokens were subscribed successfully");
Interfejs Admin FCM API umożliwia też anulowanie subskrypcji urządzeń z tego tematu przekazując tokeny rejestracji do odpowiedniego :
Node.js
// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
'YOUR_REGISTRATION_TOKEN_1',
// ...
'YOUR_REGISTRATION_TOKEN_n'
];
// Unsubscribe the devices corresponding to the registration tokens from
// the topic.
getMessaging().unsubscribeFromTopic(registrationTokens, topic)
.then((response) => {
// See the MessagingTopicManagementResponse reference documentation
// for the contents of response.
console.log('Successfully unsubscribed from topic:', response);
})
.catch((error) => {
console.log('Error unsubscribing from topic:', error);
});
Java
// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
"YOUR_REGISTRATION_TOKEN_1",
// ...
"YOUR_REGISTRATION_TOKEN_n"
);
// Unsubscribe the devices corresponding to the registration tokens from
// the topic.
TopicManagementResponse response = FirebaseMessaging.getInstance().unsubscribeFromTopic(
registrationTokens, topic);
// See the TopicManagementResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " tokens were unsubscribed successfully");
Python
# These registration tokens come from the client FCM SDKs.
registration_tokens = [
'YOUR_REGISTRATION_TOKEN_1',
# ...
'YOUR_REGISTRATION_TOKEN_n',
]
# Unubscribe the devices corresponding to the registration tokens from the
# topic.
response = messaging.unsubscribe_from_topic(registration_tokens, topic)
# See the TopicManagementResponse reference documentation
# for the contents of response.
print(response.success_count, 'tokens were unsubscribed successfully')
Go
// These registration tokens come from the client FCM SDKs.
registrationTokens := []string{
"YOUR_REGISTRATION_TOKEN_1",
// ...
"YOUR_REGISTRATION_TOKEN_n",
}
// Unsubscribe the devices corresponding to the registration tokens from
// the topic.
response, err := client.UnsubscribeFromTopic(ctx, registrationTokens, topic)
if err != nil {
log.Fatalln(err)
}
// See the TopicManagementResponse reference documentation
// for the contents of response.
fmt.Println(response.SuccessCount, "tokens were unsubscribed successfully")
C#
// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
"YOUR_REGISTRATION_TOKEN_1",
// ...
"YOUR_REGISTRATION_TOKEN_n",
};
// Unsubscribe the devices corresponding to the registration tokens from the
// topic
var response = await FirebaseMessaging.DefaultInstance.UnsubscribeFromTopicAsync(
registrationTokens, topic);
// See the TopicManagementResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} tokens were unsubscribed successfully");
Metody subscribeToTopic()
i unsubscribeFromTopic()
dają wartość
obiekt z odpowiedzią z FCM. Zwracany typ ma takie samo
formatu niezależnie od liczby tokenów rejestracji określonych w tagu
użytkownika.
W przypadku błędu (niepowodzenia uwierzytelniania, nieprawidłowego tokena lub tematu itp.) te metody skutkują błędem. Pełną listę kodów błędów wraz z opisami i sposobów jego rozwiązania znajdziesz Błędy interfejsu API administratora FCM.
Odbieranie i obsługę wiadomości dotyczących tematów
FCM dostarcza wiadomości tematyczne w taki sam sposób, jak inne wiadomości na kolejnym etapie wiadomości.
Zastępując metodę
::firebase::messaging::Listener::OnMessage
,
możesz wykonywać działania na podstawie otrzymanej wiadomości i pobierać dane dotyczące wiadomości:
void OnMessage(const ::firebase::messaging::Message& message) { LogMessage(TAG, "From: %s", message.from.c_str()); LogMessage(TAG, "Message ID: %s", message.message_id.c_str()); }
Tworzenie żądań wysyłania
Po utworzeniu tematu przez zasubskrybowanie instancji aplikacji klienckiej po stronie klienta lub w interfejs API serwera, możesz wysyłać komunikaty do temat. Jeśli po raz pierwszy tworzysz prośby o wysłanie próśb do usługi FCM, zobacz przewodnik środowisko serwera i FCM dla najważniejsze informacje i informacje o konfiguracji.
W logice wysyłania w backendzie określ odpowiednią nazwę tematu Jak widać:
Node.js
// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';
const message = {
data: {
score: '850',
time: '2:45'
},
topic: topic
};
// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Java
// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";
// See documentation on defining a message payload.
Message message = Message.builder()
.putData("score", "850")
.putData("time", "2:45")
.setTopic(topic)
.build();
// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Python
# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'
# See documentation on defining a message payload.
message = messaging.Message(
data={
'score': '850',
'time': '2:45',
},
topic=topic,
)
# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Go
// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Topic: topic,
}
// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
C#
// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";
// See documentation on defining a message payload.
var message = new Message()
{
Data = new Dictionary<string, string>()
{
{ "score", "850" },
{ "time", "2:45" },
},
Topic = topic,
};
// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
REST
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"topic" : "foo-bar",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message"
}
}
}
Polecenie cURL:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message": {
"topic" : "foo-bar",
"notification": {
"body": "This is a Firebase Cloud Messaging Topic Message!",
"title": "FCM Message"
}
}
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Aby wysłać wiadomość do kombinacji tematów:
Określ warunek, czyli wyrażenie logiczne, które określa
kierowania na tematy. Na przykład poniższy warunek spowoduje wysłanie wiadomości do
urządzenia z subskrypcją TopicA
oraz TopicB
lub TopicC
:
"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"
Funkcja FCM najpierw sprawdza warunki w nawiasach, a potem
od lewej do prawej. W powyższym wyrażeniu użytkownik zasubskrybował
każdy z tematów nie otrzyma wiadomości. Podobnie użytkownik, który nie
subskrypcja użytkownika TopicA
nie otrzymuje wiadomości. Takie kombinacje mają
go otrzymać:
TopicA
iTopicB
TopicA
iTopicC
Wyrażenie warunkowe może zawierać maksymalnie 5 tematów.
Aby wysłać do warunku:
Node.js
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';
// See documentation on defining a message payload.
const message = {
notification: {
title: '$FooCorp up 1.43% on the day',
body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
},
condition: condition
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Java
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
Message message = Message.builder()
.setNotification(Notification.builder()
.setTitle("$GOOG up 1.43% on the day")
.setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
.build())
.setCondition(condition)
.build();
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Python
# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"
# See documentation on defining a message payload.
message = messaging.Message(
notification=messaging.Notification(
title='$GOOG up 1.43% on the day',
body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
),
condition=condition,
)
# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Go
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Condition: condition,
}
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
C#
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
var message = new Message()
{
Notification = new Notification()
{
Title = "$GOOG up 1.43% on the day",
Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
},
Condition = condition,
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
REST
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"condition": "'dogs' in topics || 'cats' in topics",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message",
}
}
}
Polecenie cURL:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"notification": {
"title": "FCM Message",
"body": "This is a Firebase Cloud Messaging Topic Message!",
},
"condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1