historyItem-RessourcentyphistoryItem resource type

Namespace: Microsoft. GraphNamespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können Änderungen unterworfen werden.APIs under the /beta version in Microsoft Graph are subject to change. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.Use of these APIs in production applications is not supported.

Stellt ein Verlaufselement für eine Aktivität in einer APP dar.Represents a history item for an activity in an app. Benutzeraktivitäten stellen ein einzelnes Ziel in Ihrer APP dar, beispielsweise eine TV-Sendung, ein Dokument oder eine aktuelle Kampagne in einem Videospiel.User activities represent a single destination within your app - for example, a TV show, a document, or a current campaign in a video game. Wenn ein Benutzer diese Aktivität einsetzt, wird das Engagement als Verlaufselement erfasst, das die Anfangs-und Endzeit für diese Aktivität angibt.When a user engages with that activity, the engagement is captured as a history item that indicates the start and end time for that activity. Wenn sich der Benutzer im Laufe der Zeit erneut mit dieser Aktivität beschäftigt, werden mehrere Verlaufselemente für eine einzelne Benutzeraktivität aufgezeichnet.As the user re-engages with that activity over time, multiple history items are recorded for a single user activity.

Wenn eine APP eine Sitzung erstellt, sollte dem Activity -Objekt ein historyItem -Objekt hinzugefügt werden, um den Zeitraum des Benutzer Engagements widerzuspiegeln.When an app creates a session, a historyItem object should be added to the activity object to reflect the period of user engagement. Jedes Mal, wenn ein Benutzer eine Aktivität erneut einbindet, wird der Aktivität ein neuer historyItem hinzugefügt, um das Benutzer Engagement aufzunehmen.Each time a user re-engages with an activity, a new historyItem is added to the activity to accrue user engagement.

MethodenMethods

MethodeMethod RückgabetypReturn Type BeschreibungDescription
Erstellen oder Ersetzen von historyItemCreate or replace historyItem historyItemhistoryItem Erstellt oder ersetzt eine vorhandene historyItem für diese Aktivität (Upsert).Creates or replaces an existing historyItem for that activity (upsert). Die ID muss eine GUID sein.The ID needs to be a GUID.
Löschen eines historyItemDelete a historyItem Kein InhaltNo Content Löscht die angegebene historyItem für diese Aktivität.Deletes the specified historyItem for that activity.

EigenschaftenProperties

NameName TypType BeschreibungDescription
statusstatus stringstring Vom Server festgelegt.Set by the server. Ein Statuscode, der zum Identifizieren gültiger Objekte verwendet wird.A status code used to identify valid objects. Werte: aktiv, aktualisiert, gelöscht, ignoriert.Values: active, updated, deleted, ignored.
userTimezoneuserTimezone ZeichenfolgeString Optional.Optional. Die Zeitzone, in der das Gerät des Benutzers zum Generieren der Aktivität zum Zeitpunkt der Erstellung der Aktivität gefunden wurde.The timezone in which the user's device used to generate the activity was located at activity creation time. Werte, die als Olson-IDs bereitgestellt werden, um die plattformübergreifende Darstellung zu unterstützen.Values supplied as Olson IDs in order to support cross-platform representation.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset Vom Server festgelegt.Set by the server. DateTime in UTC, als das Objekt auf dem Server erstellt wurde.DateTime in UTC when the object was created on the server.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset Vom Server festgelegt.Set by the server. DateTime in UTC, wenn das Objekt auf dem Server geändert wurde.DateTime in UTC when the object was modified on the server.
idid ZeichenfolgeString Erforderlich.Required. Client-legen Sie die GUID für das historyItem -Objekt fest.Client-set GUID for the historyItem object.
startedDateTimestartedDateTime DateTimeOffsetDateTimeOffset Erforderlich.Required. UTC DateTime, wenn die historyItem (Aktivitäts Sitzung) gestartet wurde.UTC DateTime when the historyItem (activity session) was started. Für Chronik Verlauf erforderlich.Required for timeline history.
lastActiveDateTimelastActiveDateTime DateTimeOffsetDateTimeOffset Optional.Optional. UTC DateTime wenn die historyItem (Aktivitäts Sitzung) zuletzt als aktiv oder abgeschlossen (wenn NULL) verstanden wurde, sollte der historyItem -Status fortgesetzt werden.UTC DateTime when the historyItem (activity session) was last understood as active or finished - if null, historyItem status should be Ongoing.
expirationDateTimeexpirationDateTime DateTimeOffsetDateTimeOffset Optional.Optional. UTC DateTime, wenn das historyItem -Objekt dem Hard-Delete unterzogen wird.UTC DateTime when the historyItem will undergo hard-delete. Kann vom Client festgelegt werden.Can be set by the client.
activeDurationSecondsactiveDurationSeconds intint Optional.Optional. Die Dauer des aktiven Benutzer Engagements.The duration of active user engagement. Wenn diese nicht angegeben wird, wird dies aus dem startedDateTime und lastActiveDateTimeberechnet.if not supplied, this is calculated from the startedDateTime and lastActiveDateTime.

BeziehungenRelationships

BeziehungRelationship TypType BeschreibungDescription
activityactivity Kommentaraktivitätactivity Optional.Optional. NavigationProperty/Containment; Navigationseigenschaft der zugeordneten Aktivität.NavigationProperty/Containment; navigation property to the associated activity.

JSON-DarstellungJSON representation

Es folgt eine JSON-Darstellung der Ressource.Here is a JSON representation of the resource.

{
    "status": "String (EnumType)",
    "createdDateTime": "DateTimeOffset",
    "lastModifiedDateTime": "DateTimeOffset",
    "id": "String",
    "expirationDateTime": "DateTimeOffset",
    "startedDateTime": "DateTimeOffset",
    "userTimezone": "String",
    "lastActiveDateTime": "DateTimeOffset",
    "activeDurationSeconds":"int"
}