Отправьте тестовое сообщение в фоновое приложение Apple.

Чтобы начать работу с FCM , разработайте самый простой вариант использования: отправку тестового уведомления из композитора уведомлений на устройство разработки, когда приложение находится на устройстве в фоновом режиме. На этой странице перечислены все шаги для достижения этой цели — от настройки до проверки — здесь могут быть описаны шаги, которые вы уже выполнили, если вы настроили клиентское приложение Apple для FCM .

Добавьте Firebase в свой проект Apple

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

Предварительные условия

• Установите следующее:

  • Xcode 15.2 или новее

• Убедитесь, что ваш проект соответствует этим требованиям:

  • Ваш проект должен быть ориентирован на эти версии платформы или более поздние:
    • iOS 13
    • macOS 10.15
    • ТВОС 13
    • смотретьOS 7

• Настройте физическое устройство Apple для запуска вашего приложения и выполните следующие задачи:

  • Получите ключ аутентификации Apple Push Notification для своей учетной записи Apple Developer .
  • Включите push-уведомления в XCode в разделе «Приложение» > «Возможности» .

• Войдите в Firebase, используя свою учетную запись Google.

Если у вас еще нет проекта Xcode и вы просто хотите опробовать продукт Firebase, вы можете загрузить один из наших примеров быстрого запуска .

Создать проект Firebase

Прежде чем вы сможете добавить Firebase в свое приложение Apple, вам необходимо создать проект Firebase для подключения к вашему приложению. Посетите раздел «Понимание проектов Firebase» , чтобы узнать больше о проектах Firebase.

Создать проект Firebase

1. В консоли Firebase нажмите «Добавить проект» .

   • Чтобы добавить ресурсы Firebase в существующий проект Google Cloud , введите название его проекта или выберите его из раскрывающегося меню.

   • Чтобы создать новый проект, введите желаемое имя проекта. Вы также можете при желании изменить идентификатор проекта, отображаемый под названием проекта.

     Firebase генерирует уникальный идентификатор для вашего проекта Firebase на основе заданного вами имени. Если вы хотите отредактировать этот идентификатор проекта, вы должны сделать это сейчас, поскольку его нельзя изменить после того, как Firebase предоставит ресурсы для вашего проекта. Посетите раздел «Понимание проектов Firebase» , чтобы узнать, как Firebase использует идентификатор проекта.

2. При появлении запроса прочтите и примите условия Firebase .

3. Нажмите Продолжить .

4. (Необязательно) Настройте Google Analytics для своего проекта, что позволит вам оптимально использовать любой из следующих продуктов Firebase:

   Firebase Crashlytics Firebase Cloud Messaging

   Firebase In-App Messaging Firebase Remote Config

   Персонализация Remote Config Firebase A/B Testing

   Либо выберите существующую учетную запись Google Analytics , либо создайте новую учетную запись.

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

   Вы всегда можете настроить Google Analytics позже на вкладке «Интеграции» ваших . Настройки проекта .

5. Нажмите «Создать проект» (или «Добавить Firebase» , если вы используете существующий проект Google Cloud ).

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

Зарегистрируйте свое приложение в Firebase

Чтобы использовать Firebase в своем приложении Apple, вам необходимо зарегистрировать свое приложение в проекте Firebase. Регистрация вашего приложения часто называется «добавлением» вашего приложения в проект.

Примечание. Ознакомьтесь с нашими рекомендациями по добавлению приложений в проект Firebase, в том числе о том, как обрабатывать несколько вариантов.

1. Перейдите в консоль Firebase .

2. В центре страницы обзора проекта щелкните значок iOS+ , чтобы запустить рабочий процесс установки.

   Если вы уже добавили приложение в свой проект Firebase, нажмите «Добавить приложение» , чтобы отобразить параметры платформы.

3. Введите идентификатор пакета вашего приложения в поле идентификатора пакета .

   Что такое идентификатор пакета и где его найти?

   • Идентификатор пакета однозначно идентифицирует приложение в экосистеме Apple.

   • Найдите идентификатор своего пакета: откройте свой проект в Xcode, выберите приложение верхнего уровня в навигаторе проекта, затем выберите вкладку «Общие» .

     Значением поля «Идентификатор пакета» является идентификатор пакета (например, com.yourcompany.yourproject ).

   • Имейте в виду, что значение идентификатора пакета чувствительно к регистру и его нельзя изменить для этого приложения Firebase после его регистрации в вашем проекте Firebase.

   Обязательно введите идентификатор пакета, который фактически использует ваше приложение. Значение идентификатора пакета чувствительно к регистру, и его нельзя изменить для этого приложения Firebase Apple после его регистрации в вашем проекте Firebase.

4. (Необязательно) Введите другую информацию о приложении: псевдоним приложения и идентификатор App Store .

   Как псевдоним приложения и идентификатор App Store используются в Firebase?

   • Псевдоним приложения : внутренний удобный идентификатор, который виден только вам в консоли Firebase

   • Идентификатор App Store : используется Firebase Dynamic Links для перенаправления пользователей на вашу страницу в App Store и Google Analytics для импорта событий-конверсий в Google Ads . Если у вашего приложения еще нет идентификатора App Store, вы можете добавить его позже в настройках проекта .

5. Нажмите Зарегистрировать приложение .

Добавьте файл конфигурации Firebase

1. Нажмите «Загрузить GoogleService-Info.plist» , чтобы получить файл конфигурации платформы Firebase Apple ( GoogleService-Info.plist ).

   Что вам нужно знать об этом конфигурационном файле?

   • Файл конфигурации Firebase содержит уникальные, но несекретные идентификаторы вашего проекта. Чтобы узнать больше об этом файле конфигурации, посетите раздел «Понимание проектов Firebase» .

   • Вы можете снова загрузить файл конфигурации Firebase в любое время.

   • Убедитесь, что к имени файла конфигурации не добавлены дополнительные символы, например (2) .

2. Переместите файл конфигурации в корень вашего проекта Xcode. При появлении запроса выберите добавление файла конфигурации ко всем целевым объектам.

Если в вашем проекте есть несколько идентификаторов пакета, вы должны связать каждый идентификатор пакета с зарегистрированным приложением в консоли Firebase , чтобы каждое приложение могло иметь собственный файл GoogleService-Info.plist .

Добавьте Firebase SDK в свое приложение

Используйте Swift Package Manager для установки зависимостей Firebase и управления ими.

Посетите наше руководство по установке , чтобы узнать о различных способах добавления Firebase SDK в ваш проект Apple, включая прямой импорт фреймворков и использование CocoaPods.

1. В Xcode, открыв проект приложения, выберите «Файл» > «Добавить пакеты» .
2. При появлении запроса добавьте репозиторий Firebase SDK для платформ Apple:

  https://github.com/firebase/firebase-ios-sdk.git

Примечание. В новых проектах должна использоваться версия SDK по умолчанию (последняя), но при необходимости вы можете выбрать более старую версию.
3. Выберите библиотеку Firebase Cloud Messaging .
4. Добавьте флаг -ObjC в раздел «Другие флаги компоновщика» настроек сборки вашей цели.
5. Для оптимальной работы с Firebase Cloud Messaging мы рекомендуем включить Google Analytics в вашем проекте Firebase и добавить Firebase SDK для Google Analytics в ваше приложение. Вы можете выбрать библиотеку без коллекции IDFA или с коллекцией IDFA.
6. По завершении Xcode автоматически начнет разрешать и загружать ваши зависимости в фоновом режиме.

Загрузите свой ключ аутентификации APNs

Загрузите ключ аутентификации APN в Firebase. Если у вас еще нет ключа аутентификации APN, обязательно создайте его в Центре участников Apple Developer .

1. Внутри вашего проекта в консоли Firebase выберите значок шестеренки, выберите «Настройки проекта» , а затем выберите вкладку «Облачные сообщения» .

2. В разделе «Ключ аутентификации APN» в разделе «Конфигурация приложения iOS» нажмите кнопку «Загрузить» .

3. Перейдите в папку, в которой вы сохранили ключ, выберите его и нажмите «Открыть» . Добавьте идентификатор ключа (доступен в Центре участников Apple Developer ) и нажмите «Загрузить» .

Инициализируйте Firebase в своем приложении

Вам нужно будет добавить код инициализации Firebase в свое приложение. Импортируйте модуль Firebase и настройте общий экземпляр, как показано:

1. Импортируйте модуль FirebaseCore в свой UIApplicationDelegate , а также любые другие модули Firebase, которые использует ваш делегат приложения. Например, чтобы использовать Cloud Firestore и Authentication :

   SwiftUI

   import SwiftUI
   import FirebaseCore
   import FirebaseFirestore
   import FirebaseAuth
   // ...
         

   Быстрый

   import FirebaseCore
   import FirebaseFirestore
   import FirebaseAuth
   // ...
         

   Цель-C

   @import FirebaseCore;
   @import FirebaseFirestore;
   @import FirebaseAuth;
   // ...
         

2. Настройте общий экземпляр FirebaseApp в методе application(_:didFinishLaunchingWithOptions:) делегата вашего приложения:

   SwiftUI

   // Use Firebase library to configure APIs
   FirebaseApp.configure()

   Быстрый

   // Use Firebase library to configure APIs
   FirebaseApp.configure()

   Цель-C

   // Use Firebase library to configure APIs
   [FIRApp configure];

3. Если вы используете SwiftUI, вам необходимо создать делегат приложения и прикрепить его к структуре вашего App через UIApplicationDelegateAdaptor или NSApplicationDelegateAdaptor . Вы также должны отключить переключение делегатов приложений. Дополнительную информацию смотрите в инструкциях SwiftUI .

   SwiftUI

   @main
   struct YourApp: App {
     // register app delegate for Firebase setup
     @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate
   
     var body: some Scene {
       WindowGroup {
         NavigationView {
           ContentView()
         }
       }
     }
   }
         

Зарегистрируйтесь для удаленных уведомлений

Либо при запуске, либо в нужном месте потока приложения зарегистрируйте приложение для удаленных уведомлений. Вызовите registerForRemoteNotifications , как показано:

Примечание. Приложения SwiftUI должны использовать оболочки свойств UIApplicationDelegateAdaptor или NSApplicationDelegateAdaptor , чтобы предоставить тип, соответствующий соответствующему протоколу делегата приложения.

Быстрый

UNUserNotificationCenter.current().delegate = self

let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
UNUserNotificationCenter.current().requestAuthorization(
  options: authOptions,
  completionHandler: { _, _ in }
)

application.registerForRemoteNotifications()
AppDelegate.swift

Цель-C

[UNUserNotificationCenter currentNotificationCenter].delegate = self;
UNAuthorizationOptions authOptions = UNAuthorizationOptionAlert |
    UNAuthorizationOptionSound | UNAuthorizationOptionBadge;
[[UNUserNotificationCenter currentNotificationCenter]
    requestAuthorizationWithOptions:authOptions
    completionHandler:^(BOOL granted, NSError * _Nullable error) {
      // ...
    }];

[application registerForRemoteNotifications];
AppDelegate.m

Вы должны назначить свойство delegate UNUserNotificationCenter и свойство delegate FIRMessaging. Например, в приложении iOS назначьте его в методе applicationWillFinishLaunchingWithOptions: или applicationDidFinishLaunchingWithOptions: делегата приложения.

Доступ к регистрационному токену

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

По умолчанию FCM SDK создает токен регистрации для экземпляра клиентского приложения при запуске приложения. Подобно токену устройства APN, этот токен позволяет отправлять целевые уведомления любому конкретному экземпляру вашего приложения.

Точно так же, как платформы Apple обычно доставляют токен устройства APNs при запуске приложения, FCM предоставляет токен регистрации через метод messaging:didReceiveRegistrationToken: FIRMessagingDelegate . FCM SDK извлекает новый или существующий токен во время первоначального запуска приложения, а также всякий раз, когда токен обновляется или становится недействительным. Во всех случаях пакет SDK FCM вызывает messaging:didReceiveRegistrationToken: с действительным токеном.

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

Регистрационный токен может измениться в следующих случаях:

• Приложение восстанавливается на новом устройстве.
• Пользователь удаляет/переустанавливает приложение.
• Пользователь удаляет данные приложения.

Установите делегата обмена сообщениями

Чтобы получить токены регистрации, реализуйте протокол делегата обмена сообщениями и установите свойство delegate FIRMessaging после вызова [FIRApp configure] . Например, если делегат вашего приложения соответствует протоколу делегата обмена сообщениями, вы можете установить делегат в application:didFinishLaunchingWithOptions: на самого себя.

Быстрый

Messaging.messaging().delegate = self

Цель-C

[FIRMessaging messaging].delegate = self;

Получение текущего регистрационного токена

Токены регистрации доставляются с помощью метода messaging:didReceiveRegistrationToken: . Этот метод обычно вызывается один раз для каждого запуска приложения с использованием токена регистрации. Когда вызывается этот метод, это идеальное время для:

• Если регистрационный токен новый, отправьте его на сервер приложений.
• Подпишите регистрационный токен на темы. Это требуется только для новых подписок или в ситуациях, когда пользователь переустановил приложение.

Вы можете получить токен напрямую, используя token(completion:) . Ненулевая ошибка выдается, если получение токена каким-либо образом не удалось.

Быстрый

Messaging.messaging().token { token, error in
  if let error = error {
    print("Error fetching FCM registration token: \(error)")
  } else if let token = token {
    print("FCM registration token: \(token)")
    self.fcmRegTokenMessage.text  = "Remote FCM registration token: \(token)"
  }
}

Цель-C

[[FIRMessaging messaging] tokenWithCompletion:^(NSString *token, NSError *error) {
  if (error != nil) {
    NSLog(@"Error getting FCM registration token: %@", error);
  } else {
    NSLog(@"FCM registration token: %@", token);
    self.fcmRegTokenMessage.text = token;
  }
}];

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

Мониторинг обновления токена

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

Быстрый

func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String?) {
  print("Firebase registration token: \(String(describing: fcmToken))")

  let dataDict: [String: String] = ["token": fcmToken ?? ""]
  NotificationCenter.default.post(
    name: Notification.Name("FCMToken"),
    object: nil,
    userInfo: dataDict
  )
  // TODO: If necessary send token to application server.
  // Note: This callback is fired at each app startup and whenever a new token is generated.
}
AppDelegate.swift

Цель-C

- (void)messaging:(FIRMessaging *)messaging didReceiveRegistrationToken:(NSString *)fcmToken {
    NSLog(@"FCM registration token: %@", fcmToken);
    // Notify about received token.
    NSDictionary *dataDict = [NSDictionary dictionaryWithObject:fcmToken forKey:@"token"];
    [[NSNotificationCenter defaultCenter] postNotificationName:
     @"FCMToken" object:nil userInfo:dataDict];
    // TODO: If necessary send token to application server.
    // Note: This callback is fired at each app startup and whenever a new token is generated.
}
AppDelegate.m

Альтернативно вы можете прослушивать NSNotification с именем kFIRMessagingRegistrationTokenRefreshNotification вместо предоставления метода делегата. Свойство token всегда имеет текущее значение токена.

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

1. Установите и запустите приложение на целевом устройстве. На устройствах Apple вам необходимо принять запрос на разрешение на получение удаленных уведомлений.

2. Убедитесь, что приложение работает на устройстве в фоновом режиме.

3. В консоли Firebase откройте страницу «Сообщения» .

4. Если это ваше первое сообщение, выберите «Создать первую кампанию» .

   1. Выберите «Уведомительные сообщения Firebase» и выберите «Создать» .

5. В противном случае на вкладке «Кампании» выберите «Новая кампания» , а затем «Уведомления» .

6. Введите текст сообщения. Все остальные поля являются необязательными.

7. Выберите Отправить тестовое сообщение на правой панели.

8. В поле « Добавить регистрационный токен FCM» введите регистрационный токен, который вы получили в предыдущем разделе этого руководства.

9. Выберите Тест .

После того, как вы выберете «Тест» , целевое клиентское устройство (с приложением в фоновом режиме) должно получить уведомление.

Для получения более подробной информации о доставке сообщений в ваше приложение см. панель отчетов FCM , которая записывает количество сообщений, отправленных и открытых на устройствах Apple и Android, а также данные о «показах» (уведомлениях, которые видят пользователи) для приложений Android.

Следующие шаги

Чтобы выйти за рамки уведомлений и добавить в приложение другое, более продвинутое поведение, см.:

• Получайте сообщения в клиентском приложении Apple
• Отправка сообщений на несколько устройств