名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
アプリ内の 1 つのアクティビティ (テレビ番組、ドキュメント、ビデオ ゲームの現在のキャンペーンなど) を表します。 ユーザーがそのアクティビティに関与すると、そのアクティビティの開始時刻と終了時刻を示す 履歴アイテム としてエンゲージメントがキャプチャされます。 ユーザーが時間の経過と共にそのアクティビティに再び関与すると、1 つのユーザー アクティビティに対して複数の履歴項目が記録されます。
Microsoft Graph のアクティビティを使用すると、ユーザーが複数のデバイスにわたってアプリで実行していた操作に戻ることができるようになります。 アプリが作成したアクティビティは、すべてのユーザーのデバイスに表示され、アプリ内の特定のコンテンツへのディープ リンクとしてユーザーに表示されます。 アプリ内の特定のコンテンツを、Windows で表示される、または iOS および Android デバイスで Cortana 通知経由でアクセス可能な宛先として表現することができます。
すべてのアプリは異なるため、アプリケーション内のアクションを Cortana とタイムラインに表示されるユーザー アクティビティにマップする最適な方法を理解する必要があります。 たとえば、ゲームではキャンペーンごとにアクティビティが作成され、ドキュメント作成アプリでは固有のドキュメントごとにアクティビティが作成され、基幹業務アプリではワークフローごとにアクティビティが作成されます。
ユーザー アクティビティは、Cortana および Windows タイムラインのユーザー エクスペリエンスで表示されます。ユーザーが過去に作業したコンテンツに戻れるようにすることで、ユーザーの生産性と効率を向上させることに重点が置かれます。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| アクティビティを作成または置換する | userActivity | 既存のアクティビティを作成または置換します (アップサート)。 appActivityId は URL セーフである必要がありますが (RFC 2396 の予約されていない文字を除くすべての文字は 16 進数表現に変換する必要があります)、元の appActivityId は URL セーフである必要はありません。 |
| アクティビティを削除する | コンテンツはありません | そのユーザーの指定されたアクティビティをアプリから削除します。 |
| アクティビティを取得する | userActivity のコレクション | 特定のユーザーのアプリのアクティビティを取得します。 |
| 最近のアクティビティを取得する | userActivity のコレクション | 特定のユーザーのアプリの最新のアクティビティを取得し、並べ替えて、最後に作成または更新された activityHistoryItems に基づいて取得します。 |
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
| userTimezone | String | 省略可能。 アクティビティの作成時に、アクティビティの生成に使用されたユーザーのデバイスが配置されていたタイムゾーン。クロスプラットフォーム表現をサポートするために、Olson ID として提供される値。 |
| createdDateTime | DateTimeOffset | サーバーで設定します。 オブジェクトがサーバー上で作成された UTC 形式の DateTime。 |
| lastModifiedDateTime | DateTimeOffset | サーバーで設定します。 オブジェクトがサーバーで変更されたときの UTC での DateTime。 |
| id | 文字列 | URL アドレス指定に使用されるサーバー生成 ID。 |
| appActivityId | String | 必須です。 アプリのコンテキストにおける一意のアクティビティ ID - 呼び出し元によって提供され、その後は変更できません。 |
| activitySourceHost | String | 必須です。 アプリのクロスプラットフォーム ID マッピングを表すドメインの URL。 マッピングは、ドメインでホストされている JSON ファイルとして保存されるか、Windows デベロッパー センターで構成できます。 JSON ファイルは cross-platform-app-identifiers という名前で、HTTPS ドメインのルート (トップ レベル ドメインまたはサブ ドメインを含む) でホストされます。 例: https://contoso.com または https://myapp.contoso.com。しかし、https://myapp.contoso.com/somepath は無効です。 クロスプラットフォーム アプリの ID ごとに、一意のファイルとドメイン (またはサブドメイン) が必要です。 たとえば、Word と PowerPoint では、別のファイルとドメインが必要です。 |
| appDisplayName | String | 省略可能。 アプリがユーザーのローカル デバイスにインストールされていない場合に使用するアクティビティを生成するために使用されるアプリの短い説明。 |
| activationUrl | String | 必須です。 appId で表される最高のネイティブ エクスペリエンスでアクティビティを起動するために使用される URL。 ネイティブ アプリが存在しない場合、Web ベースのアプリを起動する場合があります。 |
| fallbackUrl | String | 省略可能。 Web ベースのアプリでアクティビティを起動するために使用される URL(使用可能な場合)。 |
| contentUrl | String | 省略可能。 コンテンツをネイティブまたは Web ベースのアプリ エクスペリエンスの外部でレンダリングできる場合に使用されます (たとえば、RSS フィード内の項目へのポインター)。 |
| visualElements | visualInfo | 必須です。 UX でアクティビティをレンダリングするための情報を含むオブジェクト。 |
| contentInfo | 型指定されていない JSON オブジェクト | 省略可能。 カスタムデータ - schema.org 構文に従ったコンテンツの JSON-LD 拡張可能な説明。 |
| expirationDateTime | DateTimeOffset | サーバーで設定します。 オブジェクトがサーバーで期限切れになった UTC の DateTime。 |
| status | string | サーバーで設定します。 有効なオブジェクトを識別するために使用される状態コード。 値: active、updated、deleted、ignored。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| historyItems | activityHistoryItem コレクション | 省略可能。 NavigationProperty/Containment;navigation プロパティをアクティビティの activityHistoryItems に追加します。 |
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": "string",
"contentInfo": { "@data.type": "microsoft.graph.Json" },
"visualElements": { "@data.type": "microsoft.graph.visualInfo" },
"historyItems": [{ "@odata.type": "microsoft.graph.activityHistoryItem" }]
}