userActivity type de ressource

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Représente une activité unique dans une application, par exemple, une émission TV, un document ou une campagne actuelle dans un jeu vidéo. Lorsqu’un utilisateur s’engage dans cette activité, l’engagement est capturé sous la forme d’un élément d’historique qui indique l’heure de début et de fin de cette activité. À mesure que l’utilisateur se réengage dans cette activité au fil du temps, plusieurs éléments d’historique sont enregistrés pour une activité utilisateur unique.

Vous pouvez utiliser les activités dans Microsoft Graph pour permettre aux utilisateurs de revenir à ce qu’ils faisaient dans leur application, sur plusieurs appareils. Les activités créées par votre application apparaissent sur les appareils de tous les utilisateurs et sont exposées aux utilisateurs sous forme de liens profonds vers un contenu spécifique au sein de votre application. Vous pouvez exprimer un contenu spécifique au sein de votre application sous la forme d’une destination présentée dans Windows et accessible sur les appareils iOS et Android via les notifications Cortana.

Chaque application étant différente, c’est à vous de comprendre la meilleure façon de mapper les actions au sein de votre application aux activités des utilisateurs qui apparaîtront dans Cortana et la chronologie. Par exemple, les jeux peuvent créer une activité pour chaque campagne, les applications de création de documents peuvent créer une activité pour chaque document unique et les applications cœur de métier peuvent créer une activité pour chaque flux de travail.

Vos activités d’utilisateur seront présentées dans les expériences utilisateur Cortana et Chronologie Windows, qui sont axées sur l’augmentation de la productivité et de l’efficacité des utilisateurs en les aidant à revenir au contenu sur lequel ils ont travaillé dans le passé.

Méthodes

Méthode Type renvoyé Description
Créer ou remplacer une activité userActivity Crée ou remplace une activité existante (upsert). L’appActivityId doit être sécurisé pour les URL (tous les caractères, à l’exception des caractères non réservés RFC 2396, doivent être convertis en leur représentation hexadécimale), mais l’appActivityId d’origine n’a pas besoin d’être sécurisé pour les URL.
Supprimer l’activité Aucun contenu Supprime de votre application l’activité spécifiée pour cet utilisateur.
Obtenir les activités Collecte de userActivity Obtient les activités de votre application pour un utilisateur donné.
Obtenir les activités récentes Collecte de userActivity Obtient les activités les plus récentes de votre application pour un utilisateur donné, triées et basées sur la dernière création ou mise à jour activityHistoryItems.

Propriétés

Nom Type Description
userTimezone String Facultatif. Fuseau horaire dans lequel se trouvait l’appareil de l’utilisateur utilisé pour générer l’activité au moment de la création de l’activité ; valeurs fournies en tant qu’identifiants Olson afin de prendre en charge la représentation multiplateforme.
createdDateTime DateTimeOffset Défini par le serveur. DateTime en UTC lorsque l’objet a été créé sur le serveur.
lastModifiedDateTime DateTimeOffset Défini par le serveur. DateTime au format UTC lorsque l’objet a été modifié sur le serveur.
id String ID généré par le serveur utilisé pour l’adressage d’URL.
appActivityId String Obligatoire. ID d’activité unique dans le contexte de l’application : fourni par l’appelant et immuable par la suite.
activitySourceHost String Obligatoire. URL du domaine représentant le mappage d’identité multiplateforme pour l’application. Le mappage est stocké sous forme de fichier JSON hébergé sur le domaine ou configurable via le Centre de développement Windows. Le fichier JSON est nommé cross-platform-app-identifiers et est hébergé à la racine de votre domaine HTTPS, soit dans le domaine de niveau supérieur, soit avec un sous-domaine. Par exemple : https://contoso.com ou https://myapp.contoso.com mais PAS https://myapp.contoso.com/somepath. Vous devez disposer d’un fichier et d’un domaine (ou d’un sous-domaine) uniques par identité d’application multiplateforme. Par exemple, un fichier et un domaine distincts sont nécessaires pour Word et PowerPoint.
appDisplayName String Facultatif. Brève description de l’application utilisée pour générer l’activité à utiliser dans les cas où l’application n’est pas installée sur l’appareil local de l’utilisateur.
activationUrl String Obligatoire. URL utilisée pour lancer l’activité dans la meilleure expérience native représentée par l’appId. Peut lancer une application web si aucune application native n’existe.
fallbackUrl String Facultatif. URL utilisée pour lancer l’activité dans une application web, le cas échéant.
contentUrl String Facultatif. Utilisé dans le cas où le contenu peut être rendu en dehors d’une expérience d’application native ou web (par exemple, un pointeur vers un élément dans un flux RSS).
Éléments visuels informations visuelles Obligatoire. Objet contenant des informations pour afficher l’activité dans l’UX.
contentInfo Objet JSON non typé Facultatif. Une donnée personnalisée : description extensible JSON-LD du contenu selon schema.org syntaxe.
expirationDateTime DateTimeOffset Défini par le serveur. DateTime au format UTC lorsque l’objet a expiré sur le serveur.
statut string Défini par le serveur. Code de status utilisé pour identifier les objets valides. Valeurs : actif, mis à jour, supprimé, ignoré.

Relations

Relation Type Description
historyItems collection activityHistoryItem Facultatif. NavigationPropriété/Confinement ; vers la propriété activityHistoryItems de l’activité.

Représentation JSON

La représentation JSON suivante montre le type de 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": "string",
    "contentInfo": { "@data.type": "microsoft.graph.Json" },
    "visualElements": { "@data.type": "microsoft.graph.visualInfo" },
    "historyItems": [{ "@odata.type": "microsoft.graph.activityHistoryItem" }]
}
  • Dernière mise à jour :