このページでは、SmartFormat（スマートフォーマット）を開発する方に向けた情報をまとめています。SmartFormatの概要はSmartFormatとはを、開発時のツールやガイドはSmartFormatを開発する方へカテゴリ内の記事をご覧ください。
フォーマット
SmartFormat ファイルのフォーマットは、RSS 2.0の仕様、もしくはAtomの仕様に準拠します。また、XML の namespace を用いて一部仕様を拡張しています。拡張した仕様一覧については、下記「拡張要素一覧」をご確認ください。
仕様書
※ 他のフォーマットに対応する予定は現状ございません。
拡張要素一覧
| 要素 | 説明 |
|---|---|
| snf:logo | サイトを象徴するロゴ画像 |
| snf:darkModeLogo | サイトを象徴するロゴ画像 (ダークモード用) |
| snf:analytics | SmartView上の解析ツールに関連する情報 |
| snf:advertisement | SmartView 内に掲出する広告に関する情報 |
| snf:sponsoredLink | 記事広告 |
| snf:video | 埋め込み動画を指定 |
拡張した要素をご利用いただいていないファイルは、SmartFormatチェックツールでエラーとなる可能性があります。仕様書にしたがって、必要要素の拡張をお願いたします。
制限事項
ファイル容量
SmartFormatのファイルサイズは、全体で1MB以内を推奨しております。推奨値以上のファイルサイズについては、SmartFormatチェッカーでエラーとなる恐れがあります。
また、ご用意いただいたファイルサイズはSmartFormatチェックツールにてチェック可能です。
使用できるHTMLタグ
a, abbr, acronym, address, article, aside, b, base, basefont, bdi, bdo, bgsound, big, blink, blockquote, body, br, caption, center, cite, code, col, colgroup, command, data, datalist, dd, del, details, dfn, dir, div, dl, dt, em, fieldset, figcaption, figure, font, footer, form, h1, h2, h3, h4, h5, h6, header, hgroup, hr, html, i, img, ins, kbd, label, legend, li, listing, main, mark, marquee, menu, meter, nav, nobr, ol, p, plaintext, pre, q, rb, rp, rt, ruby, s, samp, section, small, spacer, span, strike, strong, sub, summary, sup, tfoot, thead, time, tt, u, ul, var, wbr, xmp
その他注意事項
- SmartFormatファイルの作成について：汎用のフィード（SmartNews以外へのデータ配信に使用しているフィード）を拡張しないでください。必ず、SmartFormat用のファイルを新規作成してください。
- 関連記事の設置について：関連記事（おすすめ）は、弊社レコメンドエンジンによって最大５本まで自動的にWebViewで適用されます。
- 本文内でのJavaScriptについて：JavaScriptは使用できません。
- CSSについて：スタイルの設定はできません。
- ファイル中に含まれる文字列について：SmartFormatのファイルはXML形式となっており、ファイル中にXMLの仕様として許可されていない文字列( "<", ">", "&" 等)が含まれていると情報を正しく解析できません。
- SNSの引用について：TwitterやInstagram等のSNSのコンテンツを引用する場合、画像及びテキストは埋め込みタグを用いて、各SNSの規定に従って表示してください。
- HTTP Content-Typeヘッダ形式について：HTTPレスポンスのContent-Typeヘッダーは application/rss+xml, application/atom+xml, application/xml, text/xml のいずれかを指定してください。非推奨のファイル形式の場合、表示保証の範囲外となります。
- SmartFormatファイルに含める記事について：一つのSmartFormatファイルには、一つの媒体の記事のみ含めてください。複数の媒体の記事を、一つのSmartFormatファイルに含めないでください。
- 音声ファイルの取扱いについて：MP3等の音楽ファイル形式には対応していません。
- 上記とあわせて、SmartFormat申請前のチェックリストもあらかじめご確認ください。
- 対応の基本多言語面：Basic Multilingual Plane, BMP, SMP, SIP, TIP, SSP, PUA-A, PUA-B
SmartFormatチェックツールの提供
SmartFormatファイルが弊社の定める仕様に適合しているかどうかを簡易的に確認するチェックツールを用意しております。記事の表示イメージも確認できます。
SmartFormatチェックツール上でのプレビューは、SmartNewsアプリ上での表示を完全に再現したものではありません。仕様への適合や、おおよその表示イメージの確認にご利用ください。
動画コンテンツの配信について
SmartNewsアプリでは様々な動画配信方法があります。そのため、入稿方法も複数あります。
詳細は動画記事の配信についてのページをご覧ください。
接続仕様
データ取得間隔
ご用意いただいたSmartFormatファイルへの弊社からのアクセスは、最短で１分に１度の間隔で取得処理を行います。取得間隔については、SmartFormatファイル上の "ttl" 要素にて任意に設定できます。
※設定内容の反映は遅れる可能性があります。
<ttl>1</ttl> <!-- 単位:分 -->
取得間隔が長いと、弊社側での情報取得漏れが発生する可能性が高まります。可能であれば短めの値を設定することを推奨いたします。
※Atomに準拠した形式でファイルを用意した場合、取得間隔は任意に設定することができません。
弊社からの通信方式
ご提供いただいたSmartFormatファイルへHTTP経由で接続します。使用するMethodはGETです。
GET /files/snf.xml HTTP/1.1
なお、現時点では HTTPまたはHTTPS以外の接続について対応予定はありません。
また、通信する際のUser-Agentは下記になります。
User-Agent: Crowsnest （先頭に”Crowsnest”という文字列を含む）
User-Agent:SmartNewsProxy-Thumbnail
弊社からの接続開始タイミング
SmartFormatファイルへの弊社からのアクセスは、媒体運営者から許可があった後に行います。
SmartFormatによる記事配信に則って登録してください。
SmartFormatへの接続制限について
SmartFormatファイルは弊社からインターネット接続が可能な状況である必要がありますが、不特定多数からのアクセスを望まない場合、以下の接続制限方式に対応します。
- IPアドレスによる接続制限
- Basic認証による接続制限
制限を望まれる方は、お問い合わせフォームからご連絡ください。
SmartFormat更新履歴
SmartFormatの更新履歴をご覧ください。