APIによるモバイルプッシュの送信

NTT CPaaSは、モバイルプッシュ通知用メッセージを送信したり、そのメッセージに関する分析情報を取得したりできるようにする信頼性の高いAPIを提供しています。このAPIは、トランザクション、情報やプロモーション関連のユースケースに使用できます。

APIによるモバイルプッシュの送信

モバイルプッシュ通知用メッセージを1人以上の受信者に送信したい時は、Send Push notifications (プッシュ通知を送信 (opens in a new tab)メソッドを使用します。APIの構造は、どのチャネルにも対応できるように統一されていますので、アプリと容易に統合できます。モバイルプッシュ通知パラメーターを使用すると、特定のモバイルアプリケーションのユーザーまたはユーザーのセグメントをターゲットにすることができます。

以下のフィールドの構成を完了します。

Sender (送信者)

アプリケーションプロファイルの識別子です。NTT CPaaSのWebインターフェイスで作成した アプリケーションプロファイル のアプリケーションコードまたはアプリケーションIDを使用します。

Destination (送信先)

モバイルプッシュ通知用メッセージを単一の受信者に送信する場合は、次のいずれかのパラメータータイプを使用します：

• External user ID (外部ユーザーID)
• Email (メールアドレス)
• Phone number (電話番号)
• Registration (登録)

モバイルプッシュ通知用メッセージを複数の受信者に送信する場合は、Multiple (複数) を使用します。

詳しくは、このページの関連セクションをご参照ください。

パーソナライズされていないデバイスを持つ単一の受信者をターゲットにする場合

パーソナライズされていないデバイスとは、パーソナライズ化に必要な標準属性 (外部ユーザーID、メールアドレスまたは電話番号) のいずれにも関連付けられていないエンドユーザーのデバイスのことです。

パーソナライズされていないデバイスにモバイルプッシュ通知用メッセージを送信するには、次の操作を行います。

• 送信先のタイプ としてREGISTRATION (登録) を指定します。
• プッシュ通知登録IDを指定します。この値は、インストールするすべてのモバイルアプリケーションにデフォルトで使用できます。

コードサンプル

    "destinations": [
	{
	"pushRegistrationId": "DBE0B0B6-668E-491E-8EE8-2A3DB2C71CBE",
	"type": "REGISTRATION"
	}
	]

プッシュ通知登録ID

次の表に、プッシュ通知登録IDに関する情報を示します。

パーソナライズされたデバイスを持つ単一の受信者をターゲットにする場合

パーソナライズされたデバイスとは、パーソナライズされた標準属性 (外部ユーザーID、メールアドレスまたは電話番号) の1つ以上に紐づけられているエンドユーザーのデバイスのことです。

次のいずれかを送信先アドレスとして使用します。

これらは、デフォルトでは使用できないタイプのアドレスです。Mobile SDKまたはPeople APIで定義する必要があります。

• Android (opens in a new tab)
• iOS (opens in a new tab)
• Huawei (opens in a new tab)
• Flutter (opens in a new tab)
• React Native (opens in a new tab)
• Cordova (opens in a new tab)
• People API (opens in a new tab)

コードサンプル

    "destinations": [
	{
	"externalUserId": "customer_21234",
	"type": "EXTERNAL_USER_ID"
	}
	]

OR演算子を使って複数の受信者をターゲットにする場合

モバイルプッシュ通知用メッセージを複数の受信者に送信するには、次の操作を行います。

• 送信先の タイプ として MULTIPLE (複数) を指定します。
• 送信先パラメーターに複数の値を指定するには、<OR>演算子を使用します。

コードサンプル

    "destinations": [
     {
        "$or": [
          {
             "externalUserId": "customer_21234"
           },
           {
             "externalUserId": "customer_21235"
           }
         ],
         "type": "MULTIPLE"
     }
]

デバイス属性を使って複数の受信者をターゲットにする場合

デバイス属性に基づいて複数の受信者をターゲットにすることができます。

これらの送信先アドレスタイプは、デフォルトで有効になっています。

次の送信先アドレスの種類は、デフォルトでは使用できません。Mobile SDK で定義する必要があります。

モバイルプッシュ通知用メッセージを複数の受信者に送信するには、次の操作を行います。

• 送信先の タイプ として MULTIPLE (複数) を指定します。
• 送信先パラメーターに複数の値を指定したい場合は、<and>演算子と <or>演算子を使用します。

次の例では、すべてのiOSデバイスをターゲットにしています。

コードサンプル

    "destinations": [
     {
        "$or": [
          {
             "platform": "iOS"
           }
         ],
         "type": "MULTIPLE"
     }
]

高度なターゲティング

必要なユーザーセグメントを作成し、そのセグメントにモバイルプッシュ通知用メッセージを送信するには、次の操作を行います。

• 送信先の タイプ として MULTIPLE (複数) を指定します。
• <and>演算子と <or> 演算子を使用します。

例1

この例では、特定の電話番号に紐づけられている受信者が持っているすべての iOS デバイスがターゲットになります。

コードサンプル

"destinations": [
     {
        "$and": [
          {
             "platform": "iOS"
           }, 
          {
             "phoneNumber": "441134960001"
           }
         ],
         "type": "MULTIPLE"
     }
]

例2

この例では、以下の基準を両方とも満たす受信者のみがターゲットになります。

• カスタムデバイス属性である*Device type (デバイスタイプ)がPersonal (個人用)またはBusiness (業務用)*のどちらかであること。
• ターゲットにするデバイスが iOSであること。

コードサンプル

"destinations": [
     {
        "$and": [
          {
             "platform": "iOS"
           }, 
          {
             "DeviceType": "personal"
           }
           ],
        "$or": [
           {
            "DeviceType": "business"
           } 
           ],
         "type": "MULTIPLE"
     }
]

アプリケーション内でのプッシュ通知のミラーリング

Send push API (プッシュ通知送信用API) を使用すると、以下のシナリオでアプリケーション内に通知を表示できるようになります。

• プッシュ通知を表示するだけでなく、アプリ内でも通知を表示できるようにしたい場合。 例： アプリケーションを使用しているが、プッシュ通知を表示できないエンドユーザーに対してトランザクション情報をサポートする場合。
• プッシュ通知を表示せずに、アプリケーション内でのみ通知を表示できるようにしたい場合。このシナリオでは、通知は通知センターに表示されません。このオプションを使用するには、Silent (サイレント) をプッシュ通知タイプとして選択して有効にします。

メッセージ形式

アプリケーション内で通知を表示したい場合、以下の形式で表示できます：

• Modal (モーダル)：この表示形式を選択すると、通知が画面の一部に重なるようにポップアップとして表示されます。モーダルポップアップ形式は通常、エンドユーザーの注意を十分に引いて、何かを行うように促したい時に選択します。
• Banner (バナー)：この表示形式を選択すると、通知がモバイルアプリのコンテンツ上に小さな通知として一時的に表示されます。バナーとして表示される通知は、モバイルデバイスの画面の上部または下部に表示され、数秒後に自動的に閉じます。バナー形式は通常、アプリを操作中のエンドユーザーに、その操作を中断させることなく、何かを知らせる必要がある時に選択します。

SDKの対応バージョン

アプリ内でメッセージを表示できるSDKバージョンは、以下の通りです。

通知パラメーター

アプリ内で通知を送信するには、notificationOptionsに以下のパラメーターを追加します。

APIによる統計データの取得

一括で送信されたプッシュ通知用メッセージの統計データを取得するには、 一括プッシュ通知用メッセージ統計メソッド (opens in a new tab)を使用します。

クエリパラメーター

応答形式

エラー

配信

OMNI APIによるプッシュ通知の送信

OMNI APIは、定義された順序に従って別のチャネルへの自動フォールバックを有効にします。

OMNI APIを使用してプッシュ通知を送信するには、以下の操作を行う必要があります：

• OMNIシナリオの作成
• OMNIシナリオに基づくメッセージの送信
• 配信レポートの取得 (任意)

OMNIシナリオの作成

OMNIシナリオを作成するには、順番に実行するOMNIステップを定義する必要があります。

シナリオに基づいてプッシュ通知を送信するには、モバイルアプリケーションのセットアップ中に生成された送信者 ("from": "APPLICATION CODE") としてプッシュ通知("channel": "PUSH")とAPPLICATION CODEを使用する必要があります。

OMNIシナリオの作成方法について詳しく知りたい時は、NTT CPaaS ドキュメントハブで入手できるモバイルアプリケーションプロファイルの作成 と題した記事をご参照ください。 また、NTT CPaaS API開発者ハブでは、OMNIシナリオの作成方法 (opens in a new tab)ついて詳述しているドキュメントもご参照いただけます。

最も一般的なOMNIシナリオは、SMSをフォールバックチャネルとして使用したプッシュ通知を送信するシナリオです。このようなシナリオを作成する方法については、下記のコードスニペットをご参照ください。

    {
      "name" : "push + SMS scenario",
      "flow": [
        {
          "from": "APPLICATION CODE",
          "channel": "PUSH"
        },
        {
          "from": "YOUR_REGISTERED_SMS_SENDER",
          "channel": "SMS"
        }
      ],
      "default": true
    }

OMNIシナリオに基づくメッセージの送信

OMNIシナリオ (keyパラメーターで識別) を作成したら、定義された通信チャネルを介してOMNIメッセージを送信できるようになります。

1つまたは複数のメッセージを異なるチャネルに送信する場合は、 高度なOMNIメッセージ送信メソッド (opens in a new tab)を使用する必要があります。

受信したプッシュ通知は、様々なオプションを使って処理できます。

このコードスニペットは、OMNI APIでオプションを使用してプッシュ通知を送信する方法を示しています。

    {
      "scenarioKey": "key",
      "destinations": [
        {
          "to": {
            "phoneNumber": "phone number"
          }
        }
      ],
      "push": {
        "text": "This PUSH message will pop up on your mobile device.",
        "customPayload": {
          "contentUrl": "https://someurl.com/content",
          "deepLink": "myApp://some/link"
        },
        "notificationOptions": {
          "vibrationEnabled": true,
          "soundEnabled": true,
          "soundName": "sound.wav",
          "badge": 1,
          "contentUrl": "http://www.mydomain.com/images/image1.jpg",
          "category": "mm_accept_decline",
          "inAppStyle": "MODAL",
          "title": "This is some title"
        },
        "targetOnlyPrimaryDevices": true,
        "includeNotificationsDisabledDevices": true
      },
      "sms": {
        "text": "This is the SMS failover message"
      }
    }

配信レポートの取得

OMNIレポート (opens in a new tab)メソッドを使用すると、送信したメッセージのステータスを確認したり、配信レポートを取得したりできます。