Iterable コネクタ構成ガイド | サーバーサイドコネクター

構成の構成

コネクタマーケットプレイスに移動して、新しいコネクタを追加します。詳細については、コネクタについてを参照してください。

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

ホスト
- EUベースのAPIエンドポイントの場合、https://app.eu.iterable.com を選択します。
- USベースのAPIエンドポイントの場合、https://app.iterable.com を選択します。
API キー

API キーを見つけるには、Iterable サイトで Integrations > API Keys に移動します。

サポートされるアクション

アクション名	AudienceStream	EventStream
イベントの追跡（バッチ処理）	✗	✓
ユーザーのアップサート（バッチ処理）	✓	✓
GDPRに準拠してユーザーを忘れる	✓	✓
ユーザーにSMS通知を送信	✓	✓
メールアドレスにメールを送信	✓	✓
ワークフローをトリガー	✓	✓
ユーザーを購読（ASのみ）	✓	✗
ユーザーの購読を解除（ASのみ）	✓	✗
リストにユーザーを購読	✓	✗
リストからユーザーを購読解除	✓	✗
ユーザーのメールを更新	✓	✓
ショッピングカートを更新	✓	✓
購入を追跡	✓	✓
顧客データをマージ	✓	✓

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

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

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

アクション — イベントの追跡（バッチ処理）

バッチ制限

このアクションは、バッチリクエストを使用してベンダーへの大量データ転送をサポートします。詳細については、バッチアクションを参照してください。リクエストは、次のいずれかの閾値が達成されるか、プロファイルが公開されるまでキューに入れられます：

最大リクエスト数：1000
最古のリクエストからの最大時間：10分
リクエストの最大サイズ：4 MB

パラメータ

パラメータ	説明
イベント名	必須。イベントの名前。
作成日時	イベントが発生した時間。指定されていない場合は、イベントが受信された時間に構成されます。Unixタイムスタンプを期待します。このフィールドがマッピングされていない場合、現在のタイムスタンプで初期化されます。
メール	メールまたはユーザーIDのいずれかを入力してユーザーを識別する必要があります。両方が入力されている場合は、メールが優先されます。
イベントID	入力されたIDのイベントが存在する場合、そのイベントは更新されます。イベントIDが指定されていない場合、新しいIDが自動的に生成され、返されます。このIDは512バイトを超えることはできません。
ユーザーID	`updateUser`コールに渡されたユーザーID。
キャンペーン	変換に関連するキャンペーン。詳細については、キャンペーンの紹介を参照してください。
プロジェクトテンプレート	テンプレートID。詳細については、テンプレートの紹介を参照してください。
データフィールド	イベントに関連する追加データ。たとえば、アイテムの金額や数量などです。同じ名前のイベントの場合、同じ名前のデータフィールドは同じタイプでなければなりません。
テンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数に名前を付けます。たとえば、`items.name`です。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
テンプレート	本文データで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。サポートされるフィールドに名前でテンプレートが注入されます。たとえば、`{{SomeTemplateName}}`です。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーを上書きするために、APIキーを入力するか、APIキーの属性をマッピングします。

アクション — ユーザーのアップサート（バッチ処理）

バッチ制限

最大リクエスト数：1000
最古のリクエストからの最大時間：10分
リクエストの最大サイズ：4 MB

パラメータ

パラメータ	説明
メール	プロファイルが既にユーザーIDで存在する場合を除き、メールを構成する必要があります。プロファイルが既に存在する場合は、ユーザーIDからメールへのルックアップが実行されます。
ネストされたオブジェクトのマージ	トップレベルのオブジェクトを上書きするのではなくマージします。デフォルト値は `False` です。たとえば、ユーザープロファイルに `{mySettings:{mobile:true}}` が含まれ、変更された連絡先フィールドに `{mySettings:{email:true}}` が含まれている場合、結果のプロファイルは `{mySettings:{mobile:true,email:true}}` を含みます。
ユーザーIDを優先	ユーザーがまだ存在しない場合は、指定されたユーザーIDで新しいユーザーを作成します。
ユーザーID	通常はデータベースで生成されたIDです。メールまたはユーザーIDのいずれかを指定する必要があります。
データフィールド	ユーザープロファイルに保存するデータフィールド。
テンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数に名前を付けます。たとえば、`items.name`です。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
テンプレート	本文データで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。サポートされるフィールドに名前でテンプレートが注入されます。たとえば、`{{SomeTemplateName}}`です。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーを上書きするために、APIキーを入力するか、APIキーの属性をマッピングします。

アクション — GDPRに準拠してユーザーを忘れる

パラメータ

パラメータ	説明
メール	指定されたユーザーのデータをIterableプロジェクトから削除し、今後のデータ収集を防ぎたい場合は、ユーザーのメールを提供します。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーを上書きするために、APIキーを入力するか、APIキーの属性をマッピングします。

アクション — ユーザーにSMS通知を送信

パラメータ

パラメータ	説明
キャンペーン	キャンペーンID。詳細については、キャンペーンの紹介を参照してください。
繰り返しマーケティング送信を許可	デフォルトはTrueです。
受信者のメール	メールまたはユーザーIDのいずれかを入力してユーザーを識別する必要があります。両方が入力されている場合は、メールが優先されます。
受信者のユーザーID	`updateUser`コールに渡されたユーザーID。
送信時刻	最大365日先までメッセージのスケジュールを構成します。過去に構成されている場合は、メッセージは即時に送信されます。予想される形式は `YYYY-MM-DD HH:MM:SS` です。データが適切にフォーマットされていることを確認してください。Dateタイプの属性が提供された場合、コネクタは上記の適切な日付形式に値を変換します。
データフィールド	テンプレートにマージするフィールド。
テンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数に名前を付けます。たとえば、`items.name`です。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
テンプレート	本文データで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。サポートされるフィールドに名前でテンプレートが注入されます。たとえば、`{{SomeTemplateName}}`です。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーを上書きするために、APIキーを入力するか、APIキーの属性をマッピングします。

アクション — メールアドレスにメールを送信

パラメータ

パラメータ	説明
キャンペーン	キャンペーンID。詳細については、Iterable: キャンペーンの紹介を参照してください。
繰り返しマーケティング送信を許可	デフォルトはTrueです。
受信者のメール	メールまたはユーザーIDのいずれかを入力してユーザーを識別する必要があります。両方が入力された場合、メールが優先されます。
受信者ユーザーID	`updateUser`コールに渡されたユーザーID。
送信時刻	メッセージを最大365日後までスケジュール可能です。過去に構成された場合、メッセージは即時に送信されます。期待される形式は`YYYY-MM-DD HH:MM:SS`です。データが適切にフォーマットされていることを確認してください。日付タイプの属性が提供された場合、コネクタは値を上記の適切な日付形式に変換します。
データフィールド	メールテンプレートにマージするフィールド。
メタデータ	Webhooksを介して返送されるメタデータ。レンダリングには使用されません。
テンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数を名前付けします。例：`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
テンプレート	本文データで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。サポートされるフィールドに名前でテンプレートを注入します。例：`{{SomeTemplateName}}`。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーをオーバーライドするためにAPIキーを入力するか、APIキーの属性をマッピングします。

アクション — ワークフローをトリガーする

パラメータ

パラメータ	説明
ワークフローID	トリガーするワークフローのID。詳細については、Iterable: ワークフローの紹介を参照してください。
リスト	リスト内のすべてのユーザーに対してワークフローをトリガーします。
メール	指定されたメールアドレスのワークフローをトリガーします。メールまたはリストのみでトリガーします。
データフィールド	トリガーイベントに関連する追加データ。
テンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数を名前付けします。例：`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
テンプレート	本文データで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。サポートされるフィールドに名前でテンプレートを注入します。例：`{{SomeTemplateName}}`。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーをオーバーライドするためにAPIキーを入力するか、APIキーの属性をマッピングします。

アクション — ユーザーを登録する（ASのみ）

パラメータ

パラメータ	説明
サブスクリプショングループ	サブスクリプショングループを選択します。
サブスクリプショングループID	メッセージチャンネル、メッセージタイプ、またはメールリストのIDを提供します。これにより、ユーザーを登録します。
メール	登録するユーザーのメールアドレスを提供します。
ユーザーID	登録するユーザーのユーザーIDを提供します。メールまたはユーザーIDのいずれかが指定されている必要があります。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーをオーバーライドするためにAPIキーを入力するか、APIキーの属性をマッピングします。

アクション — ユーザーの登録を解除する（ASのみ）

パラメータ

パラメータ	説明
サブスクリプショングループ	サブスクリプショングループを選択します。
サブスクリプショングループID	メッセージチャンネル、メッセージタイプ、またはメールリストのIDを提供します。これにより、ユーザーの登録を解除します。
メール	登録を解除するユーザーのメールアドレスを提供します。
ユーザーID	登録を解除するユーザーのユーザーIDを提供します。メールまたはユーザーIDのいずれかが指定されている必要があります。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーをオーバーライドするためにAPIキーを入力するか、APIキーの属性をマッピングします。

アクション — ユーザーをリストに登録する

パラメータ

パラメータ	説明
リスト	ユーザーを登録するリストを選択します。
メール	プロファイルが既にユーザーIDで存在する場合を除き、メールを構成する必要があります。その場合、ユーザーIDからメールへのルックアップが実行されます。
ネストされたオブジェクトのマージ	上位レベルのオブジェクトを上書きするのではなくマージします。デフォルト値は`False`です。例えば、ユーザープロファイルが`{mySettings:{mobile:true}}`を含み、変更された連絡先フィールドが`{mySettings:{email:true}}`を含む場合、結果のプロファイルは`{mySettings:{mobile:true,email:true}}`を含みます。
ユーザーID優先	ユーザーがまだ存在しない場合、指定されたユーザーIDで新しいユーザーを作成します。
ユーザーID	通常はデータベースで生成されたIDです。メールまたはユーザーIDのいずれかが指定されている必要があります。
データフィールド	ユーザープロファイルに保存するデータフィールド。
テンプレート変数	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数を名前付けします。例：`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
テンプレート	本文データで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。サポートされるフィールドに名前でテンプレートを注入します。例：`{{SomeTemplateName}}`。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーをオーバーライドするためにAPIキーを入力するか、APIキーの属性をマッピングします。

アクション — ユーザーをリストから登録解除する

パラメータ

パラメータ	説明
リスト	登録解除するユーザーのリストを選択します。
メール	ユーザーのメール。
ユーザーID	通常はデータベースで生成されたIDです。メールまたはユーザーIDのいずれかが指定されている必要があります。
キャンペーン	キャンペーンに登録解除する属性。詳細については、Iterable: キャンペーンの紹介を参照してください。
チャンネル登録解除	リストに関連するチャンネルからメールを登録解除します。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーをオーバーライドするためにAPIキーを入力するか、APIキーの属性をマッピングします。

アクション — ユーザーのメールを更新する

パラメータ

パラメータ	説明
新しいメール	必須。新しいユーザーメール。
現在のメール	現在のユーザーメール。
現在のユーザーID	通常はデータベースで生成されたIDです。メールまたはユーザーIDのいずれかが指定されている必要があります。
APIキーオーバーライド	コネクタ構成で指定されたAPIキーをオーバーライドするためにAPIキーを入力するか、APIキーの属性をマッピングします。

アクション — ショッピングカートを更新する

パラメータ

パラメータ	説明
Email	ユーザーのメールアドレス。
Merge Nested Objects	トップレベルのオブジェクトを上書きするのではなく、マージします。デフォルト値は `False` です。例えば、ユーザープロファイルが `{mySettings:{mobile:true}}` を含み、変更連絡先フィールドが `{mySettings:{email:true}}` を含む場合、結果のプロファイルは `{mySettings:{mobile:true,email:true}}` を含むことになります。
Prefer User ID	ユーザーがまだ存在しない場合、指定されたユーザーIDで新しいユーザーを作成します。
User ID	通常はデータベースで生成されたIDです。Email または User ID のいずれかが指定されている必要があります。
User Data Fields	ユーザープロファイルに保存するデータフィールド。
User Data Fields Template Variables	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数を名前付けします。例：`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
User Data Fields Templates	User Data Fieldsで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。テンプレートは名前で二重中括弧を使用してサポートされるフィールドに注入されます。例：`{{SomeTemplateName}}`。

アイテム属性

パラメータ	説明
Item ID	商品アイテムID。
SKU	商品SKU。
Name	商品名。
Description	商品説明。
Category	商品カテゴリ。
Subcategory	商品サブカテゴリ。
Price	商品価格。
Quantity	商品数量。
Image URL	商品画像のURL。
URL	商品ページのURL。
Items Data Fields	追加のアイテムプロパティ。複数のアイテムを追加するために配列タイプの属性を提供します。配列タイプの属性は同じ長さでなければなりません。 Items Data Fields配列とItems Attributes配列は同じ長さでなければなりません。単一値属性を使用することができ、各アイテムに適用されます。
Items Template Variables	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数を名前付けします。例：`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
Items Template	ネストされたオブジェクトのサポートが必要な場合、このセクションを使用してテンプレートを定義します。テンプレートはJSON配列形式を期待します。テンプレートが定義されている場合、Items Attributesセクションの構成は無視されます。 Items Template または Items Attributes のいずれかが指定されている必要があります。詳細については、コネクターテンプレートについてを参照してください。
API Key Override	コネクタ構成で指定されたAPIキーを上書きするためにAPIキーを入力するか、APIキーのための属性をマッピングします。

アクション — 購入追跡

パラメータ

パラメータ	説明
Total	必須。注文総額。
Purchase ID	購入トランザクションのID。
Created At	イベントが発生した時間。指定されていない場合は、受信した時間に構成されます。Unixタイムスタンプを期待します。このフィールドがマップされていない場合、現在のタイムスタンプで初期化されます。

ユーザー属性

パラメータ	説明
Email	Email または User ID のいずれかが入力されている必要があります。両方が入力されている場合は、Email が優先されます。
Merge Nested Objects	トップレベルのオブジェクトを上書きするのではなく、マージします。デフォルト値は `False` です。例えば、ユーザープロファイルが `{mySettings:{mobile:true}}` を含み、変更連絡先フィールドが `{mySettings:{email:true}}` を含む場合、結果のプロファイルは `{mySettings:{mobile:true,email:true}}` を含むことになります。
Prefer User ID	ユーザーがまだ存在しない場合、指定されたユーザーIDで新しいユーザーを作成します。
User ID	通常はデータベースで生成されたIDです。EmailまたはUser IDのいずれかが指定されている必要があります。
Campaign	キャンペーンID。詳細については、Iterable: キャンペーンへの導入を参照してください。
Project Template	テンプレートID。詳細については、Iterable: テンプレートへの導入を参照してください。
Data Fields	追跡する追加フィールド。
User Data Fields	ユーザープロファイルに保存するデータフィールド。
Data Fields Template Variables	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数を名前付けします。例：`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
Data Fields Templates	Data FieldsおよびUser Data Fieldsで参照されるテンプレートを提供します。詳細については、コネクターテンプレートについてを参照してください。テンプレートは名前で二重中括弧を使用してサポートされるフィールドに注入されます。例：`{{SomeTemplateName}}`。

アイテム属性

パラメータ	説明
Item ID	商品アイテムID。
SKU	商品SKU。
Name	商品名。
Description	商品説明。
Category	商品カテゴリ。
Subcategory	商品サブカテゴリ。
Price	商品価格。
Quantity	購入された商品の数量。
Image URL	商品画像のURL。
URL	商品ページのURL。
Items Data Fields	追加のアイテムプロパティ。複数のアイテムを追加するために配列タイプの属性を提供します。配列タイプの属性は同じ長さでなければなりません。 Items Data Fields配列とItems Attributes配列は同じ長さでなければなりません。単一値属性を使用することができ、各アイテムに適用されます。
Items Template Variables	データ入力としてテンプレート変数を提供します。詳細については、コネクターテンプレート変数を参照してください。ドット表記を使用してネストされたテンプレート変数を名前付けします。例：`items.name`。ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
Items Template	ネストされたオブジェクトのサポートが必要な場合、このセクションを使用してテンプレートを定義します。テンプレートはJSON配列形式を期待します。テンプレートが定義されている場合、Items Attributesセクションの構成は無視されます。 Items Template または Items Attributes のいずれかが指定されている必要があります。詳細については、コネクターテンプレートについてを参照してください。
API Key Override	コネクタ構成で指定されたAPIキーを上書きするためにAPIキーを入力するか、APIキーのための属性をマッピングします。

顧客データのマージ

ソースユーザーパラメータ

パラメータ	説明
Source Email	メールによってソースユーザープロファイルを識別します。このパラメータは文字列または配列であることができます。配列のサイズ制限は10です。
Source User ID	ユーザーIDによってソースユーザープロファイルを識別します。このパラメータは文字列または配列であることができます。配列のサイズ制限は10です。

宛先ユーザーパラメータ

パラメータ	説明
Destination Email	メールによって宛先ユーザープロファイルを識別します。このパラメータは文字列または配列であることができます。配列のサイズ制限は10であり、ソースパラメータと同じサイズでなければなりません。
Destination User ID	ユーザーIDによって宛先ユーザープロファイルを識別します。このパラメータは文字列または配列であることができます。配列のサイズ制限は10であり、ソースパラメータと同じサイズでなければなりません。
API Key Override	コネクタ構成で指定されたAPIキーを上書きするためにAPIキーを入力するか、APIキーのための属性をマッピングします。