履歴項目リソースの種類

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

アプリ内の アクティビティ の履歴アイテムを表します。 ユーザーアクティビティは、テレビ番組、ドキュメント、ビデオゲームの現在のキャンペーンなど、アプリ内の単一の場所を表します。 ユーザーがそのアクティビティを使用すると、そのアクティビティの開始時刻と終了時刻を示す履歴項目として契約が取得されます。 ユーザーが時間をかけてそのアクティビティを再実行すると、1つのユーザーアクティビティに対して複数の履歴項目が記録されます。

アプリでセッションを作成するときには、ユーザーの活動期間を反映するために、 履歴項目 オブジェクトを activity オブジェクトに追加する必要があります。 ユーザーがアクティビティを再実行するたびに、新しい 履歴アイテム が、[見越計上] ユーザー契約に追加されます。

メソッド

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

プロパティ

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

リレーションシップ

リレーションシップ	型	説明
activity	アクティビティ	省略可能。 NavigationProperty/コンテインメント;関連付けられたアクティビティへのナビゲーションプロパティ。

JSON 表記

以下は、リソースの JSON 表記です。

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