activityHistoryItem リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
アプリ内の アクティビティ の履歴アイテムを表します。 ユーザー アクティビティは、アプリ内の 1 つの宛先を表します。たとえば、テレビ番組、ドキュメント、ビデオ ゲームの現在のキャンペーンなどです。 ユーザーがそのアクティビティに関与すると、そのアクティビティの開始時刻と終了時刻を示す履歴アイテムとしてエンゲージメントがキャプチャされます。 ユーザーが時間の経過と共にそのアクティビティに再び関与すると、1 つのユーザー アクティビティに対して複数の履歴項目が記録されます。
アプリがセッションを作成する場合、ユーザー エンゲージメントの期間を反映するために activityHistoryItem オブジェクトを アクティビティ オブジェクトに追加する必要があります。 ユーザーがアクティビティに再参加するたびに、新しい activityHistoryItem がアクティビティに追加され、ユーザー エンゲージメントが発生します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| 履歴項目を作成または置換する | activityHistoryItem | そのアクティビティの既存の アクティビティHistoryItem を作成または置き換えます (アップサート)。 ID は GUID である必要があります。 |
| 履歴項目を削除する | コンテンツはありません | 指定したアクティビティを削除します。そのアクティビティの HistoryItem 。 |
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
| status | string | サーバーによって設定されます。 有効なオブジェクトを識別するために使用される状態コード。 値: アクティブ、更新、削除、無視。 |
| userTimezone | String | 省略可能。 アクティビティの生成に使用されたユーザーのデバイスがアクティビティの作成時に配置されたタイム ゾーン。 クロスプラットフォーム表現をサポートするために Olson ID として指定された値。 |
| createdDateTime | DateTimeOffset | サーバーによって設定されます。 オブジェクトがサーバー上に作成されたときの DATETime (UTC)。 |
| lastModifiedDateTime | DateTimeOffset | サーバーによって設定されます。 オブジェクトがサーバー上で変更されたときの DATETime (UTC)。 |
| id | String | 必須です。 activityHistoryItem オブジェクトのクライアント セット GUID。 |
| startedDateTime | DateTimeOffset | 必須です。 activityHistoryItem (アクティビティ セッション) が開始された UTC DateTime。 タイムラインの履歴に必要です。 |
| lastActiveDateTime | DateTimeOffset | 省略可能。 アクティビティHistoryItem (アクティビティ セッション) が最後にアクティブまたは完了と認識された場合の UTC DateTime - null の場合、activityHistoryItem の状態は [進行中] である必要があります。 |
| expirationDateTime | DateTimeOffset | 省略可能。 アクティビティHistoryItem がハード削除される UTC DateTime。 クライアントで設定できます。 |
| activeDurationSeconds | int | 省略可能。 アクティブなユーザー エンゲージメントの期間。 指定されていない場合、これは startedDateTime と lastActiveDateTime から計算されます。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| アクティビティ | userActivity | 省略可能。 NavigationProperty/Containment;ナビゲーション プロパティを関連付けられたアクティビティに移動します。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"activeDurationSeconds":"int",
"createdDateTime": "DateTimeOffset",
"expirationDateTime": "DateTimeOffset",
"id": "String",
"lastActiveDateTime": "DateTimeOffset",
"lastModifiedDateTime": "DateTimeOffset",
"startedDateTime": "DateTimeOffset",
"status": "String",
"userTimezone": "String"
}