Type de ressource userActivity

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 seule activité au sein d’une application, par exemple, une émission de télévision, un document ou une campagne en cours dans un jeu vidéo. Lorsqu’un utilisateur s’engage avec 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éengager avec cette activité au fil du temps, plusieurs éléments d’historique sont enregistrés pour une seule activité utilisateur.

Vous pouvez utiliser des 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 du contenu spécifique au sein de votre application. Vous pouvez exprimer du contenu spécifique au sein de votre application en tant que destination présentée dans Windows et accessible sur les appareils iOS et Android via des notifications Cortana.

Étant donné que chaque application est différente, c’est à vous de comprendre la meilleure façon de mapper les actions au sein de votre application aux activités utilisateur 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 métier peuvent créer une activité pour chaque workflow.

Vos activités 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é par 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 URL-safe.
Supprimer l’activité	Aucun contenu	Supprime l’activité spécifiée pour cet utilisateur de votre application.
Obtenir les activités	Collection de userActivity	Obtient les activités de votre application pour un utilisateur donné.
Obtenir les activités récentes	Collection de userActivity	Obtient les activités les plus récentes de votre application pour un utilisateur donné, triées et basées sur les éléments activityHistoryItems les plus récemment créés ou mis à jour.

Propriétés

Nom	Type	Description
userTimezone	String	Facultatif. Fuseau horaire dans lequel l’appareil de l’utilisateur utilisé pour générer l’activité se trouvait au moment de la création de l’activité ; valeurs fournies en tant qu’ID Olson afin de prendre en charge la représentation multiplateforme.
createdDateTime	DateTimeOffset	Défini par le serveur. DateTime au format 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	Chaîne	ID généré par le serveur utilisé pour l’adressage d’URL.
appActivityId	Chaîne	Obligatoire. ID d’activité unique dans le contexte de l’application - fourni par l’appelant et immuable par la suite.
activitySourceHost	Chaîne	Obligatoire. URL du domaine représentant le mappage d’identité multiplateforme pour l’application. Le mappage est stocké sous la forme d’un 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 au niveau du domaine de niveau supérieur, soit en incluant 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 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 textuelle 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	Chaîne	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, si disponible.
contentUrl	String	Facultatif. Utilisé dans le cas où le contenu peut être affiché en dehors d’une expérience d’application native ou web (par exemple, un pointeur vers un élément dans un flux RSS).
visualElements	visualInfo	Obligatoire. Objet contenant des informations pour afficher l’activité dans l’expérience utilisateur.
contentInfo	Objet JSON non typé	Optional. Élément de données personnalisé : description extensible JSON-LD du contenu en fonction de la syntaxe schema.org .
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 status utilisé pour identifier les objets valides. Valeurs : actif, mis à jour, supprimé, ignoré.

Relations

Relation	Type	Description
historyItems	collection activityHistoryItem	Optional. NavigationProperty/Containment ; propriété de navigation vers l’objet 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" }]
}