当ドキュメントについて

当ドキュメントでは、SmartFormatの仕様、ならびにSmartFormatを利用したコンテンツの配信方法について解説します。 SmartFormatの概要についてはこちらをご参照ください。

バージョン

2.0

バージョン2.0の主要な変更点

SmartFormatバージョン2.0は、SmartView優先表示に対応した仕様となっています。 なお、SmartFormatバージョン2.0を作成後、SmartView優先表示に切り替えるためには弊社システムへの登録が必要となります。自動的にSmartView優先表示に切り替わる訳ではない旨、ご了承ください。

追加または削除された要素 対応する新機能
channel 要素内に<snf:logo>を追加 SmartView上部にサイトロゴを常時表示
item / entry 要素内に<snf:analytics>を追加 SmartViewにおけるトラフィック計測のためのタグ埋込み
item / entry 要素内の<snf:advertisement>の子要素に<snf:sponsoredLink>を追加 記事広告(自社広告)2枠
<snf:relatedLink> を削除 弊社レコメンドエンジンによる関連記事の自動選出

バージョン1.0からアップデートする際の注意点

SmartFormatバージョン1.0をすでにご提供いただいており、バージョンをアップデートする場合は、SmartFormat登録フォームより改めて登録してください。内容を確認し、弊社にて動作確認後、SmartViewへの切替えをします。

なお、SmartViewへ未切替えの場合は、SmartFormatバージョン2.0の新機能(サイトロゴ掲出、計測タグ埋込み、広告記事枠等)が適用できませんので、ご注意ください。

ファイル仕様

用意したファイルが下記のSmartFormatの仕様に適合していない場合、そのファイルの内容は反映されません。

フォーマット

SmartFormat ファイルのフォーマットは、RSS 2.0の仕様 (http://cyber.law.harvard.edu/rss/rss.html) 、もしくはAtomの仕様(http://tools.ietf.org/html/rfc4287)に準拠します。また、XML の namespace を用いて一部仕様を拡張しています。 現状、その他のフォーマットに対応する予定はございません。

文字コード

UTF-8に対応します。

ファイルサイズ

SmartFormatのファイルサイズは全体で1MB以内を推奨値としております。 ファイルサイズについてはSmartFormatチェックツールにて確認できます。

xml

xml文書のバージョン、ならびに使用される文字コード情報などを定義します。

<?xml version="1.0" encoding="utf-8" ?>

RSS 2.0

詳細はこちら

サンプル(RSS 2.0準拠)

<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:media="http://search.yahoo.com/mrss/" xmlns:snf="http://www.smartnews.be/snf">
  <channel>
    <title>スマートタイムス</title>
    <link>http://times.smartnews.co.jp/</link>
    <description>スマートなニュースをすべての人へ</description>
    <pubDate>Fri, 16 May 2014 06:00:00 GMT</pubDate>
    <language>ja</language>
    <copyright>(c) SmartNews, Inc.</copyright>
    <ttl>1</ttl>
    <snf:logo><url>http://times.smartnews.co.jp/snlogo.png</url></snf:logo>
    <item>
        <title>渋谷区桜丘エリアの再開発計画が決定</title>
        <link>http://times.smartnews.co.jp/2014/06/16/sakuragaoka</link>
        <guid>http://times.smartnews.co.jp/2014/06/16/sakuragaoka</guid>
        <description><![CDATA[
      渋谷駅桜丘口地区再開発準備組合と東急不動産株式会社は、2014年6月16日、渋谷区の市街地再開発等の都市開発計画が東京都により決定されたと発表した。
        ]]></description>
        <pubDate>Fri, 16 May 2014 06:00:00 GMT</pubDate>
        <content:encoded><![CDATA[
      <p>渋谷駅桜丘口地区再開発準備組合と東急不動産株式会社は、2014年6月16日、渋谷区の市街地再開発等の都市開発計画が東京都により決定されたと発表した。</p>
      <p>この都市計画は、2013年12月19日より東京都知事に対して提案されていたもので、渋谷駅中心地区の都市基盤整備を完成させる重要なプロジェクトとなっている。</p>
      <p>今後、周辺再開発と連携した縦動線アーバン・コア、歩行者デッキ、ネットワークの整備を行うほか、街区再編と併せた都市計画道路の整備および地下車路ネットワーク等の整備により、利便性・安全性の向上を図っていくとのこと。</p>
      <figure>
          <img src="img.png">
          <figcaption>完成イメージ</figcaption>
      </figure>
        ]]></content:encoded>
        <category>iphone,technology</category>
        <dc:creator>須磨戸 太郎</dc:creator>
        <dc:language>ja</dc:language>
        <media:thumbnail url="http://times.smartnews.co.jp/2014/06/16/sakuragaoka/img.png" />
      <snf:advertisement>
        <snf:sponsoredLink link="http://times.smartnews.com/sponsored/article1.html" thumbnail="http://times.smartnews.com/sponsored/image1.jpg" title="桜丘に新スイーツ店が誕生!" advertiser="桜丘スイーツ"/>
        <snf:sponsoredLink link="http://times.smartnews.com/sponsored/article2.html" thumbnail="http://times.smartnews.com/sponsored/image2.jpg" title="sponsored link 2" advertiser="Example Company"/>
        <snf:adcontent id="51290410"><![CDATA[
        <script src="http://ad.smartnews.co.jp/m/51290410" />
        ]]></snf:adcontent>
      </snf:advertisement>
      <snf:analytics><![CDATA[
        <script>
      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

      ga('create', 'UA-xxx-2', 'examplecom');
      ga('require', 'displayfeatures');
      ga('set', 'referrer', 'http://www.smartnews.com/');
      ga('send', 'pageview', '/260984/upsee/');
        </script>
        ]]>
      </snf:analytics> 
    </item>
    <item>
      ...
    </item>
    <item>
      ...
    </item>
</channel>
</rss>

Atom

詳細はこちら

サンプル(Atom準拠)

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:media="http://search.yahoo.com/mrss/" xmlns:snf="http://www.smartnews.be/snf">
  <title>スマートタイムス</title>
  <link type="text/html" href="http://times.smartnews.co.jp/" rel="alternate"/>
  <subtitle>スマートなニュースをすべての人へ</subtitle>
  <updated>2014-05-16T06:00:00+0000</updated>
  <rights>(c) SmartNews, Inc.</rights>
  <logo>http://times.smartnews.co.jp/logo.png</logo>
  <snf:logo><url>http://times.smartnews.co.jp/snlogo.png</url></snf:logo>
  <entry>
    <title>渋谷区桜丘エリアの再開発計画が決定</title>
  <link type="text/html" href="http://times.smartnews.co.jp/2014/06/16/sakuragaoka" rel="alternate"/>
    <id>http://times.smartnews.co.jp/2014/06/16/sakuragaoka</id>
    <updated>2014-05-16T06:00:00+0000</updated>
    <content><![CDATA[
      <p>渋谷駅桜丘口地区再開発準備組合と東急不動産株式会社は、2014年6月16日、渋谷区の市街地再開発等の都市開発計画が東京都により決定されたと発表した。</p>
      <p>この都市計画は、2013年12月19日より東京都知事に対して提案されていたもので、渋谷駅中心地区の都市基盤整備を完成させる重要なプロジェクトとなっている。</p>
      <p>今後、周辺再開発と連携した縦動線アーバン・コア、歩行者デッキ、ネットワークの整備を行うほか、街区再編と併せた都市計画道路の整備および地下車路ネットワーク等の整備により、利便性・安全性の向上を図っていくとのこと。</p>
      <figure>
          <img src="img.png">
          <figcaption>完成イメージ</figcaption>
      </figure>
        ]]></content>
    <category>iphone,technology</category>
    <author>須磨戸 太郎</author>
    <dc:language>ja</dc:language>
    <media:thumbnail url="http://times.smartnews.co.jp/2014/06/16/sakuragaoka/img.png" />
    <snf:advertisement>
     <snf:sponsoredLink link="http://times.smartnews.com/sponsored/article1.html" thumbnail="http://times.smartnews.com/sponsored/image1.jpg" title="桜丘に新スイーツ店が誕生!" advertiser="桜丘スイーツ"/>
     <snf:sponsoredLink link="http://times.smartnews.com/sponsored/article2.html" thumbnail="http://times.smartnews.com/sponsored/image2.jpg" title="sponsored link 2" advertiser="Example Company"/>
     <snf:adcontent id="51290410"><![CDATA[
     <script src="http://ad.smartnews.co.jp/m/51290410" />
     ]]></snf:adcontent>
    </snf:advertisement>
    <snf:analytics><![CDATA[
      <script>
    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
    m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
    })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

    ga('create', 'UA-xxx-2', 'examplecom');
    ga('require', 'displayfeatures');
    ga('set', 'referrer', 'http://www.smartnews.com/');
    ga('send', 'pageview', '/260984/upsee/');
      </script>
      ]]>
    </snf:analytics> 
  </entry>
  <entry>
    ...
  </entry>
</feed>

接続仕様

弊社からのデータ取得方法について

作成したSmartFormatは、ウェブサイト上の任意の場所に設置できます。

データ取得間隔

最短で1分に1度の間隔で取得処理を行います。取得間隔については、SmartFormatファイル上の "ttl" 要素にて任意に設定できます。

(※設定内容の反映は遅れる可能性があります。)

<ttl>1</ttl> <!-- 単位:分 -->

取得間隔が長いと弊社側での情報取得漏れが発生する可能性が高まりますので、可能であれば短めの値を設定することを推奨いたします。

(※Atomに準拠した形式でファイルを用意した場合、取得間隔は任意に設定することができません。)

通信方式

HTTP経由で接続します。使用するMethodはGETです。

GET /files/snf.xml HTTP/1.1

なお、現時点では HTTPまたはHTTPS以外の接続について対応予定はありません。

User-Agent

User−Agentの先頭に”Crowsnest”という文字列を含みます。

User-Agent: Crowsnest

弊社からの接続開始

SmartFormatファイルへの弊社からのアクセスは、媒体運営者から許可があった後に行います。 SmartFormatファイルをご用意いただいた場合には、SmartFormatによる記事配信に則って登録してください。

接続制限

SmartFormatファイルは弊社からインターネット接続が可能な状況である必要がありますが、不特定多数からのアクセスを望まない場合、以下の接続制限方式に対応します。

  • IPアドレスによる接続制限
  • Basic認証による接続制限

制限を望まれる方は、問い合わせ先までご連絡ください。

ファイルの妥当性の検証

SmartFormatファイルが弊社の定める仕様に適合しているかどうかを簡易的に確認するチェックツールを用意しております。

https://sf-validator.smartnews.com/

上記URLにてSmartFormatファイルをチェックすることで、仕様への適合や、記事の表示イメージの確認を行う事が可能です。

SmartFormatファイル作成時の注意点

ファイル中に含まれる文字列

SmartFormatのファイルはXML形式となっており、ファイル中にXMLの仕様として許可されていない文字列が含まれていると情報を正しく解析できません。XMLの仕様の詳細についてはW3Cのサイト(http://www.w3.org/XML/Core/#Publications)などを参照してください。

ここでは、よく起こる事象について記載します。

HTMLタグのエスケープ漏れ

<,> については、それぞれ &lt;,&gt;に置き換えてください。

その他HTML、XMLの中で特別の意味をもつ文字のエスケープ漏れ

&,",' については、それぞれ &amp;,&quot;,&apos;に置き換えてください。

動画コンテンツの配信について

SmartNewsのネイティブプレイヤーをご利用の場合

SmartNewsアプリ内での自然な動画閲覧体験に最適化したプレイヤーを提供しています。

入稿方法、再生方法ともに2通りあります。
また、ChannelView面ではサムネイルが再生マーク付きで表示されます。

入稿方法

  1. SmartFormat内で各記事ごとに、弊社指定タグ<snf:video>に動画URLを指定します。
    • サムネイルの指定と同様に、媒体運営者のサーバ上の動画ファイルをクロールいたします。
    • 動画URLによる指定の詳細は、 下記リンクの<snf:video>の項目をご覧ください。
  2. 動画用CMSにより、動画ファイルをローカル環境から直接アップロードできます。
    • 動画ファイルの直接入稿(CMS)の詳細は弊社担当者までお問い合わせください。

再生方法

  1. SmartView面上部にプレイヤーが表示され自動再生
    • 記事をスクロール中も上部固定で自動再生されます。
  2. 記事一覧画面から記事をタップすると、全画面での自動再生
    • 記事本文は表示されません。
    • 全画面での再生をご希望される場合は弊社担当者までお問い合わせください。

動画ファイルの仕様

  • ファイルサイズ: 600MB
  • 長さ: 最長5分(推奨90秒以内)
  • 動画コーデック: h.264
  • 音声コーデック: aac
  • ビットレート: 1Mbps
  • ファイル形式: mp4

外部サービスのプレイヤーをご利用の場合

入稿方法

SmartFormatの本文内に、YouTube,Vimeo,Brightcoveの埋め込みタグを記述します。

再生方法

本文内の指定された位置で埋め込みプレイヤーにより再生されます。

SNSの引用について

TwitterやInstagram等のSNSのコンテンツを引用する場合、画像及びテキストは埋め込みタグを用いて、各SNSの規定に従って表示してください。

関連記事の設置

関連記事(おすすめ)は、弊社レコメンドエンジンによって最大5本まで自動的にSmartViewで適用されます。本文内( content:encoded 内)へのリンク設置はご遠慮ください。

記事中に表示する関連記事や広告の表示場所

現時点では表示位置は固定です。

配信記事のコントロール

SmartFormatを登録した直後は、SmartFormatと、従来のサイトクロールによる配信方法を平行して行います。その期間内は、SmartFormatに記載していない記事も配信される可能性があります。

SmartNewsからのアクセス量の確認

弊社からのアクセスには、記事に飛んだ際に「www.smartnews.com」「www.smartnews.be」いずれかの値を出力されています(.comがSmartNewsのver2.0以降、.beがそれ以前となっています)。

変更履歴

  • 2014年7月1日 バージョン 1.0 仕様公開
  • 2016年2月15日 バージョン 2.0 仕様公開