Guides and Sample Code

Developer

Playground Book Format Reference

On This Page

Subscription Feed Format
サブスクリプションフィード書式

The sections below describe the fields used in a subscription’s feed. You use these fields to specify top-level details about the feed, as well as the details and metadata for each document in the feed. For an example of a JSON object that follows this format, see An Example Subscription Feed.
下の節は、サブスクリプションの持つフィードにおいて使われるフィールドを説明します。あなたは、これらのフィールドを使ってトップレベルの詳細をそのフィードについて指定します、それだけでなくそのフィードの中の各ドキュメントについての詳細とメタデータも。この書式に従うJSONオブジェクトの例として、サブスクリプションフィードの例を見てください。

The Top-Level Structure of a Subscription’s Feed
サブスクリプションのもつフィードのトップレベル構造

The keys in this table must be present at the top level of the JSON object that represents a feed.
この表の中のキーは、あるフィードを表すJSONオブジェクトのトップレベルに存在しなければなりません。

Field
フィールド

Description
説明

formatVersion

The version of the feed format to which this feed conforms. The current format version is "1.0".
このフィードが準拠するフィード書式のバージョン。現在の書式バージョンは、"1.0"です。

title

The name of your subscription.
あなたのサブスクリプションの名前。

publisherName

The organization publishing the subscription. Often an institution or company name.
サブスクリプションを出版している組織。たいていは団体または会社名。

feedIdentifier

A reverse-DNS string for the domain hosting this feed.
このフィードをホストしているドメインの逆DNS文字列。

contactURL

The contact URL you use to get information about and report problems with the feed.
このフィードについての情報取得や問題報告のためにあなたが使う連絡URL。

documents

An array of objects representing the playground books in your feed. The format for the objects in this array is described in the section below.
あなたのフィードの中のプレイグラウンドを表しているオブジェクトからなる配列。この配列の中のオブジェクトの書式は、下の節で説明されます。

The Format of a Feed’s Documents
フィードのもつ書類の書式

Each book in your subscription should be represented in your feed’s documents array by an object that has the fields listed below.
あなたのサブスクリプションの中のそれぞれのブックは、あなたのフィードのdocuments配列の中で、下で一覧にされるフィールドを持つあるオブジェクトによって表されなければなりません。

Field
フィールド

Description
説明

title

The name of the playground book.
プレイグラウンドブックの名前。

overviewSubtitle

The subtitle of the playground book displayed in overviews. Expand on the name of the book to provide additional context.
概要において表示されるプレイグラウンドブックのサブタイトル。ブックの名前を詳しく述べることで追加の内容を提供します。

detailSubtitle

Optional. The subtitle of the playground book displayed in detail views. Expand further on the name of the book to provide additional context.
任意。詳細ビューにおいて表示されるプレイグラウンドブックのサブタイトル。ブックの名前をさらに詳しく述べることで追加の内容を提供します。

description

A description that shows up in detail views before opening a book in the subscription.
サブスクリプションの中のあるブックを開く前に詳細ビューにおいて姿を見せる解説。

difficultyLevel

Optional. The difficulty level of the material taught in the book. The level must be "beginner", "intermediate", "expert", or "advanced".
任意。ブックにおいて学ばせる題材の難易度レベル。レベルは、"beginner""intermediate""expert"、または"advanced"でなければなりません。

contentIdentifier

A reverse-DNS identifier unique to the book. The identifier must match the ContentIdentifier Key in the book’s manifest and start with the feedIdentifier of the feed that contains this book.
ブックに対して特有である逆DNS識別子。識別子は、ブックの持つマニフェストの中のContentIdentifierキーに合致して、このブックを含んでいるフィードのfeedIdentifierで始まらなければなりません。

contentVersion

A version number you need to increment when you update the book. The version must match the ContentVersion Key in the book’s manifest.
あなたがブックを更新する時にあなたが漸増する必要があるバージョンナンバー。バージョンナンバーは、ブックの持つマニフェストの中のContentVersionキーに合致しなければなりません。

sha512

Optional. The SHA-512 hash of the ZIP-compressed version of the book. Required when the playground book is hosted on a different domain than the feed.
任意。ブックのZIP圧縮バージョンのSHA-512ハッシュ。プレイグラウンドブックがフィードと異なるドメインでホストされる場合に必要です。

url

A link to your a zipped copy of the book’s .playgroundbook file.
このブックの持つ.playgroundbookファイルの、あなたのzipされたコピーへのリンク。

publishedDate

The ISO 8601-formatted date when you first published the book.
あなたが最初にブックを出版した時の、ISO 8601書式化された日付。

lastUpdatedDate

The ISO 8601-formatted date when you last updated the book.
あなたが最後にブックを更新した時の、ISO 8601書式化された日付。

thumbnailURL

A link to a picture of the cover of the book. Thumbnail images should be 902px × 678px.
ブックの表紙の絵へのリンク。サムネイル画像は、902px × 678pxでなければなりません。

bannerImageURL

A link to the banner image used to display the book. Banner images should be 1080px × 400px.
ブックを陳列するために使われるバナー画像へのリンク。バナー画像は、1080px × 400pxでなければなりません。

additionalInformation

An array of objects you use to supply metadata. The format for the objects in this array is described in the section below.
幾らかのオブジェクトからなるあるリスト、あなたがメタデータを供給するために使います。この配列の中のオブジェクトの書式は、下の節で説明されます。

previewImageURLs

An array of URLs to images that highlight parts of the book. Preview images should be 800px × 600px.
ブックの呼び物部分の画像へのURLからなる配列。プレビュー画像は、800px × 600pxでなければなりません。

The Format of a Book’s Metadata
ブックの持つメタデータの書式。

Store additional information and metadata about your feed in the format described below. This information is displayed alongside the book’s preview images to provide details about the book—such as available localizations—before a user downloads it.
あなたのフィードについての追加の情報とメタデータを下で記述される形式で格納してください。この情報はブックのプレビュー画像に並んで表示されてブックについての詳細—利用可能な現地語化など—を、利用者がそれをダウンロードする前に提供します。

For more information about localizing feeds, see Localizing a Feed.
フィードの現地語化についてのさらなる情報として、フィードの現地語化を見てください。

Field
フィールド

Description
説明

name

A metadata key name.
メタデータキー名。

value

A metadata key value.
メタデータキー値。

type

Optional. The type of the value specified by the value field. The type must be "string" or "date". The default value is "string". Dates must be ISO 8601-formatted date strings.
任意。値フィールドによって指定される値の型。型は、"string"または"date"でなければなりません。省略時の値は"string"です。日付は、ISO 8601書式化された日付文字列でなければなりません。