アクティビティ リソースの種類

名前空間: microsoft.graph

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

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

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

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

メソッド

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

プロパティ

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

リレーションシップ

リレーションシップ	型	説明
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" }]
}