SMP連携オブジェクトリファレンス

SMP連携オブジェクトリファレンスSMP連携オブジェクトごとにAPIの仕様について記述します。連携オブジェクトによって、連携元として利用する場合に必須となる項目マッピングが存在します。SMPからデータ取得する場合のSMP連携オブジェクトごとのAPI仕様SMPへのデータ登録・更新・削除場合のSMP連携オブジェクトごとのAPI仕様SMPからデータ取得する場合のSMP連携オブジェクトごとのAPI仕様SMPからデータ取得する場合のSMP連携オブジェクトごとのAPI仕様です。実際に利用されるSMPAPIと必須となる項目マッピングは、次のとおりです。リードキャンペーンサブキャンペーンキャンペーン申込サブキャンペーン申込キャンペーン申込アンケートサブキャンペーン申込アンケートキャンペーン来場サブキャンペーン来場メール履歴クリックカウント履歴アンケート履歴活動履歴資料ダウンロード履歴Webトラッキング履歴Webトラッキングセッション履歴割引履歴1.リードデータ取得時に利用されるSMPAPIメソッドvisitor.getデータ取得時に必要な項目マッピング特にありません2.キャンペーンデータ取得時に利用されるSMPAPIメソッドseminar.getデータ取得時に必要な項目マッピング特にありません3.サブキャンペーンデータ取得時に利用されるSMPAPIメソッドseminar.getSessionデータ取得時に必要な項目マッピング特にありません4.キャンペーン申込注意・「キャンペーン申込」オブジェクトではサブキャンペーンへの申込情報は取得できません。サブキャンペーン申込情報を取得する場合は、キャンペーン申込とは別に「サブキャンペーン申込」オブジェクトを利用してオブジェクトマッピングを設定してください。・「キャンペーン申込」オブジェクトでは申込に伴うアンケート回答情報は取得できません。アンケート回答情報も取得する必要がある場合は、「キャンペーン申込アンケート」オブジェクトを利用してください。データ取得時に利用されるSMPAPIメソッドvisitor.getApplicationSeminarvisitor.getApplicationvisitor.getseminar.getFlowseminar.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getApplicationSeminarSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込IDVisitorApplicationSeminar.TransactionIdList外部IDSMP項目が選択リストリードIDVisitorApplicationSeminar.VisitorId任意--なし--visitor.getApplicationSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込IDVisitorApplication.Id任意--なし--申込フローIDVisitorApplication.ApplicationFlow任意SMP項目が選択リストvisitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--seminar.getFlowSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込フローIDSeminarFlow.Id任意--なし--キャンペーンIDSeminarFlow.Seminar任意SMP項目が選択リストseminar.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性キャンペーンIDSeminar.Id任意--なし--5.サブキャンペーン申込データ取得時に利用されるSMPAPIメソッドvisitor.getApplicationSessionvisitor.getApplicationvisitor.getseminar.getFlowseminar.getseminar.getSessionデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getApplicationSessionSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込IDVisitorApplicationSession.TransactionIdList外部IDSMP項目が選択リストリードIDVisitorApplicationSession.VisitorId任意--なし--サブキャンペーンIDVisitorApplicationSession.session任意SMP項目が選択リストvisitor.getApplicationSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込IDVisitorApplication.Id任意--なし--申込フローIDVisitorApplication.ApplicationFlow任意SMP項目が選択リストvisitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--seminar.getFlowSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込フローIDSeminarFlow.Id任意--なし--キャンペーンIDSeminarFlow.Seminar任意SMP項目が選択リストseminar.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性キャンペーンIDSeminar.Id任意--なし--seminar.getSessionSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性サブキャンペーンIDSeminarSession.Id任意--なし--6.キャンペーン申込アンケート注意「キャンペーン申込アンケート」オブジェクトではサブキャンペーンへの申込情報は取得できません。サブキャンペーン申込情報を取得する場合は、キャンペーン申込アンケートとは別に「サブキャンペーン申込アンケート」オブジェクトを利用してオブジェクトマッピングを設定してください。データ取得時に利用されるSMPAPIメソッドvisitor.getApplicationSeminarvisitor.getApplicationvisitor.getseminar.getFlowseminar.getvisitor.getEnqueteenquetehistory.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getApplicationSeminarSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込IDVisitorApplicationSeminar.TransactionIdList外部IDSMP項目が選択リストリードIDVisitorApplicationSeminar.VisitorId任意--なし--visitor.getApplicationSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込IDVisitorApplication.Id任意--なし--申込フローIDVisitorApplication.ApplicationFlow任意SMP項目が選択リストアンケート回答情報ID*VisitorApplication.EnqueteDataId任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--seminar.getFlowSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込フローIDSeminarFlow.Id任意--なし--キャンペーンIDSeminarFlow.Seminar任意SMP項目が選択リストseminar.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性キャンペーンIDSeminar.Id任意--なし--visitor.getEnqueteSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性アンケート回答情報ID*VisitorEnquete.DataId任意--なし--アンケート履歴ID*VisitorEnquete.HistoryId任意--なし--enquetehistory.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性アンケート履歴ID*Enquetehistory.Id任意--なし--補足アンケート回答を持たない申込情報を取得した場合は、値が存在しません。7.サブキャンペーン申込アンケートデータ取得時に利用されるSMPAPIメソッドvisitor.getApplicationSessionvisitor.getApplicationvisitor.getseminar.getFlowseminar.getseminar.getSessionvisitor.getEnqueteenquetehistory.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getApplicationSessionSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込IDVisitorApplicationSession.TransactionIdList外部IDSMP項目が選択リストリードIDVisitorApplicationSession.VisitorId任意--なし--サブキャンペーンIDVisitorApplicationSession.session任意SMP項目が選択リストvisitor.getApplicationSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込IDVisitorApplication.Id任意--なし--申込フローIDVisitorApplication.ApplicationFlow任意SMP項目が選択リストアンケート回答情報ID*VisitorApplication.EnqueteDataId任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--seminar.getFlowSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込フローIDSeminarFlow.Id任意--なし--キャンペーンIDSeminarFlow.Seminar任意SMP項目が選択リストseminar.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性キャンペーンIDSeminar.Id任意--なし--seminar.getSessionSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性サブキャンペーンIDSeminarSession.Id任意--なし--visitor.getEnqueteSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性アンケート回答情報ID*VisitorEnquete.DataId任意--なし--アンケート履歴ID*VisitorEnquete.HistoryId任意--なし--enquetehistory.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性+アンケート履歴ID*Enquetehistory.Id任意--なし--補足アンケート回答を持たない申込情報を取得した場合は、値が存在しません。8.キャンペーン来場データ取得時に利用されるSMPAPIメソッドvisitor.getAttendanceSeminarseminar.getvisitor.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getAttendanceSeminarSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性+来場履歴IDVisitorAttendanceSeminar.Id外部ID--なし--キャンペーンIDVisitorAttendanceSeminar.Seminar任意SMP項目が選択リストリードIDVisitorAttendanceSeminar.VisitorId任意--なし--seminar.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性キャンペーンIDSeminar.Id任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--9.サブキャンペーン来場データ取得時に利用されるSMPAPIメソッドvisitor.getAttendanceSessionseminar.getSessionseminar.getvisitor.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getAttendanceSessionSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性来場履歴IDVisitorAttendanceSession.Id外部ID--なし--サブキャンペーンIDVisitorAttendanceSession.Session任意SMP項目が選択リストリードIDVisitorAttendanceSession.VisitorId任意--なし--seminar.getSessionSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性サブキャンペーンIDSeminarSession.Id任意--なし--キャンペーンIDSeminarSession.Seminar任意SMP項目が選択リストseminar.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性キャンペーンIDSeminar.Id任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--10.メール履歴データ取得時に利用されるSMPAPIメソッドvisitor.getMailvisitor.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getMailSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性メール情報IDVisitorMail.Id外部ID--なし--リードIDVisitorMail.VisitorId任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--11.クリックカウント履歴データ取得時に利用されるSMPAPIメソッドvisitor.getClickcountclickcounturl.getvisitor.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getClickcountSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性クリックカウント履歴IDVisitorClickcount.Id外部ID--なし--クリックカウントURLIDVisitorClickcount.ClickCountUrlId任意--なし--リードIDVisitorClickcount.VisitorId任意--なし--clickcounturl.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性クリックカウントURLIDClickcounturl.Id任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--12.アンケート履歴データ取得時に利用されるSMPAPIメソッドvisitor.getEnqueteenquetehistory.getvisitor.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getEnqueteSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性アンケート履歴ID-リードIDVisitorEnquete.Id外部ID--なし--アンケート履歴IDVisitorEnquete.HistoryId任意--なし--リードIDVisitorEnquete.VisitorId任意--なし--enquetehistory.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性アンケート履歴IDEnquetehistory.Id任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--13.活動履歴データ取得時に利用されるSMPAPIメソッドvisitor.getActivityvisitor.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getActivitySMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性活動履歴IDVisitorActivity.Id外部ID--なし--リードIDVisitorActivity.VisitorId任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--14.資料ダウンロード履歴データ取得時に利用されるSMPAPIメソッドvisitor.getDocumentdownloaddocument.getvisitor.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getDocumentdownloadSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性資料ダウンロード履歴IDVisitorDocumentdownload.Id外部ID--なし--資料IDVisitorDocumentdownload.DocumentId任意--なし--リードIDVisitorDocumentdownload.VisitorId任意--なし--document.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性資料IDDocument.Id任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--15.Webトラッキング履歴データ取得時に利用されるSMPAPIメソッドvisitor.getTrackingaccesslogvisitor.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getTrackingaccesslogSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性アクセス履歴IDVisitorTrackingaccesslog.Id外部ID--なし--リードIDVisitorTrackingaccesslog.VisitorId任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--16.Webトラッキングセッション履歴データ取得時に利用されるSMPAPIメソッドvisitor.getTrackingsessionvisitor.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getTrackingsessionSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性トラッキングセッション履歴IDVisitorTrackingsession.Id外部ID--なし--リードIDVisitorTrackingsession.VisitorId任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--17.割引履歴データ取得時に利用されるSMPAPIメソッドvisitor.getDiscounthistoryseminar.getDiscountvisitor.getApplicationvisitor.getデータ取得時に必要な項目マッピング最低限、設定すべき項目マッピングは、次のとおりです。visitor.getDiscounthistorySMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性割引履歴IDVisitorDiscounthistory.Id外部ID--なし--申込履歴IDVisitorDiscounthistory.ApplicationId任意--なし--割引IDVisitorDiscounthistory.DiscountId任意--なし--seminar.getDiscountSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性割引IDSeminarDiscount.Id任意--なし--visitor.getApplicationSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性申込IDVisitorApplication.Id任意--なし--リードIDVisitorApplication.VisitorId任意--なし--visitor.getSMP項目名SMP項目または連携先SFDC項目SFDC項目SMP項目の属性リードIDVisitor.Id任意--なし--SMPへのデータ登録・更新・削除場合のSMP連携オブジェクトごとのAPI仕様SMPへのデータ連携は、「SMPオブジェクト名とAPIの対応表」ページに記載されているAPIメソッドの実行によって実現します。連携可能な項目については、APIマニュアルにて対応するメソッドを参照しつつ、連携設定を行ってください。以下では、一部の特殊仕様を持つメソッドについて説明します。キャンペーン申込SMPへのキャンペーン申込を実行するためには、SMPのキャンペーン申込API(application.post)に必要なパラメータと項目をリクエストするように連携設定を行う必要があります。以下のパラメータおよび項目が必須です。申込フローID(APIパラメータapplication_flow_id)キャンペーンID(SsDataId)申込数(NumberOfApplication)また、キャンペーン申込APIは、ひとつのメソッドの中で複数のエレメント(VisitorData,Transaction,etc)を指定する特殊な仕様になっています。そのため、項目マッピングでも項目名の部分をApplication.Transaction_SsDataIdのように、アンダースコアを区切り文字として_を表記します。さらに、キャンペーン申込APIは登録成功すると申込IDとリードIDの２つをレスポンスします。これらを格納するために、「SMPAPIレスポンスで格納する要素」「SMPAPIレスポンスを格納するSFDC項目」をカンマ区切りで複数指定することができます。キャンペーン申込の連携設定例連携元のSFDCオブジェクトに、以下のAPI名の項目が作成されているとして、最低限の設定例を下記に例示します。SMP_ID__c(申込IDを格納するための項目)SMP_V_ID__c(リードIDを格納するための項目)SMP_Flow_ID__c(SMP申込フローIDを保持している項目)SMP_Seminar_ID__c(SMPキャンペーンIDを保持している項目)オブジェクトマッピングの「SFDC→SMP」部分の設定例は以下のようになります。申込ID、リードIDをそれぞれレスポンスから格納するようにしています。項目名設定値SMP更新キーApplication.IdSMP更新方法POSTSMPAPIレスポンスで格納する要素Id,VisitorIdSMPAPIレスポンスを格納するSFDC項目SMP_ID__c,SMP_V_ID__cAPIパラメータは以下のように設定します。SMP_Flow_ID__cを括弧で括っている点に注意してください。APIパラメータキーAPIパラメータ内容検索オペレータ前回実行日・条件日時を指定application_flow_id(SMP_Flow_ID__c)eq--なし--ignore_itemcheck1eq--なし--項目マッピングは以下のように設定します。TransactionエレメントのCartListに指定する項目について、「SMP項目の属性」として「SMP項目がカート一覧」を指定している点に注意してください。SMP項目または連携先SFDC項目SFDC項目SMP項目の属性Application.IdSMP_ID__c--なし--Application.Transaction_SsDataIdSMP_Seminar_ID__cSMP項目がカート一覧Application.Transaction_NumberOfApplicationSMP_Seminar_ID__cSMP項目がカート一覧また、申込数を1で固定するため、上で設定した項目マッピング「Application.Transaction_NumberOfApplication」に対して、以下のフィルターを設定します。フィルター種類フィルター式実行順序固定値の代入[1]1オブジェクトマッピングの設定画面の例は以下のようになります。キャンペーン申込の注意・制限事項申込時の、登録時言語の指定はサポートされていませんその他、キャンペーン申込APIの仕様・制限事項について、「キャンペーン申込・会員登録API」もご参照ください。キャンペーン申込キャンセルSMPへのキャンペーン申込を実行するためには、SMPのキャンペーン申込API(application.delete)に必要なパラメータと項目をリクエストするように連携設定を行う必要があります。以下のパラメータおよび項目が必須です。申込ID(APIパラメータによってキャンセル対象の申込のIDを指定します)キャンペーン申込キャンセルの連携設定例連携元のSFDCオブジェクトに、以下のAPI名の項目が作成されているとして、最低限の設定例を下記に例示します。SMP_ID__c(申込IDを格納するための項目)オブジェクトマッピングの「SFDC→SMP」部分の設定例は以下のようになります。項目名設定値SMP更新キーApplication.IdSMP更新方法DELETESMPAPIレスポンスで格納する要素Application.IdSMPAPIレスポンスを格納するSFDC項目SMP_ID__cAPIパラメータは以下のように設定します。SMP_ID__cを括弧で括っている点に注意してください。APIパラメータキーAPIパラメータ内容検索オペレータ前回実行日・条件日時を指定id(SMP_ID__c)eq--なし--項目マッピングは以下のように設定します。SMP項目または連携先SFDC項目SFDC項目SMP項目の属性Application.IdSMP_ID__c--なし--キャンペーン申込キャンセルの注意・制限事項キャンセル実行時はSMPAPIレスポンスから格納できる情報はありませんそのため、「SMPAPIレスポンスで格納する要素」「SMPAPIレスポンスを格納するSFDC項目」への入力は擬似設定であり、実効性はありませんその他、キャンペーン申込APIの仕様・制限事項について、「申込キャンセルAPI」もご参照ください。