Article ۰ Metadata
Article metadata like publication state and technical timestamps.
| Field name | Type | Description |
|---|---|---|
state | State | State of the article in the content management system. See enum State |
start_time | Timestamp | Manually set editorial timestamp (Gültig von) at which the article is valid to deliver on digital platforms in seconds of UTC time since Unix epoch. |
end_time | Timestamp | Manually set editorial timestamp (Gültig bis) till the article is valid to deliver on digital platforms in seconds of UTC time since Unix epoch. |
publish_time | Timestamp | Editorial timestamp (Publikationsdatum) of the first publication of the article in seconds of UTC time since Unix epoch. This date will be set automatically by the content management system. |
update_time | Timestamp | Editorial timestamp (Aktualisierungsdatum) at which the article was updated in seconds of UTC time since Unix epoch. On first publication this timestamp matches publish_time. Afterwards it's either updated manually in the content management system or automatically if the article content changed significantly. |
transformation_time | Timestamp | Technical timestamp at which the article was transformed in the API layer in seconds of UTC time since Unix epoch. |
transformation_errors | int64 | Number of errors occurred while fetching and/or transforming optional article components (e.g. embeds or nested documents) to an article message. |
last_modification_time | Timestamp | Technical timestamp at which the article was published regardless of the amount and significance of the change. |
event_source | EventSource | Source of the event that caused this item to be transformed and to be written into the DB. |
seo_score | double | The article score (originates from team data's Content Engine, higher scores are better) |
publication_id | int64 | The unique publication_id provided by the CMS, can be used to correlate the state of documents in tapir with the corresponding CMS publication event. |
related_article_source | string | Source of this article, if embedded in another article as a related article. |
tenant | string | The tenant this article belongs to. e.g. www, berlin or such |
message Metadata {
State state = 1;
google.protobuf.Timestamp start_time = 2;
google.protobuf.Timestamp end_time = 3;
google.protobuf.Timestamp publish_time = 4;
google.protobuf.Timestamp update_time = 5;
google.protobuf.Timestamp transformation_time = 6;
int64 transformation_errors = 7;
google.protobuf.Timestamp last_modification_time = 8;
EventSource event_source = 9;
double seo_score = 10;
int64 publication_id = 11;
string related_article_source = 12;
string tenant = 13;
enum State
State of the item (Article, Element)
in the content management system. The state in combination with
start_time and end_time determines whether or not this item should be
rendered; this must be respected by all consumers especially
when content is duplicated or cached.
The terms deleted (articles) and archived (media lib) are interchangeable/synonyms.
This enum combines those two into State.DELETED. An Article is in State.DELETED
if it was deleted in the content management system, or if it's end_time
has been reached.
An Article is in State.DRAFT if it has never been published, or if the
start_time lies in the future.
| Enum value | description |
|---|---|
STATE_UNSPECIFIED | unspecified |
PUBLISHED | published content which is currently within its validity dates |
DELETED | this content is deleted or expired in the CMS |
DRAFT | this content was never published in the CMS |
enum State {
STATE_UNSPECIFIED = 0;
PUBLISHED = 1;
DELETED = 2;
DRAFT = 3;
}
enum EventSource
Even more detail about the circumstances of transformation for this article.
The EventSource will be of type:
PRIMARYin case this article was directly updated and publishedSECONDARYin case this article was indirectly updated. This can be caused by updates of nested elements, such as Videos that may expire at some point. Another source of change may be Scheduled Events like this item becomes valid or invalid at some point in time in the future after the item's original publication time.
| Enum value | description |
|---|---|
| EVENT_SOURCE_UNSPECIFIED | unspecified |
| PRIMARY | this article's transformation was caused by a direct change in the CMS |
| SECONDARY | this article's transformation was caused by a transitive update |
| CONTENT_ENGINE | this article's transformation was caused by an external system (Content Engine) |
enum EventSource {
EVENT_SOURCE_UNSPECIFIED = 0;
PRIMARY = 1;
SECONDARY = 2;
CONTENT_ENGINE = 3;
}