Brightspot Integrations Guide

Creating or updating Apple News Channels


By accessing Apple News Channels, you can create a new Apple News Channel or edit an existing one. You can also filter on channels that have either a failed or successful distribution job status. This filter can also be used when searching Apple News Sections and Apple News Articles.

To create a new Apple News channel:

  1. Click menu > Admin > Sites & Settings.
  2. In the Sites widget, select the site for which you want to configure this setting.
  3. Click search, located to the left of more_horiz, and type Apple.
  4. Under Apple News, expand Default Channel and select Create New.
  5. Using the following tables as a reference, complete the fields as needed.
    Click the tab names to view the fields table for that tab.

    Main

    FieldDescription
    Channel NameThe name of the Apple News Channel.
    Channel IDThe ID of the Apple News channel. An administrator can find this ID in the News Publisher Console in Apple iCloud.
    StylesheetThe stylesheet you want to use for all Apple News Articles published in this Apple News Channel.
    Advertisement Auto-PlacementDefines the automatic placement of ads at the channel level.

    API

    FieldDescription
    API KeyThe API key of the Apple News Channel. This can be obtained by generating CMS integration credentials in the Apple News Publisher console.
    API SecretThe API secret of the Apple News Channel. This can be obtained by generating CMS integration credentials in the Apple News Publisher console.
    Advanced
    Connection SettingsThe Connection Settings allow you to extend the API client timeout durations for large article payloads.



    Select one of the two choices:

    • None—Does not modify any of the connection settings for the Apple News Channel.
    • Set—Exposes the fields necessary to modify the connection settings.
    Connection TimeoutSet the timeout (in seconds) before the connection attempt is aborted (defaults to 10s).
    Read TimeoutSet the timeout (in seconds) before the read attempt is aborted (defaults to 10s).
    Write TimeoutSet the timeout (in seconds) before the write attempt is aborted (defaults to 10s).
    Follow SSL RedirectsToggle on to automatically follow redirects for SSL connections. This setting defaults to on.
    Follow RedirectsToggle on to automatically follow redirects for non-SSL connections. This setting defaults to on.
    Cache SettingsThe Cache Settings allow you to modify the standard browser request/response caching for Apple News.



    Select one of the two choices:

    • None—Does not modify any of the cache settings for the Apple News Channel.
    • Set—Exposes the fields necessary to modify the cache settings.
    Disable CachingToggle on to disable the Apple News caching for this site. This setting defaults to off (caching enabled).
    Force CachingToggle on to force caching of the Apple News channel for this site. This setting defaults to off (force caching is disabled).
    Maximum Cache SizeSet the maximum size of the Apple News cache in MB.
    Cache DurationEnter the amount of time (in seconds) the content is cached, before it should be refreshed.
    Always RevalidateToggle on to always have the cache revalidated. This setting defaults to off (no revalidation).
    Prevent Content TransformationToggle on to prevent the transformation of content. This setting defaults to off (content transformation enabled).
    Do Not Refresh CacheToggle on to prevent contacting the server more than once. This setting defaults to off (allows the recontacting of the server).
    Tolerated Duration After ExpirationSet how long (in seconds) after which the cache expires and content is refreshed. This is the max-stale value.
    Required Duration After ExpirationSet how long (in seconds) before its expiration the cache should refresh content This is the min-fresh value.

    Refresh

    FieldDescription
    EnabledToggle on to periodically poll Apple News upstream to get new Apple News Channel information, or to refresh the Apple News Sections defined in Apple News. This allows refresh operations to run on the set cron schedule.
    Cron ExpressionThe cron-based schedule on which the task will run.
    Task UserThe generic Brightspot user who will be associated with Apple News refresh task events. If a generic user does not already exist, it should be created and added to this task.
    Run ImmediatelyToggle on to automatically run the task off schedule when the Apple News Channel is updated.
  6. Click Save.
Note
After the channel is saved, the Apple News Channel Quota, Apple News Share URL, and Apple News Distributions appear. See more information below the tables.

Additional widgets

Once the Apple News Channel is saved and the first refresh occurs, the following widgets appear:

  • Apple News Channel Quota—Displays details about your channel’s remaining quota for sending create and update requests, queue size, and wait time.

    Apple News Channel Quota widget.png Apple News Channel Quota widget.png

  • Apple News Share URL—After the Apple News Article is successfully sent, this widget provides easy access to the story on Apple News.

    Apple News Share URL widget.png Apple News Share URL widget.png

  • Apple News Distributions—Shows all distributions for all jobs sent to the channel.
    Apple News Distributions widget.png Apple News Distributions widget.png
Previous Topic
Associating an Apple News Channel to a site
Next Topic
Applying overrides on an Apple News Section
Was this topic helpful?
Thanks for your feedback.
Our robust, flexible Design System provides hundreds of pre-built components you can use to build the presentation layer of your dreams.

Asset types
Module types
Page types
Brightspot is packaged with content types that get you up and running in a matter of days, including assets, modules and landing pages.

Content types
Modules
Landing pages
Everything you need to know when creating, managing, and administering content within Brightspot CMS.

Dashboards
Publishing
Workflows
Admin configurations
A guide for installing, supporting, extending, modifying and administering code on the Brightspot platform.

Field types
Content modeling
Rich-text elements
Images
A guide to configuring Brightspot's library of integrations, including pre-built options and developer-configured extensions.

Google Analytics
Shopify
Apple News