一括登録API

マーケティングプラットフォームの情報を一括で登録するためのAPIです。

メソッド名

bulkapi.post

リクエスト情報

アクセスURL

メソッド	URL
POST	https://{domainname}/services/rest/bulkapi

URL部パラメータ

なし

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

★ エレメント名：Bulk ★ データ型：BulkType

カラム名	必須	データ型	内容
Method	必須	string	登録可能なAPIのメソッドを指定します。指定できるメソッドについては下の表[指定可能なAPI]を参照してください。
ParameterList	必須	ParameterListType	Parameter：URLパラメータ Key：Value URLパラメータキー：URLパラメータ値 Methodで指定したAPIに応じて指定します。指定できるパラメータについては、各APIのマニュアルを参照してください。
BulkData	必須	BulkDataType	Methodで指定したAPIに応じて、登録するデータを指定します。登録するデータの型については下の表[指定可能なAPI]を参照してください。

指定可能なAPI

API	メソッド	指定可能なデータ型
リード情報登録API	visitor.post	VisitorDataList
リード情報更新API	visitor.put	VisitorDataList
リストへリードを追加API	staticlist.postVisitor	StaticlistVisitorList
リストからリードを除外API	staticlist.deleteVisitor	StaticlistVisitorList

レスポンス情報

レスポンスコード

コード	内容
201	正常終了

HTTPレスポンスヘッダ

パラメータ名	データ型	内容
Location	string	登録されたリソースへのURL https://{domainname}/services/rest/bulkapi/{id}

HTTPレスポンスボディ

なし

XMLサンプル

リクエストXMLサンプル

visitor.putの場合の例です：

<?xml version='1.0' encoding='UTF-8'?>
<Bulk xmlns="http://smartseminar.jp/">
<Method>visitor.put</Method>
　<ParameterList>
　　<Parameter>
　　　<Key>upsert</Key>
　　　<Value>1</Value>
　　</Parameter>
　　<Parameter>
　　　<Key>update_key</Key>
　　　<Value>email</Value>
　　</Parameter>
　</ParameterList>
　<BulkData>
　　<VisitorDataList>
　　　<VisitorData>
　　　　<LoginId>test_user001</LoginId>
　　　　<LoginPassword>test_pass001</LoginPassword>
　　　　<Name1>テスト</Name1>
　　　　<Name2>太郎</Name2>
　　　　<Name3>J</Name3>
　　　　<Name1Ka>テスト</Name1Ka>
　　　　<Address1>札幌市</Address1>
　　　　<Address2>中央区</Address2>
　　　　<Email>failure01@shanon.co.jp</Email>
　　　　<SubEmail>failure02@shanon.co.jp</SubEmail>
　　　　<Attribute1>追加属性１</Attribute1>
　　　　<Attribute2List>
　　　　　<Attribute2>
　　　　　　<Attribute2Id>1</Attribute2Id>
　　　　　　<Attribute2Name>選択肢１</Attribute2Name>
　　　　　</Attribute2>
　　　　</Attribute2List>
　　　</VisitorData>
　　</VisitorDataList>
　</BulkData>
</Bulk>

staticlist.postVisitorの場合の例です：

<?xml version="1.0" encoding="UTF-8"?>
<Bulk xmlns="http://smartseminar.jp/">
   <Method>staticlist.postVisitor</Method>
   <ParameterList>
      <Parameter>
         <Key>staticlist_id</Key>
         <Value>12</Value>
      </Parameter>
   </ParameterList>
   <BulkData>
      <StaticlistVisitorList>
         <StaticlistVisitor>
            <VisitorId>30</VisitorId>
         </StaticlistVisitor>
         <StaticlistVisitor>
            <VisitorId>31</VisitorId>
         </StaticlistVisitor>
      </StaticlistVisitorList>
   </BulkData>
</Bulk>

staticlist.deleteVisitorの場合の例です：

<?xml version="1.0" encoding="UTF-8"?>
<Bulk xmlns="http://smartseminar.jp/">
   <Method>staticlist.deleteVisitor</Method>
   <ParameterList>
      <Parameter>
         <Key>staticlist_id</Key>
         <Value>12</Value>
      </Parameter>
   </ParameterList>
   <BulkData>
      <StaticlistVisitorList>
         <StaticlistVisitor>
            <VisitorId>30</VisitorId>
         </StaticlistVisitor>
         <StaticlistVisitor>
            <VisitorId>31</VisitorId>
         </StaticlistVisitor>
      </StaticlistVisitorList>
   </BulkData>
</Bulk>

レスポンスXMLサンプル

なし

制限事項

詳しくは、APIの利用方法より一括登録APIをご参照ください。
1度のリクエストに指定出来るレコード数の上限は、10000件です。上限を超えたリクエストを行った場合、エラーレスポンスが返ります。
一度のリクエストに指定出来るレコードサイズの上限は10MBです。上限を超えたリクエストを行った場合、エラーレスポンスが返ります。
一括登録APIは同時実行できません。直前のリクエストの処理が終わるまでは、次のリクエストを行うことが出来ません。別のリクエストを処理中である場合、後から実行したリクエストに対してはエラーレスポンスが返ります。
一度に登録する BulkDataに含めるデータの項目は、全て同じである必要があります。レコードによって含まれる項目が異なるリクエストを行った場合は、エラーレスポンスが返ります。

正しい例

<Method>visitor.post</Method>
<BulkData>
　<VisitorDataList>
　　<VisitorData>
　　　<LoginId>test_user001</LoginId>
　　　<Name1>テスト</Name1>
　　　<Name2>太郎</Name2>
　　　<Email>failure01@shanon.co.jp</Email>
　　</VisitorData>
　　<VisitorData>
　　　<LoginId>test_user002</LoginId>
　　　<Name1>James</Name1>
　　　<Name2>Brian</Name2>
　　　<Email>failure02@shanon.co.jp</Email>
　　</VisitorData>
　　<VisitorData>
　　　<LoginId>test_user003</LoginId>
　　　<Name1>テスト</Name1>
　　　<Name2>三郎</Name2>
　　　<Email>failure03@shanon.co.jp</Email>
　　</VisitorData>
　</VisitorDataList>
</BulkData>

間違った例

<Method>visitor.post</Method>
<BulkData>
　<VisitorDataList>
　　<VisitorData>
　　　<LoginId>test_user001</LoginId>
　　　<Name1>テスト</Name1>
　　　<Name2>太郎</Name2>
　　　<Email>failure01@shanon.co.jp</Email>
　　</VisitorData>
　　<VisitorData>
　　　<Name1>James</Name1>
　　　<Email>failure02@shanon.co.jp</Email>
　　</VisitorData>
　　<VisitorData>
　　　<CompanyName>エーピーアイコーポレーション</CompanyName>
　　　<Name1>テスト</Name1>
　　　<Name2>三郎</Name2>
　　　<Email>failure03@shanon.co.jp</Email>
　　</VisitorData>
　</VisitorDataList>
</BulkData>

メソッドに visitor.post, visitor.put を指定した場合に固有の制限事項

ファイル型、画像型の追加項目を登録、更新することはできません。ファイル型、画像型の項目を必須に設定していた場合も、必須チェックは実施されません。
一部の項目のみを更新対象に指定する「部分更新(※1)」を行う場合、更新対象に指定した項目のみがエラーチェックの対象となります。
システム設定一覧「リードパスワード閲覧制限」が無効の場合、ログインパスワードの登録・更新が可能となるが、以下のシステム設定に対する入力形式チェックは実施されません。
- 最小パスワード長(リード)
- パスワード文字列の制限(リード)
- ユーザIDとパスワードが同じものを認めない
Country、PermissionType、Prefectureについては、入力が必須かつ空白値を指定した場合は、必須チェックが実施されません (新規登録かつ項目をリクエストXMLに含めない場合は、必須チェックが実施されます)。
新規登録時に「部分更新(※1)」を行う場合、入力値が指定されていない項目にはデフォルト値が設定されます。

※1　一部の項目のみを更新対象に指定する登録方法

メソッドに staticlist.postVisitor, staticlist.deleteVisitor を指定した場合に固有の制限事項

リストへのリード追加とリストからのリード除外は、一つのリストだけを指定するので、リストの指定はBulkDataではなく、ParameterListで指定します。BulkDataで指定するのは基本的にリードの情報であり、リストの情報を指定するとエラーになる可能性があります。