ステップ 3: 追加のリクエストを送信する

Postman の設定とテストが完了したら、Amazon Pinpoint API に追加のリクエストの送信を開始することができます。このセクションには、リクエストの送信を開始する前に知っておく必要がある情報が記載されています。また、Amazon Pinpoint コレクションの使用方法の説明に役立つリクエスト例も 2 つ含まれています。

重要

このセクションの手順を完了したら、Amazon Pinpoint API へのリクエストを送信します。これらのリクエストでは、Amazon Pinpoint アカウントでの新しいリソースの作成、既存のリソースの変更、メッセージの送信、Amazon Pinpoint プロジェクトの設定の変更、その他の Amazon Pinpoint 機能の使用を行います。これらのリクエストを実行するときには注意が必要です。

Amazon Pinpoint Postman コレクションのほとんどのオペレーションは、使用する前に設定する必要があります。GET と DELETE オペレーションの場合、通常は、[Pre-request Script] タブで設定されている変数を変更するだけです。

注記

「IAM ポリシーの作成」に示されている IAM ポリシーを使用する場合、このコレクションに含まれるDELETEリクエストを実行することはできません。

例えば、GetCampaign オペレーションでは、projectId と campaignId を指定する必要があります。[Pre-request Script] タブには、これら両方の変が存在し、値の例が設定されています。値の例を削除し、Amazon Pinpoint プロジェクトとキャンペーンに該当する値に置き換えます。

これらの変数のうち、最も一般的に使用されるのは projectId 変数です。この変数の値は、リクエストが適用されるプロジェクトの一意の識別子であることが必要です。プロジェクトの識別子のリストを取得するには、このチュートリアルの前のステップで送信した GetApps リクエストに対するレスポンスを参照してください。そのレスポンスで、Id フィールドにプロジェクトの一意の識別子が表示されています。GetApps オペレーションおよびレスポンスの各フィールドの意味の詳細については、「Amazon Pinpoint APIリファレンス」の「Apps」を参照してください。

注記

Amazon Pinpoint では、「プロジェクト」は「アプリ」や「アプリアプリケーション」と同じです。

POST オペレーションと PUT オペレーションの場合、リクエスト本文を変更して、API に送信する値が含まれるようにする必要もあります。例えば、POST リクエストである CreateApp リクエストを送信するときには、作成するプロジェクトの名前を指定する必要があります。[本文] タブで、リクエストを変更することができます。この例では、"Name" の横にある値をプロジェクトの名前に置き換えます。プロジェクトにタグを追加するには、tags オブジェクトで指定します。または、タグを追加しない場合は、tags オブジェクト全体を削除することができます。

注記

UntagResource オペレーションでは、URL パラメータを指定する必要もあります。これらのパラメータは、[Params] タブで指定することができます。[VALUE] 列の値を、指定されたリソースについて削除するタグに置き換えます。

Amazon Pinpoint でセグメントおよびキャンペーンを作成する前に、まずプロジェクトを作成する必要があります。Amazon Pinpoint では、プロジェクトは、セグメント、キャンペーン、設定、および共通の目的で結合されたデータで構成されます。例えば、特定のアプリケーション、または特定のブランドまたはマーケティングイニシアティブに関連するすべてのコンテンツを含むプロジェクトを使用できます。Amazon Pinpoint にお客様の情報を追加すると、その情報はプロジェクトに関連付けられます。

CreateApp API リクエストを送信してプロジェクトを作成するには

環境メニューで、プロジェクト AWS リージョンを作成するを選択します。

この例では、[環境] メニューには次の 4 つのオプションが表示されるように Postman が設定されています。
- 米国東部 (バージニア北部)
- 米国西部 (オレゴン)
- 欧州 (フランクフルト)
- 欧州 (アイルランド)
Apps フォルダで、 CreateAppオペレーション > を選択します。

Amazon Pinpoint Postman コレクション内の [Apps] フォルダが展開され、次のリクエストが表示されます。
- GetApp
- GetApps
- CreateApp
- DeleteApp
[本文] タブの、"Name" の横にあるプレースホルダーの値 ("string") を、"MySampleProject" など、キャンペーンの名前に置き換えます。
キャンペーン名の後ろにあるカンマを削除し、3～5 行目にある tags オブジェクト全体を削除します。終了すると、リクエストは次のコードスニペットの例のようになります。
```
{
    "Name": "MySampleProject"
}
```
Postman は未加工の JSON ペイロードとしてリクエストを送信するように設定されています。

[送信] を選択します。キャンペーンが正常に作成された場合、[レスポンス] ペインに 201 Created のステータスが表示されます。


{
    "Name": "MySampleProject"
    "Id": "12345678901234567890123456789012",
    "Arn": "arn:aws:mobiletargeting:us-east-1:123456789012:apps/12345678901234567890123456789012",
    "tags": {}
}

トランザクションメッセージを送信するために Amazon Pinpoint SendMessages API を使用するのは非常に一般的です。キャンペーンを作成するのではなく、SendMessages API を使用してメッセージを送信する利点の 1 つは、E メールアドレス、電話番号、デバイストークンなど任意のアドレスにメッセージを送信できることです。メッセージの送信先のアドレスは、Amazon Pinpoint アカウント内に存在している必要はありません。この方法を、キャンペーンを作成してメッセージを送信する方法と比較してみましょう。Amazon Pinpoint でキャンペーンを送信する前に、Amazon Pinpoint アカウントにエンドポイントを追加し、セグメントを作成し、キャンペーンを作成し実行する必要があります。

このセクションの例は、特定の E メールアドレスに直接トランザクションメールメッセージを送信する方法を説明しています。このリクエストを変更して、SMS、モバイルプッシュ、または音声など、他のチャネル経由でメッセージを送信できます。

SendMessages リクエストを送信して E メールメッセージを送信するには

E メールチャネルがプロジェクトで有効になっており、メッセージの送受信に使用する E メールアドレスやドメインが設定されていることを確認します。詳細については、『Amazon Pinpoint ユーザーガイド』の「E メールチャネルの有効化と無効化」と「E メール ID の検証」を参照してください。

注記
このセクションの手順を実行するには、E メールアドレスを検証する必要があります。
環境メニューで、メッセージを送信 AWS リージョンするを選択します。

この例では、[環境] メニューには次の 4 つのオプションが表示されるように Postman が設定されています。
- 米国東部 (バージニア北部)
- 米国西部 (オレゴン)
- 欧州 (フランクフルト)
- 欧州 (アイルランド)
Messages フォルダで、 SendMessagesオペレーションを選択します。
[Pre-request Script] タブで、projectId 変数の値をこのセクションのステップ 2 で選択したリージョンに既に存在するプロジェクトの ID と置き換えます。

[本文] タブで、リクエストエディタに示されているリクエストの例を削除します。次のコードを貼り付けます。


{
    "MessageConfiguration":{
        "EmailMessage":{
            "FromAddress":"sender@example.com",
            "SimpleEmail":{
                "Subject":{
                    "Data":"Sample Amazon Pinpoint message"
                },
                "HtmlPart":{
                    "Data":"<h1>Test message</h1><p>This is a sample message sent from <a href=\"https://aws.amazon.com/pinpoint\">Amazon Pinpoint</a> using the SendMessages API.</p>"
                },
                "TextPart":{
                    "Data":"This is a sample message sent from Amazon Pinpoint using the SendMessages API."
                }
            }
        }
    },
    "Addresses":{
        "recipient@example.com": {
            "ChannelType": "EMAIL"
        }
    }
}

前述のコードで、sender@example.com を検証済みの E メールアドレスに置き換えます。recipient@example.com を、メッセージの送信先にする検証済み E メールアドレスに置き換えます。

注記
アカウントがまだ Amazon Pinpoint E メールサンドボックスにある場合は、Amazon Pinpoint アカウントで検証済みのアドレスまたはドメインにのみ E メールを送信できます。アカウントをサンドボックスから削除する方法については、『Amazon Pinpoint ユーザーガイド』の「 Requesting production access for email」を参照してください。

[送信] を選択します。メッセージが正常に送信された場合、[レスポンス] ペインに 200 OK のステータスが表示されます。


{
    "ApplicationId": "12345678901234567890123456789012",
    "RequestId": "<sampleValue>",
    "Result": {
        "recipient@example.com": {
            "DeliveryStatus": "SUCCESSFUL",
            "StatusCode": 200,
            "StatusMessage": "<sampleValue>",
            "MessageId": "<sampleValue>"
        }
    }
}

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

ステップ 2: Postman をセットアップする

SMS 登録システムのセットアップ