Object

Article

See the fields returned by the article endpoints.

Properties

accessoryText
string

Text that appears alongside article headlines — author name, channel name, subtitle, and so on.

Maximum length: 100 characters.

Default value: metadata.authors from the Apple News Format article.

createdAt
date-time

The date and time the article was created.

document
string

The content of the article, as an Apple News Format document.

id
uuid

The unique identifier of the article.

isCandidateToBeFeatured
boolean

A Boolean value that indicates whether or not this article should be considered for featuring in News.

Default value: false

isPreview
boolean

A Boolean value that indicates whether this article should be public (live) or should be a preview that is only visible to members of your channel. Set isPreview to false to publish the article immediately and make it visible to all News users.

If your channel has not yet been approved to publish articles in Apple News Format, setting isPreview to false results in an ONLY_PREVIEW_ALLOWED error.

Default value: true if your channel has not yet been approved to publish articles in Apple News Format; false if your channel has been approved.

isSponsored
boolean

A Boolean value that indicates whether this article consists of sponsored content for promotional purposes. Sponsored content must be marked as such; channels that do not follow this policy may be suspended.

When using isSponsored, if you do not want the sponsored article to appear in your channel’s feed, set sections to [] (an empty array).

Default value: false

links
ArticleLinksResponse
ArticleLinks

The URL of the channel in which the article appears.

maturityRating
string

A string value that indicates the viewing audience for the content. The types of audiences or ratings are KIDS, MATURE, and GENERAL, or null if unspecified. A MATURE rating indicates explicit content that is only appropriate for a specific audience.

Default value: null

modifiedAt
date-time

The date and time this article was last modified.

revision
string

The current revision token for the article.

The latest revision must be sent when issuing a request to Update an Article.

The value of this field must match the latest revision from an earlier Create, Read, or Update Article call. This field prevents multiple users from updating an article simultaneously, which would result in data loss.

Required: Yes

shareUrl
string

The URL to the article within the News app. The shareUrl field applies only on devices with iOS 9 or later installed.

state
string

The current state of the article, which can be one of the following:

  • PROCESSING: The article has been published and is in processing.

  • LIVE: The article has been published, has finished processing, and is visible in the News app.

  • PROCESSING_UPDATE: A previous version of the article is visible in the News app, and an update is currently in processing.

  • TAKEN_DOWN: The article was previously visible in the News app, but was taken down.

  • FAILED_PROCESSING: The article failed during processing and is not visible in the News app.

  • FAILED_PROCESSING_UPDATE: A previous version of the article is visible in the News app, but an update failed during processing.

  • DUPLICATE. The article is a duplicate of another article and is not visible in the News app.

title
string

The title of the article, as specified in the Apple News Format document.

type
string

Article

warnings

A list of warning messages indicating nonfatal problems with the article.

See Also

Articles

Create an Article

Publish an article to your channel.

Read Article Information

Retrieve information about an article, such as the revision number and maturity rating.

Search Articles in a Channel

See a list of all articles in a channel that match the specified search criteria.

Search Articles in a Section

See a list of all articles in a section that match the specified search criteria.

Update an Article

Update an existing article in your channel.

Delete an Article

Delete the specified article from your channel.

object Create Article Metadata Fields

See the optional metadata fields for the create article request.

object ArticleLinksRequest

See the required field for the create article request.

object Update Article Metadata Fields

See the metadata fields for the update article request.

object ArticleResponse

See which objects make up the create article, read article, and update article responses.

object ArticleLinksResponse

See the links returned by the article endpoints.

object SearchResponse

See the fields returned by the search article endpoints.

object Meta

See the object that wraps the throttling information that's returned for the create article and read article endpoints.

object Throttling

See the object that wraps the throttling information that's returned for the create article and update article endpoints.