| Field | Type | Required | Description | Example |
|---|---|---|---|---|
start_time |
date | ➖ | The date and time at which the announcement becomes active. | |
end_time |
date | ➖ | The date and time at which the announcement expires. | |
title |
Optional[str] | ➖ | The headline of the announcement. | |
body |
Optional[models.StructuredText] | ➖ | N/A | |
emoji |
Optional[str] | ➖ | An emoji used to indicate the nature of the announcement. | |
thumbnail |
Optional[models.Thumbnail] | ➖ | N/A | |
banner |
Optional[models.Thumbnail] | ➖ | N/A | |
audience_filters |
List[models.FacetFilter] | ➖ | Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search. | |
source_document_id |
Optional[str] | ➖ | The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). | |
hide_attribution |
Optional[bool] | ➖ | Whether or not to hide an author attribution. | |
channel |
Optional[models.AnnouncementChannel] | ➖ | This determines whether this is a Social Feed post or a regular announcement. | |
post_type |
Optional[models.AnnouncementPostType] | ➖ | This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. | |
is_prioritized |
Optional[bool] | ➖ | Used by the Social Feed to pin posts to the front of the feed. | |
view_url |
Optional[str] | ➖ | URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED". | |
draft_id |
Optional[int] | ➖ | The opaque id of the associated draft. | |
permissions |
Optional[models.ObjectPermissions] | ➖ | N/A | |
id |
Optional[int] | ➖ | The opaque id of the announcement. | |
author |
Optional[models.Person] | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
create_timestamp |
Optional[int] | ➖ | Server Unix timestamp of the creation time (in seconds since epoch UTC). | |
last_update_timestamp |
Optional[int] | ➖ | Server Unix timestamp of the last update time (in seconds since epoch UTC). | |
updated_by |
Optional[models.Person] | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
viewer_info |
Optional[models.AnnouncementViewerInfo] | ➖ | N/A | |
source_document |
Optional[models.Document] | ➖ | N/A | |
is_published |
Optional[bool] | ➖ | Whether or not the announcement is published. |