| Field | Type | Required | Description | Example |
|---|---|---|---|---|
startTime |
OffsetDateTime | ➖ | The date and time at which the announcement becomes active. | |
endTime |
OffsetDateTime | ➖ | The date and time at which the announcement expires. | |
title |
Optional<String> | ➖ | The headline of the announcement. | |
body |
Optional<StructuredText> | ➖ | N/A | |
emoji |
Optional<String> | ➖ | An emoji used to indicate the nature of the announcement. | |
thumbnail |
Optional<Thumbnail> | ➖ | N/A | |
banner |
Optional<Thumbnail> | ➖ | N/A | |
audienceFilters |
List<FacetFilter> | ➖ | Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search. | |
sourceDocumentId |
Optional<String> | ➖ | The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread). | |
hideAttribution |
Optional<Boolean> | ➖ | Whether or not to hide an author attribution. | |
channel |
Optional<AnnouncementChannel> | ➖ | This determines whether this is a Social Feed post or a regular announcement. | |
postType |
Optional<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. | |
isPrioritized |
Optional<Boolean> | ➖ | Used by the Social Feed to pin posts to the front of the feed. | |
viewUrl |
Optional<String> | ➖ | 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". | |
draftId |
Optional<Long> | ➖ | The opaque id of the associated draft. | |
permissions |
Optional<ObjectPermissions> | ➖ | N/A | |
trackingToken |
Optional<String> | ➖ | An opaque token that represents this particular UGC. To be used for /feedback reporting. |
|
id |
Optional<Long> | ➖ | The opaque id of the announcement. | |
author |
Optional<Person> | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
createTimestamp |
Optional<Long> | ➖ | Server Unix timestamp of the creation time (in seconds since epoch UTC). | |
lastUpdateTimestamp |
Optional<Long> | ➖ | Server Unix timestamp of the last update time (in seconds since epoch UTC). | |
updatedBy |
Optional<Person> | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
viewerInfo |
Optional<AnnouncementViewerInfo> | ➖ | N/A | |
sourceDocument |
Optional<Document> | ➖ | N/A | |
isPublished |
Optional<Boolean> | ➖ | Whether or not the announcement is published. | |
favoriteInfo |
Optional<FavoriteInfo> | ➖ | N/A |