SmartFormat(スマートフォーマット)とは、SmartNewsに記事を配信するためのフィードのことです。詳しくはSmartFormatについてをご覧ください。SmartFormatを用意するためには、開発が必要です。
「フィード」とは?
「フィード」とは一般に、サイト上での記事の更新、タイトルや本文などの情報をユーザーや外部サイトに提供する文書や形式のことをいいます。
SmartNewsに記事を配信したい方は、SmartNewsにはじめて記事を配信するを併せてご覧ください。
開発者の方はSmartFormat概要や、SmartFormatを開発する方へ内のページをご覧ください。
SmartFormatファイルの基本的な要素
下記に、SmartFormatファイルのコードサンプル(RSS2.0準拠)を用いながら、ファイルを構成する基本的な要素について解説します。それぞれの要素について詳しくは記事情報の基本的な要素を指定するも併せてお読みください。
コードサンプルの一例
上記がSmartFormatの最低限のコードとなります。
※部分は必須記述項目です。
※部分以外は、記述がなくても記事を表示できます。
記述方法は下記をご参照ください。
① RSSのルートノード(コードサンプルの1〜6、32行目)を記述
【この部分に、この後説明の②、③を記述します】
② <channel></channel>内を記述する
channel 要素でRSSフィードを記述します。必須要素以外は省略可能です。
サンプルコード行 |
要素 | 必須 | 説明 |
8、31 | <channel></channel> | ◯ | channel要素を示すタグ |
9 | <title></title> | ◯ | オリジナルサイト名を記述 |
10 | <link></link> | ◯ | オリジナルサイトURLを記述 |
11 | <description></description> | ◯ | オリジナルサイトの説明文(15字以内を推奨) |
12 | <pubDate></pubDate> | ◯ | オリジナルサイトの作成日時を記述 例:Wed, 23 Oct 2019 18:00:00 +0900 |
13 | <language></language> | 言語(日本語のサイトであればja)を記述 | |
14 | <copyright></copyright> | サイト提供者のcopyrightを記述 | |
15 | <ttl></ttl> | このリソースが新規に更新されるまでのおおよその期間(単位は分、1〜5程度を推奨) | |
16 | <snf:logo><url></url></snf:logo> | 記事の上部に表示されるサイトロゴURLを記述 |
③ <item></item>内を記述する
item要素で記事の内容を記述します。item要素はひとつのSmartFormat内にいくつでも設置できます(容量がオーバーにならないようご留意ください)。
必須要素以外は省略可能です。
サンプルコード行 |
要素 | 必須 | 説明 |
18、29 | <item></item> | ◯ | item(記事)要素を示すタグ |
19 | <title></title> | ◯ | 記事のタイトルを記述 |
20 | <link></link> | ◯ | オリジナルサイトの記事URLを記述 |
21 | <description></description> | ◯ | オリジナルサイトの記事作成日時を記述 例:Wed, 23 Oct 2019 18:17:01 +0900 |
22 | <content:encoded></content:encoded> | ◯ | オリジナルサイトの記事本文を記述 |
28 | <media:thumbnailurl="" /> | サムネイルとして表示したい画像URLを記述 |
④ 作成後、チェックツールで確認する
https://sf-validator.smartnews.com/
プレビュータブで、アプリ上の表示を擬似確認できます。
⑤コードのNG例
- 必須タグが全て記述されていない
必須に印のあるコードは、必ずすべて記述してください。 - タグの中に何も記述されていない
例)
<ttl>1</ttl> OK
<ttl></ttl> NG
Tips
- 使用できるHTMLタグには限りがあります。
- ファイルの容量は1MB以内を推奨しています。
- 動画も配信可能です。詳細は動画記事を配信についてをご覧ください。
- JavaScriptは使用できません。
- SNSの埋め込みスクリプトは、公式の埋め込みコードであれば使用できます。