SDK: Expoプラグイン

ステップ 1: パッケージをインストールする

@pushly/push-sdk-expo ネイティブ構成を適用します; @pushly/push-sdk-react-native インポート元となる実行時 SDK を提供します。両方をインストールしてください。

yarn add @pushly/push-sdk-expo @pushly/push-sdk-react-native

npm install --save @pushly/push-sdk-expo @pushly/push-sdk-react-native

ステップ 2: Expo 設定にプラグインを追加する

ステップ 2.1: Google Services

追加してください google-services.json ファイルを app ディレクトリに。

ステップ 2.2: app.config.js

Expo 設定にプラグインを追加し、App Group ID、Android アプリケーション ID（内側のパッケージと一致する必要があります google-services.json）、および以下へのパスを指定してください google-services.json ファイル:

export default {
  expo: {
    ...,
    plugins: [
      [
        '@pushly/push-sdk-expo',
        {
          ios: {
            nseTargetName: 'NotificationServiceExtension',
            nseBundleIdSuffix: '.NotificationServiceExtension',
            appGroupId: 'group.com.example.myapp.push',
            swiftVersion: '5.0',
          },
          android: {
            applicationId: 'com.example.myapp',
            googleServicesFile: './app/google-services.json',
            applyGoogleServicesPlugin: true,
          },
        },
      ],
    ],
  },
};

プロパティ

定義

ios.nseTargetName

NotificationServiceExtension のユーザー定義名。 デフォルト: NotificationServiceExtension

ios.nseBundleIdSuffix

NotificationServiceExtension のバンドル ID サフィックス。値は PRODUCT_BUNDLE_IDENTIFIER 環境変数に追加されます。 デフォルト: .NotificationServiceExtension

ios.appGroupId

PushSDK が情報を適切に取得できるようにするには、コンテナ名を group.{app-bundle-id}.push.

ios.swiftVersion

pbxproj ファイル内で NotificationServiceExtension ターゲットを設定するために使用されます。 デフォルト: 5.0

android.applicationId

Android アプリケーションで使用されるアプリケーション ID。デフォルトは android.package Expo 設定から。

android.googleServicesFile

プロジェクトのルートからの相対パスでの google-services.json ファイルの場所

android.applyGoogleServicesPlugin

Gradle で Google Services プラグインを適用すべきです。 デフォルト: true

実行 expo prebuild --clean （または EAS Build / カスタム dev クライアントを使用して）Pushly のセットアップが適用されたネイティブプロジェクトを生成します。

ステップ 3: iOS のセットアップ

ステップ 3.1: Pods のインストール

次の <project_root>/ios ディレクトリで次を実行: bundle exec pod install

ステップ 3.2: Notification Service Extension

1つの Notification Service Extension は、完全なリッチメディアと分析トラッキング機能を有効にするために必要です。このプラグインは prebuild 中に自動でインストールします。

使用する expo run:ios または EAS ビルドを使用して、NSE が自動的にインストールされるようにしてください。プロジェクトにチェックイン済みの ios/ ディレクトリがある場合、 expo prebuild は再生成されず、EAS は prebuild を完全にスキップします。その場合は、 npx expo prebuild --platform ios --clean を実行して、拡張機能をインストールしてください。

ビルドに拡張機能がインストールされたことを確認するには、IPA を確認します:

unzip -l YourApp.ipa | grep appex

次が表示されるはずです PlugIns/NotificationServiceExtension.appex。表示されない場合、拡張機能はインストールされていません — dev ビルドまたは EAS ビルドを使用していること、および prebuild が実行されたことを確認してください。

ステップ 4: SDK の初期化

あなたの index.tsx または app.tsx ファイルで、以下のサンプル実装コードを使用して PushSDK を初期化します。

次の REPLACE_WITH_SDK_KEY の setConfiguration メソッド内を、プラットフォームの設定ページにある SDK キーに置き換えてください。

...
import { PushSDK, LogLevel } from '@pushly/push-sdk-react-native';

export const App = () => {
    ...

    // PushSDK は useEffect ブロック内で初期化することを推奨します
    // アプリケーションが次の呼び出しを試みるのを防ぐためです
    // PushSDK.setConfiguration() を再レンダーのたびに実行するのを防ぐためです
    React.useEffect(() => {
        PushSDK.setLogLevel(LogLevel.INFO);
        PushSDK.setConfiguration({ appKey: 'REPLACE_WITH_SDK_KEY' });

        PushSDK.showNativeNotificationPermissionPrompt().then(({ granted }) => {
            console.log(`権限が付与されました: ${granted}`);
        });
    }, []);
    
    // アプリの残りの部分
    ...
};

Android デバイスまたはエミュレーター上でアプリケーションを実行し（エミュレーターに Google Play ストアサービス がインストールされていることを確認してください）、または iOS 向けにビルドする場合は iOS デバイス上で実行し、正しくビルドされることを確認してください。

前の手順で追加したコードにより、アプリを開くとプッシュ権限ダイアログが表示されます。これは SDK メソッドを使って、ダイアログを表示するタイミングを制御することでカスタマイズできます。

ダイアログを承認した後、プラットフォームにログインして Notifications > Create Notification に移動し、適切な ネイティブ: iOS または ネイティブ: Android チャネルを対象にして、最初の通知を送信してください。

次の手順

SDK が正しく動作していることを確認できたら、次のような追加のオプション機能を引き続き追加できます。

前へReact Native Expoプラグイン

次へExpoプラグイン変更履歴

最終更新 2 か月前