Notificaciones de usuario

Las notificaciones de experiencia son una forma para que los usuarios optados de edad 13+ se mantengan al día con sus experiencias favoritas a través de notificaciones personalizadas y oportunas.Como desarrollador, puedes determinar qué tipos de actividades en la experiencia son más importantes para notificar a tus usuarios, así como definir el contenido de la notificación.

Después de recibir una notificaciones, los usuarios pueden unirse a la experiencia directamente a través del botón Unirse y generar según sus datos de lanzamiento de lanzamiento.

Para obtener más información sobre funciones, requisitos de elegibilidad, directrices de uso y la API de motor correspondiente, consulte la guía de experiencias.

Implementación

La notificación de usuario recurso te permite enviar notificaciones de experiencia a usuarios.Antes de usarlo, debes generar una clave API o configurar OAuth 2.0 para tu aplicación (app).Los ejemplos de esta página utilizan claves de API.

Para enviar una notificación de experiencia a un usuario:

1. Crea una cadena de notificación en el Panel del creador.Este paso debe hacerse en el tablero de control del creador; no hay API de nube abierta para ello.
2. Formular la solicitud:

   1. Copia la clave de API al encabezado de solicitud x-api-key.
   2. Copia el ID de atributo de cadena de notificación como el valor de la propiedad payload.message_id.
   3. Establecer payload.type a "MOMENT".
   4. Establece source.universe para ser la URL de recursos del universo "universes/${UniverseID}".

Envía una notificacionesexperiencia
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"
	}
}'

Ejemplo de respuesta que devuelve el ID de notificación en el campo id:

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

Personalizar notificaciones usando parámetros

Para personalizar la notificación para cada destinatario, incluya parámetros en la cadena de notificación.Luego personalice los parámetros al llamar la API.Por ejemplo, puedes definir la cadena de notificación como:

Añade los parámetros userId-friend y points en el script:

Personalizar notificación usando parámetros
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"}
		}
	}
}'

Incluir datos de lanzamiento y análisis

Para mejorar aún más la experiencia del usuario, puedes incluir datos de lanzamiento en la notificación, útil para escenarios como enrutar a los usuarios a una ubicación de coordenadas o personalizar la experiencia de unión.Además, puedes incluir datos de análisis para segmentar el rendimiento de diferentes categorías de notificaciones.

Incluir datos de lanzamiento y datos de análisis
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"
	}
}'

Límites de tasa y entrega

Cada usuario puede recibir una notificación por día de una experiencia determinada, y recibes comentarios transparentes cuando se alcanza el límite de velocidad de un usuario.

Hay muchas otras razones por las que una notificación no se puede entregar. Para obtener más información, consulte Sistema de entrega en la guía del motor.