Документація

01 / Підключити застосунок

Створення застосунку

Увійдіть через Google або підтверджену пошту й пароль. Відкрийте «Застосунки», створіть застосунок і виберіть Android. Налаштування iOS і Web можна зберегти на майбутнє.

Скопіюйте App ID з налаштувань. Це ідентифікатор PushPort, а не ID проєкту Firebase чи назва Android-пакета.

Перед початком

• Android-застосунок з API 23 або вище.
• Тестовий пристрій із Google Play Services і доступом до мережі.
• Доступ до Firebase-проєкту цього застосунку.

02 / Підключити застосунок

Підключення Firebase

Відкрийте потрібний проєкт у консолі Firebase. У Project settings → Service accounts створіть приватний JSON-ключ. Завантажте його в налаштування Android відповідного застосунку PushPort.

Приватний ключ зберігається на сервері — не додавайте його до Android-проєкту. Для цієї інтеграції PushPort застосунку не потрібні google-services.json і плагін Google Services. Власна незалежна інтеграція Firebase може залишитися.

• Використовуйте реквізити правильного Firebase-проєкту.
• Обмеження пакета має збігатися з Android applicationId.
• Firebase Analytics для даних про локаль не потрібна.

03 / Підключити застосунок

Встановлення Android SDK

SDK 0.3.0 поки поширюється як збірка Maven-репозиторію, а не через Maven Central. Запросіть збірку в підтримки й укажіть шлях до репозиторію в Gradle. Один AAR без метаданих не підключає транзитивні залежності.

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("/path/to/pushport-maven-repository")
            content { includeGroup("dev.pushport") }
        }
    }
}

dependencies {
    implementation("dev.pushport:android-sdk:0.3.0")
}

Ініціалізуйте SDK у класі Application і зареєструйте цей клас в AndroidManifest.xml. Якщо Application уже є, додайте виклик до нього. У застосунках із кількома процесами виконуйте ініціалізацію лише в основному.

import android.app.Application
import dev.pushport.sdk.PushPort

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        PushPort.initWithContext(this, "PUSHPORT_APP_ID")
    }
}

<application android:name=".MyApplication" />

PushPort.requestNotificationPermission(this)

• Запросіть дозвіл на сповіщення з видимої Activity, пояснивши користь.
• Firebase Messaging, WorkManager і компоненти маніфесту підключаються із залежністю.
• Запустіть застосунок, дозвольте сповіщення й знайдіть установку в «Аудиторії».

04 / Працювати з повідомленнями

Робота з аудиторією

В аудиторії показано установки. Одна людина з двома пристроями може бути присутня двічі. Фільтруйте за мовою, локаллю, приблизною країною та станом підписки; зберігайте корисні поєднання як сегменти.

SDK синхронізує локаль застосунку й системні локалі, часовий пояс, версію та стан сповіщень. Локаль de-DE відрізняється від мови de. Країна визначається приблизно за IP і може бути невідомою.

PushPort.setLocale(context, "de-DE")
PushPort.setLocale(context, null)
PushPort.setSubscribed(context, false)
PushPort.setSubscribed(context, true)
PushPort.sync(context)

• SUBSCRIBED — надсилання доступне за наявності токена й дозволу.
• UNSUBSCRIBED / PERMISSION_DENIED — сповіщення вимкнено застосунком або системою.
• AWAITING_TOKEN / INVALID_TOKEN — немає придатного токена.

05 / Працювати з повідомленнями

Надсилання й розклад

Відкрийте «Кампанії» вибраного застосунку. Збережіть чернетку із заголовком, текстом та аудиторією. Перевірте кількість доступних отримувачів і надішліть тест на свою установку.

Виберіть надсилання зараз або майбутню дату. Час показано в часовому поясі браузера й зберігається як UTC. Розклад виконується на сервері навіть після закриття сторінки.

• Пріоритет перекладу: точна локаль → мова → основний текст.
• Доступні одноразові розклади. Повтори та надсилання за місцевим часом отримувача ще не реалізовані.
• Скасування зупиняє повідомлення в очікуванні, але не відкликає вже передані FCM.

06 / Працювати з повідомленнями

Зображення та посилання

Укажіть загальнодоступне HTTPS-посилання на зображення й за потреби HTTPS-посилання переходу. В SDK 0.3.0 спочатку з’являється текст, а потім картинка, якщо її успішно завантажено.

Підтримуються PNG, JPEG і WebP до 1 МіБ: кожна сторона до 4096 пікселів, загалом до 8 мільйонів пікселів. Посилання з авторизацією й адреси приватних мереж не підходять.

• Зображення має залишатися доступним під час надсилання.
• Перевірте картинку й перехід на реальному пристрої.
• Якщо зображення не завантажилось, текст усе одно може відобразитися.

07 / Перевірити й розібратися

Результати надсилання

Прийняття FCM означає, що провайдер прийняв запит. Це не підтверджує показ на пристрої. Відкриття враховуються окремо, коли SDK повідомляє про натискання.

Дивіться результат кампанії разом зі станом установки. Недійсний токен і тимчасова помилка провайдера — різні причини. Невизначений результат не повторюється автоматично, щоб не створити дублікат.

• Перед повтором перевірте підписку й системний дозвіл.
• Аудиторія під час перегляду та в момент надсилання може відрізнятися.
• Для розбору проблеми порівняйте час та ID установки.

08 / Перевірити й розібратися

Розв’язання проблем

Якщо установки немає в списку, запустіть застосунок і перевірте App ID, доступ до сервера та ініціалізацію SDK. Якщо установка є, але недоступна, перевірте дозвіл, підписку й стан токена.

Якщо повідомлення прийнято, але не видно, перевірте мережу, налаштування сповіщень і вибрану установку. Якщо проблема лише із зображенням, відкрийте його URL без авторизації й перевірте формат і розмір.

• Немає листа з кодом: перевірте спам та адресу й зачекайте хвилину до нового запиту.
• Помилка Firebase: перевірте, чи реквізити відправника належать потрібному проєкту.
• Не допомогло? Напишіть через «Контакти»: App ID, приблизний час та очікуваний результат.