historyItem リソースの種類

名前空間: microsoft.graph

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

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

メソッド

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

プロパティ

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

リレーションシップ

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

JSON 表記

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

{
    "status": "active | updated | deleted | ignored",
    "createdDateTime": "DateTimeOffset",
    "lastModifiedDateTime": "DateTimeOffset",
    "id": "String",
    "expirationDateTime": "DateTimeOffset",
    "startedDateTime": "DateTimeOffset",
    "userTimezone": "String",
    "lastActiveDateTime": "DateTimeOffset",
    "activeDurationSeconds":"int"
}