userActivity リソースの種類

名前空間: microsoft.graph

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

Microsoft Graph のアクティビティを使用すると、ユーザーが複数のデバイス間でアプリで行っていた操作に戻ることができます。 アプリが作成するアクティビティは、すべてのユーザーのデバイスに表示され、アプリ内の特定のコンテンツへのディープ リンクとしてユーザーに公開されます。 アプリ内の特定のコンテンツを、Windows で紹介され、Cortana 通知を介して iOS および Android デバイスでアクセスできる宛先として表現できます。

すべてのアプリが異なるため、Cortana とタイムラインに表示されるユーザー アクティビティにアプリケーション内のアクションをマップする最善の方法を理解する必要があります。 たとえば、ゲームはキャンペーンごとにアクティビティを作成し、ドキュメント作成アプリは一意のドキュメントごとにアクティビティを作成し、基幹業務アプリはワークフローごとにアクティビティを作成する場合があります。

ユーザー アクティビティは Cortana と Windows タイムラインのユーザー エクスペリエンスで紹介されます。これは、ユーザーが過去に取り組んだコンテンツに戻ることを支援することで、ユーザーの生産性と効率を高めることに重点を置いています。

メソッド

メソッド	戻り値の型	説明
アクティビティを作成または置換する	userActivity	既存のアクティビティ (アップサート) を作成または置き換えます。 appActivityId は URL セーフである必要がありますが (RFC 2396 の予約されていない文字を除くすべての文字を 16 進表現に変換する必要があります)、元の appActivityId は URL セーフである必要はありません。
アクティビティを削除する	コンテンツはありません	アプリからそのユーザーの指定したアクティビティを削除します。
アクティビティを取得する	userActivities のコレクション	特定のユーザーのアプリのアクティビティを取得します。
最近のアクティビティを取得する	userActivities のコレクション	特定のユーザーのアプリの最新のアクティビティを取得します。並べ替えられ、最後に作成または更新された アクティビティHistoryItems に基づきます。

プロパティ

名前	種類	説明
activationUrl	String	必須。 appId で表される最適なネイティブ エクスペリエンスでアクティビティを起動するために使用される URL。 ネイティブ アプリが存在しない場合は、Web ベースのアプリを起動する可能性があります。
activitySourceHost	String	必須。 アプリのクロスプラットフォーム ID マッピングを表すドメインの URL。 マッピングは、ドメインでホストされている JSON ファイルとして格納されるか、Windows デベロッパー センター経由で構成できます。 JSON ファイルはクロスプラットフォーム アプリ識別子という名前で、HTTPS ドメインのルート (最上位ドメインまたはサブドメインを含む) でホストされます。 例: https://contoso.com または https://myapp.contoso.com。しかし、https://myapp.contoso.com/somepath は無効です。 クロスプラットフォーム アプリ ID ごとに一意のファイルとドメイン (またはサブ ドメイン) が必要です。 たとえば、Wordと PowerPoint には別のファイルとドメインが必要です。
appActivityId	String	必須。 アプリのコンテキスト内の一意のアクティビティ ID 。 呼び出し元によって提供され、その後は変更できません。
appDisplayName	String	省略可能。 ユーザーのローカル デバイスにアプリがインストールされていない場合に使用するアクティビティの生成に使用されるアプリの短いテキスト説明。
contentInfo	型指定されていない JSON オブジェクト	省略可能。 カスタム データ - JSON-LD は、 schema.org 構文に従ったコンテンツの拡張可能な説明です。
contentUrl	String	省略可能。 コンテンツをネイティブまたは Web ベースのアプリ エクスペリエンス (たとえば、RSS フィード内のアイテムへのポインター) の外部でレンダリングできる場合に使用されます。
createdDateTime	DateTimeOffset	サーバーによって設定されます。 オブジェクトがサーバー上に作成されたときの DATETime (UTC)。
expirationDateTime	DateTimeOffset	サーバーによって設定されます。 オブジェクトがサーバーで期限切れになったときの DATETime (UTC)。
fallbackUrl	String	省略可能。 Web ベースのアプリでアクティビティを起動するために使用される URL (使用可能な場合)。
id	String	URL アドレス指定に使用されるサーバー生成 ID。
lastModifiedDateTime	DateTimeOffset	サーバーによって設定されます。 オブジェクトがサーバー上で変更されたときの DATETime (UTC)。
status	status	サーバーによって設定されます。 有効なオブジェクトを識別するために使用される状態コード。 値: アクティブ、更新、削除、無視。
userTimezone	String	省略可能。 アクティビティの生成に使用されたユーザーのデバイスがアクティビティの作成時に配置されたタイム ゾーン。は、クロスプラットフォーム表現をサポートするために Olson ID として提供される値です。
visualElements	visualInfo	必須。 UX でアクティビティをレンダリングするための情報を含むオブジェクト。

リレーションシップ

リレーションシップ	型	説明
historyItems	activityHistoryItem コレクション	省略可能。 NavigationProperty/Containment;ナビゲーション プロパティをアクティビティの historyItems に移動します。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
    "appActivityId": "String",
    "activitySourceHost": "String (host name/domain/URL)",
    "userTimezone": "String",
    "appDisplayName": "String",
    "activationUrl": "String (URL)",
    "contentUrl": "String (URL)",
    "fallbackUrl": "String (URL)",
    "createdDateTime": "DateTimeOffset",
    "lastModifiedDateTime": "DateTimeOffset",
    "expirationDateTime": "DateTimeOffset",
    "id": "String",
    "status": "active | updated | deleted | ignored",
    "contentInfo": { "@odata.type": "microsoft.graph.Json" },
    "visualElements": { "@odata.type": "microsoft.graph.visualInfo" },
    "historyItems": [{ "@odata.type": "microsoft.graph.activityHistoryItem" }]
}