コーディアルコネクタ構成ガイド
この記事では、コーディアルコネクタの構成方法について説明します。
API情報
このコネクタは以下のベンダーAPIを使用します：
- API名：Cordial API
- APIバージョン：v1.0
- ドキュメント：Cordial API
構成
コネクタマーケットプレイスに移動し、新しいコネクタを追加します。コネクタを追加する一般的な手順については、コネクタについてを参照してください。
コネクタを追加した後、以下の構成を構成します：
-
APIキー
CordialはHTTP Basic認証（BA）を使用します。Cordialプラットフォーム内で、アカウント用のエンコードされたAPIキーを生成できます。このキーはBA認証のusernameとして使用されます。詳細については、RESTful APIの概要と使用法を参照してください。Cordialの
API_KEYホワイトリストにTealiumのIPアドレスを追加する必要があります。 -
パスURL
以下のパスURLのいずれかを選択するか、手動で入力します。https://api.cordial.io/v2/- 管理パネルのURLがhttps://admin.cordial.io/の場合、このURLを使用します。https://api.usw2.cordial.io/v2/- 管理パネルのURLがhttps://usw2.admin.cordial.io/の場合、このURLを使用します。
コネクタの構成が完了したら、完了をクリックします。
アクション
| アクション名 | AudienceStream | EventStream |
|---|---|---|
| コンタクトのアップサート | ✓ | ✓ |
| コンタクトにカートを追加 | ✗ | ✓ |
| コンタクト活動の記録（イベント） | ✓ | ✓ |
| アカウントリストからコンタクトを追加または削除 | ✓ | ✓ |
| 新しい注文を作成 | ✗ | ✓ |
| 通知を送信 | ✓ | ✓ |
| コンタクト活動の記録（バッチ） | ✓ | ✓ |
続行をクリックして、コネクタアクションを構成します。アクションの名前を入力し、ドロップダウンメニューからアクションタイプを選択します。
次のセクションでは、各アクションのパラメータとオプションの構成方法について説明します。
コンタクトのアップサート
パラメータ
| パラメータ | 説明 |
|---|---|
| コンタクト識別キー | コンタクト識別キー。例：email, cID。 |
| コンタクト識別値 | コンタクト識別値。 |
| メールアドレス | コンタクトを識別および参照するためのユニークなチャネルアドレス。 |
| 購読ステータス | subscribedに構成されていない限り、プロモーションメッセージは送信されません。デフォルトはnoneです。可能な値：none, subscribed, unsubscribed。 |
| トリガーの抑制 | trueの場合、コンタクト属性値の更新に基づくメッセージトリガーを抑制します。デフォルトはtrueです。 |
| 強制購読 | 購読解除されている場合、このキーを使用して購読ステータスを購読に更新する必要があります。可能な値：true, false。 |
| 無効 | falseに構成されていない限り、メールメッセージは送信されません。デフォルトはfalseです。可能な値：true, false。 |
オプションパラメータ
| パラメータ | 説明 |
|---|---|
| アカウントリスト | リストからコンタクトを追加または削除します。可能な値：true, false。 |
| 文字列パラメータ | 属性タイプが文字列として構成されている場合、文字列属性値を追加します。 |
| 数値パラメータ | 属性タイプが数値として構成されている場合、数値属性値を追加します。 |
| 日付パラメータ | 属性タイプが日付として構成されている場合、日付属性値を追加します。 |
| ジオパラメータ | 属性タイプがジオとして構成されている場合、ジオ属性値を追加します。ジオ属性には次のキー名のスキーマが含まれています：
|
| 配列パラメータ | 属性タイプが配列として構成されている場合、配列属性値を追加します。デフォルトの動作は、提供された値で配列値を置き換えることです。デフォルトをオーバーライドするために、追加/削除動作を指定するオブジェクトを指定できます。最大アイテム数の制限（デフォルトは25）を超える場合、新しい値は最も古い値を置き換えます。 |
コンタクトにカートを追加
パラメータ
| パラメータ | 説明 |
|---|---|
| コンタクト識別キー | コンタクト識別キー。例：email, cID。 |
| コンタクト識別値 | コンタクト識別値。 |
| メッセージコンタクトID | メッセージコンタクトID。 |
| 顧客ID | 顧客ID。 |
| リンクID | リンクID。 |
| カートURL | カートURL。 |
カートアイテムパラメータ
| パラメータ | 説明 |
|---|---|
| 商品ID | アイテム識別子。 |
| 名前 | アイテム名。 |
| SKU | アイテム番号。 |
| カテゴリ | アイテムカテゴリ。 |
| 数量 | カート内の数量。 |
| 画像 | 画像名またはパス。アイテムに複数の画像がある場合、提供された値はコンマ（,）で分割されます。 |
| アイテム価格 | アイテムの価格。 |
| 説明 | アイテムの説明。 |
| URL | アイテムへのリンク。 |
コンタクト活動の記録（イベント）
パラメータ
| パラメータ | 説明 |
|---|---|
| コンタクト識別キー | コンタクト識別キー。例：email, cID。 |
| コンタクト識別値 | コンタクト識別値。 |
| アクション | カスタムアクションを作成するための定義。例：browse, order, cartなどのカスタムアクション。パラメータの最大長は40文字です。POSTメソッドを介して追加できない予約済みアクションに注意してください。詳細については、コンタクト活動（イベント）APIを参照してください。 |
| アクションタイムスタンプ | アクションタイムスタンプ。未定義の場合、現在の日付と時刻が使用されます。日付形式はISO 8601標準です。 |
| プロパティ | 追加のイベント属性のオブジェクト。イベントが持つことができるプロパティのデフォルトの最大数は1,000です。数字のみの値（例：57）やドットを含むキー（例：shoes.color）は削除されます。 |
アカウントリストからコンタクトを追加または削除
パラメータ
| パラメータ | 説明 |
|---|---|
| アカウントリスト | アカウントリストを選択するか、リストIDを入力します。 |
| アクション | AddまたはDeleteのアクションを選択します。 |
| コンタクト識別キー | コンタクト識別キー。例：email, cID。 |
| コンタクト識別値 | コンタクト識別値。 |
新しい注文を作成
パラメータ
| パラメータ | 説明 |
|---|---|
| コンタクト識別キー | コンタクト識別キー。例：email, cID。 |
| コンタクト識別値 | コンタクト識別値。 |
| 注文ID | 注文に割り当てられたユニークな識別子。 |
| 購入日 | 購入日時を示す日付値。日付形式はISO 8601です。 |
| mcID | アカウント、コンタクト、メッセージを表すCordial ID。メールによる収益帰属を追跡するために必要です。 |
| msID | メッセージを表すCordial ID。 |
| 顧客ID | eCommerceまたはCRMシステムによって割り当てられたID値。 |
| リンクID | メッセージとリンクを表すCordial ID。特定のリンクによる収益帰属を追跡するために必要です。 |
| 合計金額 | 各item.amountの合計として自動計算されます。 |
| 税金 | 税金の金額。 |
| 配送料および取扱手数料 | 配送料および取扱手数料の金額。 |
| プロパティ | 注文のプロパティを説明するキー値ペア。 |
配送先住所
| パラメータ | 説明 |
|---|---|
| 住所 | 住所。 |
| 市区町村 | 市区町村。 |
| 国 | 国。 |
| 名前 | 名前。 |
| 郵便番号 | 郵便番号。 |
| 州 | 州。 |
請求先住所
| パラメータ | 説明 |
|---|---|
| 住所 | 住所。 |
| 市区町村 | 市区町村。 |
| 国 | 国。 |
| 名前 | 名前。 |
| 郵便番号 | 郵便番号。 |
| 州 | 州。 |
アイテムパラメータ
| パラメータ | 説明 |
|---|---|
| 商品ID | アイテム識別子。 |
| 名前 | アイテム名。 |
| SKU | アイテム番号。 |
| カテゴリ | アイテムのカテゴリ。 |
| 数量 | 購入されたアイテムの数。指定されていない場合のデフォルトは 1。 |
| 画像 | 画像名またはパス。アイテムに複数の画像がある場合、提供された値はコンマ（,）で分割されます。 |
| アイテム価格 | アイテムごとの価格。 |
| 説明 | アイテムの説明。 |
| URL | アイテムへのリンク。 |
| 金額 | qty x itemPrice として自動計算されます。qty x itemPrice と等しくない値が渡された場合、それは上書きされます。 |
| タグ | 製品を説明するためのカンマ区切りの値の配列。英数字またはダッシュのみを受け付けます。 |
通知を送信
パラメータ
| パラメータ | 説明 |
|---|---|
| 自動化テンプレート | テンプレートを選択するか、テンプレートIDを提供します。 |
| メール | メールアドレス。 |
| CID | コンタクトID。 |
| 識別方法 | リクエストボディ内のどの識別キーを使用してコンタクトを検索するかを指定します。 |
| 外部変数 | 外部変数をサポートします。テンプレートが使用されます。 |
| テンプレート変数 |
|
| テンプレート |
|
コンタクト活動を記録（バッチ）
バッチ制限
このアクションは、ベンダーへの大量データ転送をサポートするためにバッチリクエストを使用します。次のいずれかの閾値に達するまでリクエストはキューに入れられます：
- 最大リクエスト数：99
- 最古のリクエストからの最大時間：10分
- リクエストの最大サイズ：10 MB
パラメータ
| パラメータ | 説明 |
|---|---|
| ホスト | Cordialリージョンを指定します：
|
| ソース | データソース。デフォルト値は TEALIUM です。 |
識別子
| パラメータ | 説明 |
|---|---|
| コンタクトID | コンタクトID。 |
| メール | コンタクトのメールアドレス。 |
| 電話 | コンタクトの電話番号。 |
| カスタムID | アカウントで構成された主キーまたは副キー。詳細については、Cordial: 主キー対副キーを参照してください。 |
| 識別子の優先順位 | コンタクトを検索する際に使用される識別子の順序。 |
コンタクト活動
| パラメータ | 説明 |
|---|---|
| 名前 | イベント名。 |
| 時間 | アクションのタイムスタンプ。未定義の場合は現在の日時が使用されます。日付形式は ISO 8601 標準です。 |
| 市 | 市の名前。 |
| 国 | 国の名前。 |
| 緯度 | 緯度座標。 |
| 経度 | 経度座標。 |
| デバイス | 特定のデバイスモデル。 |
| プラットフォーム | デバイスのオペレーティングシステム。 |
| ブラウザ | デバイスで使用されるブラウザ。 |
| IP | デバイスのIPアドレス。 |
| ロボット | デバイスがボットによって操作されているかどうかを示します。 |
| デバイスタイプ | デバイスのタイプ、例えばモバイルやデスクトップなど。 |
| コンタクト活動プロパティ | 追加のイベント属性。デフォルトでは、各イベントは最大1,000のプロパティを持つことができます。数字のみ（例：57）やドットを含む（例：shoes.color）プロパティキーは削除されます。 |
| コンタクト属性 | コンタクトが存在しない場合に構成される属性。新しいコンタクトが作成されるべきです。 |
コンタクトオプション
| パラメータ | 説明 |
|---|---|
| 強制購読 | 強制購読。 |
| マージ許可 | マージ許可。 |
| マージ可能な副キー | email など、コンタクトレコードをマージするために使用できる副キー。 |
| 作成可能 | （オプション）デフォルト値は false です。既に存在しない場合、新しいコンタクトを作成します。 |
| 更新可能 | （オプション）デフォルト値は false です。既に存在する場合、コンタクトを更新します。 |
| バッチの有効期限 | 有効期限は1分から60分の間です。デフォルト値は10分です。 |
最終更新日 :: 2025年August月20日