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 in einer App dar, z. B. eine TV-Show, ein Dokument oder eine aktuelle Kampagne in einem Videospiel. Wenn ein Benutzer mit dieser Aktivität interagiert, wird die Interaktion als Verlaufselement erfasst, das die Start- und Endzeit für diese Aktivität angibt. Wenn der Benutzer diese Aktivität im Laufe der Zeit wieder aufnimmt, 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 dem, was sie in ihrer App getan haben, zurückzukehren. Aktivitäten, die Ihre App erstellt, werden auf den Geräten aller Benutzer angezeigt und den Benutzern als Deeplinks zu bestimmten Inhalten innerhalb Ihrer App angezeigt. Sie können bestimmte Inhalte in Ihrer App als Ziel ausdrücken, die in Windows präsentiert werden und auf iOS- und Android-Geräten über Cortana-Benachrichtigungen zugänglich sind.

Da jede App anders ist, müssen Sie selbst verstehen, wie Sie Aktionen in Ihrer Anwendung am besten den Benutzeraktivitäten zuordnen, die in Cortana und der Zeitleiste angezeigt werden. Spiele können z. B. für jede Kampagne eine Aktivität erstellen, Apps zur Dokumenterstellung eine Aktivität für jedes eindeutige Dokument und Branchen-Apps können eine Aktivität für jeden Workflow erstellen.

Ihre Benutzeraktivitäten werden in den Benutzererfahrungen von Cortana und Windows Timeline präsentiert, die darauf ausgerichtet sind, die Produktivität und Effizienz der Benutzer zu steigern, 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 userActivity Erstellt oder ersetzt eine vorhandene Aktivität (Upsert). Die appActivityId muss URL-sicher sein (alle Zeichen mit Ausnahme von RFC 2396, die nicht reserviert sind, 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 Ihrer 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, das zum Generieren der Aktivität verwendet wurde, zum Zeitpunkt der Aktivitätserstellung befand; Werte, die als Olson-IDs bereitgestellt werden, um die plattformübergreifende Darstellung zu unterstützen.
createdDateTime DateTimeOffset Festgelegt durch den Server. DateTime in UTC, als das Objekt auf dem Server erstellt wurde.
lastModifiedDateTime DateTimeOffset Festgelegt durch den Server. DateTime in UTC, als 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 konfiguriert werden kann. Die JSON-Datei heißt "cross-platform-app-identifiers" 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 wird für Word im Vergleich zu PowerPoint eine separate Datei und Domäne benötigt.
appDisplayName Zeichenfolge Optional. Kurzbeschreibung der App, mit der die Aktivität generiert wird, um sie in Fällen zu verwenden, in denen die App nicht auf dem lokalen Gerät des Benutzers installiert ist.
activationUrl Zeichenfolge Erforderlich. URL, die zum Starten der Aktivität in der besten nativen Erfahrung verwendet wird, dargestellt durch die appId. Startet möglicherweise eine webbasierte App, wenn keine native App vorhanden ist.
FallbackUrl Zeichenfolge Optional. URL, die zum Starten der Aktivität in einer webbasierten App verwendet wird (falls verfügbar).
contentUrl Zeichenfolge Optional. Wird für den Fall verwendet, dass der Inhalt außerhalb einer nativen oder webbasierten App-Erfahrung gerendert werden kann (z. B. ein Zeiger auf ein Element in einem RSS-Feed).
visualElements visualInfo Erforderlich. Das Objekt, das Informationen enthält, um die Aktivität in der Benutzeroberfläche zu rendern.
contentInfo Nicht typisiertes JSON-Objekt Optional. Ein benutzerdefiniertes Datenelement – erweiterbare JSON-LD-Beschreibung des Inhalts gemäß schema.org Syntax.
expirationDateTime DateTimeOffset Festgelegt durch den Server. DateTime in UTC, als das Objekt auf dem Server abgelaufen ist.
status Zeichenfolge Festgelegt durch den Server. Ein Status-Code, der zum Identifizieren gültiger Objekte verwendet wird. Werte: active, updated, deleted, ignored.

Beziehungen

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

JSON-Darstellung

Die folgende JSON-Darstellung veranschaulicht 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" }]
}
  • Last updated on