userActivity-Ressourcentyp

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Stellt eine einzelne Aktivität innerhalb einer App dar, z. B. eine Fernsehsendung, ein Dokument oder eine aktuelle Kampagne in einem Videospiel. Wenn sich ein Benutzer mit dieser Aktivität beschäftigt, wird die Interaktion als Verlaufselement erfasst, das die Start- und Endzeit für diese Aktivität angibt. Wenn sich der Benutzer im Laufe der Zeit erneut mit dieser Aktivität beschäftigt, werden mehrere Verlaufselemente für eine einzelne Benutzeraktivität aufgezeichnet.

Sie können Aktivitäten in Microsoft Graph verwenden, um Benutzern zu ermöglichen, auf mehreren Geräten zu den Aktionen in ihrer App zurückzukehren. Aktivitäten, die Ihre App erstellt, werden auf allen Geräten aller Benutzer angezeigt und werden benutzern als Deep-Links zu bestimmten Inhalten in Ihrer App verfügbar gemacht. Sie können bestimmte Inhalte in Ihrer App als Ziel ausdrücken, das in Windows vorgestellt wird und auf iOS- und Android-Geräten über Cortana-Benachrichtigungen zugänglich ist.

Da jede App anders ist, liegt es an Ihnen, zu verstehen, wie Sie Aktionen innerhalb Ihrer Anwendung am besten benutzerseitigen Aktivitäten zuordnen können, die in Cortana und der Zeitachse angezeigt werden. Beispielsweise können Spiele eine Aktivität für jede Kampagne erstellen, Dokumenterstellungs-Apps können eine Aktivität für jedes eindeutige Dokument erstellen, und Branchen-Apps können eine Aktivität für jeden Workflow erstellen.

Ihre Benutzeraktivitäten werden in Cortana- und Windows-Zeitachsen-Benutzererfahrungen vorgestellt, die sich auf die Steigerung der Produktivität und Effizienz der Benutzer konzentrieren, indem sie zu Inhalten zurückkehren, an denen sie in der Vergangenheit gearbeitet haben.

Methoden

Methode	Rückgabetyp	Beschreibung
Aktivität erstellen oder ersetzen	userActivity	Erstellt oder ersetzt eine vorhandene Aktivität (Upsert). Die appActivityId muss URL-sicher sein (alle Zeichen mit Ausnahme von nicht reservierten RFC 2396-Zeichen müssen in ihre hexadezimale Darstellung konvertiert werden), aber die ursprüngliche appActivityId muss nicht URL-sicher sein.
Aktivität löschen	Kein Inhalt	Löscht die angegebene Aktivität für diesen Benutzer aus Ihrer App.
Aktivitäten abrufen	Sammlung von userActivity	Ruft die Aktivitäten für Ihre App für einen bestimmten Benutzer ab.
Aktuelle Aktivitäten abrufen	Sammlung von userActivity	Ruft die letzten Aktivitäten für Ihre App für einen bestimmten Benutzer ab, sortiert und basierend auf den zuletzt erstellten oder aktualisierten activityHistoryItems.

Eigenschaften

Name	Typ	Beschreibung
userTimezone	Zeichenfolge	Optional. Die Zeitzone, in der sich das Gerät des Benutzers zum Generieren der Aktivität zum Zeitpunkt der Aktivitätserstellung befand; Werte, die als Olson-IDs angegeben werden, um die plattformübergreifende Darstellung zu unterstützen.
createdDateTime	DateTimeOffset	Wird vom Server festgelegt. DateTime in UTC, wenn das Objekt auf dem Server erstellt wurde.
lastModifiedDateTime	DateTimeOffset	Wird vom Server festgelegt. DateTime in UTC, wenn das Objekt auf dem Server geändert wurde.
id	Zeichenfolge	Vom Server generierte ID, die für die URL-Adressierung verwendet wird.
appActivityId	Zeichenfolge	Erforderlich. Die eindeutige Aktivitäts-ID im Kontext der App – vom Aufrufer bereitgestellt und danach unveränderlich.
activitySourceHost	Zeichenfolge	Erforderlich. URL für die Domäne, die die plattformübergreifende Identitätszuordnung für die App darstellt. Die Zuordnung wird entweder als JSON-Datei gespeichert, die in der Domäne gehostet wird oder über Windows Dev Center konfigurierbar ist. Die JSON-Datei heißt plattformübergreifende App-Bezeichner und wird im Stammverzeichnis Ihrer HTTPS-Domäne gehostet, entweder in der Domäne der obersten Ebene oder in einer Unterdomäne. Zum Beispiel: https://contoso.com oder https://myapp.contoso.com, jedoch NICHT https://myapp.contoso.com/somepath. Sie müssen über eine eindeutige Datei und Domäne (oder Unterdomäne) pro plattformübergreifender App-Identität verfügen. Beispielsweise ist eine separate Datei und Domäne für Word und PowerPoint erforderlich.
appDisplayName	Zeichenfolge	Optional. Kurze Textbeschreibung der App, die verwendet wird, um die Aktivität für die Verwendung in Fällen zu generieren, in der die App nicht auf dem lokalen Gerät des Benutzers installiert ist.
activationUrl	Zeichenfolge	Erforderlich. URL, die verwendet wird, um die Aktivität in der besten nativen Umgebung zu starten, die durch die appId dargestellt wird. Kann eine webbasierte App starten, wenn keine native App vorhanden ist.
fallbackUrl	Zeichenfolge	Optional. URL, die zum Starten der Aktivität in einer webbasierten App verwendet wird( sofern verfügbar).
contentUrl	Zeichenfolge	Optional. Wird verwendet, wenn der Inhalt außerhalb einer nativen oder webbasierten App-Oberfläche gerendert werden kann (z. B. ein Zeiger auf ein Element in einem RSS-Feed).
visualElements	visualInfo	Erforderlich. Das -Objekt, das Informationen zum Rendern der Aktivität in der Benutzeroberfläche enthält.
Contentinfo	Nicht typisiertes JSON-Objekt	Optional. Ein benutzerdefiniertes Datenelement: Erweiterbare JSON-LD-Beschreibung des Inhalts gemäß schema.org Syntax.
expirationDateTime	DateTimeOffset	Wird vom Server festgelegt. DateTime in UTC, wenn das Objekt auf dem Server abgelaufen ist.
status	Zeichenfolge	Wird vom Server festgelegt. Ein status Code, der zum Identifizieren gültiger Objekte verwendet wird. Werte: aktiv, aktualisiert, gelöscht, ignoriert.

Beziehungen

Beziehung	Typ	Beschreibung
historyItems	activityHistoryItem-Auflistung	Optional. NavigationProperty/Containment; Navigationseigenschaft für die activityHistoryItems der Aktivität.

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

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