ADMメッセージのタイプ

Amazon Device Messaging（ADM）では、プッシュ通知（メッセージ）を使用して、アプリに関するメッセージをユーザーのデバイスに表示することができます。ADMメッセージを使用するには、まずアプリにADMを統合する必要があります。

• メッセージのタイプ
• データメッセージ
• 通知メッセージ
• データメッセージと通知メッセージ
• メッセージの動作
• メッセージの優先度
• ADMの統合に関するテスト

メッセージのタイプ

ADMにおいて、メッセージは開発者のアプリとサーバー間の通信手段です。ADMでは、次の表に示す3種類のメッセージを使用できます。

各メッセージタイプの詳細については、以下のセクションを参照してください。

データメッセージ

データメッセージは、カスタムロジックを使用して作成されるADMメッセージで、ADMを介してデバイスに渡されます。この通知のロジックはアプリで構成する必要があります。dataメッセージのメッセージペイロードの例を以下に示します。

{
    "data":
    {
        "key1":"value1",
        "key2":"value2"
    },
    "consolidationKey":"Some Key",
    "expiresAfter":86400
}

詳細については、メッセージの送信方法を参照してください。

通知メッセージ

ADM通知は、ADMからユーザーのデバイスに送信されるメッセージです。メッセージの処理と通知の送信は、ADM SDKが開発者に代わって行います。

プログラムで通知メッセージを送信するには、notificationキーを設定し、ユーザーに表示されるメッセージのキーと値のペアを追加します。たとえば、「新しい特典があります」などの通知メッセージを次のように設定できます。

{
    "notification":
    {
        "title":"ADMメッセージ通知",      
        "body":"新しい特典があります"
    }
    "expiresAfter":86400
}

通知メッセージでは、事前に定義されたキーと値のペアを使用する必要があります。ADM通知でサポートされるキーと値のペアを次の表に示します。

メッセージペイロードの定義の詳細については、メッセージの送信方法を参照してください。

データメッセージと通知メッセージ

notificationペイロードとdataペイロードを構成して、データメッセージのキーと値のペアを含む通知メッセージを送信することもできます。このシナリオでは、通知メッセージはADM SDKで処理され、データメッセージペイロードはアプリで処理されます。

通知メッセージとデータメッセージの両方を含むメッセージペイロードの例を以下に示します。

{
    "data":
    {
        "key1":"value1",
        "key2":"value2"
    },
    "notification":
    {
        "title":"ADMメッセージ通知",      
        "body":"新しい特典があります"
    }
    "expiresAfter":86400
}  

メッセージの動作

ADM SDKでは、メッセージの処理はonMessageメソッドで行われます。デバイスでのADMメッセージの動作は、アプリの状態（アプリがバックグラウンドにあるかフォアグラウンドにあるか）によって異なります。

フォアグラウンドのアプリは、デバイスがメッセージを受信すると、データメッセージと通知メッセージの両方のメッセージペイロードを受け取ります。バックグラウンドのアプリは、システムトレイで通知ペイロードを受け取り、ユーザーが通知をタップしたらメッセージを配信します。

アプリの状態に基づくメッセージの動作を次の表に示します。

メッセージの優先度

データメッセージおよび通知メッセージには、normal（通常）とhigh（高）の2つの優先度があります。どちらのメッセージタイプも、デフォルトの優先度はnormalです。

優先度がnormalのメッセージは、アプリがフォアグラウンドにある場合はすぐに配信されます。デバイスがDozeモードの場合は、アプリがフォアグラウンドに移行するまで配信が先送りされます。

優先度がhighのメッセージは、ユーザーのデバイスの状態に関係なく、ADMによって即時配信が試みられます。アプリが1日に受信できる優先度highのメッセージの数は、アプリスタンバイバケットに基づいて制限されます。

メッセージの優先度を設定するには、priorityパラメーターを使用します。優先度がhighのメッセージのリクエスト例を以下に示します。

{
    "data":{"key1":"value1","key2":"value2"},
    "priority":"high"
    "expiresAfter":86400
}

詳細については、メッセージの送信方法を参照してください。

ADMの統合に関するテスト

デバイスにテスト通知を送信することで、アプリにADMがセットアップされていることを確認できます。詳細については、メッセージの送信方法を参照してください。

Last updated: 2022年6月8日