Expo SDKセットアップ

​

概要

​

要件

• 管理されたExpoアプリ。ベアReact Nativeアプリについては、React Native SDKセットアップを参照してください。
• Expo 開発ビルド
• Expo SDK 48+（手順ではバージョン54.0.8を使用）
• EAS CLI（EAS Buildドキュメント）
• React Native 0.71+（手順ではバージョン0.81.4を使用）
• 構成されたOneSignalアプリとプラットフォーム

• Xcode 14+を搭載したmacOS（セットアップ手順ではXcode 16.2を使用）
• iOS 12+、iPadOS 12+を搭載したデバイス、またはiOS 16.2+を実行しているXcodeシミュレーター
• CocoaPods 1.16.2+

• Android 7.0+デバイスまたはGoogle Play Store（Services）がインストールされたエミュレーター

​

配置您的 OneSignal 应用和平台

配置 OneSignal 应用的分步说明。

您可以在单个 OneSignal 应用下管理多个平台（iOS、Android、华为、Amazon、Web）。

1

创建或选择您的应用

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

示例显示创建新应用。

2

设置并激活平台

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

设置首个 OneSignal 应用、组织和频道的示例。

3

配置平台凭据

根据您的平台按照提示操作：

• Android：设置 Firebase 凭据
• iOS：p8 令牌（推荐） 或 p12 证书
• Amazon：生成 API 密钥
• 华为：授权 OneSignal

输入您的凭据后点击 保存并继续。

4

选择目标 SDK

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

选择您正在使用的 SDK 以导航到文档。

5

安装 SDK 并保存您的应用 ID

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

保存您的应用 ID 并邀请其他团队成员。

完成后，请遵循您所选平台的 SDK 安装指南以完成 OneSignal 集成。

​

SDKセットアップ

​

1. SDKを追加する

npx expo install onesignal-expo-plugin

npm install --save react-native-onesignal

​

2. プラグインを構成する

• "bundleIdentifier"：OneSignalアプリで使用しているp8またはp12認証に一致するアプリのバンドル識別子。
• "infoPlist"：UIBackgroundModesキーを["remote-notification"]に設定する必要があります。
• "entitlements"
  • aps-environmentキーをテスト用に"development"に、TestflightおよびApp Storeビルド用に"production"に設定する必要があります。
  • com.apple.security.application-groupsキーを["group.${ios.bundleIdentifier}.onesignal"]に設定する必要があります。
• "android"：packageキーをアプリのパッケージ名に設定する必要があります。
• "plugins"：アプリのplugins配列。プラグイン配列の先頭にプラグイン[onesignal-expo-plugin]を追加する必要があります。また、テスト用にmodeキーを"development"に、TestflightおよびApp Storeビルド用に"production"に設定する必要があります。

  {
    "expo": {
      "ios": {
        "bundleIdentifier": "com.yourcompany.yourapp",
        "infoPlist": {
          "UIBackgroundModes": ["remote-notification"]
        },
        "entitlements": {
          "aps-environment": "development",
          "com.apple.security.application-groups": [
            "group.${ios.bundleIdentifier}.onesignal"
          ]
        }
      },
      "android": {
        "package": "com.yourcompany.yourapp"
      },
      "plugins": [
        [
          "onesignal-expo-plugin",
          {
            "mode": "development"
          }
        ]
      ]
    }
  }

​

3. SDKを初期化する

import React, { useEffect } from 'react';
// Include the OneSignal package
import { OneSignal, LogLevel } from 'react-native-onesignal';

export default function App(): React.JSX.Element {
  // Initialize OneSignal in useEffect to ensure it runs only once
  useEffect(() => {
    // Enable verbose logging for debugging (remove in production)
    OneSignal.Debug.setLogLevel(LogLevel.Verbose);
    // Initialize with your OneSignal App ID
    OneSignal.initialize('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.
    OneSignal.Notifications.requestPermission(false);
  }, []); // Ensure this only runs once on app mount
}

​

Android 设置

​

iOSセットアップ

​

iOSでビルドする

​

iOSビルドの一般的なエラー

Cycle Inside... building could produce unreliable results.

Xcode 15+でビルドする場合、クロスプラットフォームシステムに影響するデフォルト構成の変更により、このエラーが表示される場合があります。

1. Xcodeで.xcworkspaceフォルダーを開き、アプリターゲット > Build Phasesに移動します。
2. **「Embed Foundation Extensions」または「Embed App Extensions」**というフェーズが必要です。
3. このビルドフェーズを**「Run Script」**の_上_にドラッグして移動します。
4. アプリをビルドして実行します。エラーが解決されるはずです。

Xcodeのビルドフェーズの正しい順序。

「Copy only when installing」のチェックを外します。

PBXGroupエラー

RuntimeError - PBXGroupが不明なISA PBXFileSystemSynchronizedRootGroupの属性からオブジェクトを初期化しようとしました：{"isa"=>"...", "exceptions"=>["//", "..."], "explicitFileTypes"=>{}, "explicitFolders"=>[], "path"=>"OneSignalNotificationServiceExtension", "sourceTree"=>"<group>"}

修正：

1. エラーの「path」の下にリストされているフォルダーを見つけます
2. Xcodeプロジェクトサイドバーで、フォルダーを右クリックします
3. **「Convert to Group」**を選択します

PBXGroupのパスエラー。

フォルダーをグループに変換します。

​

测试 OneSignal SDK 集成

​

检查移动端订阅

1

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

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

iOS 和 Android 推送权限提示

2

检查您的 OneSignal 控制台

在接受提示之前，请检查 OneSignal 控制台：

• 转到 受众 > 订阅。
• 您应该看到一个状态为”从未订阅”的新条目。

控制台显示 '从未订阅' 状态的订阅

3

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

4

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

订阅状态现在应该显示为已订阅。

控制台显示 '已订阅' 状态的订阅

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

​

设置测试订阅

1

添加到测试订阅。

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

将设备添加到测试订阅

2

为您的订阅命名。

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

控制台显示 '为您的订阅命名' 字段

3

创建测试用户分组。

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

4

为分组命名。

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

5

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

使用测试用户过滤器创建 'Test Users' 分组

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

​

通过 API 发送测试推送

1

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

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

2

更新提供的代码。

将下面代码中的 YOUR_APP_API_KEY 和 YOUR_APP_ID 替换为您的实际密钥。此代码使用我们之前创建的 Test Users 分组。

Copy

Ask AI

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

检查图片和确认送达。

如果所有设置步骤都成功完成，测试订阅应该会收到包含图片的通知：

iOS 和 Android 上包含图片的推送通知

图片在折叠的通知视图中会显得很小。展开通知以查看完整图片。

5

检查确认送达。

在您的控制台中，转到 送达 > 已发送消息，然后点击消息查看统计数据。您应该会看到已确认统计，表示设备收到了推送。

显示确认送达的送达统计

如果您使用的是专业版或更高版本，请滚动到受众活动以查看订阅级别的确认：

受众活动中设备级别的确认送达

您已成功通过我们的 API 向分组发送了通知。

• 没有收到图片？您的通知服务扩展可能缺失。
• 没有确认送达？请检查您的应用组设置。
• 遇到问题？将 API 请求和应用启动从开始到结束的日志复制粘贴到 .txt 文件中。然后将两者都发送给 support@onesignal.com。

​

发送应用内消息

1

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

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

2

创建应用内消息。

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

使用应用内消息定位 'Test Users' 分组

3

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

应用内欢迎消息的自定义示例

4

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

5

安排频率。

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

应用内消息安排选项

6

使消息生效。

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

7

打开应用并查看消息。

应用内消息生效后，打开您的应用。您应该会看到它显示：

在设备上显示的欢迎应用内消息

没有看到消息？

• 开始新会话
  • 您必须关闭或将应用切换到后台至少 30 秒后再重新打开。这可以确保开始新会话。
  • 更多信息，请参阅应用内消息如何显示。
• 仍在 Test Users 分组中？
  • 如果您重新安装或更换了设备，请重新将设备添加到测试订阅并确认它是 Test Users 分组的一部分。
• 遇到问题？
  • 在重现上述步骤时，请遵循获取调试日志。这将生成额外的日志，您可以与 support@onesignal.com 分享，我们将帮助调查正在发生的情况。

​

用户识别

​

分配外部 ID

​

添加数据标签

OneSignal 中带有名为'current_level'标签设置为'6'的用户档案

分组编辑器显示针对 current_level 值大于 4 且小于 10 的用户的分组

屏幕截图显示针对 5-10 级分组发送的个性化推送通知

iOS 和 Android 设备上收到的包含个性化内容的推送通知

​

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

• 使用addEmail 方法创建电子邮件订阅。
• 使用addSms 方法创建短信订阅。

通过外部 ID 统一的包含推送、电子邮件和短信订阅的用户档案

​

隐私和用户同意

• setConsentRequired(true)：阻止数据收集直到获得同意。
• setConsentGiven(true)：一旦获得同意即启用数据收集。

• SDK 收集的数据
• 处理个人数据

​

提示推送权限

​

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

​

推送通知事件

• addClickListener()：检测通知被点击时。对深度链接有帮助。
• addForegroundLifecycleListener()：控制通知在前台的行为方式。

​

用户状态变化

• addObserver() 用于用户状态：检测外部 ID 设置时。
• addPermissionObserver()：跟踪用户与原生推送权限提示的特定交互。
• addObserver() 用于推送订阅：跟踪推送订阅状态变化时。

​

应用内消息事件

• addClickListener()：处理应用内点击操作。适用于深度链接或跟踪事件。
• addLifecycleListener()：跟踪应用内消息的完整生命周期（显示、点击、关闭等）。

​

高级设置和功能

• 🔁 从其他服务迁移到 OneSignal
• 🌍 位置跟踪
• 🔗 深度链接
• 🔌 集成
• 🧩 移动端服务扩展
• 🛎️ 操作按钮
• 🌐 多语言消息
• 🛡️ 身份验证
• 📊 自定义结果
• 📲 Live Activities

​

移动端 SDK 设置和参考