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

アプリ内の1つのアクティビティを表します。たとえば、テレビ番組、ドキュメント、ビデオゲームの現在のキャンペーンなどがあります。Represents a single activity within an app - for example, a TV show, a document, or a current campaign in a video game. ユーザーがそのアクティビティを使用すると、そのアクティビティの開始時刻と終了時刻を示す履歴項目として契約が取得されます。When a user engages with that activity, the engagement is captured as a history item that indicates the start and end time for that activity. ユーザーが時間をかけてそのアクティビティを再実行すると、1つのユーザーアクティビティに対して複数の履歴項目が記録されます。As the user re-engages with that activity over time, multiple history items are recorded for a single user activity.

Microsoft Graph のアクティビティを使用すると、ユーザーが複数のデバイスでアプリで実行していた操作に戻れるようにすることができます。You can use activities in Microsoft Graph to enable users to get back to what they were doing in their app, across multiple devices. アプリによって作成されるアクティビティは、すべてのユーザーのデバイスに表示され、アプリ内の特定のコンテンツへの詳細なリンクとしてユーザーに公開されます。Activities that your app creates appear on all users' devices, and are exposed to users as deep links to specific content within your app. アプリ内の特定のコンテンツを、Windows で紹介されている送信先として表現し、Cortana 通知を介して iOS および Android デバイスでアクセスすることができます。You can express specific content within your app as a destination that is showcased in Windows, and accessible on iOS and Android devices through Cortana notifications.

すべてのアプリは異なるため、アプリケーション内のアクションを Cortana とタイムラインで表示されるユーザーアクティビティにマップするための最善の方法を理解しておく必要があります。Because every app is different, it's up to you to understand the best way to map actions within your application to user activities that will appear in Cortana and Timeline. たとえば、ゲームは各キャンペーンに対してアクティビティを作成し、ドキュメント作成アプリは固有のドキュメントごとにアクティビティを作成し、基幹業務アプリは各ワークフローのアクティビティを作成する場合があります。For example, games might create an activity for each campaign, document authoring apps might create an activity for each unique document, and line-of-business apps might create an activity for each workflow.

ユーザーのアクティビティは、Cortana および Windows タイムラインのユーザーエクスペリエンスで紹介されています。これは、ユーザーが過去に作業したコンテンツに戻れるようにすることによって、ユーザーの生産性と効率を向上させることに重点を置いています。Your user activities will be showcased in Cortana and Windows Timeline user experiences, which are focused on increasing users' productivity and efficiency by helping them get back to content they worked on in the past.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
アクティビティを作成または置換するCreate or replace activity アクティビティactivity 既存のアクティビティ (upsert) を作成または置換します。Creates or replaces an existing activity (upsert). AppActivityId は URL セーフである必要があります (RFC 2396 の予約されていない文字を除くすべての文字を16進表記に変換する必要があります) が、元の appActivityId を URL セーフにする必要はありません。The appActivityId needs to be URL-safe (all characters except for RFC 2396 unreserved characters must be converted to their hexadecimal representation), but the original appActivityId does not have to be URL-safe.
アクティビティを削除するDelete an activity コンテンツはありませんNo Content そのユーザーの指定したアクティビティをアプリから削除します。Deletes the specified activity for that user from your app.
アクティビティを取得するGet activities アクティビティのコレクションCollection of activities 特定のユーザーのアプリのアクティビティを取得します。Gets the activities for your app for a given user.
最近のアクティビティを取得するGet recent activities アクティビティのコレクションCollection of activities 指定されたユーザーのアプリの最新のアクティビティを取得し、最後に作成または更新された履歴アイテムに基づいて並べ替えます。Gets the most recent activities for your app for a given user, sorted and based on the most recently created or updated historyItems.

プロパティProperties

名前Name Type 説明Description
userTimezoneuserTimezone StringString 省略可能。Optional. アクティビティを生成するために使用されたユーザーのデバイスがアクティビティの作成時にあるタイムゾーン。クロスプラットフォーム表現をサポートするために Olson Id として提供される値。The timezone in which the user's device used to generate the activity was located at activity creation time; values supplied as Olson IDs in order to support cross-platform representation.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset サーバーによって設定されます。Set by the server. サーバー上でオブジェクトが作成された日時 (UTC)。DateTime in UTC when the object was created on the server.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset サーバーによって設定されます。Set by the server. サーバー上のオブジェクトが変更された日時 (UTC)。DateTime in UTC when the object was modified on the server.
idid 文字列String サーバーによって生成された ID。 URL アドレス指定に使用されます。Server-generated ID used for URL addressing.
appActivityIdappActivityId StringString 必須。Required. 発信者によって提供される、またはその後に不変である、アプリのコンテキスト内の一意のアクティビティ ID。The unique activity ID in the context of the app - supplied by caller and immutable thereafter.
activitySourceHostactivitySourceHost StringString 必須。Required. アプリのクロスプラットフォーム id マッピングを表すドメインの URL。URL for the domain representing the cross-platform identity mapping for the app. マッピングは、ドメインでホストされている JSON ファイルとして、または Windows デベロッパーセンターから構成可能な JSON ファイルのいずれかとして格納されます。Mapping is stored either as a JSON file hosted on the domain or configurable via Windows Dev Center. JSON ファイルは、クロスプラットフォームアプリ識別子と呼ばれ、トップレベルドメインまたはサブドメインを含む HTTPS ドメインのルートでホストされます。The JSON file is named cross-platform-app-identifiers and is hosted at root of your HTTPS domain, either at the top level domain or include a sub domain. 例: https://contoso.com または https://myapp.contoso.com。しかし、https://myapp.contoso.com/somepath は無効です。For example: https://contoso.com or https://myapp.contoso.com but NOT https://myapp.contoso.com/somepath. クロスプラットフォームのアプリ id ごとに一意のファイルとドメイン (またはサブドメイン) が必要です。You must have a unique file and domain (or sub domain) per cross-platform app identity. たとえば、Word と PowerPoint では、別のファイルとドメインが必要になります。For example, a separate file and domain is needed for Word vs. PowerPoint.
appDisplayNameappDisplayName StringString 省略可能。Optional. アプリがユーザーのローカルデバイスにインストールされていない場合に使用するアクティビティの生成に使用するアプリの短いテキストの説明。Short text description of the app used to generate the activity for use in cases when the app is not installed on the user’s local device.
activationUrlactivationUrl StringString 必須。Required. AppId で表される最高のネイティブの操作でアクティビティを開始するために使用される URL。URL used to launch the activity in the best native experience represented by the appId. ネイティブアプリが存在しない場合は、web ベースのアプリを起動する可能性があります。Might launch a web-based app if no native app exists.
fallbackUrlfallbackUrl StringString 省略可能。Optional. Web ベースのアプリでアクティビティを起動するために使用される URL (可能な場合)。URL used to launch the activity in a web-based app, if available.
contentUrlcontentUrl StringString 省略可能。Optional. ネイティブまたは web ベースのアプリの使用状況 (RSS フィード内のアイテムへのポインターなど) の外部でコンテンツをレンダリングできる場合に使用します。Used in the event the content can be rendered outside of a native or web-based app experience (for example, a pointer to an item in an RSS feed).
visualElementsvisualElements visualInfovisualInfo 必須です。Required. UX でアクティビティをレンダリングするための情報を含むオブジェクト。The object containing information to render the activity in the UX.
contentInfocontentInfo 型指定のない JSON オブジェクトUntyped JSON object 省略可能。Optional. Schema.org構文に従ったコンテンツの、データのカスタム部分。A custom piece of data - JSON-LD extensible description of content according to schema.org syntax.
expirationDateTimeexpirationDateTime DateTimeOffsetDateTimeOffset サーバーによって設定されます。Set by the server. サーバー上のオブジェクトの有効期限が切れたときの日時。DateTime in UTC when the object expired on the server.
statusstatus statusstatus サーバーによって設定されます。Set by the server. 有効なオブジェクトを識別するために使用される状態コード。A status code used to identify valid objects. 値: アクティブ、更新済み、削除済み、無視。Values: active, updated, deleted, ignored.

リレーションシップRelationships

リレーションシップRelationship Type 説明Description
historyItemshistoryItems Activityhistory itemコレクションactivityHistoryItem collection 省略可能。Optional. NavigationProperty/コンテインメント;アクティビティの履歴アイテムへのナビゲーションプロパティ。NavigationProperty/Containment; navigation property to the activity's historyItems.

JSON 表記JSON representation

以下は、リソースの JSON 表記です。Here is a JSON representation of the resource.

{
    "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" }]
}