跳转到主要内容

​
概述

Android 推送通知对于推动您的 Android 应用中的持续用户参与度和留存率至关重要。它们使您能够直接向用户提供实时更新、提醒和个性化消息，改善整体用户体验和应用的粘性。OneSignal 利用 Firebase Cloud Messaging (FCM)，但旨在提供更多的灵活性和功能，如本指南所示。

​
要求

  • 安装了“Google Play Store（服务）”的 Android 7.0+ 设备或模拟器。
  • Android Studio（设置说明使用 Android Studio Meerkat）。
  • 已配置的 OneSignal 应用和平台。

​
配置您的 OneSignal 应用和平台

推送通知所需设置 要开始使用 OneSignal 发送推送通知，您必须首先为您支持的所有平台配置 OneSignal 应用——Apple (APNs)、Google (FCM)、华为 (HMS) 和/或 Amazon (ADM)。
如果您的组织已有 OneSignal 账户，请要求邀请您为管理员角色以配置应用。否则，请注册免费账户以开始使用。
您可以在单个 OneSignal 应用下管理多个平台（iOS、Android、华为、Amazon、Web）。
1

创建或选择您的应用

  • 要向现有应用添加平台，请在 OneSignal 控制台中转到 设置 > 推送和应用内。
  • 要重新开始，请点击 新应用/网站 并按照提示操作。
2

设置并激活平台

  • 为您的应用和组织选择一个清晰且易识别的名称。
  • 选择您要配置的平台（iOS、Android 等）。
  • 点击 下一步：配置您的平台。
3

配置平台凭据

根据您的平台按照提示操作：输入您的凭据后点击 保存并继续。
4

选择目标 SDK

选择与您的开发平台匹配的 SDK（例如，iOS、Android、React Native、Unity），然后点击 保存并继续。
5

安装 SDK 并保存您的应用 ID

配置好您的平台后，将显示您的 OneSignal 应用 ID。复制并保存此 ID——在安装和初始化 SDK 时您将需要它。如果与他人协作，请使用 邀请 按钮添加开发人员或团队成员，然后点击 完成 以完成设置。
完成后，请遵循您所选平台的 SDK 安装指南以完成 OneSignal 集成。

​
Android 设置

​
1. 添加 OneSignal SDK

在 Android Studio 中，打开您的 build.gradle.kts (Module: app) 或 build.gradle (Module: app) 文件，并将 OneSignal 添加到 dependencies 中。 
implementation("com.onesignal:OneSignal:[5.1.0, 5.1.99]")

​
同步 Gradle

添加依赖项后，同步您的项目：
  • 点击横幅中的 Sync Now
  • 或者转到 File > Sync Project with Gradle Files

​
2. 在 Application 类中初始化 SDK

最佳实践是在 Application 类的 onCreate 方法中初始化 OneSignal，以确保在所有入口点都正确设置 SDK。
创建一个新类（例如：ApplicationClass）并添加以下代码。
package com.your.package.name // Replace with your package name
import android.app.Application

class ApplicationClass : Application() {
  override fun onCreate() {
    super.onCreate()
    // OneSignal initialization will go here
  }
}
打开您应用的 AndroidManifest.xml在您的 <application> 标签中添加 android:name=".ApplicationClass"（如果您设置了不同的类名，请将 .ApplicationClass 替换为您的实际类名）。
xml
  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
      xmlns:tools="http://schemas.android.com/tools">

     <application
          android:name=".ApplicationClass"
          android:icon="@mipmap/ic_launcher"
          android:label="@string/app_name"
          ...
      </application>

  </manifest>
在您的 ApplicationClass 中，使用提供的方法初始化 OneSignal。 将 YOUR_APP_ID 替换为您在 OneSignal 仪表板中 设置 > 密钥和 ID 下找到的 OneSignal 应用 ID。如果您无法访问 OneSignal 应用，请让您的团队成员邀请您。 
package com.your.package.name // Replace with your package name

import android.app.Application
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch

import com.onesignal.OneSignal
import com.onesignal.debug.LogLevel

class ApplicationClass : Application() {
   override fun onCreate() {
      super.onCreate()

      // Enable verbose logging for debugging (remove in production)
      OneSignal.Debug.logLevel = LogLevel.VERBOSE
      // Initialize with your OneSignal App ID
      OneSignal.initWithContext(this, "YOUR_APP_ID")
      // Use this method to prompt for push notifications.
      // We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
      CoroutineScope(Dispatchers.IO).launch {
         OneSignal.Notifications.requestPermission(true)
      }
   }
}
不建议在 Activity（如 MainActivity）中初始化，因为在从深度链接或通知的应用冷启动时可能不会被调用。始终在您的 Application 类中初始化 OneSignal 以确保可靠性。

​
3. 自定义默认图标

我们建议配置您的通知图标以匹配您应用的品牌。否则，OneSignal 将使用默认的铃铛图标。

​
测试 OneSignal SDK 集成

本指南帮助您通过测试推送通知、订阅注册和应用内消息来验证 OneSignal SDK 集成是否正常工作。

​
检查移动端订阅

1

在测试设备上启动您的应用。

如果您在初始化时添加了 requestPermission 方法，原生推送权限提示应该会自动出现。
2

检查您的 OneSignal 控制台

在接受提示之前，请检查 OneSignal 控制台：
  • 转到 受众 > 订阅。
  • 您应该看到一个状态为”从未订阅”的新条目。
3

返回应用并在提示中点击允许。

4

刷新 OneSignal 控制台的订阅页面。

订阅状态现在应该显示为已订阅。
您已成功创建了移动端订阅。 移动端订阅是在用户首次在设备上打开您的应用时创建的，或者在同一设备上卸载并重新安装您的应用时创建的。

​
设置测试订阅

测试订阅有助于在发送消息之前测试推送通知。
1

添加到测试订阅。

在控制台中，在订阅旁边，点击选项（三个点）按钮并选择添加到测试订阅。
2

为您的订阅命名。

为订阅命名，以便您稍后能够在测试订阅标签中轻松识别您的设备。
3

创建测试用户分组。

转到 受众 > 分组 > 新建分组。
4

为分组命名。

将分组命名为 Test Users（名称很重要，因为稍后会使用到）。
5

添加测试用户过滤器并点击创建分组。

您已成功创建了测试用户分组。 现在我们可以测试向这个单独的设备和测试用户组发送消息。

​
通过 API 发送测试推送

1

获取您的应用 API 密钥和应用 ID。

在您的 OneSignal 控制台中，转到 设置 > 密钥和 ID。
2

更新提供的代码。

将下面代码中的 YOUR_APP_API_KEY 和 YOUR_APP_ID 替换为您的实际密钥。此代码使用我们之前创建的 Test Users 分组。
curl -X \
POST --url 'https://api.onesignal.com/notifications' \
 --header 'content-type: application/json; charset=utf-8' \
 --header 'authorization: Key YOUR_APP_API_KEY' \
 --data \
 '{
  "app_id": "YOUR_APP_ID",
  "target_channel": "push",
  "name": "Testing basic setup",
  "headings": {
  	"en": "👋"
  },
  "contents": {
    "en": "Hello world!"
  },
  "included_segments": [
    "Test Users"
  ],
  "ios_attachments": {
    "onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
  },
  "big_picture": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'
3

运行代码。

在您的终端中运行代码。
4

检查图片和确认送达。

如果所有设置步骤都成功完成，测试订阅应该会收到包含图片的通知：
图片在折叠的通知视图中会显得很小。展开通知以查看完整图片。
5

检查确认送达。

在您的控制台中，转到 送达 > 已发送消息，然后点击消息查看统计数据。您应该会看到已确认统计，表示设备收到了推送。
如果您使用的是专业版或更高版本，请滚动到受众活动以查看订阅级别的确认：
您已成功通过我们的 API 向分组发送了通知。
  • 没有收到图片？您的通知服务扩展可能缺失。
  • 没有确认送达？请检查您的应用组设置。
  • 遇到问题？将 API 请求和应用启动从开始到结束的日志复制粘贴到 .txt 文件中。然后将两者都发送给 [email protected]。

​
发送应用内消息

应用内消息让您可以在用户使用您的应用时与他们进行沟通。
1

在设备上关闭或将您的应用切换到后台。

这是因为用户必须在新会话开始_之前_满足应用内受众条件。在 OneSignal 中，当用户在应用处于后台或关闭至少 30 秒后重新打开应用时，会开始一个新会话。更多详情，请参阅我们的应用内消息如何显示指南。
2

创建应用内消息。

  • 在您的 OneSignal 控制台中，导航到 消息 > 应用内 > 新建应用内消息。
  • 找到并选择欢迎消息。
  • 将您的受众设置为我们之前使用的 Test Users 分组。
3

如需要，请自定义消息内容。

4

将触发器设置为 '应用打开时'。

5

安排频率。

在 安排 > 您希望多久显示一次此消息？ 下选择 每次触发条件满足时。
6

使消息生效。

点击 使消息生效，这样每次测试用户打开应用时都可以使用该消息。
7

打开应用并查看消息。

应用内消息生效后，打开您的应用。您应该会看到它显示：
没有看到消息？
  • 开始新会话
    • 您必须关闭或将应用切换到后台至少 30 秒后再重新打开。这可以确保开始新会话。
    • 更多信息，请参阅应用内消息如何显示。
  • 仍在 Test Users 分组中？
    • 如果您重新安装或更换了设备，请重新将设备添加到测试订阅并确认它是 Test Users 分组的一部分。
  • 遇到问题？
您已成功设置 OneSignal SDK 并学习了重要概念，如：继续阅读本指南以在您的应用中识别用户并设置其他功能。

​
用户识别

之前，我们演示了如何创建移动端订阅。现在我们将扩展到使用 OneSignal SDK 在所有订阅（包括推送、电子邮件和短信）中识别用户。我们将涵盖外部 ID、标签、多渠道订阅、隐私和事件跟踪，以帮助您统一用户并跨平台与他们互动。

​
分配外部 ID

使用外部 ID 通过您后端的用户标识符在设备、电子邮件地址和电话号码之间一致地识别用户。这确保您的消息传递在各个渠道和第三方系统中保持统一（对集成特别重要）。 每次您的应用识别用户时，使用我们 SDK 的login 方法设置外部 ID。
OneSignal 为订阅（订阅 ID）和用户（OneSignal ID）生成唯一的只读 ID。当用户在不同设备上下载您的应用、订阅您的网站，和/或在您的应用之外提供电子邮件地址和电话号码时，将创建新的订阅。强烈建议通过我们的 SDK 设置外部 ID，以在用户的所有订阅中识别用户，无论订阅是如何创建的。

​
添加数据标签

标签是字符串数据的键值对，您可以使用它们来存储用户属性（如 username、role 或偏好）和事件（如 purchase_date、game_level 或用户交互）。标签支持高级消息个性化和分组，允许更高级的用例。 在您的应用中发生事件时，使用我们 SDK 的addTag 和 addTags 方法设置标签。 在这个示例中，用户达到了第 6 级，可以通过名为 current_level 的标签识别，其值设置为 6。
我们可以创建一个等级在 5 到 10 之间的用户分组，并使用它来发送有针对性的个性化消息：


​
添加电子邮件和/或短信订阅

之前我们了解了我们的 SDK 如何创建移动端订阅来发送推送和应用内消息。您还可以通过创建相应的订阅，通过电子邮件和短信渠道联系用户。 如果电子邮件地址和/或电话号码在 OneSignal 应用中已存在，SDK 会将其添加到现有用户，不会创建重复项。 您可以通过控制台中的 受众 > 用户 或使用查看用户 API查看统一的用户。
多渠道沟通的最佳实践
  • 在添加电子邮件或短信订阅之前获得明确同意。
  • 向用户解释每个沟通渠道的好处。
  • 提供渠道偏好，让用户可以选择他们偏好的渠道。

​
隐私和用户同意

要控制 OneSignal 何时收集用户数据，请使用 SDK 的同意管控方法： 有关更多信息，请参阅我们的隐私和安全文档：

​
提示推送权限

不要在应用打开时立即调用 requestPermission()，而是采取更策略性的方法。在请求权限之前，使用应用内消息解释推送通知的价值。 有关最佳实践和实现细节，请参阅我们的提示推送权限指南。

​
监听推送、用户和应用内事件

使用 SDK 监听器来响应用户操作和状态变化。 SDK 提供了几个事件监听器供您使用。更多详情请参阅我们的SDK 参考指南。

​
推送通知事件

要进行完全自定义，请参阅移动端服务扩展。

​
用户状态变化

​
应用内消息事件

​
高级设置和功能

探索更多功能以增强您的集成：

​
移动端 SDK 设置和参考

通过查看移动端推送设置指南，确保您已启用所有关键功能。 有关可用方法和配置选项的完整详细信息，请访问移动端 SDK 参考。
恭喜！您已成功完成移动端 SDK 设置指南。

​
自定义通知布局

Android 12 及更高版本强制使用系统模板来显示自定义通知。但是，您仍然可以使用 Android 的标准通知样式来自定义您的布局。
针对 Android 12+ 的应用由于行为变更无法使用完全自定义布局。请参阅 Notification.DecoratedCustomViewStyle 了解可用的自定义选项。
自定义布局：

​
禁用默认打开行为

当点击通知时，OneSignal 将恢复您的应用，或在应用被滑动关闭时打开您的启动器 Activity。要防止 OneSignal 在点击通知时自动打开您的启动器 Activity，请将此内容添加到您的 AndroidManifest.xml 中：
AndroidManifest.xml
  <application ...>
     <meta-data android:name="com.onesignal.NotificationOpened.DEFAULT" android:value="DISABLE" />
  </application>
您必须在 Application 类的 onCreate 方法中实现自定义的通知打开监听器。您需要从此回调中调用 startActivity 将用户引导到您期望的 Activity。

​
后台数据和推送覆盖

​
从右到左 (RTL) 语言支持

要在通知和 UI 中支持 RTL 语言，请将此内容添加到您的 AndroidManifest.xml 中：
AndroidManifest.xml
  <application
    android:supportsRtl="true"
    ...
  </application>
确保测试所有 Activity 和视图以验证正确的 RTL 行为。 请参阅 Android 应用本地化文档 了解更多信息。
需要帮助？与我们的支持团队聊天或发送邮件至 [email protected]请包含以下信息：
  • 您遇到的问题详情以及复现步骤（如有）
  • 您的 OneSignal 应用 ID
  • 外部 ID 或订阅 ID（如适用）
  • 您在 OneSignal 控制台中测试的消息 URL（如适用）
  • 任何相关的日志或错误信息
我们很乐意为您提供帮助！