The root object of an Apple News article, containing required properties, metadata, content, layout, and styles.
- Apple News Format 1.7+
The component text styles that can be referred to by components in this document. Each
article file must have, at minimum, a default component text style named
default. Defaults by component role can also be set. See Defining and Using Text Styles.
An unique, publisher-provided identifier for this article. This identifier must remain constant; it cannot change when the article is updated.
This identifier can include the following:
Up to 64 characters
Uppercase and lowercase letters
A code that indicates the language of the article. Use the IANA.org language subtag registry to find the appropriate code; e.g.,
en for English, or the more specific
en for English (U.K.) or
en for English (U.S.).
The article’s column system. Apple News Format layouts make it possible to recreate print design on iPhone, iPad, iPod touch and Mac. Layout information is also used to calculate relative positioning and size for these devices. See Planning the Layout for Your Article.
The article title or headline. Should be plain text; formatted text (HTML or Markdown) is not supported.
The version of Apple News Format used in the JSON document.
The value of the
version property must not be earlier than the version number of any property that is used anywhere in the article.
The current version of Apple News Format is 1.9.
An advertisement to be inserted at a position that is both possible and optimal. You can specify what
banner you want to have automatically inserted.
Note. This property is deprecated. Use the object instead.
The metadata, appearance, and placement of advertising and related content components within Apple News Format articles.
An object containing the background color of the article.
The article's metadata, such as publication date, ad campaign data, and other information that is not part of the core article content.
The article subtitle. Should be plain text; formatted text (HTML or Markdown) is not supported.
Every Apple News Format document must have the same filename:
article file must contain the
Article object. This is the object that is sent in Create an Article and Update an Article requests.
In JSON, the order of properties in an object is not important; however, as you create your JSON document, you may find it useful to follow the order shown in the example that follows.
To view this example in News Preview, copy the example code to a file named
article and put a file named
image in the same folder. (You can use any JPEG, GIF, or PNG file.)