キャンペーン情報登録API

マーケティングプラットフォームのキャンペーン情報を新規登録するためのAPIです。コピー元となるキャンペーンのIDを指定することで、既に登録済みのキャンペーン情報を元に新たなキャンペーンをコピー登録することもできます。

メソッド名

seminar.post

リクエスト情報

アクセスURL

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

URL部パラメータ

なし

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

★ エレメント名：Seminar ★ データ型：SeminarType

カラム名	必須	データ型	内容
Id	オプション	string	キャンペーンID
SsTargetType	必須	SsTargetTypeType	キャンペーンタイプID SsTargetTypeId：SsTargetTypeName 　1：キャンペーン　2：サブキャンペーン
PriceType	必須	PriceTypeType	課金種別 PriceTypeId：PriceTypeName 　1：無料　2：キャンペーン課金　3：サブキャンペーン課金　5：パッケージ課金
SeminarCategory	オプション	SeminarCategoryType	カテゴリ SeminarCategoryId：SeminarCategoryName
SeminarCopyCategory	オプション	SeminarCopyCategoryType	“キャンペーンコピーカテゴリ - CsvDownloadSetting（クイックCSV） - Discount（割引コード） - EnqueteTemplate(アンケートテンプレート) - ExternalService(外部接続設定) - Flow(フロー) - I18nSetting(言語設定) - IdRule(請求CODE,リードCODE連番設定) - MailTemplate(メールテンプレート) - SearchColumn(表示項目設定) - SearchCondition(検索条件) - SeminarAdmin(キャンペーン担当者) - SeminarDocument(キャンペーン公開資料) - SeminarSetting(キャンペーン設定) - SeminarSpeaker(キャンペーン講演者) - SeminarTemplate(キャンペーンテンプレート) - Session(サブキャンペーン情報) - SessionAdmin(サブキャンペーン担当者) - SessionDocument(サブキャンペーン公開資料) - SessionPrice(課金パッケージおよび課金要素) - SessionSpeaker(サブキャンペーン講演者) - StepMail (ステップメール設定) - VisitorDataSetting(基本項目設定)”
SeminarStatus	必須	SeminarStatusType	状態 SeminarStatusId：SeminarStatusName 　1：公開　2：会員のみ申込可　3：会員のみ公開　4：ポータルページ非公開　5：準備中・終了　6：カスタム設定
PortalPublicationType	オプション	PortalPublicationTypeType	カスタム設定(ポータル公開条件) PortalPublicationTypeId： PortalPublicationTypeName 　1：非公開　2：検索条件でフィルタされた会員　3：会員　4：すべて公開
SeminarPublicationType	オプション	SeminarPublicationTypeType	カスタム設定(キャンペーン詳細公開条件) SeminarPublicationTypeId：SeminarPublicationTypeName 　1：非公開　2：検索条件でフィルタされた会員　3：会員　4：すべて公開
FlowPublicationType	オプション	FlowPublicationTypeType	カスタム設定(申込条件) FlowPublicationTypeId： FlowPublicationTypeName 　2：検索条件でフィルタされた会員　3：会員　4：すべて公開
PreserveSearchCondition	オプション	PreserveSearchConditionType	カスタム設定(リードの検索条件フィルタ) PreserveSearchConditionId：PreserveSearchConditionName
Title	必須	string	キャンペーンタイトル
SubTitle	オプション	string	キャンペーンサブタイトル
Summary	オプション	string	キャンペーン概要
Detail	オプション	string	キャンペーン詳細
Notes	オプション	string	注意事項
TargetUser	オプション	string	対象者
Sponsor	オプション	string	主催
CoSponsor	オプション	string	共催
Support	オプション	string	協賛
HtmlEditorType	オプション	HtmlEditorTypeType	エディタ種別ID HtmlEditorTypeId：HtmlEditorTypeName 　1：エディタ　2：HTMLソース
NewsBody	オプション	string	フリー入力欄
Memo	オプション	string	メモ
StartDay	必須	dateTime	開催期間(開始日時)
EndDay	必須	dateTime	開催期間(終了日時)
StartDayDisplay	オプション	string	表示用開催期間（開始日時）
ApplicationStartDay	必須	dateTime	申込期間(開始日時)
ApplicationEndDay	必須	dateTime	申込期間(終了日時)
ApplicationStartDayDisplay	オプション	string	表示用申込期間(開始日時)
LimitUserNum	オプション	nonNegativeInteger	定員
LimitUserNumDisplay	オプション	string	表示用定員
Cost	オプション	string	実施コスト
TargetCostPerPerson	オプション	string	目標単価
HallName	オプション	string	会場名
HallZipcode	オプション	string	会場の郵便番号
Prefecture	オプション	PrefectureType	会場の住所（都道府県）都道府県IDと都道府県名の対応表参照
HallAddress	オプション	string	会場の住所
HallTel	オプション	string	会場の電話番号
HallNote	オプション	string	会場備考
HallMapUrl	オプション	string	会場URL
ReferenceName	オプション	string	お問合せ先名
ReferencePersonInCharge	オプション	string	お問合せ先担当者
ReferenceEmail	オプション	string	お問合せ先E-mail
ReferenceTel	オプション	string	お問合せ先電話番号
ReferenceFax	オプション	string	お問合せ先ファックス番号
ReferenceAddress	オプション	string	お問合せ先住所
ReferenceNote	オプション	string	お問合せ先備考
Price	必須	nonNegativeInteger	金額
PriceDisplay	オプション	string	表示用金額
DetailFile	オプション	DetailFileType	詳細画像 DetailFileID：DetailFileName：DetailFilePath：DetailFileExtension
HallFile	オプション	HallFileType	会場地図 HallFileId：HallFileName：HallFilePath：HallFileExtension
HeaderFile	オプション	HeaderFileType	ヘッダー画像 HeaderFileId：HeaderFileName：HeaderFilePath：HeaderFileExtension
Duplicate	オプション	nonNegativeInteger	コピー元キャンペーンID ※コピー時必須
Attribute{aid}	オプション	―	追加項目 ※API メソッドリファレンス「追加項目のデータ型」を参照

レスポンス情報

レスポンスコード

コード	内容
201	正常終了

HTTPレスポンスヘッダ

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

HTTPレスポンスボディ

なし

リクエストXMLサンプル

<?xml version='1.0' encoding='UTF-8'?>
<Seminar xmlns="http://smartseminar.jp/">
　<ApplicationEndDay>2014-01-01T23:55:00+09:00</ApplicationEndDay>
　<ApplicationStartDay>2013-01-01T10:05:00+09:00</ApplicationStartDay>
　<ApplicationStartDayDisplay>2013年元旦より受け付け開始</ApplicationStartDayDisplay>
　<Attribute1>テストアトリビュートテキスト１</Attribute1>
　<Attribute2List>
　　<Attribute2>
　　　<Attribute2Id>2</Attribute2Id>
　　　<Attribute2Name>選択肢２</Attribute2Name>
　　</Attribute2>
　</Attribute2List>
　<Attribute3List>
　　<Attribute3>
　　　<Attribute3Id>1</Attribute3Id>
　　　<Attribute3Name>選択肢１</Attribute3Name>
　　</Attribute3>
　</Attribute3List>
　<EndDay>2014-02-02T17:00:00+09:00</EndDay>
　<HallFile><HallFileId>1234</HallFileId></HallFile>
　<LimitUserNum>1000</LimitUserNum>
　<LimitUserNumDisplay>１０００名限定</LimitUserNumDisplay>
　<NewsBody>&lt;h1&gt;API Seminar&lt;/h1&gt;</NewsBody>
　<Prefecture>
　　<PrefectureId>10</PrefectureId>
　　<PrefectureName>東京都</PrefectureName>
　</Prefecture>
　<Price>0</Price>
　<PriceDisplay>無料です</PriceDisplay>
　<PriceType>
　　<PriceTypeId>1</PriceTypeId>
　　<PriceTypeName>無料</PriceTypeName>
　</PriceType>
  <HtmlEditorType>
    <HtmlEditorTypeId>1</HtmlEditorTypeId>
    <HtmlEditorTypeName>エディタ</HtmlEditorTypeName>
  </HtmlEditorType>
　<SeminarCategory>
　　<SeminarCategoryId>1</SeminarCategoryId>
　　<SeminarCategoryName>てすとカテゴリ</SeminarCategoryName>
　</SeminarCategory>
　<SsTargetType>
　　<SsTargetTypeId>1</SsTargetTypeId>
　　<SsTargetTypeName>キャンペーン</SsTargetTypeName>
　</SsTargetType>
　<StartDay>2014-02-02T11:10:00+09:00</StartDay>
　<StartDayDisplay>２０１４年２月２日開催</StartDayDisplay>
　<Title>APIレスポンス説明会キャンペーン</Title>
</Seminar>

リクエストXMLサンプル (コピーによる登録)

<?xml version='1.0' encoding='UTF-8'?>
<Seminar xmlns="http://smartseminar.jp/">
　<ApplicationEndDay>2014-03-01T23:55:00+09:00</ApplicationEndDay>
　<Duplicate>173</Duplicate>
　<EndDay>2014-03-03T17:00:00+09:00</EndDay>
　<SeminarCopyCategory>
　　<Discount>1</Discount>
　　<Flow>1</Flow>
　　<MailTemplate>1</MailTemplate>
　　<SearchCondition>1</SearchCondition>
　　<Session>1</Session>
　　<VisitorDataSetting>1</VisitorDataSetting>
　</SeminarCopyCategory>
　<StartDay>2014-03-03T11:10:00+09:00</StartDay>
　<StartDayDisplay>２０１４年３月３日開催</StartDayDisplay>
　<Title>コピー後のキャンペーンタイトル</Title>
　<Attribute3List>
　　<Attribute3>
　　　<Attribute3Id>4</Attribute3Id>
　　　<Attribute3Name>選択肢４</Attribute3Name>
　　</Attribute3>
　</Attribute3List>
</Seminar>

制限事項

seminar.get のレスポンスに含まれる以下の項目は、seminar.post では登録できません。
- AcceptanceStatus
- ApplicationAmount
- CapacityStatus
- DateRegist
- DateUpdate
- NumberOfApplicants
- NumberOfApplications
- SpeakerList
- StatusChangedDate
- UseSessionFlag
- VisitorAmount
講演者の割り当てはできません。
担当者の割り当てはできません (別途、キャンペーン担当者割当情報API を利用してください)。
ファイル型 - 画像型の項目について、ファイルを直接このAPIで登録することはできません。別途、ファイル登録APIでファイルを仮登録した後、そのIDを指定してください。
追加項目以外の画像型項目について、代替テキストの入力はサポートされておりません。
以下の項目を設定するためには、SeminarStatus (状態) を「6: カスタム設定」にする必要があります。また、以下の項目で「2: 検索条件でフィルタされた会員」に設定する場合は、PreserveSearchCondition で検索条件のIDを指定してください。
- PortalPublicationType (ポータル公開条件)
- SeminarPublicationType (キャンペーン詳細公開条件)
- FlowPublicationType (申込条件)
キャンペーンコピーにおいて、 SeminarCopyCategory で指定されていない項目については、コピーされません。
キャンペーンコピーを行う場合は、コピーしたい項目に[1]を指定してください。
日時に関する以下の項目に関しては、空での更新はできません。ステータスの管理はキャンペーンのSeminarStatusの項目をご利用ください。
- ApplicationStartDay
- ApplicationEndDay
- StartDay
- EndDay