Тип ресурса userActivity

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Представляет одно действие в приложении, например тв-шоу, документ или текущую кампанию в видеоигре. Когда пользователь участвует в этом действии, задействование записывается как элемент журнала , указывающий время начала и окончания этого действия. По мере того как пользователь повторно взаимодействует с этим действием с течением времени, для одного действия пользователя записываются несколько элементов журнала.

Вы можете использовать действия в Microsoft Graph, чтобы позволить пользователям вернуться к тому, что они делали в своем приложении, на нескольких устройствах. Действия, создаваемые приложением, отображаются на всех устройствах пользователей и предоставляются пользователям в виде прямых ссылок на определенное содержимое в приложении. Вы можете выразить определенное содержимое в приложении в качестве назначения, которое демонстрируется в Windows и доступно на устройствах iOS и Android с помощью уведомлений Кортаны.

Так как каждое приложение отличается, вы можете понять, как лучше всего сопоставить действия в приложении с действиями пользователей, которые будут отображаться в Кортане и временной шкале. Например, игры могут создавать действия для каждой кампании, приложения для разработки документов могут создавать действия для каждого уникального документа, а бизнес-приложения могут создавать действия для каждого рабочего процесса.

Ваши действия пользователей будут показаны в пользовательском интерфейсе Кортаны и Временной шкалы Windows, которые направлены на повышение производительности и эффективности пользователей, помогая им вернуться к содержимому, над которым они работали ранее.

Методы

Метод	Возвращаемый тип	Описание
Создание или замена действия	userActivity	Создает или заменяет существующее действие (upsert). AppActivityId должен быть безопасным по URL-адресу (все символы, кроме rfc 2396 без резервирования, должны быть преобразованы в шестнадцатеричное представление), но исходный идентификатор appActivityId не обязательно должен быть URL-безопасным.
Удаление действия	Содержимое отсутствует	Удаляет указанное действие для этого пользователя из приложения.
Получение действий	Коллекция userActivity	Возвращает действия для приложения для данного пользователя.
Получение последних действий	Коллекция userActivity	Возвращает последние действия для приложения для данного пользователя, отсортированные и основанные на последних созданных или обновленных activityHistoryItems.

Свойства

Имя	Тип	Описание
userTimezone	String	Необязательный параметр. Часовой пояс, в котором устройство пользователя, используемое для создания действия, находилось во время создания действия; значения, предоставленные в виде идентификаторов Olson для поддержки кроссплатформенного представления.
createdDateTime	DateTimeOffset	Задается сервером. DateTime в формате UTC, когда объект был создан на сервере.
lastModifiedDateTime	DateTimeOffset	Задается сервером. DateTime в формате UTC, когда объект был изменен на сервере.
id	String	Идентификатор сервера, используемый для адресации URL-адресов.
appActivityId	String	Обязательный. Уникальный идентификатор действия в контексте приложения , предоставленный вызывающим и неизменяемый после этого.
activitySourceHost	String	Обязательный. URL-адрес домена, представляющего кроссплатформенное сопоставление удостоверений для приложения. Сопоставление хранится в виде JSON-файла, размещенного в домене, или настраивается в Центре разработки для Windows. JSON-файл называется cross-platform-app-identifiers и размещается в корне домена HTTPS либо в домене верхнего уровня, либо включает в себя поддомен. Примеры: https://contoso.com или https://myapp.contoso.com, но НЕ https://myapp.contoso.com/somepath. У вас должен быть уникальный файл и домен (или поддомен) для каждого кроссплатформенного удостоверения приложения. Например, для Word и PowerPoint требуется отдельный файл и домен.
appDisplayName	String	Необязательный параметр. Краткое текстовое описание приложения, используемого для создания действия для использования в случаях, когда приложение не установлено на локальном устройстве пользователя.
activationUrl	String	Обязательный. URL-адрес, используемый для запуска действия в лучшем собственном интерфейсе, представленном appId. Может запускать веб-приложение, если не существует собственного приложения.
fallbackUrl	String	Необязательный параметр. URL-адрес, используемый для запуска действия в веб-приложении, если он доступен.
contentUrl	String	Необязательный параметр. Используется в случае, если содержимое может быть отрисовано за пределами собственного или веб-интерфейса приложения (например, указатель на элемент в RSS-канале).
visualElements	visualInfo	Обязательно. Объект , содержащий сведения для отрисовки действия в пользовательском интерфейсе.
contentInfo	Нетипизированный объект JSON	Необязательный параметр. Пользовательский фрагмент данных — расширяемое описание содержимого JSON-LD в соответствии с синтаксисом schema.org .
expirationDateTime	DateTimeOffset	Задается сервером. DateTime в формате UTC, когда срок действия объекта истек на сервере.
status	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" }]
}