Google is committed to advancing racial equity for Black communities. See how.
Эта страница была переведа с помощью Cloud Translation API.
Switch to English

Создание запросов на отправку сервера приложений

Используя Firebase Admin SDK или протоколы сервера приложений FCM, вы можете создавать запросы сообщений и отправлять их следующим типам целей:

  • Название темы
  • Состояние
  • Токен регистрации устройства
  • Имя группы устройств (устаревшие протоколы и Firebase Admin SDK только для Node.js)

Вы можете отправлять сообщения с полезной нагрузкой уведомления, состоящей из предопределенных полей, с полезной нагрузкой данных из ваших собственных пользовательских полей или с сообщением, содержащим оба типа полезной нагрузки. См. Раздел Типы сообщений для получения дополнительной информации.

Примеры на этой странице показывают, как отправлять уведомления с помощью Firebase Admin SDK (который поддерживает Node , Java , Python , C # и Go ) и протокола HTTP v1 . Также есть руководство по отправке сообщений через устаревшие протоколы HTTP и XMPP .

Отправлять сообщения на определенные устройства

Чтобы отправить на одно конкретное устройство, передайте регистрационный токен устройства, как показано. См. Информацию о настройке клиента для вашей платформы, чтобы узнать больше о токенах регистрации.

Node.js

// This registration token comes from the client FCM SDKs.
var registrationToken = 'YOUR_REGISTRATION_TOKEN';

var message = {
  data: {
    score: '850',
    time: '2:45'
  },
  token: registrationToken
};

// Send a message to the device corresponding to the provided
// registration token.
admin.messaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Ява

// This registration token comes from the client FCM SDKs.
String registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setToken(registrationToken)
    .build();

// Send a message to the device corresponding to the provided
// registration token.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);

Python

# This registration token comes from the client FCM SDKs.
registration_token = 'YOUR_REGISTRATION_TOKEN'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    token=registration_token,
)

# Send a message to the device corresponding to the provided
# registration token.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)

Идти

// Obtain a messaging.Client from the App.
ctx := context.Background()
client, err := app.Messaging(ctx)
if err != nil {
	log.Fatalf("error getting Messaging client: %v\n", err)
}

// This registration token comes from the client FCM SDKs.
registrationToken := "YOUR_REGISTRATION_TOKEN"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Token: registrationToken,
}

// Send a message to the device corresponding to the provided
// registration token.
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 #

// This registration token comes from the client FCM SDKs.
var registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Token = registrationToken,
};

// Send a message to the device corresponding to the provided
// registration token.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

ОТДЫХ

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":{
      "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
      "notification":{
        "body":"This is an FCM notification message!",
        "title":"FCM Message"
      }
   }
}

команда cURL:

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "notification":{
     "title":"FCM Message",
     "body":"This is an FCM Message"
   },
   "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

В случае успеха каждый метод отправки возвращает идентификатор сообщения. SDK администратора Firebase возвращает строку идентификатора в формате projects/{project_id}/messages/{message_id} . Ответ протокола HTTP - это единственный ключ JSON:

    {
      "name":"projects/myproject-b5ae1/messages/0:1500415314455276%31bd1c9631bd1c96"
    }

Отправлять сообщения на несколько устройств

REST API и Admin FCM API позволяют выполнять многоадресную рассылку сообщения в список токенов регистрации устройств. Вы можете указать до 100 токенов регистрации устройства (500 для Java и Node.js) за один вызов.

Node.js

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
}

admin.messaging().sendMulticast(message)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');

Ява

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");

Python

# Create a list containing up to 500 registration tokens.
# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))

Идти

// Create a list containing up to 100 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)

C #

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendMulticastAsync(message);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");

ОТДЫХ

Создайте пакетный HTTP-запрос:

--subrequest_boundary
Content-Type: application/http
Content-Transfer-Encoding: binary
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

POST /v1/projects/myproject-b5ae1/messages:send
Content-Type: application/json
accept: application/json

{
  "message":{
     "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
     "notification":{
       "title":"FCM Message",
       "body":"This is an FCM notification message!"
     }
  }
}

...

--subrequest_boundary
Content-Type: application/http
Content-Transfer-Encoding: binary
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

POST /v1/projects/myproject-b5ae1/messages:send
Content-Type: application/json
accept: application/json

{
  "message":{
     "token":"cR1rjyj4_Kc:APA91bGusqbypSuMdsh7jSNrW4nzsM...",
     "notification":{
       "title":"FCM Message",
       "body":"This is an FCM notification message!"
     }
  }
}
--subrequest_boundary--

Сохраните запрос в файл (в этом примере batch_request.txt). Затем используйте команду cURL:

curl --data-binary @batch_request.txt -H 'Content-Type: multipart/mixed; boundary="subrequest_boundary"' https://fcm.googleapis.com/batch

Для пакетов SDK Firebase Admin эта операция использует sendAll() API sendAll() , как показано в примерах. Возвращаемое значение - это BatchResponse , список ответов которого соответствует порядку входных токенов. Это полезно, когда вы хотите проверить, какие токены привели к ошибкам.

Node.js

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
}

admin.messaging().sendMulticast(message)
  .then((response) => {
    if (response.failureCount > 0) {
      const failedTokens = [];
      response.responses.forEach((resp, idx) => {
        if (!resp.success) {
          failedTokens.push(registrationTokens[idx]);
        }
      });
      console.log('List of tokens that caused failures: ' + failedTokens);
    }
  });

Ява

// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
if (response.getFailureCount() > 0) {
  List<SendResponse> responses = response.getResponses();
  List<String> failedTokens = new ArrayList<>();
  for (int i = 0; i < responses.size(); i++) {
    if (!responses.get(i).isSuccessful()) {
      // The order of responses corresponds to the order of the registration tokens.
      failedTokens.add(registrationTokens.get(i));
    }
  }

  System.out.println("List of tokens that caused failures: " + failedTokens);
}

Python

# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
if response.failure_count > 0:
    responses = response.responses
    failed_tokens = []
    for idx, resp in enumerate(responses):
        if not resp.success:
            # The order of responses corresponds to the order of the registration tokens.
            failed_tokens.append(registration_tokens[idx])
    print('List of tokens that caused failures: {0}'.format(failed_tokens))

Идти

// Create a list containing up to 100 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

if br.FailureCount > 0 {
	var failedTokens []string
	for idx, resp := range br.Responses {
		if !resp.Success {
			// The order of responses corresponds to the order of the registration tokens.
			failedTokens = append(failedTokens, registrationTokens[idx])
		}
	}

	fmt.Printf("List of tokens that caused failures: %v\n", failedTokens)
}

C #

// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendMulticastAsync(message);
if (response.FailureCount > 0)
{
    var failedTokens = new List<string>();
    for (var i = 0; i < response.Responses.Count; i++)
    {
        if (!response.Responses[i].IsSuccess)
        {
            // The order of responses corresponds to the order of the registration tokens.
            failedTokens.Add(registrationTokens[i]);
        }
    }

    Console.WriteLine($"List of tokens that caused failures: {failedTokens}");
}

ОТДЫХ

Каждая подотправка отправки возвращает ответ. Ответы разделяются граничной строкой ответа, начинающейся с --batch_ .

--batch_nDhMX4IzFTDLsCJ3kHH7v_44ua-aJT6q
Content-Type: application/http
Content-ID: response-

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Vary: Origin
Vary: X-Origin
Vary: Referer

{
  "name": "projects/35006771263/messages/0:1570471792141125%43c11b7043c11b70"
}

...

--batch_nDhMX4IzFTDLsCJ3kHH7v_44ua-aJT6q
Content-Type: application/http
Content-ID: response-

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Vary: Origin
Vary: X-Origin
Vary: Referer

{
  "name": "projects/35006771263/messages/0:1570471792141696%43c11b7043c11b70"
}

--batch_nDhMX4IzFTDLsCJ3kHH7v_44ua-aJT6q--

Отправлять сообщения в темы

После создания темы, подписав экземпляры клиентского приложения на тему на стороне клиента или через серверный API , вы можете отправлять сообщения в тему. Если вы впервые создаете запросы отправки для FCM, см. Руководство по серверной среде и FCM для получения важной справочной информации и информации о настройке.

В логике отправки на серверной части укажите желаемое имя темы, как показано:

Node.js

// The topic name can be optionally prefixed with "/topics/".
var topic = 'highScores';

var message = {
  data: {
    score: '850',
    time: '2:45'
  },
  topic: topic
};

// Send a message to devices subscribed to the provided topic.
admin.messaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Ява

// 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)

Идти

// 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);

ОТДЫХ

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"
      }
   }
}

команда 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

Чтобы отправить сообщение на комбинацию тем, укажите условие , которое является логическим выражением, определяющим целевые темы. Например, следующее условие отправит сообщения на устройства, которые подписаны на TopicA и на TopicB или TopicC :

"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"

FCM сначала оценивает любые условия в круглых скобках, а затем вычисляет выражение слева направо. В приведенном выше выражении пользователь, подписанный на какую-либо отдельную тему, не получает сообщение. Аналогичным образом, пользователь, не подписанный на TopicA , не получит сообщение. Эти комбинации действительно получают:

  • TopicA и TopicB
  • TopicA и TopicC

В условное выражение можно включить до пяти тем.

Чтобы отправить в условие:

Node.js

// 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 = {
  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.
admin.messaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Ява

// 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)

Идти

// 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);

ОТДЫХ

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",
    }
  }
}

команда 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

Отправить пачку сообщений

Пакеты REST API и Admin SDK поддерживают отправку сообщений пакетами. Вы можете сгруппировать до 500 сообщений в один пакет и отправить их все за один вызов API, со значительным улучшением производительности по сравнению с отправкой отдельных HTTP-запросов для каждого сообщения.

Эту функцию можно использовать для создания настраиваемого набора сообщений и отправки их разным получателям, включая темы или определенные токены регистрации устройства. Используйте эту функцию, когда, например, вам нужно одновременно отправлять сообщения разным аудиториям с немного разными деталями в теле сообщения.

Node.js

// Create a list containing up to 500 messages.
const messages = [];
messages.push({
  notification: {title: 'Price drop', body: '5% off all electronics'},
  token: registrationToken,
});
messages.push({
  notification: {title: 'Price drop', body: '2% off all books'},
  topic: 'readers-club',
});

admin.messaging().sendAll(messages)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

Ява

// Create a list containing up to 500 messages.
List<Message> messages = Arrays.asList(
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("5% off all electronics")
            .build())
        .setToken(registrationToken)
        .build(),
    // ...
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("2% off all books")
            .build())
        .setTopic("readers-club")
        .build()
);

BatchResponse response = FirebaseMessaging.getInstance().sendAll(messages);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");

Python

# Create a list containing up to 500 messages.
messages = [
    messaging.Message(
        notification=messaging.Notification('Price drop', '5% off all electronics'),
        token=registration_token,
    ),
    # ...
    messaging.Message(
        notification=messaging.Notification('Price drop', '2% off all books'),
        topic='readers-club',
    ),
]

response = messaging.send_all(messages)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))

Идти

// Create a list containing up to 100 messages.
messages := []*messaging.Message{
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "5% off all electronics",
		},
		Token: registrationToken,
	},
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "2% off all books",
		},
		Topic: "readers-club",
	},
}

br, err := client.SendAll(context.Background(), messages)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)

C #

// Create a list containing up to 500 messages.
var messages = new List<Message>()
{
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "5% off all electronics",
        },
        Token = registrationToken,
    },
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "2% off all books",
        },
        Topic = "readers-club",
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendAllAsync(messages);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");

ОТДЫХ

Создайте пакетный HTTP-запрос, объединив список подзапросов:

--subrequest_boundary
Content-Type: application/http
Content-Transfer-Encoding: binary
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

POST /v1/projects/myproject-b5ae1/messages:send
Content-Type: application/json
accept: application/json

{
  "message":{
     "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
     "notification":{
       "title":"FCM Message",
       "body":"This is an FCM notification message to device 0!"
     }
  }
}

--subrequest_boundary
Content-Type: application/http
Content-Transfer-Encoding: binary
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

POST /v1/projects/myproject-b5ae1/messages:send
Content-Type: application/json
accept: application/json

{
  "message":{
     "topic":"readers-club",
     "notification":{
       "title":"Price drop",
       "body":"2% off all books"
     }
  }
}

...

--subrequest_boundary
Content-Type: application/http
Content-Transfer-Encoding: binary
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

POST /v1/projects/myproject-b5ae1/messages:send
Content-Type: application/json
accept: application/json

{
  "message":{
     "token":"cR1rjyj4_Kc:APA91bGusqbypSuMdsh7jSNrW4nzsM...",
     "notification":{
       "title":"FCM Message",
       "body":"This is an FCM notification message to device N!"
     }
  }
}
--subrequest_boundary--

Вы можете запросить возвращенный BatchResponse чтобы проверить, сколько сообщений было успешно передано в FCM. Он также предоставляет список ответов, которые можно использовать для проверки состояния отдельных сообщений. Порядок ответов соответствует порядку сообщений в списке ввода.

Отправлять сообщения с прямой загрузкой (только для Android)

Вы можете отправлять сообщения на устройства в режиме прямой загрузки, используя HTTP v1 или устаревшие HTTP API. Перед отправкой на устройства в режиме прямой загрузки убедитесь, что вы выполнили шаги, позволяющие клиентским устройствам получать сообщения FCM в режиме прямой загрузки .

Отправка с использованием HTTP API FCM v1

Запрос сообщения должен включать ключ "direct_book_ok" : true в параметрах AndroidConfig тела запроса. Например:

https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
  "Message":{
    "token" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
    "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "android": {
      "direct_boot_ok": true,
    },
}

Отправить с помощью устаревшего HTTP API FCM

Запрос сообщения должен включать ключ "direct_book_ok" : true на верхнем уровне тела запроса. Например:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  "direct_book_ok" : true
}

Сообщения, отправленные с этим ключом в теле запроса, могут обрабатываться приложениями на устройствах, которые в настоящее время находятся в режиме прямой загрузки (а также когда не в этом режиме).

Настройте сообщения на разных платформах

Как Firebase Admin SDK, так и протокол HTTP FCM v1 позволяют вашим запросам сообщений устанавливать все поля, доступные в объекте message . Это включает в себя:

  • общий набор полей, которые будут интерпретироваться всеми экземплярами приложения, получающими сообщение.
  • зависящие от платформы наборы полей, такие как AndroidConfig и WebpushConfig , интерпретируются только экземплярами приложения, запущенными на указанной платформе.

Блоки, зависящие от платформы, позволяют гибко настраивать сообщения для разных платформ, чтобы гарантировать, что они будут правильно обрабатываться при получении. Бэкэнд FCM будет учитывать все указанные параметры и настраивать сообщение для каждой платформы.

Когда использовать общие поля

Используйте общие поля, когда вы:

  • Таргетинг на экземпляры приложений на всех платформах - iOS, Android и в Интернете
  • Отправка сообщений в темы

Все экземпляры приложения, независимо от платформы, могут интерпретировать следующие общие поля:

Когда использовать поля, зависящие от платформы

Используйте специфичные для платформы поля, если хотите:

  • Отправлять поля только на определенные платформы
  • Отправлять поля для конкретной платформы в дополнение к общим полям

Если вы хотите отправлять значения только на определенные платформы, не используйте общие поля; используйте поля, зависящие от платформы. Например, чтобы отправить уведомление только в iOS и Интернет, но не в Android, вы должны использовать два отдельных набора полей: один для iOS и один для Интернета.

Когда вы отправляете сообщения с определенными параметрами доставки , используйте для их настройки поля, зависящие от платформы. При желании вы можете указать разные значения для каждой платформы. Однако даже если вы хотите установить по существу одно и то же значение для разных платформ, вы должны использовать поля, зависящие от платформы. Это связано с тем, что каждая платформа может интерпретировать значение немного по-разному - например, время жизни устанавливается на Android как время истечения срока в секундах, а на iOS оно устанавливается как срок годности .

Пример: уведомление с параметрами цвета и значка

В этом примере запрос на отправку отправляет общий заголовок и контент уведомления на все платформы, но он также отправляет некоторые зависящие от платформы переопределения на устройства Android.

Для Android запрос устанавливает специальный значок и цвет для отображения на устройствах Android. Как указано в справке по AndroidNotification , цвет указывается в формате #rrggbb, а изображение должно быть ресурсом значка с возможностью рисования, локальным для приложения Android.

Вот примерный визуальный эффект на устройстве пользователя:

Node.js

var admin = require("firebase-admin")

admin.initializeApp({
  credential: admin.credential.applicationDefault(),
});

var topicName = 'industry-tech'

var 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.'
  },
  android: {
    notification: {
      icon: 'stock_ticker_update',
      color: '#7e55c3'
    }
  },
  topic: topicName,
};

admin.messaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Ява

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())
    .setAndroidConfig(AndroidConfig.builder()
        .setTtl(3600 * 1000)
        .setNotification(AndroidNotification.builder()
            .setIcon("stock_ticker_update")
            .setColor("#f45342")
            .build())
        .build())
    .setApnsConfig(ApnsConfig.builder()
        .setAps(Aps.builder()
            .setBadge(42)
            .build())
        .build())
    .setTopic("industry-tech")
    .build();

Python

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.',
    ),
    android=messaging.AndroidConfig(
        ttl=datetime.timedelta(seconds=3600),
        priority='normal',
        notification=messaging.AndroidNotification(
            icon='stock_ticker_update',
            color='#f45342'
        ),
    ),
    apns=messaging.APNSConfig(
        payload=messaging.APNSPayload(
            aps=messaging.Aps(badge=42),
        ),
    ),
    topic='industry-tech',
)

Идти

oneHour := time.Duration(1) * time.Hour
badge := 42
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.",
	},
	Android: &messaging.AndroidConfig{
		TTL: &oneHour,
		Notification: &messaging.AndroidNotification{
			Icon:  "stock_ticker_update",
			Color: "#f45342",
		},
	},
	APNS: &messaging.APNSConfig{
		Payload: &messaging.APNSPayload{
			Aps: &messaging.Aps{
				Badge: &badge,
			},
		},
	},
	Topic: "industry-tech",
}

C #

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.",
    },
    Android = new AndroidConfig()
    {
        TimeToLive = TimeSpan.FromHours(1),
        Notification = new AndroidNotification()
        {
            Icon = "stock_ticker_update",
            Color = "#f45342",
        },
    },
    Apns = new ApnsConfig()
    {
        Aps = new Aps()
        {
            Badge = 42,
        },
    },
    Topic = "industry-tech",
};

ОТДЫХ

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":"industry-tech",
     "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."
     },
     "android":{
       "notification":{
         "icon":"stock_ticker_update",
         "color":"#7e55c3"
       }
     }
   }
 }

См. Справочную документацию HTTP v1 для получения полной информации о ключах, доступных в блоках для конкретной платформы в теле сообщения.

Пример: уведомление с настраиваемым изображением

В следующем примере запрос на отправку отправляет общий заголовок уведомления всем платформам, но также отправляет изображение. Вот примерный визуальный эффект на устройстве пользователя:

Node.js

var admin = require("firebase-admin")

admin.initializeApp({
  credential: admin.credential.applicationDefault(),
});

var topicName = 'industry-tech'

var message = {
  notification: {
    title: 'Sparky says hello!'
  },
  android: {
    notification: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  apns: {
    payload: {
      aps: {
        'mutable-content': 1
      }
    },
    fcm_options: {
      image: 'https://foo.bar.pizza-monster.png''
    }
  },
  webpush: {
    headers: {
      image: 'https://foo.bar.pizza-monster.png''
    }
  },
  topic: topicName,
};

admin.messaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

ОТДЫХ

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":"industry-tech",
     "notification":{
       "title":"Sparky says hello!",
     },
     "android":{
       "notification":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "mutable-content":1
         }
       },
       "fcm_options": {
           "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "webpush":{
       "headers":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     }
   }
 }

См. Справочную документацию HTTP v1 для получения полной информации о ключах, доступных в блоках для конкретной платформы в теле сообщения.

Пример: уведомление с соответствующим действием клика

В следующем примере запрос на отправку отправляет общий заголовок уведомления всем платформам, но он также отправляет действие, которое приложение должно выполнить в ответ на взаимодействие пользователя с уведомлением. Вот примерный визуальный эффект на устройстве пользователя:

Node.js

var admin = require("firebase-admin")

admin.initializeApp({
  credential: admin.credential.applicationDefault(),
});

var topicName = 'industry-tech'

var message = {
  notification: {
    title: 'Breaking News....'
  },
  android: {
    notification: {
      click_action: 'news_intent'
    }
  },
  apns: {
    payload: {
      aps: {
        'category': 'INVITE_CATEGORY'
      }
    }
  },
  webpush: {
    fcm_options: {
      link: 'breakingnews.html'
    }
  },
  topic: topicName,
};

admin.messaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

ОТДЫХ

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":"industry-tech",
     "notification":{
       "title":"Breaking News...",
     },
     "android":{
       "notification":{
         "click_action":"news_intent"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "category" : "INVITE_CATEGORY"
         }
       },
     },
     "webpush":{
       "fcm_options":{
         "link":"breakingnews.html"
       }
     }
   }
 }

См. Справочную документацию HTTP v1 для получения полной информации о ключах, доступных в блоках, зависящих от платформы, в теле сообщения.

Пример: уведомление с параметрами локализации

В следующем примере запрос на отправку отправляет клиенту параметры локализации для отображения локализованных сообщений. Вот примерный визуальный эффект на устройстве пользователя:

Node.js

var admin = require("firebase-admin")

admin.initializeApp({
  credential: admin.credential.applicationDefault(),
});

var topicName = 'industry-tech'

var message = {
  android: {
    ttl: 3600000,
    notification: {
      body_loc_key: 'STOCK_NOTIFICATION_BODY',
      body_loc_args: ['FooCorp', '11.80', '835.67', '1.43']
    }
  },
  apns: {
    payload: {
      aps: {
        'alert': {
          'loc-key': 'STOCK_NOTIFICATION_BODY',
          'loc-args': ['FooCorp', '11.80', '835.67', '1.43']
        }
      }
    }
  },
  topic: topicName,
};

admin.messaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

ОТДЫХ

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":"Tech",
             "android":{
               "ttl":"3600s",
               "notification":{
                 "body_loc_key": "STOCK_NOTIFICATION_BODY",
                 "body_loc_args":  ["FooCorp", "11.80", "835.67", "1.43"],
               },
             },
             "apns":{
               "payload":{
                 "aps":{
                   "alert" : {
                     "loc-key": "STOCK_NOTIFICATION_BODY",
                     "loc-args":  ["FooCorp", "11.80", "835.67", "1.43"],
                    },
                 },
               },
             },
  },
}'

См. Справочную документацию HTTP v1 для получения полной информации о ключах, доступных в блоках для конкретной платформы в теле сообщения.

Коды ошибок администратора

В следующей таблице перечислены коды ошибок API Firebase Admin FCM и их описания, включая рекомендуемые шаги по их устранению.

Код ошибки Описание и шаги решения
messaging/invalid-argument Методу FCM предоставлен недопустимый аргумент. Сообщение об ошибке должно содержать дополнительную информацию.
messaging/invalid-recipient Предполагаемый получатель сообщения недействителен. Сообщение об ошибке должно содержать дополнительную информацию.
messaging/invalid-payload Предоставлен недопустимый объект полезной нагрузки сообщения. Сообщение об ошибке должно содержать дополнительную информацию.
messaging/invalid-data-payload-key Полезные данные сообщения данных содержат недопустимый ключ. См. Справочную документацию по DataMessagePayload для ключей с ограниченным доступом.
messaging/payload-size-limit-exceeded Предоставленная полезная нагрузка сообщения превышает ограничения размера FCM. Для большинства сообщений ограничение составляет 4096 байт. Для сообщений, отправленных в темы, ограничение составляет 2048 байт. Общий размер полезной нагрузки включает как ключи, так и значения.
messaging/invalid-options Предоставлен недопустимый объект параметров сообщения. Сообщение об ошибке должно содержать дополнительную информацию.
messaging/invalid-registration-token Предоставлен недействительный регистрационный токен. Убедитесь, что он соответствует токену регистрации, который клиентское приложение получает при регистрации в FCM. Не усекайте его и не добавляйте к нему дополнительные символы.
messaging/registration-token-not-registered Предоставленный регистрационный токен не зарегистрирован. Ранее действующий регистрационный токен может быть отменен по разным причинам, в том числе:
  • Клиентское приложение отменило регистрацию в FCM.
  • Регистрация клиентского приложения была автоматически отменена. Это может произойти, если пользователь удалит приложение или, в iOS, если служба обратной связи APN сообщила, что токен APN недействителен.
  • Срок действия регистрационного токена истек. Например, Google может решить обновить регистрационные токены или срок действия токена APNs для устройств iOS истек.
  • Клиентское приложение было обновлено, но новая версия не настроена для приема сообщений.
Во всех этих случаях удалите этот регистрационный токен и прекратите использовать его для отправки сообщений.
messaging/invalid-package-name Сообщение было адресовано регистрационным знак которого имя пакета не соответствует указанному restrictedPackageName вариант.
messaging/message-rate-exceeded Слишком высокая скорость сообщений для конкретной цели. Уменьшите количество сообщений, отправляемых на это устройство или в тему, и не пытайтесь сразу же повторно отправить эту цель.
messaging/device-message-rate-exceeded Скорость отправки сообщений на конкретное устройство слишком высока. Уменьшите количество сообщений, отправляемых на это устройство, и не пытайтесь сразу же повторно отправить на это устройство.
messaging/topics-message-rate-exceeded Скорость сообщений подписчикам на определенную тему слишком высока. Уменьшите количество сообщений, отправляемых по этой теме, и не пытайтесь сразу же повторять отправку в эту тему.
messaging/too-many-topics Жетон регистрации подписан на максимальное количество тем и больше не может быть подписан.
messaging/invalid-apns-credentials Сообщение, предназначенное для устройства iOS, не может быть отправлено, потому что требуемый сертификат SSL APN не был загружен или истек. Проверьте действительность ваших сертификатов разработки и производства.
messaging/mismatched-credential Учетные данные, используемые для аутентификации этого SDK, не имеют разрешения на отправку сообщений на устройство, соответствующее предоставленному токену регистрации. Убедитесь, что учетные данные и регистрационный токен принадлежат одному проекту Firebase. См. Раздел Добавление Firebase в ваше приложение для получения документации о том, как аутентифицировать Firebase Admin SDK.
messaging/authentication-error SDK не может пройти аутентификацию на серверах FCM. Убедитесь, что вы аутентифицируете Firebase Admin SDK с учетными данными, которые имеют соответствующие разрешения для отправки сообщений FCM. См. Раздел Добавление Firebase в ваше приложение для получения документации о том, как аутентифицировать Firebase Admin SDK.
messaging/server-unavailable Сервер FCM не смог обработать запрос вовремя. Вам следует повторить тот же запрос, но вы должны:
  • Retry-After заголовок Retry-After если он включен в ответ от сервера соединений FCM.
  • Реализуйте экспоненциальную задержку в вашем механизме повтора. Например, если вы ждали одну секунду перед первой попыткой, подождите не менее двух секунд перед следующей, затем четыре секунды и так далее. Если вы отправляете несколько сообщений, задержите каждое из них независимо на дополнительную случайную величину, чтобы не выдавать новый запрос для всех сообщений одновременно.
Отправители, вызывающие проблемы, рискуют попасть в черный список.
messaging/internal-error Сервер FCM обнаружил ошибку при попытке обработать запрос. Вы можете повторить тот же запрос, следуя требованиям, перечисленным в строке messaging/server-unavailable выше. Если ошибка не исчезнет, ​​сообщите о проблеме в наш канал поддержки отчетов об ошибках .
messaging/unknown-error Возвращена неизвестная ошибка сервера. Дополнительные сведения см. В необработанном ответе сервера в сообщении об ошибке. Если вы получили эту ошибку, сообщите полный текст сообщения об ошибке в наш канал поддержки отчетов об ошибках .

Отправлять сообщения с использованием устаревших протоколов сервера приложений

Если вы предпочитаете использовать устаревшие протоколы, создавайте запросы сообщений, как показано в этом разделе. Имейте в виду, что если вы отправляете на несколько платформ через HTTP, протокол v1 может упростить ваши запросы сообщений.

Отправлять сообщения на определенные устройства

Чтобы отправлять сообщения на определенные устройства, установите to ключа регистрации токен для конкретного экземпляра приложения. См. Информацию о настройке клиента для вашей платформы, чтобы узнать больше о токенах регистрации.

HTTP POST запрос

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}

HTTP-ответ

{ "multicast_id": 108,
  "success": 1,
  "failure": 0,
  "results": [
    { "message_id": "1:08" }
  ]
}

Сообщение XMPP

<message id="">
  <gcm xmlns="google:mobile:data">
    { "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  }
  </gcm>
</message>

XMPP ответ

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "from":"REGID",
      "message_id":"m-1366082849205"
      "message_type":"ack"
  }
  </gcm>
</message>

Сервер соединений XMPP предоставляет некоторые другие варианты ответов. См. Формат ответа сервера .

Полный список параметров сообщений, доступных при отправке нисходящих сообщений в клиентские приложения, см. В справочной информации для выбранного вами протокола сервера соединений, HTTP или XMPP .

Отправлять сообщения в темы

Отправка сообщений в тему Firebase Cloud Messaging очень похожа на отправку сообщений на отдельное устройство или группу пользователей. Сервер устанавливает приложение на to ключ со значением , как /topics/yourTopic . Разработчики могут выбрать любое название темы, которое соответствует регулярному выражению: "/topics/[a-zA-Z0-9-_.~%]+" .

Для того, чтобы отправить комбинации нескольких тем, сервер приложений необходимо установить condition ключ (вместо to ключу) в логическом условие , которое определяет целевое тем. Например, чтобы отправлять сообщения на устройства, подписанные на TopicA и TopicB или TopicC :

'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)

FCM сначала оценивает любые условия в скобках, а затем вычисляет выражение слева направо. В приведенном выше выражении пользователь, подписанный на какую-либо отдельную тему, не получает сообщение. Аналогичным образом, пользователь, не подписанный на TopicA, не получит сообщение. Эти комбинации действительно получают:

  • Тема A и Тема B
  • TopicA и TopicC

В условное выражение можно включить до пяти тем. Поддерживаются круглые скобки. Поддерживаемые операторы: && , || , ! . Обратите внимание на использование ! :

!('TopicA' in topics)

С помощью этого выражения все экземпляры приложений, которые не подписаны на TopicA, включая экземпляры приложений, не подписанных ни на одну тему, получают сообщение.

Дополнительные сведения о ключах сервера приложений см. В справочной информации для выбранного вами протокола сервера подключения, HTTP или XMPP . Примеры на этой странице показывают, как отправлять сообщения в темы как в HTTP, так и в XMPP.

Тема HTTP POST-запрос

Отправить в отдельную тему:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA


Отправлять на устройства с подпиской на темы «собаки» или «кошки»:

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA


HTTP-ответ темы

//Success example:
{
  "message_id": "1023456"
}

//failure example:
{
  "error": "TopicsMessageRateExceeded"
}

Тема сообщения XMPP

Отправить в отдельную тему:

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

Отправлять на устройства с подпиской на темы «собаки» или «кошки»:

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

Тема XMPP ответ

//Success example:
{
  "message_id": "1023456"
}

//failure example:
{
  "error": "TopicsMessageRateExceeded"
}

Ожидайте до 30 секунд задержки, прежде чем сервер FCM вернет успешный или неудачный ответ на запросы отправки темы. Обязательно установите значение тайм-аута сервера приложений в запросе соответствующим образом.

Полный список параметров сообщения см. В справочной информации для выбранного вами протокола сервера подключения, HTTP или XMPP .

Отправлять сообщения группам устройств

Отправка сообщений группе устройств очень похожа на отправку сообщений на отдельное устройство. Задайте to параметра to уникальный ключ уведомления для группы устройств. См. Типы сообщений для получения подробной информации о поддержке полезной нагрузки. Примеры на этой странице показывают, как отправлять сообщения с данными группам устройств по протоколам HTTP и XMPP.

HTTP-запрос POST группы устройств

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{
  "to": "aUniqueKey",
  "data": {
    "hello": "This is a Firebase Cloud Messaging Device Group Message!",
   }
}

HTTP-ответ группы устройств

Вот пример «успеха» - с notification_key связано 2 регистрационных токена, и сообщение было успешно отправлено им обоим:

{
  "success": 2,
  "failure": 0
}

Вот пример «частичного успеха» - с notification_key связаны 3 регистрационных токена. Сообщение было успешно отправлено только на 1 из токенов регистрации. В ответном сообщении перечислены токены регистрации, которым не удалось получить сообщение:

{
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

Когда сообщение не может быть доставлено одному или нескольким маркерам регистрации, связанным с notification_key , сервер приложений должен повторить попытку с отсрочкой между попытками.

Если сервер пытается отправить сообщение группе устройств, у которой нет членов, ответ будет выглядеть следующим образом: 0 успехов и 0 ошибок:

{
  "success": 0,
  "failure": 0
}

Сообщение XMPP группы устройств

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "to": "aUniqueKey",
      "message_id": "m-1366082849205" ,
      "data": {
          "hello":"This is a Firebase Cloud Messaging Device Group Message!"
      }
  }
  </gcm>
</message>

Ответ XMPP группы устройств

Когда сообщение успешно отправлено на любое из устройств в группе, сервер соединений XMPP отвечает ACK. Если все сообщения, отправленные на все устройства в группе, терпят неудачу, сервер соединений XMPP отвечает NACK.

Вот пример «успеха» - с notification_key связаны 3 регистрационных токена, и сообщение было успешно отправлено всем из них:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success": 3,
  "failure": 0,
  "message_id": "m-1366082849205"
}

Вот пример «частичного успеха» - с notification_key связаны 3 регистрационных токена. Сообщение было успешно отправлено только на 1 из токенов регистрации. В ответном сообщении перечислены токены регистрации, которым не удалось получить сообщение:

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

Когда сервер соединений FCM не может доставить на все устройства в группе. Сервер приложений получит ответ «нет».

Полный список параметров сообщения см. В справочной информации для выбранного вами протокола сервера подключения, HTTP или XMPP .

Устаревшие методы отправки Firebase Admin SDK

SDK Firebase Admin Node.js поддерживает методы отправки (FCM) сообщений на основе устаревшего API сервера FCM . Эти методы принимают разные аргументы по сравнению с методом send() . По возможности следует использовать метод send() и использовать только методы, описанные на этой странице, при отправке сообщений на отдельные устройства или группы устройств.

Отправить на отдельные устройства

Вы можете передать токен регистрации sendToDevice() чтобы отправить сообщение на это устройство:

Node.js

// This registration token comes from the client FCM SDKs.
var registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
var payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device corresponding to the provided
// registration token.
admin.messaging().sendToDevice(registrationToken, payload)
  .then(function(response) {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch(function(error) {
    console.log('Error sending message:', error);
  });

Метод sendToDevice() также может отправлять многоадресное сообщение (то есть сообщение на несколько устройств), передавая массив регистрационных токенов вместо одного регистрационного токена:

Node.js

// These registration tokens come from the client FCM SDKs.
var registrationTokens = [
  'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...',
  // ...
  'ecupwIfBy1w:APA91bFtuMY7MktgxA3Au_Qx7cKqnf...'
];

// See the "Defining the message payload" section below for details
// on how to define a message payload.
var payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the devices corresponding to the provided
// registration tokens.
admin.messaging().sendToDevice(registrationTokens, payload)
  .then(function(response) {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch(function(error) {
    console.log('Error sending message:', error);
  });

Метод sendToDevice() возвращает обещание, которое разрешается с помощью объекта MessagingDevicesResponse содержащего ответ от FCM. Тип возврата имеет тот же формат при передаче одного токена регистрации или массива токенов регистрации.

Некоторые случаи, такие как ошибка аутентификации или ограничение скорости, приводят к невозможности обработки всего сообщения. В этих случаях обещание, возвращаемое sendToDevice() , отклоняется с ошибкой. Полный список кодов ошибок, включая описания и шаги по устранению, см. В разделе Ошибки API администратора FCM .

Отправить в группу устройств

Обмен сообщениями между группами устройств позволяет добавлять несколько устройств в одну группу. Это похоже на обмен сообщениями по темам, но включает аутентификацию, чтобы гарантировать, что членство в группе управляется только вашими серверами. Например, если вы хотите отправлять разные сообщения на разные модели телефонов, ваши серверы могут добавлять / удалять регистрации в соответствующие группы и отправлять соответствующее сообщение каждой группе. Обмен сообщениями между группами устройств отличается от обмена сообщениями по темам тем, что он включает управление группами устройств с серверов, а не непосредственно в приложении.

Вы можете использовать обмен сообщениями между группами устройств через устаревшие протоколы XMPP или HTTP на сервере приложений. SDK Firebase Admin для Node.js, основанный на устаревших протоколах, также предоставляет возможности обмена сообщениями между группами устройств. Максимальное количество членов, разрешенное для ключа уведомления - 20.

Вы можете создавать группы устройств и генерировать ключи уведомлений через сервер приложений или клиент Android. Подробнее см. Управление группами устройств .

Метод sendToDeviceGroup() позволяет отправить сообщение группе устройств, указав ключ уведомления для этой группы устройств:

Node.js

// See the "Managing device groups" link above on how to generate a
// notification key.
var notificationKey = 'some-notification-key';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
var payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device group corresponding to the provided
// notification key.
admin.messaging().sendToDeviceGroup(notificationKey, payload)
  .then(function(response) {
    // See the MessagingDeviceGroupResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch(function(error) {
    console.log('Error sending message:', error);
  });

Метод sendToDeviceGroup() возвращает обещание, которое разрешается с помощью объекта MessagingDeviceGroupResponse содержащего ответ от FCM.

В некоторых случаях, таких как ошибка аутентификации или ограничение скорости, сообщение не может быть обработано целиком. В этих случаях обещание, возвращаемое sendToDeviceGroup() , отклоняется с ошибкой. Полный список кодов ошибок, включая описания и шаги по устранению, см. В разделе Ошибки API администратора FCM .

Определение полезной нагрузки сообщения

Вышеупомянутые методы, основанные на устаревших протоколах FCM, принимают полезную нагрузку сообщения в качестве второго аргумента и поддерживают как уведомления, так и сообщения данных . Вы можете указать один или оба типа сообщений, создав объект с ключами data и / или notification . Например, вот как определить различные типы полезных данных сообщения:

Уведомительное сообщение

var payload = {
  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.'
  }
};

Сообщение данных

var payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

Комбинированное сообщение

var payload = {
  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.'
  },
  data: {
    stock: 'GOOG',
    open: '829.62',
    close: '635.67'
  }
};

Полезные данные уведомляющих сообщений имеют предопределенный набор допустимых свойств и незначительно отличаются в зависимости от целевой мобильной операционной системы. Полный список см. В справочной документации для NotificationMessagePayload .

Полезные данные сообщения данных состоят из настраиваемых пар ключ-значение с некоторыми ограничениями, включая тот факт, что все значения должны быть строками. См. Справочную документацию для DataMessagePayload для получения полного списка ограничений.

Определение параметров сообщения

Вышеупомянутые методы, основанные на устаревших протоколах FCM, принимают необязательный третий аргумент, определяющий некоторые параметры сообщения. Например, в следующем примере на устройство отправляется сообщение с высоким приоритетом, срок действия которого истекает через 24 часа:

Node.js

// This registration token comes from the client FCM SDKs.
var registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section above for details
// on how to define a message payload.
var payload = {
  notification: {
    title: 'Urgent action needed!',
    body: 'Urgent action is needed to prevent your account from being disabled!'
  }
};

// Set the message as high priority and have it expire after 24 hours.
var options = {
  priority: 'high',
  timeToLive: 60 * 60 * 24
};

// Send a message to the device corresponding to the provided
// registration token with the provided options.
admin.messaging().sendToDevice(registrationToken, payload, options)
  .then(function(response) {
    console.log('Successfully sent message:', response);
  })
  .catch(function(error) {
    console.log('Error sending message:', error);
  });

См. Справочную документацию по MessagingOptions для получения полного списка доступных параметров.