userActivity 资源类型

项目
05/24/2024

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。不支持在生产应用程序中使用这些 API。若要确定 API 是否在 v1.0 中可用，请使用版本选择器。

表示应用内的单个活动 - 例如，电视节目、文档或视频游戏中的当前市场活动。当用户参与该活动时，活动将捕获为指示该活动的开始和结束时间的历史记录项。随着用户随着时间的推移重新参与该活动，单个用户活动将记录多个历史记录项。

可以使用 Microsoft Graph 中的活动，让用户跨多台设备回到应用中执行的操作。应用创建的活动显示在所有用户的设备上，并作为指向应用中特定内容的深层链接向用户公开。可以将应用中的特定内容表达为在 Windows 中展示的目标，并通过 Cortana 通知在 iOS 和 Android 设备上访问。

由于每个应用都不同，因此你需要了解将应用程序中的操作映射到将在 Cortana 和时间线中显示的用户活动的最佳方法。例如，游戏可能会为每个市场活动创建活动，文档创作应用可能会为每个唯一文档创建一个活动，业务线应用可能会为每个工作流创建一个活动。

你的用户活动将在 Cortana 和 Windows 时间线用户体验中展示，这些体验侧重于通过帮助他们恢复过去处理的内容来提高用户的工作效率和效率。

方法

方法	返回类型	说明
创建或替换活动	userActivity	创建或替换现有活动， (upsert) 。 appActivityId 必须是 URL 安全 (除 RFC 2396 未保留字符之外的所有字符都必须转换为其) 的十六进制表示形式，但原始 appActivityId 不必是 URL 安全。
删除活动	无内容	从应用中删除该用户的指定活动。
获取活动	userActivity 的集合	获取给定用户的应用的活动。
获取最近的活动	userActivity 的集合	获取给定用户应用的最新活动，根据最近创建或更新的活动HistoryItems进行排序。

属性

名称	类型	说明
userTimezone	String	可选。用于生成活动的用户的设备的时区位于活动创建时;作为 Olson ID 提供的值，以支持跨平台表示形式。
createdDateTime	DateTimeOffset	由服务器设置。在服务器上创建对象的日期/时间（UTC）。
lastModifiedDateTime	DateTimeOffset	由服务器设置。在服务器上修改对象时的 UTC 日期/时间。
id	String	用于 URL 寻址的服务器生成的 ID。
appActivityId	String	必填。应用上下文中的唯一活动 ID - 由调用方提供，此后不可变。
activitySourceHost	String	必填。表示应用的跨平台标识映射的域的 URL。映射存储为域上托管的 JSON 文件，或通过 Windows 开发人员中心进行配置。 JSON 文件名为跨平台应用标识符，托管在 HTTPS 域的根目录中，可以是顶级域，要么包含子域。例如：https://contoso.com 或 https://myapp.contoso.com，但不是 https://myapp.contoso.com/somepath。对于每个跨平台应用标识，必须具有唯一的文件和域 (或子域) 。例如，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。
状态	string	由服务器设置。用于标识有效对象的状态代码。值：活动、更新、删除、忽略。

关系

关系	类型	说明
historyItems	activityHistoryItem 集合	可选。 NavigationProperty/Containment;活动 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" }]
}

通过

userActivity 资源类型

方法

属性

关系

JSON 表示形式

反馈

其他资源