コーディアルコネクタ構成ガイド
この記事では、コーディアルコネクタの構成方法について説明します。
コネクタアクション
アクション名 | AudienceStream | EventStream |
---|---|---|
コンタクトのアップサート | ✓ | ✓ |
コンタクトにカートを追加 | ✗ | ✓ |
コンタクトアクティビティ(イベント)の記録 | ✓ | ✓ |
アカウントリストからコンタクトを追加または削除 | ✓ | ✓ |
新しい注文を作成 | ✗ | ✓ |
通知を送信 | ✓ | ✓ |
API情報
このコネクタは以下のベンダーAPIを使用します:
- API名:Cordial API
- APIバージョン:v1.0
- ドキュメント:Cordial API
構成の構成
コネクタマーケットプレイスに移動して新しいコネクタを追加します。コネクタを追加する一般的な手順については、コネクタについてを参照してください。
コネクタを追加した後、以下の構成を構成します:
-
APIキー
CordialはHTTP Basic Authentication(BA)を使用します。Cordialプラットフォーム内で、アカウント用のエンコードされたAPIキーを生成できます。このキーはBA認証のusername
として使用されます。詳細については、RESTful APIの概要と使用法を参照してください。TealiumのIPアドレスをCordialの
API_KEY
ホワイトリストに追加する必要があります。 -
Path-URL
以下のPath 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を使用します。
コネクタの構成が完了したら、完了をクリックします。
アクション構成 - パラメータとオプション
コネクタアクションの構成を続けるには、続行をクリックします。アクションの名前を入力し、ドロップダウンメニューからアクションタイプを選択します。
次のセクションでは、各アクションのパラメータとオプションの構成方法について説明します。
アクション - コンタクトのアップサート
パラメータ
パラメータ | 説明 |
---|---|
コンタクト識別キー | コンタクト識別キー。例: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 。 |
コンタクト識別値 | コンタクト識別値。 |
アクション | カスタムアクションを定義します。例えば、閲覧、注文、カート、その他のカスタムアクションなどです。パラメータの最大長は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 の合計として自動計算されます。 |
税金 | 税金の金額。 |
配送料および取扱手数料 | 配送料および取扱手数料の金額。 |
プロパティ | 注文のプロパティを説明するキー値ペア。 |
配送先住所
パラメータ | 説明 |
---|---|
住所 | 住所。 |
市区町村 | 市区町村。 |
国 | 国。 |
名前 | 名前。 |
郵便番号 | 郵便番号。 |
州 | 州。 |
請求先住所
パラメータ | 説明 |
---|---|
住所 | 住所。 |
市区町村 | 市区町村。 |
国 | 国。 |
名前 | 名前。 |
郵便番号 | 郵便番号。 |
州 | 州。 |
アイテムパラメータ
パラメータ | 説明 |
---|---|
Product ID | アイテム識別子。 |
Name | アイテム名。 |
SKU | アイテム番号。 |
Category | アイテムカテゴリ。 |
Quantity | 購入されたアイテムの数。指定されていない場合のデフォルトは 1 。 |
Images | 画像名またはパス。アイテムに複数の画像がある場合、カンマ(, )で分割された値が提供されます。 |
Item Price | アイテムの価格。 |
Description | アイテムの説明。 |
URL | アイテムへのリンク。 |
Amount | qty x itemPrice として自動計算されます。qty x itemPrice と等しくない値が渡された場合、それは上書きされます。 |
Tags | 製品を説明するためのカンマ区切りの値の配列。英数字またはダッシュのみを受け付けます。 |
アクション - 通知を送信
パラメータ
パラメータ | 説明 |
---|---|
Automation Template | テンプレートを選択するか、テンプレートIDを提供します。 |
電子メール。 | |
CID | コンタクトID。 |
Identify By | リクエストボディ内のどの識別キーを使用してコンタクトを検索するかを指定します。 |
External Variables | 外部変数。テンプレートをサポートします。 |
Template Variables |
|
Templates |
|
最終更新日 :: 2025年June月13日