Benutzerbenachrichtigungen

Erfahrungsbenachrichtigungen sind eine Möglichkeit für eingewilligte Benutzer im Alter von 13+, mit zeitnahen, personalisierten Benachrichtigungen mit ihren Lieblingserlebnissen Schritt zu halten.Als Entwickler kannst du bestimmen, welche Arten von Erlebnissenaktivitäten für die Benachrichtigung deiner Benutzer am wichtigsten sind, und den Benachrichtigungsinhalt definieren.

Nachdem sie eine Benachrichtigungenerhalten, können Benutzer der Erfahrung direkt über die Schaltfläche Beitreten beitreten und entsprechend Ihren Startdaten spawnen.

Für weitere Informationen zu Funktionen, Anforderungen an die Berechtigung, Nutzungsrichtlinien und der entsprechenden Engine-API siehe den Erlebnissen-Leitfaden.

Umsetzung

Die Benutzerbenachrichtigung-Ressource lässt dich Benachrichtigungen über Erlebnisse an Benutzer senden.Bevor du es verwendest, musst du einen API-Schlüssel generieren oder OAuth 2.0 für deine App konfigurieren.Die Beispiele auf dieser Seite verwenden API-Schlüssel.

Um eine Erlebnisbenachrichtigung an einen Benutzer zu senden:

1. Erstelle einen Benachrichtigungstext im Creator-Dashboard.Dieser Schritt muss im Creator-Dashboard ausgeführt werden; es gibt keine Open Cloud API dafür.
2. Formulieren Sie die Anfrage:

   1. Kopiere den API-Schlüssel in den x-api-key Anforderungskopf.
   2. Kopiere die Notifikationsstring-Asset-ID als Wert der payload.message_id Eigenschaften.
   3. Setze payload.type auf "MOMENT".
   4. Setze source.universe darauf, die Universumressourcen-URL zu sein "universes/${UniverseID}" .

Sende eine Benachrichtigungen
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"
	}
}'

Beispielantwort, die die Benachrichtigungs-ID im Feld id zurückgibt:

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

Benutzerdefinierte Benachrichtigungen mit Parametern anpassen

Um die Benachrichtigung für jeden Empfänger anzupassen, füge Parameter in den Benachrichtigungstext ein.Dann passe die Parameter an, wenn du die API aufrufst.Zum Beispiel können Sie die Benachrichtigungszeile als:

Füge die userId-friend und points Parameter in das Skript, das. PL: die Skriptsein:

Benutzerdefinierte Benachrichtigung mit Parametern anpassen
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"}
		}
	}
}'

Einschließlich Start- und Analysedaten

Um die Erlebnisweiter zu verbessern, kannst du Startdaten in die Benachrichtigung einfügen, nützlich für Szenarien wie das Routing von Benutzern an einen Koordinatenstandort oder die Personalisierung der Erlebnis.Zusätzlich können Sie Analysedaten einfügen, um die Leistung verschiedener Kategorien von Benachrichtigungen zu segmentieren.

Einschließlich Startdaten und Analysedaten
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"
	}
}'

Zinngrenzen und Lieferung

Jeder Benutzer kann eine Benachrichtigung pro Tag von einer bestimmten Erlebniserhalten, und du erhältst transparentes Feedback, wenn das Drossellimit eines Benutzers erreicht wird.

Es gibt viele andere Gründe, warum eine Benachrichtigung möglicherweise nicht geliefert wird. Weitere Informationen finden Sie unter Lieferungssystem im Engine-Leitfaden.