Amazon Pinpointコネクタの構成ガイド | サーバーサイドコネクタ

API情報

このコネクタは、次のベンダーAPIを使用します：

API名：Amazon Pinpoint API
APIバージョン：v1
APIエンドポイント：https://pinpoint.us-east-1.amazonaws.com
ドキュメント：Amazon Pinpointドキュメント

コネクタアクション

アクション名	AudienceStream	EventStream
メッセージの送信	✓	✓
プッシュ通知の送信	✓	✓
テンプレートの送信	✓	✓
イベントの登録	✓	✓
エンドポイントの更新	✓	✓

構成の構成

コネクタマーケットプレイスに移動し、新しいコネクタを追加します。コネクタの追加方法については、コネクタの概要の記事を参照してください。

コネクタを追加した後、次の構成を構成します：

アクセスキー
- 必須：IAMユーザーのアクセスキーを入力してください
- 関連するIAMポリシー（IAMユーザーまたはアサームドロールのいずれか）は、mobiletargeting:*、ses:*、sms-voice:\*の権限を付与する必要があります
- 追加情報については、Amazon Pinpointを参照してください。
シークレットキー
- 必須
- IAMユーザーのシークレットキーを入力してください
リージョン
- 必須
- リージョンを選択してください
アサームドロール：ARN
- オプション
- アサームドロールのAmazonリソース名（ARN）を入力してください
- 例：arn:aws:iam::222222222222:role/myrole
- 追加情報については、IAMロールへの切り替えを参照してください。
アサームドロール：セッション名
- オプション
- アサームドロールセッションの識別子を入力してください
アサームドロール：外部ID
- オプション
- 外部識別子を入力してください
- 詳細については、外部IDの使用方法を参照してください。

アクション構成 - パラメータとオプション

次へをクリックするか、アクションタブに移動します。ここでは、コネクタアクションを構成します。

このセクションでは、各アクションのパラメータとオプションの構成方法について説明します。

アクション - メッセージの送信

パラメータ

パラメータ	説明
アプリケーションID	必須アプリケーションの一意の識別子です。この識別子は、Amazon PinpointコンソールのプロジェクトIDとして表示されます。
メッセージタイプ	メッセージタイプオプションはEmail、SMS、またはVoiceです。 Addresses（テンプレート）、Endpoints（テンプレート）またはDestinationのいずれかが必要で、それぞれ1つだけ許可されます。 Destination、Body、Titleのフィールドは、Addresses（テンプレート）の構築に使用されます。 SMS SMSメッセージタイプの場合、Bodyは必須です。メッセージタイプの有効な値は、`TRANSACTIONAL`または`PROMOTIONAL`です。
テンプレート変数	オプションテンプレートにデータ入力として使用するテンプレート変数を指定します。詳細については、Webhook Send Custom Request Template Variables Guideを参照してください。ドット表記法を使用してネストされたテンプレート変数の名前を指定します。例：`items.name` ネストされたテンプレート変数は、通常、データレイヤーリスト属性から構築されます。
テンプレート	オプション URL、URLパラメータ、ヘッダー、またはボディデータで参照するテンプレートを指定します。詳細については、Webhook Send Custom Request Trimou Templating Engine Guideを参照してください。テンプレートは、サポートされるフィールドに二重の中括弧で名前を挿入します。例：`{{SomeTemplateName}}`
文字セット	メッセージコンテンツの文字セットマッピングです。
HTMLパート	テキストパートまたはHTMLパートのいずれか1つのみが許可されます。
件名	必須メールの件名です。
テキストパート	テキストまたはHTMLです。すべてのテキストまたはすべてのHTMLを使用します。
Raw Email	Type=Emailが選択されている場合にのみ使用されます。メールメッセージを表す生のMIMEメッセージです。メッセージ全体はBase64でエンコードする必要があります。

アクション - プッシュ通知の送信

パラメータ

パラメータ	説明
アプリケーションID	アプリケーションの一意の識別子です。この識別子は、Amazon PinpointコンソールのプロジェクトIDとして表示されます。
プッシュ通知タイプ	プッシュ通知タイプです。カスタムで入力するか、ADM、AMPS、BAIDU、GCMのいずれかを選択します。
テンプレート変数	オプションテンプレートにデータ入力として使用するテンプレート変数を指定します。詳細については、Webhook Send Custom Request Template Variables Guideを参照してください。ドット表記法を使用してネストされたテンプレート変数の名前を指定します。例：`items.name` ネストされたテンプレート変数は、通常、データレイヤーリスト属性から構築されます。
テンプレート	オプション URL、URLパラメータ、ヘッダー、またはボディデータで参照するテンプレートを指定します。詳細については、Webhook Send Custom Request Trimou Templating Engine Guideを参照してください。テンプレートは、サポートされるフィールドに二重の中括弧で名前を挿入します。例：`{{SomeTemplateName}}`

アクション - テンプレートの送信

パラメータ

パラメータ	説明
アプリケーションID	アプリケーションの一意の識別子です。この識別子は、Amazon PinpointコンソールのプロジェクトIDとして表示されます。
テンプレートタイプ	テンプレートタイプオプションはEmail、Push、SMS、Voice、またはCustomです。
Addresses（テンプレート）	Addresses（テンプレート）、Endpoints（テンプレート）、またはDestinationが必要です。 Addresses（テンプレート）、Endpoint（テンプレート）、またはDestinationのいずれか1つだけ許可されます。 Destination、Body、Titleのフィールドは、Addresses（テンプレート）の構築に使用されます。
Context（テンプレート）	オブジェクトカスタム属性をアドレスの属性にマッピングするオブジェクトで、メッセージに添付されます。属性は大文字と小文字を区別します。プッシュ通知の場合、このペイロードは`data.pinpoint`オブジェクトに追加されます。メールまたはテキストメッセージの場合、このペイロードはメール/ SMS配信レシートイベント属性に追加されます。
Destination	Addresses（テンプレート）、Endpoints（テンプレート）、またはDestinationが必要です。 Addresses（テンプレート）、Endpoint（テンプレート）、またはDestinationのいずれか1つだけ許可されます。 Destination、Body、Titleのフィールドは、Addresses（テンプレート）の構築に使用されます。
Endpoints（テンプレート）	Addresses（テンプレート）、Endpoints（テンプレート）、またはDestinationが必要です。 Addresses（テンプレート）、Endpoint（テンプレート）、またはDestinationのいずれか1つだけ許可されます。 Destination、Body、Titleのフィールドは、Addresses（テンプレート）の構築に使用されます。
名前	文字列メッセージに使用するメッセージテンプレートの名前です。指定する場合、この値は既存のメッセージテンプレートの名前と一致する必要があります。
TraceId	文字列メッセージのトレースのための一意の識別子です。この識別子は、メッセージイベントで表示されます。
バージョン	文字列メッセージに使用するメッセージテンプレートのバージョンの一意の識別子です。指定する場合、この値は既存のテンプレートバージョンの識別子と一致する必要があります。テンプレートのバージョンとバージョン識別子のリストを取得するには、Template Versionsリソースを使用します。このプロパティの値を指定しない場合、Amazon Pinpointはテンプレートのアクティブなバージョンを使用します。アクティブなバージョンは通常、最新のバージョンではなく、最後に確認および承認されたテンプレートのバージョンです。
テンプレート変数	オプションテンプレートにデータ入力として使用するテンプレート変数を指定します。詳細については、Webhook Send Custom Request Trimou Templating Engine Guideを参照してください。ドット表記法を使用してネストされたテンプレート変数の名前を指定します。例：`items.name` ネストされたテンプレート変数は、通常、データレイヤーリスト属性から構築されます。
テンプレート	オプション URL、URLパラメータ、ヘッダー、またはボディデータで参照するテンプレートを指定します。詳細については、Webhook Send Custom Request Trimou Templating Engine Guideを参照してください。テンプレートは、サポートされるフィールドに二重の中括弧で名前を挿入します。例：`{{SomeTemplateName}}`

アクション - イベントの登録

パラメータ

パラメータ	説明
アプリケーションID	アプリケーションの一意の識別子です。この識別子は、Amazon PinpointコンソールのプロジェクトIDとして表示されます。
アプリパッケージ名	文字列イベントを記録するアプリのパッケージ名です。
アプリタイトル	文字列イベントを記録するアプリのタイトルです。
アプリバージョンコード	文字列イベントを記録するアプリのバージョン番号です。
クライアントSDKバージョン	文字列クライアントデバイスで実行されているSDKのバージョンです。
イベントタイプ	必須文字列イベントの名前です。
SDK名	文字列イベントの記録に使用されるSDKの名前です。
タイムスタンプ	文字列イベントが発生した日時（ISO 8601形式）です。
イベント属性	オブジェクトイベントに関連付けられた1つ以上のカスタム属性です。
イベントメトリクス	オブジェクトイベントに関連付けられた1つ以上のカスタムメトリクスです。
期間	整数セッションの期間（ミリ秒単位）です。
ID	必須文字列セッションの一意の識別子です。
開始タイムスタンプ	文字列セッションが開始した日時です。
停止タイムスタンプ	文字列セッションが終了した日時です。
アドレス	文字列デバイストークン、メールアドレス、または携帯電話番号など、受信者の一意の識別子です。
人口統計的アプリバージョン	文字列エンドポイントに関連付けられたアプリのバージョンです。
人口統計的ロケール	文字列エンドポイントのロケールです。形式はISO 639-1のアルファ2コード、アンダースコア（_）で区切られたISO 3166-1のアルファ2値です。
人口統計的メーカー	文字列エンドポイントデバイスの製造元です。例：Apple、Samsung
人口統計的モデル	文字列エンドポイントデバイスのモデル名または番号です。例：iPhone、SM-G900F
人口統計的モデルバージョン	文字列エンドポイントデバイスのモデルバージョンです。
人口統計的プラットフォーム	文字列エンドポイントデバイスのプラットフォームです。例：ios
人口統計的プラットフォームバージョン	文字列エンドポイントデバイスのプラットフォームバージョンです。
人口統計的タイムゾーン	文字列エンドポイントのタイムゾーンです。タイムゾーンは、`tz`データベース名値（例：America/Los_Angeles）として指定されます。
有効日	文字列エンドポイントが最後に更新された日時（ISO 8601 UTC形式）です。
エンドポイントID	必須
エンドポイントステータス	文字列メッセージまたはプッシュ通知をエンドポイントに送信するかどうかを指定します。有効な値は次のとおりです： ACTIVE：メッセージがエンドポイントに送信されます。 INACTIVE：メッセージがエンドポイントに送信されません。 Amazon Pinpointは、エンドポイントを作成するか、既存のエンドポイントを更新すると、この値を自動的にACTIVEに構成します。 Amazon Pinpointは、`address`プロパティで指定されたアドレスを持つ別のエンドポイントを更新する場合、この値を自動的にINACTIVEに構成します。
場所の都市	文字列エンドポイントが位置する都市の名前です。
場所の国	文字列エンドポイントが位置する国または地域の2文字コードです（ISO 3166-1のアルファ2形式）。例：アメリカ合衆国の場合はen_US
場所の緯度	数値エンドポイントの位置の緯度座標です（小数点以下1桁に丸められます）。
場所の経度	数値エンドポイントの位置の経度座標です（小数点以下1桁に丸められます）。
場所の郵便番号	文字列エンドポイントが位置する地域の郵便番号または郵便番号です。
場所の地域	文字列エンドポイントが位置する地域の名前です。アメリカ合衆国の場合、値は州の名前です。
リクエストID	文字列エンドポイントを作成または更新するリクエストの一意の識別子です。
ユーザーID	文字列ユーザーの一意の識別子です。
エンドポイント属性	エンドポイントを説明する1つ以上のカスタム属性です。
エンドポイントメトリクス	エンドポイントに関連付けられた1つ以上のカスタムメトリクスです。
エンドポイントユーザー属性	ユーザーを説明する1つ以上のカスタム属性で、名前と値の配列を関連付けます。
エンドポイントチャネルタイプ	エンドポイントにメッセージまたはプッシュ通知を送信する際に使用するチャネルです。
エンドポイントのオプトアウト	エンドポイントに関連付けられたユーザーがメッセージやプッシュ通知の受信を拒否しているかどうかを指定します。

アクション - エンドポイントの更新

パラメータ

パラメータ	説明
アプリケーションID	アプリケーションの一意の識別子です。この識別子は、Amazon PinpointコンソールのプロジェクトIDとして表示されます。
アドレス	文字列受信者の一意の識別子（デバイストークン、メールアドレス、または携帯電話番号など）です。
人口統計的アプリバージョン	文字列エンドポイントに関連付けられたアプリのバージョンです。
人口統計的ロケール	文字列エンドポイントのロケールです。形式はISO 639-1のアルファ2コード、アンダースコア（_）で区切られたISO 3166-1のアルファ2値です。
人口統計的メーカー	文字列エンドポイントデバイスの製造元です。例：Apple、Samsung
人口統計的モデル	文字列エンドポイントデバイスのモデル名または番号です。例：iPhone、SM-G900F
人口統計的モデルバージョン	文字列エンドポイントデバイスのモデルバージョンです。
人口統計的プラットフォーム	文字列エンドポイントデバイスのプラットフォームです。例：ios
人口統計的プラットフォームバージョン	文字列エンドポイントデバイスのプラットフォームバージョンです。
人口統計的タイムゾーン	文字列エンドポイントのタイムゾーンです。タイムゾーンは、`tz`データベース名値（例：America/Los_Angeles）として指定されます。
有効日	ISO 8601 UTC形式の有効日です。
エンドポイントステータス	文字列メッセージまたはプッシュ通知をエンドポイントに送信するかどうかを指定します。有効な値は次のとおりです： ACTIVE：メッセージがエンドポイントに送信されます。 INACTIVE：メッセージがエンドポイントに送信されません。 Amazon Pinpointは、エンドポイントを作成するか、既存のエンドポイントを更新すると、この値を自動的にACTIVEに構成します。 Amazon Pinpointは、`address`プロパティで指定されたアドレスを持つ別のエンドポイントを更新する場合、この値を自動的にINACTIVEに構成します。
ID	必須文字列セッションの一意の識別子です。
場所の都市	文字列エンドポイントが位置する都市の名前です。
場所の国	文字列エンドポイントが位置する国または地域の2文字コードです（ISO 3166-1のアルファ2形式）。例：アメリカ合衆国の場合はen_US
場所の緯度	数値エンドポイントの位置の緯度座標です（小数点以下1桁に丸められます）。
場所の経度	数値エンドポイントの位置の経度座標です（小数点以下1桁に丸められます）。
場所の郵便番号	文字列エンドポイントが位置する地域の郵便番号または郵便番号です。
場所の地域	文字列エンドポイントが位置する地域の名前です。アメリカ合衆国の場合、値は州の名前です。
リクエストID	文字列リクエストまたはレスポンスの一意の識別子です。
ユーザーID	文字列ユーザーの一意の識別子です。
エンドポイント属性	エンドポイントを説明する1つ以上のカスタム属性です。
エンドポイントメトリクス	エンドポイントに関連付けられた1つ以上のカスタムメトリクスです。
エンドポイントユーザー属性	ユーザーを説明する1つ以上のカスタム属性で、名前と値の配列を関連付けます。
エンドポイントチャネルタイプ	エンドポイントにメッセージまたはプッシュ通知を送信する際に使用するチャネルです。
エンドポイントのオプトアウト	エンドポイントに関連付けられたユーザーがメッセージやプッシュ通知の受信を拒否しているかどうかを指定します。有効な値はALLまたはNONEです。