Notifications utilisateur

Les notifications d'expérience sont un moyen pour les utilisateurs ayant opté pour cette option âgés de 13 ans et plus de suivre leurs jeux préférés grâce à des notifications personnalisées et opportunes. En tant que développeur, vous pouvez déterminer quels types d'activités dans le jeu sont les plus importants à notifier à vos utilisateurs, ainsi que définir le contenu des notifications.

Après avoir reçu une notification, les utilisateurs peuvent rejoindre l'expérience directement via le bouton Rejoindre et apparaître selon vos données de lancement.

Pour plus d'informations sur les fonctionnalités, les exigences d'éligibilité, les directives d'utilisation et l'API correspondante, consultez le guide des expériences.

Mise en œuvre

La ressource UserNotification vous permet d'envoyer des notifications d'expérience aux utilisateurs. Avant de l'utiliser, vous devez générer une clé API ou configurer OAuth 2.0 pour votre application. Les exemples sur cette page utilisent des clés API.

Pour envoyer une notification d'expérience à un utilisateur :

1. Créez une chaîne de notification dans le Tableau de bord Creator (cette étape doit être effectuée dans le Tableau de bord Creator ; il n'y a pas d'API Open Cloud pour cela).
2. Formez la requête :

   1. Copiez la clé API dans l'en-tête de requête x-api-key.
   2. Copiez l'ID de l'actif de la chaîne de notification comme valeur de la propriété payload.message_id.
   3. Définissez payload.type sur "MOMENT".
   4. Définissez source.universe pour être l'URL de la ressource de l'univers "universes/${UniverseID}".

Envoyer une notification d'expérience
curl --location 'https://apis.roblox.com/cloud/v2/users/${UserId}/notifications' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
	"source": {
		"universe": "universes/${UniverseID}"
	},
	"payload": {
		"message_id": "${AssetID}",
		"type": "MOMENT"
	}
}'

Exemple de réponse qui renvoie l'ID de notification dans le champ id :

{
  "path": "users/505306092/notifications/6ca4d981-36fa-4255-82a1-14d95c116889",
  "id": "6ca4d981-36fa-4255-82a1-14d95c116889"
}

Personnalisez les notifications à l'aide de paramètres

Pour personnaliser la notification pour chaque destinataire, incluez des paramètres dans la chaîne de notification. Puis personnalisez les paramètres lors de l'appel à l'API. Par exemple, vous pouvez définir la chaîne de notification comme suit :

Ajoutez les paramètres userId-friend et points dans le script :

Personnaliser la Notification en Utilisant des Paramètres
curl --location 'https://apis.roblox.com/cloud/v2/users/${UserId}/notifications' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
	"source": {
		"universe": "universes/${UniverseID}"
	},
	"payload": {
		"message_id": "${AssetID}",
		"type": "MOMENT",
		"parameters": {
			"userId-friend": {"int64_value": 3702832553},
			"points": {"string_value": "5"}
		}
	}
}'

Inclure des données de lancement et des données analytiques

Pour améliorer encore l'expérience utilisateur, vous pouvez inclure des données de lancement dans la notification, utiles pour des scénarios tels que le routage des utilisateurs vers un emplacement de coordonnées ou la personnalisation de l'expérience de connexion. De plus, vous pouvez inclure des données analytiques pour segmenter la performance de différentes catégories de notifications.

Inclure des Données de Lancement et des Données Analytiques
curl --location 'https://apis.roblox.com/cloud/v2/users/${UserId}/notifications' \
--header 'x-api-key: ${ApiKey}' \
--header 'Content-Type: application/json' \
--data '{
	"source": {
		"universe": "universes/${UniverseID}"
	},
	"payload": {
		"message_id": "${AssetID}",
		"type": "MOMENT"
	},
	"join_experience": {
		"launch_data": "Test_Launch_Data"
	},
	"analytics_data": {
		"category": "Test_Analytics_Category"
	}
}'

Limites tarifaires et livraison

Chaque utilisateur peut recevoir une notification par jour d'une expérience donnée, et vous recevez des retours transparents lorsque la limite de fréquence d'un utilisateur est atteinte.

Il existe de nombreuses autres raisons pour lesquelles une notification pourrait ne pas être livrée. Pour plus d'informations, consultez Système de livraison dans le guide Engine.