Article
See the fields the article endpoints returned.
Declaration
object ArticleProperties
| Name | Type | Description |
|---|---|---|
accessoryText | string | Text that appears alongside article headlines — author name, channel name, subtitle, and so on. Maximum length: 100 characters. Default value: |
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 this article should be considered for featuring in Apple News. Default value: |
isPreview | boolean | A Boolean value that indicates whether this article should be public (live) or should be a preview that’s only visible to members of your channel. Set If your channel hasn’t been approved to publish articles in Apple News Format, setting Default value: |
isSponsored | boolean | A Boolean value that indicates whether this article consists of sponsored content for promotional purposes. You must mark sponsored content as such; channels that don’t follow this policy may be suspended. When using Default value: |
links | ArticleLinksResponse | 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 Default value: |
modifiedAt | date-time | The date and time this article was last modified. |
revision | string | The current revision token for the article. You must send the latest revision 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 results in data loss. Required: Yes |
shareUrl | string | The URL to the article within the News app. |
state | string | The current state of the article, which can be one of the following:
|
title | string | The title of the article, as specified in the Apple News Format document. |
type | string | The article. |
warnings | [Warning] | A list of warning messages indicating nonfatal problems with the article. |