Benutzerbenachrichtigungen

Erfahrungsbenachrichtigungen sind eine Möglichkeit für abgemeldete Nutzer, die 13 Jahre oder älter sind, um über ihre Lieblingsspiele durch rechtzeitige, personalisierte Benachrichtigungen auf dem Laufenden zu bleiben. Als Entwickler kannst du bestimmen, welche Arten von Aktivitäten im Spiel für deine Nutzer am wichtigsten sind, sowie den Inhalt der Benachrichtigungen festlegen.

Nachdem sie eine Benachrichtigung erhalten haben, können die Benutzer direkt über die Schaltfläche Beitreten am Erlebnis teilnehmen und entsprechend Ihren Startdaten spawnen.

Für weitere Informationen zu Funktionen, Zulassungsvoraussetzungen, Nutzungshinweisen und der entsprechenden Engine-API siehe das Erfahrungsleitfaden.

Implementierung

Die UserNotification Ressource ermöglicht es Ihnen, Erlebnisbenachrichtigungen an Benutzer zu senden. Bevor Sie es verwenden, müssen Sie einen API-Schlüssel generieren oder OAuth 2.0 konfigurieren für Ihre App. Die Beispiele auf dieser Seite verwenden API-Schlüssel.

Um eine Erlebnisbenachrichtigung an einen Benutzer zu senden:

1. Erstellen Sie einen Benachrichtigungsstring im Creator Dashboard (diese Schritt muss im Creator Dashboard durchgeführt werden; es gibt keine Open Cloud API dafür).
2. Bilden Sie die Anfrage:

   1. Kopieren Sie den API-Schlüssel in den x-api-key Anforderungsheader.
   2. Kopieren Sie die Asset-ID des Benachrichtigungsstrings als Wert der Eigenschaft payload.message_id.
   3. Setzen Sie payload.type auf "MOMENT".
   4. Setzen Sie source.universe auf die Universum-Ressourcen-URL "universes/${UniverseID}".

Senden einer Erlebnisbenachrichtigung
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"
}

Benachrichtigungen mit Parametern anpassen

Um die Benachrichtigung für jeden Empfänger anzupassen, fügen Sie Parameter in den Benachrichtigungsstring ein. Passen Sie dann die Parameter beim Aufruf der API an. Sie können den Benachrichtigungsstring beispielsweise wie folgt definieren:

Fügen Sie die userId-friend und points Parameter im Skript hinzu:

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"}
		}
	}
}'

Start- und Analysedaten einbeziehen

Um das Benutzererlebnis weiter zu verbessern, können Sie Startdaten in die Benachrichtigung einfügen, die nützlich sind, um Benutzer zu einem bestimmten Ort zu leiten oder das Beitretenserlebnis zu personalisieren. Zusätzlich können Sie Analyset Daten einfügen, um die Leistung verschiedener Benachrichtigungskategorien zu segmentieren.

Startdaten und Analysedaten einbeziehen
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_Start_Daten"
	},
	"analytics_data": {
		"category": "Test_Analysekategorie"
	}
}'

Ratenlimits und Lieferung

Jeder Benutzer kann eine Benachrichtigung pro Tag aus einem bestimmten Erlebnis erhalten, und Sie erhalten transparente Rückmeldungen, wenn das Drosselungslimit eines Benutzers erreicht ist.

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