Notifications d'utilisateur

Les notifications d'expérience sont un moyen pour les utilisateurs opt-in âgés de 13 ans et plus de suivre leurs expériences préférées grâce à des notifications personnalisées et opportunes.En tant que développeur, vous pouvez déterminer quelles sortes d'activités en expérience sont les plus importantes pour informer vos utilisateurs, ainsi que définir le contenu de la notification.

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 du moteurcorrespondante, voir le guide des expériences.

Implémentation

La ressource Notification d'utilisateur 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 de 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 du créateur.Cette étape doit être effectuée dans le tableau de bord du créateur ; il n'y a pas d'Open Cloud API pour cela.
2. Formuler la demande :

   1. Copiez la clé de l'API dans la tête de requête x-api-key.
   2. Copiez l'ID de la chaîne de notification comme valeur de la propriété payload.message_id.
   3. Définir payload.type à "MOMENT".
   4. Définissez source.universe pour être l'URL de la ressource universelle "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"
}

Personnaliser les notifications en utilisant des paramètres

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

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 les données de lancement et d'analyse

Pour améliorer encore l'expérience utilisateur, vous pouvez inclure les données de lancement dans la notification, utiles pour des scénarios tels que l'orientation des utilisateurs vers un lieu coordonné ou la personnalisation de l'expérience de raccord.En outre, vous pouvez inclure des données d'analyse analytiques pour segmenter les performances de différentes catégories de notifications.

Inclure les données de lancement et les données d'analyse
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 de taux et livraison

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

Il existe de nombreuses autres raisons pour lesquelles une notification peut ne pas être livrée. Pour plus d'informations, voir système de livraison dans le guide du moteur.