Cordialコネクタ構成ガイド

コネクタのアクション

アクション名	AudienceStream	EventStream
Upsert contact	✓	✓
Add cart to contact	✗	✓
Record contact activity (event)	✓	✓
Add or delete a contact from an account list	✓	✓
Create a new order	✗	✓
Send notification	✓	✓

API情報

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

• API名: Cordial API
• APIバージョン: v1.0
• ドキュメンテーション: Cordial API

構成の構成

コネクタマーケットプレイスに移動し、新しいコネクタを追加します。コネクタの追加方法の一般的な指示については、About Connectorsを参照してください。

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

• APIキー
  CordialはHTTP Basic Authentication (BA)を使用します。Cordialプラットフォーム内から、アカウント用のエンコードされたAPIキーを生成できます。このキーは、BA認証のusernameとして使用されます。詳細については、RESTful API Summary and Usageを参照してください。

  Tealium IP addressesを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を使用します。

コネクタの構成が完了したら、Doneをクリックします。

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

Continueをクリックしてコネクタのアクションを構成します。アクションの名前を入力し、ドロップダウンメニューからアクションタイプを選択します。

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

アクション - Upsert contact

パラメータ

パラメータ	説明
Contact Identifier Key	コンタクト識別キー。例：email, cID。
Contact Identifier Value	コンタクト識別値。
Email Address	コンタクトを識別し参照するためのユニークなチャネルアドレス。
Subscribe Status	subscribedに構成しない限り、プロモーションメッセージは送信されません。デフォルトはnone。可能な値：none, subscribed, unsubscribed。
Suppress Triggers	trueに構成すると、コンタクト属性値の更新に基づくメッセージトリガーが抑制されます。デフォルトはtrue。
Force Subscribe	退会済みの場合、このキーを使用して購読ステータスを購読済みに更新する必要があります。可能な値：true, false。
Invalid	falseに構成しない限り、電子メールメッセージは送信されません。デフォルトはfalse。可能な値：true, false。

オプションパラメータ

パラメータ	説明
Account Lists	コンタクトをリストに追加または削除します。可能な値：true, false。
String Parameters	属性タイプが文字列として構成されている場合、文字列属性値を追加します。
Number Parameters	属性タイプが数値として構成されている場合、数値属性値を追加します。
Date Parameters	属性タイプが日付として構成されている場合、日付属性値を追加します。
Geo Parameters	属性タイプが地理として構成されている場合、地理属性値を追加します。地理属性には以下のキー名のセットスキーマが含まれています： Street Address Street Address 2 City State Postal Code Country ISO Time Zone Location Latitude Longitude
Array Parameters	属性タイプが配列として構成されている場合、配列属性値を追加します。デフォルトの動作は、提供された値で配列値を置き換えることです。追加/削除の動作を指定するオブジェクトを指定してデフォルトを上書きすることができます。最大アイテム数の制限を超えると（デフォルトは25）、新しい値が最も古い値を置き換えます。

アクション - Add cart to contact

パラメータ

パラメータ	説明
Contact Identifier Key	コンタクト識別キー。例：email, cID。
Contact Identifier Value	コンタクト識別値。
Message Contact ID	メッセージコンタクトID。
Customer ID	顧客ID。
Link ID	リンクID。
Cart URL	カートURL。

Cart Item Parameters

パラメータ	説明
Product ID	アイテム識別子。
Name	アイテム名。
SKU	アイテム番号。
Category	アイテムカテゴリ。
Quantity	カート内の数量。
Images	画像名またはパス。アイテムに複数の画像がある場合、提供された値はカンマ（,）で分割されます。
Item Price	アイテムの価格。
Description	アイテムの説明。
URL	アイテムへのリンク。

アクション - Record contact activity (event)

パラメータ

パラメータ	説明
Contact Identifier Key	コンタクト識別キー。例：email, cID。
Contact Identifier Value	コンタクト識別値。
Action	ブラウズ、オーダー、カートなどのカスタムアクションを作成するための定義。パラメータの最大長は40文字です。予約済みのアクションはPOSTメソッドを介して追加することはできません。詳細については、Contact activities (events) APIを参照してください。
Action Timestamp	アクションのタイムスタンプ。未定義の場合、現在の日付と時刻が使用されます。日付形式はISO 8601標準です。
Properties	追加のイベント属性のオブジェクト。イベントが持つことができるプロパティのデフォルトの最大数は1,000です。数値のみの値（例：57）やdotを含むキー（例：shoes.color）は削除されます。

アクション - Add or delete a contact from an account list

パラメータ

パラメータ	説明
Account List	アカウントリストを選択するか、リストIDを入力します。
Action	AddまたはDeleteのアクションを選択します。
Contact Identifier Key	コンタクト識別キー。例：email, cID。
Contact Identifier Value	コンタクト識別値。

アクション - Create a new order

パラメータ

パラメータ	説明
Contact Identifier Key	コンタクト識別キー。例：email, cID。
Contact Identifier Value	コンタクト識別値。
Order ID	オーダーに割り当てられたユニークな識別子。
Purchase Date	購入データと時間を示す日付値。日付形式はISO 8601。
mcID	アカウント、コンタクト、メッセージを表すCordial ID。収益の帰属をメールに追跡するために必要です。
msID	メッセージを表すCordial ID。
Customer ID	eCommerceまたはCRMシステムによって割り当てられたID値。
Link ID	メッセージとリンクを表すCordial ID。特定のリンクに対する収益の帰属を追跡するために必要です。
Total Amount	各item.amountの合計として自動計算されます。
Tax	税金の額。
Shipping and Handling	送料と手数料の額。
Properties	オーダーのプロパティを説明するキーと値のペア。

配送先住所

パラメータ	説明
Address	住所。
City	市区町村。
Country	国。
Name	名前。
Postal Code	郵便番号。
State	州。

請求先住所

パラメータ	説明
Address	住所。
City	市区町村。
Country	国。
Name	名前。
Postal Code	郵便番号。
State	州。

アイテムパラメータ

パラメータ	説明
Product ID	アイテム識別子。
Name	アイテム名。
SKU	アイテム番号。
カテゴリー	アイテムのカテゴリー。
数量	購入したアイテムの数。指定されていない場合、デフォルトは 1 です。
画像	画像の名前またはパス。アイテムに複数の画像がある場合、提供された値はカンマ (,) で分割されます。
アイテム価格	アイテムごとの価格。
説明	アイテムの説明。
URL	アイテムへのリンク。
金額	qty x itemPrice として自動計算されます。qty x itemPrice と等しくない値が渡されると、それが上書きされます。
タグ	製品を説明するためのカンマ区切りの値の配列。英数字またはダッシュのみを受け付けます。

アクション - 通知を送信

パラメータ

パラメータ	説明
Automation Template	テンプレートを選択するか、テンプレートIDを提供します。
Email	メール。
CID	コンタクトID。
Identify By	リクエストボディ内のどの識別キーを使用してコンタクトを検索するかを指定します。
External Variables	外部変数。テンプレートをサポートします。
Template Variables	テンプレート変数を外部変数入力として提供します。詳細については、Template Variables Guideを参照してください。 ネストされたテンプレート変数はドット表記法で名前を付けます（例：items.name）。 ネストされたテンプレート変数は通常、データレイヤーリスト属性から構築されます。
Templates	パラメータで参照されるテンプレートを提供します。詳細については、Templates Guideを参照してください。 テンプレートは、例えば {{SomeTemplateName&}} のように、名前で二重中括弧を使用してサポートフィールドに注入されます。