Contents

Create Article Metadata Fields

See the optional metadata fields for the Create an Article Request.

Declaration

object Create Article Metadata Fields

Properties

NameTypeDescription
accessoryTextstring

The text to include below the article excerpt in the channel view, such as a byline or category label.

isCandidateToBeFeaturedboolean

A Boolean that indicates whether this article should be considered for featuring in Apple News.

isHiddenboolean

A Boolean that indicates whether the article should be temporarily hidden from display in feeds in Apple News. Note that a hidden article is accessible if you have a direct link to the article.

isPreviewboolean

A Boolean that indicates whether this article should be public (live) or should be a preview that’s 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 hasn’t yet been approved to publish articles in Apple News Format, setting isPreview to false results in an ONLY_PREVIEW_ALLOWED error.

isSponsoredboolean

A Boolean 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 isSponsored, if you don’t want the sponsored article to appear in your channel’s feed, set sections to [] (an empty array).

linksArticleLinksRequest

The section links for the article.

maturityRatingstring

A string that indicates the viewing audience for the content.

MATURE indicates explicit content that’s only appropriate for a specific audience.

By default, the article inherits the value you set for your channel in News Publisher.

targetTerritoryCountryCodes[string]

The target country codes required for publishing the article. You must enable the specified country codes in your channel. For example, to publish an article only in the United Kingdom and Australia, specify GB and AU. By default, an article inherits the channel’s territories.

Country codes must be in ISO 3166-1 alpha-2 code format; for example, AU for Australia. For a complete list of ISO country codes, see App Store Territories.

If you specify a country code that isn’t defined in your channel, the ARTICLE_TERRITORY_NOT_ALLOWED error is generated. If you specify an invalid country code, the server generates an INVALID_ARTICLE_TERRITORY error.

Mentioned in

See Also

Articles