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 です。アドレス (テンプレート)、エンドポイント (テンプレート)、または宛先が必要で、それぞれ1つのみ許可されます。宛先、本文、およびタイトルのフィールドは、アドレス (テンプレート) を構築するために使用されます。 SMS SMS メッセージタイプの本文は必須です。メッセージタイプの有効な値は `TRANSACTIONAL` または `PROMOTIONAL` です。
テンプレート変数	オプションテンプレートにデータ入力としてテンプレート変数を提供してください。詳細についてはコネクターテンプレート変数を参照してください。ドット表記でネストされたテンプレート変数を名前付けしてください。例: `items.name` ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
テンプレート	オプション URL、URLパラメータ、ヘッダー、またはボディデータで参照されるテンプレートを提供してください。詳細についてはコネクタテンプレートについてを参照してください。テンプレートは、サポートされるフィールドに名前で二重中括弧で注入されます。例: `{{SomeTemplateName}}`。
文字セット	メッセージ内容の文字セットマッピング。
HTML パート	テキストパートまたはHTMLパートのいずれか一方のみが許可されます。
件名	必須メールの件名。
テキストパート	テキストまたはHTML。すべてのテキストまたはすべてのHTMLを使用します。
生のメール	タイプ=Emailが選択された場合のみ使用されます。生のMIMEメッセージとして表されるメールメッセージ。メッセージ全体をbase64でエンコードする必要があります。

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

パラメータ

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

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

パラメータ

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

アクション - イベントを追加する

パラメータ

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