ドキュメントCampaignCampaign のテクニカルノート

v7 v8

プッシュ通知チャネルの変更

Last update: Tue Oct 08 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：
  • プッシュ

作成対象：

  • 経験者
  • 管理者

Campaign を使用すると、iOS および Android デバイスにプッシュ通知を送信できます。これを実行するには、Campaign をモバイルアプリケーションの購読サービスに依存させます。

2024 年に Android Firebase Cloud Messaging（FCM）サービスに対するいくつかの重要な変更をリリースします。このリリースは、Adobe Campaign の実装に影響を与える場合があります。この変更をサポートするには、Android プッシュメッセージの購読サービス設定を更新する必要がある場合があります。

さらに、アドビでは、証明書ベースの接続ではなく、より安全で拡張性の高いトークンベースの APN への接続に移行することを強くお勧めします。

Google Android Firebase Cloud Messaging（FCM）サービス

変更点

Google のサービス向上への継続的な取り組みの一環として、レガシー FCM API は 2024年7月22日（PT） ​に廃止されます。Firebase Cloud Messaging HTTP プロトコルについて詳しくは、Google Firebase ドキュメントを参照してください。

Adobe Campaign Classic v7 および Adobe Campaign v8 では、プッシュ通知メッセージを送信するための最新の API を既にサポートしています。ただし、古い実装の中には、依然としてレガシー API に依存するものもあります。これらの実装は更新する必要があります。

影響の有無

現在の実装がレガシー API を使用して FCM に接続する購読サービスをサポートしている場合は、影響を受けます。サービスの中断を避けるために、最新の API へのトランジションは必須です。その場合、アドビのチームがご連絡させていただきます。

影響を受けるかどうかを確認するには、以下のフィルターに従って​ サービスと購読 ​をフィルタリングします。

  • アクティブなプッシュ通知サービスのいずれかで HTTP（レガシー） API を使用している場合、設定はこの変更によって直接影響を受けます。現在の設定を確認し、以下で説明する新しい API に移行する必要があります。

  • 設定で Android プッシュ通知用の HTTP v1 API のみを使用している場合は、既に準拠しているので、追加のアクションは必要ありません。

更新方法

前提条件

  • モバイルアプリケーションを HTTP v1 に移行するには、Android Firebase Admin SDK サービスのアカウント JSON ファイルが必要です。このファイルを取得する方法について詳しくは、Google Firebase ドキュメントを参照してください。

  • Campaign Classic v7 の場合、20.3.1 リリースで HTTP v1 のサポートを追加しました。環境が古いバージョンで実行されている場合、HTTP v1 へのトランジションの前提条件は、環境を最新の Campaign Classic ビルドにアップグレードすることです。Campaign v8 の場合、HTTP v1 はすべてのリリースでサポートされ、アップグレードは必要ありません。

  • Campaign Classic v7 オンプレミスユーザーは、マーケティング実行サーバーとリアルタイム実行サーバーの両方をアップグレードする必要があります。

  • ハイブリッド、ホストおよび Managed Cloud Services のデプロイメントの場合は、以下のトランジション手順に加えて、アドビに連絡してリアルタイム（RT）実行サーバーを更新してください。

  • Android ルーティング外部アカウントについて：

    • Campaign Classic v7 オンプレミスまたはハイブリッドユーザーの場合は、Android ルーティング外部アカウントが androidPushConnectorV2.js で設定されていることを確認します。詳しくは、Campaign Classic v7 ドキュメントを参照してください。

    • ハイブリッド、ホストおよび Managed Cloud Services のデプロイメントの場合は、アドビカスタマーケアチームに連絡して、ミッドソーシングサーバーの Android ルーティング外部アカウントで androidPushConnectorV2.js (nms) コネクタが選択されていることを確認する必要もあります。

トランジション手順

環境を HTTP v1 に移行するには、次の手順に従います。

  1. サービスと購読 ​のリストを参照します。

  2. HTTP（レガシー） API バージョンを使用しているすべてのモバイルアプリケーションをリストします。

  3. これらの各モバイルアプリケーションに、API バージョン ​を HTTP v1 に設定します。

  4. 「プロジェクトの詳細を抽出するプロジェクトの JSON ファイルを読み込む…」リンクをクリックして、JSON キーファイルを直接読み込みます。

    次の詳細を手動で入力することもできます。

    • プロジェクト ID
    • 秘密鍵
    • クライアントメール

  5. 「接続をテスト」をクリックして、設定が正しいこと、およびマーケティングサーバーが FCM にアクセスできることを確認します。ミッドソーシングデプロイメントの場合、「接続をテスト」ボタンでは、サーバーが Android Firebase Cloud Messaging（FCM）サービスにアクセスできるかどうかを確認できません。

  6. オプションとして、必要に応じ、アプリケーション変数 ​を使用してプッシュメッセージのコンテンツを強化できます。これらは完全にカスタマイズ可能で、モバイルデバイスに送信されるメッセージペイロードの一部です。

  7. 「終了」、「保存」の順にクリックします。

    以下に、プッシュ通知をさらにパーソナライズするための FCM ペイロード名を示します。これらのオプションについて詳しくは、こちらを参照してください。

    メッセージタイプ
    設定可能なメッセージ要素（FCM ペイロード名）
    設定可能なオプション（FCM ペイロード名）
    データメッセージ
    該当なし
    validate_only
    通知メッセージ
    title、body、android_channel_id、icon、sound、tag、color、click_action、image、ticker、sticky、visibility、notification_priority、notification_count
    validate_only
NOTE
これらの変更をすべてのサーバーに適用すると、Android デバイスへのすべての​ 新しい ​プッシュ通知配信で HTTP v1 API が使用されます。再試行中、処理中、使用中の既存のプッシュ配信では、HTTP（レガシー）API を引き続き使用します。更新方法について詳しくは、以下の節を参照してください。

既存のテンプレートの更新

HTTP v1 のトランジションが完了したら、Android プッシュ通知の​ 配信テンプレート ​を更新して、バッチメッセージの数を増やす必要があります。これを行うには、Android 配信テンプレートのプロパティを参照し、「配信」タブでメッセージのバッチ数量を 256 に設定します。この変更を、Android 配信に使用するすべての配信テンプレートと、既存のすべての Android 配信に適用します。

HTTP v1 をサポートするバージョンにアップグレードする前に、作成済みの既存の配信と配信テンプレートを更新することもできます。次の手順を実行します。

  • Managed Cloud Services またはホスト環境のお客様は、アドビに連絡して、既存の Android 配信テンプレートを更新してください。

  • オンプレミス環境の場合は、fcm-httpv1-migration.js スクリプトをダウンロードし、以下で説明するように実行します。

    fcm-httpv1-migration.zip をダウンロードします。

    CAUTION
    スクリプトは、オンプレミスのマーケティングインスタンスで実行する必要があります。
    既存の配信とテンプレートを更新する手順（オンプレミスのみ）

    HTTP v1 をサポートするバージョンにアップグレードする前に、作成済みのすべての配信と配信テンプレートにパッチを適用するには、次の手順に従います。

    1. パッケージ内の既存の配信と配信テンプレートを書き出しておくと、パッチ適用中に予期しない問題が発生した場合にそれらを復元できるようになります。

    2. Posgresql で次のコマンドを実行します。

      pg_dump -Fp -f /sftp/<db_name>-nmsdelivery-before_rd_script.sql -t nmsdelivery -d <db_name>

    3. デフォルトでは、スクリプトは dryrun モードで実行され、そのモードでスクリプトを起動すると、一部の配信にパッチを適用する必要があるかどうかを確認できます。

      コマンド

      nlserver javascript -instance:<instance_name> -file fcm-httpv1-migration.js

      出力

      ...
HH:MM:SS >   Processing delivery (id:123456,  label:'Deliver on Android - New', name:'DM1234')
HH:MM:SS >   Dry run: Would update androidCheckParams for delivery (id:123456,  label:'Deliver on Android - New', name:'DM1234')
HH:MM:SS >   Processing delivery (id:567890,  label:'Deliver on Android - New', name:'DM5678')
HH:MM:SS >   Dry run: Would update androidCheckParams for delivery (id:567890,  label:'Deliver on Android - New', name:'DM5678')
...
HH:MM:SS >   Summary (XYZ processed deliverie(s) or delivery template(s)):
HH:MM:SS >>  - X had not patchable androidCheckParams formula!
HH:MM:SS >   - Y had androidCheckParams formula patched.
HH:MM:SS >   - Z ignored as alreading having androidCheckParams formula patched.
      NOTE
      not patchable 件の配信は手動で更新する必要があります。ID はログで確認できます。

    4. 次の方法で実行モードでスクリプトを実行して、配信を更新します。

      nlserver javascript -instance:<instance_name> -file fcm-httpv1-migration.js -arg:run

+++

Android アプリに対する影響

Android モバイルアプリケーションのコードに特別な変更は必要ありません。通知動作を変更しないでください。

ただし、HTTP v1 では、HTTPV1 その他のオプション ​を使用してプッシュ通知をさらにパーソナライズできます。

以下を行うことができます。

  • 「ティッカー」フィールドを使用して、通知のティッカーテキストを設定します。
  • 「画像」フィールドを使用して、通知に表示する画像の URL を設定します。
  • 「通知数」フィールドを使用して、アプリケーションアイコンに直接表示する新しい未読情報の数を設定します。
  • 「スティッキー」オプションを false に設定すると、ユーザーがクリックする際に、通知が自動的に閉じられます。true に設定した場合、ユーザーがクリックしても通知が表示されます。
  • 通知の​ 通知優先度 ​レベルを、デフォルト、最小、低、高のいずれかに設定します。
  • 通知の​ 表示 ​レベルをパブリック、プライベート、秘密のいずれかに設定します。

HTTP v1 その他のオプション ​とこれらのフィールドを設定する方法について詳しくは、FCM ドキュメントを参照してください。

Apple iOS プッシュ通知サービス（APNs）

変更点

Apple の推奨に従って、ステートレス認証トークンを使用して Apple プッシュ通知サービス（APNs）との通信を保護する必要があります。

トークンベースの認証では、APNs と通信するためのステートレスな方法を提供します。ステートレス通信は、APNs が証明書やプロバイダーサーバーに関連するその他の情報を検索する必要がないので、証明書ベースの通信より高速です。トークンベースの認証を使用することには他にも次のようなメリットがあります。

  • 複数のプロバイダーサーバーから同じトークンを使用できます。

  • 1 つのトークンを使用して、会社のすべてのアプリに関する通知を配布できます。

APNs へのトークンベースの接続について詳しくは、Apple 開発者向けドキュメントを参照してください。

Adobe Campaign Classic v7 および Adobe Campaign v8 は、トークンベースの接続と証明書ベースの接続の両方をサポートします。実装が証明書ベースの接続に依存している場合、アドビではトークンベースの接続に更新することを強くお勧めします。

影響の有無

現在の実装が APNs への接続に証明書ベースのリクエストに依存している場合、影響を受けます。トークンベースの接続へのトランジションをお勧めします。

影響を受けるかどうかを確認するには、以下のフィルターに従って​ サービスと購読 ​をフィルタリングします。

  • アクティブなプッシュ通知サービスのいずれかが​ 証明書ベースの認証 ​モード（.p12）を使用している場合は、現在の実装を確認し、以下で説明するように​ トークンベースの認証 ​モード（.p8）に移行する必要があります。

  • 設定で iOS プッシュ通知に​ トークンベースの認証 ​モードのみを使用している場合、実装は既に最新なので、追加のアクションは必要ありません。

更新方法

前提条件

  • Campaign Classic v7 の場合、トークンベースの認証 ​モードのサポートを 20.2 リリースで追加しました。環境が古いバージョンで実行されている場合、この変更の前提条件は、環境を最新の Campaign Classic ビルドにアップグレードすることです。Campaign v8 の場合、トークンベースの認証 ​モードはすべてのリリースでサポートされ、アップグレードは必要ありません。

  • サーバーが使用するトークンを生成するには、APNs 認証トークン署名キーが必要です。Apple 開発者向けドキュメントで説明するように、Apple 開発者アカウントからこのキーをリクエストします。

  • ハイブリッド、ホストおよび Managed Services のデプロイメントの場合は、以下のトランジション手順に加えて、アドビに連絡してリアルタイム（RT）実行サーバーを更新してください。ミッドソーシングサーバーは影響を受けません。

  • Campaign Classic v7 オンプレミスユーザーは、マーケティング実行サーバーとリアルタイム実行サーバーの両方をアップグレードする必要があります。ミッドソーシングサーバーは影響を受けません。

トランジション手順

iOS モバイルアプリケーションをトークンベースの認証モードに移行するには、次の手順に従います。

  1. サービスと購読 ​のリストを参照します。

  2. 証明書ベースの認証 ​モード（.p12）を使用してすべてのモバイルアプリケーションをリストします。

  3. これらの各モバイルアプリケーションを編集し、「証明書／秘密鍵」タブを参照します。

  4. 認証モード ​ドロップダウンから、トークンベースの認証 ​モード（.p8）を選択します。

  5. APNs 接続設定の​ キー ID、チーム ID、バンドル ID を入力し、「秘密鍵を入力…」をクリックして p8 証明書を選択します。

  6. 「接続をテスト」をクリックして、設定が正しいこと、およびサーバーが APNs にアクセスできることを確認します。ミッドソーシングデプロイメントの場合、「接続をテスト」ボタンでは、サーバーが APNs にアクセスできるかどうかを確認できません。

  7. 「次へ」をクリックして本番アプリケーションの設定を行い、上記と同じ手順に従います。

  8. 「終了」、「保存」の順にクリックします。

これで、iOS アプリケーションがトークンベースの認証モードに移行しました。

recommendation-more-help
c14bd44c-7b5f-474a-888d-1c2baee5a247