historyItem リソースの種類

[アーティクル]
03/16/2023

名前空間: microsoft.graph

アプリ内のアクティビティの履歴アイテムを表します。ユーザーアクティビティは、アプリ内の 1 つの宛先を表します。たとえば、テレビ番組、ドキュメント、ビデオゲームの現在のキャンペーンなどです。ユーザーがそのアクティビティに関与すると、そのアクティビティの開始時刻と終了時刻を示す履歴アイテムとしてエンゲージメントがキャプチャされます。ユーザーが時間の経過と共にそのアクティビティに再び関与すると、1 つのユーザーアクティビティに対して複数の履歴項目が記録されます。

アプリがセッションを作成するときは、ユーザーエンゲージメントの期間を反映するために 、historyItem オブジェクトを アクティビティ オブジェクトに追加する必要があります。ユーザーがアクティビティに再参加するたびに、新しい historyItem がアクティビティに追加され、ユーザーエンゲージメントが発生します。

メソッド

メソッド	戻り値の型	説明
historyItem を作成または置換する	historyItem	そのアクティビティの既存の historyItem を作成または置換します (アップサート)。 ID は GUID である必要があります。
historyItem を削除する	コンテンツはありません	そのアクティビティの指定した historyItem を削除します。

プロパティ

名前	型	説明
activeDurationSeconds	int	省略可能です。アクティブなユーザーエンゲージメントの期間。指定されていない場合、これは startedDateTime と lastActiveDateTime から計算されます。
createdDateTime	DateTimeOffset	サーバーによって設定されます。オブジェクトがサーバー上に作成されたときの DATETime (UTC)。
expirationDateTime	DateTimeOffset	省略可能です。 historyItem がハード削除される UTC DateTime。クライアントで設定できます。
id	String	必須です。 historyItem オブジェクトのクライアントセット GUID。
lastActiveDateTime	DateTimeOffset	オプション。 utc DateTime historyItem (アクティビティセッション) が最後にアクティブまたは完了と認識された場合 -null の場合、 historyItem の状態は進行中である必要があります。
lastModifiedDateTime	DateTimeOffset	サーバーによって設定されます。オブジェクトがサーバー上で変更されたときの DATETime (UTC)。
startedDateTime	DateTimeOffset	必須です。 historyItem (アクティビティセッション) が開始された UTC DateTime。タイムライン履歴に必要です。
status	status	サーバーによって設定されます。有効なオブジェクトを識別するために使用される状態コード。値: アクティブ、更新、削除、無視。
userTimezone	String	省略可能。アクティビティの生成に使用されたユーザーのデバイスがアクティビティの作成時に配置されたタイムゾーン。クロスプラットフォーム表現をサポートするために Olson ID として指定された値。

リレーションシップ

リレーションシップ	型	説明
アクティビティ	userActivity	オプション。 NavigationProperty/Containment;ナビゲーションプロパティを関連付けられたアクティビティに移動します。

JSON 表記

リソースの JSON 表記を次に示します。

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