Aktivitätsressourcentyp

Namespace: microsoft.graph

Stellt eine einzelne Aktivität innerhalb einer App dar, z. B. eine TV-Show, ein Dokument oder eine aktuelle Kampagne in einem Videospiel. Wenn sich ein Benutzer mit dieser Aktivität beschäftigt, wird das Engagement 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 die Möglichkeit zu geben, auf mehreren Geräten zu den Aufgaben zurückzukehren, die sie in ihrer App ausgeführt haben. Aktivitäten, die Ihre App erstellt, werden auf allen Geräten der Benutzer angezeigt und benutzern als Deep-Links zu bestimmten Inhalten in Ihrer App zur Seite stehen. Sie können bestimmte Inhalte in Ihrer App als Ziel ausdrücken, das in Windows angezeigt wird und über Cortana Benachrichtigungen auf iOS- und Android-Geräten zugänglich ist.

Da jede App anders ist, liegt es an Ihnen, die beste Möglichkeit zu verstehen, Aktionen innerhalb Ihrer Anwendung Benutzeraktivitäten zuzuordnen, die in Cortana und 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 präsentiert, die sich auf die Steigerung der Produktivität und Effizienz der Benutzer konzentrieren, indem sie ihnen helfen, zu Inhalten zurückzukehren, an denen sie in der Vergangenheit gearbeitet haben.

Methoden

Methode Rückgabetyp Beschreibung
Aktivität erstellen oder ersetzen Kommentaraktivität Erstellt oder ersetzt eine vorhandene Aktivität (Upsert). Die appActivityId muss URL-sicher sein (alle Zeichen mit Ausnahme von nicht bedienten RFC 2396-Zeichen müssen in ihre Hexadezimaldarstellung konvertiert werden), die ursprüngliche appActivityId muss jedoch 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 Aktivitäten Ruft die Aktivitäten für Ihre App für einen bestimmten Benutzer ab.
Aktuelle Aktivitäten abrufen Sammlung von Aktivitäten Ruft die neuesten Aktivitäten für Ihre App für einen bestimmten Benutzer ab, sortiert und basierend auf den zuletzt erstellten oder aktualisierten historyItems.

Eigenschaften

Name Typ Beschreibung
userTimezone Zeichenfolge Optional. Die Zeitzone, in der sich das Gerät des Benutzers, das zum Generieren der Aktivität verwendet wurde, zur Erstellungszeit der Aktivität befand. als Olson-IDs bereitgestellte Werte, um die plattformübergreifende Darstellung zu unterstützen.
createdDateTime DateTimeOffset Wird vom Server festgelegt. DateTime in UTC, als das Objekt auf dem Server erstellt wurde.
lastModifiedDateTime DateTimeOffset Wird vom Server festgelegt. DateTime in UTC, als das Objekt auf dem Server geändert wurde.
id String Servergenerierte ID, die für die URL-Adressierung verwendet wird.
appActivityId String Erforderlich. Die eindeutige Aktivitäts-ID im Kontext der App – wird vom Aufrufer bereitgestellt und kann danach unveränderlich sein.
activitySourceHost String Erforderlich. DIE 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. Die JSON-Datei heißt plattformübergreifende App-IDs 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 im Vergleich zu PowerPoint erforderlich.
appDisplayName Zeichenfolge Optional. Kurze Textbeschreibung der App, die zum Generieren der Aktivität verwendet wird, um sie in Fällen zu verwenden, in denen die App nicht auf dem lokalen Gerät des Benutzers installiert ist.
activationUrl String Erforderlich. Url, die verwendet wird, um die Aktivität in der besten systemeigenen Benutzeroberfläche zu starten, die durch die appId dargestellt wird. Kann eine webbasierte App starten, wenn keine systemeigene App vorhanden ist.
fallbackUrl Zeichenfolge Optional. Url, die verwendet wird, um die Aktivität in einer webbasierten App zu starten, falls verfügbar.
contentUrl Zeichenfolge Optional. Wird für den Fall verwendet, dass der Inhalt außerhalb einer systemeigenen oder webbasierten App 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 UX enthält.
Contentinfo Untyped JSON-Objekt Optional. Ein benutzerdefiniertes Datenelement – JSON-LD- erweiterbare Beschreibung von Inhalten gemäß schema.org Syntax.
expirationDateTime DateTimeOffset Wird vom Server festgelegt. DateTime in UTC, wenn das Objekt auf dem Server abgelaufen ist.
status status Wird vom Server festgelegt. Ein Statuscode, der zum Identifizieren gültiger Objekte verwendet wird. Werte: aktiv, aktualisiert, gelöscht, ignoriert.

Beziehungen

Beziehung Typ Beschreibung
historyItems activityHistoryItem-Sammlung Optional. NavigationProperty/Containment; Navigationseigenschaft zu den historyItems der Aktivität.

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

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