activityHistoryItem リソースの種類

[アーティクル]
05/14/2024

名前空間: microsoft.graph

重要

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

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

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

メソッド

メソッド	戻り値の型	説明
activityHistoryItem をCreateまたは置換する	activityHistoryItem	そのアクティビティの既存のアクティビティHistoryItem をCreateまたは置き換えます (upsert)。 ID は GUID である必要があります。
アクティビティの削除HistoryItem	コンテンツはありません	指定したアクティビティを削除します。そのアクティビティの 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"
}

Share via