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
|
---|---|
|
The version of the feed format to which this feed conforms. The current format version is |
|
The name of your subscription.
|
|
The organization publishing the subscription. Often an institution or company name.
|
|
A reverse-DNS string for the domain hosting this feed.
|
|
The contact URL you use to get information about and report problems with the feed.
|
|
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
|
---|---|
|
The name of the playground book.
|
|
The subtitle of the playground book displayed in overviews. Expand on the name of the book to provide additional context.
|
|
Optional. The subtitle of the playground book displayed in detail views. Expand further on the name of the book to provide additional context.
|
|
A description that shows up in detail views before opening a book in the subscription.
|
|
Optional. The difficulty level of the material taught in the book. The level must be |
|
A reverse-DNS identifier unique to the book. The identifier must match the ContentIdentifier Key in the book’s manifest and start with the |
|
A version number you need to increment when you update the book. The version must match the ContentVersion Key in the book’s manifest.
|
|
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.
|
|
A link to your a zipped copy of the book’s |
|
The ISO 8601-formatted date when you first published the book.
|
|
The ISO 8601-formatted date when you last updated the book.
|
|
A link to a picture of the cover of the book. Thumbnail images should be 902px × 678px.
|
|
A link to the banner image used to display the book. Banner images should be 1080px × 400px.
|
|
An array of objects you use to supply metadata. The format for the objects in this array is described in the section below.
|
|
An array of URLs to images that highlight parts of the book. Preview images should be 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
|
---|---|
|
A metadata key name.
|
|
A metadata key value.
|
|
Optional. The type of the value specified by the value field. The type must be |
Creating Subscriptions
サブスクリプションの作成
Copyright © 2018 Apple Inc. All rights reserved. Terms of Use | Privacy Policy | Updated: 2018-04-30