This web application event occurs when the web application starts displaying a publication, personal book, shared personal book, or map attachment.
This event contains the following fields:
| Field | Description |
|---|---|
location |
An object indicating where and how the document appeared. |
type |
Can be page when the document appears on the entire page, or preview when only a part of the document appears. |
value |
Contains more information about where the document appeared. For example, when the type is page, the value can be reader, meaning that the document was displayed in the Reader page. |
document |
An object containing information about the document. |
id |
The document's identifier. |
title |
The title of the document. |
type |
The document's type (for example, STRUCTURED_DOCUMENT). |
metadata |
A list of the document's displayed metadata with the label and values of each key. |
mimeType |
The document's MIME type for UNSTRUCTURED_DOCUMENT. |
parentId |
The ID of the parent document when the document is a resource or attachment. |
A table for the most common fields is in Analytics events.
Example:
[
{
"document": {
"id": "MUTHQr7DBstGQbqa1sJGhw",
"title": "AFS Filters Description",
"type": "STRUCTURED_DOCUMENT",
"metadata": [
{
"key": "Product",
"label": "Product",
"values": [
"AFS"
]
},
{
"key": "AFS_Version",
"label": "Plateforme",
"values": [
"7.14"
]
},
{
"key": "Category",
"label": "Category",
"values": [
"Reference Guides"
]
},
{
"key": "language",
"label": "Language",
"values": [
"English"
]
}
]
},
"location": {
"type": "page",
"value": "reader"
}
}
]