Erfahrungsbenachrichtigungen

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.

Das Erlebnisbenachrichtigungssystem verfügt über die gefolgte ProfileFunktionen:

• Anpassbare Benachrichtigungen mit Parametern — Volle Flexibilität, um die Benachrichtigungsnachricht mit Parametern anzupassen, z. B.:

  Your gold goose egg has hatched!

  Allie @LaterSk8er1 just beat your record on the Tokyo Tour track!

• Startdaten — Enthält optionale Startdaten , die gelesen werden können, wenn der Empfänger der Benachrichtigung beitritt.Dies könnte die Weiterleitung eines Benutzers an einen Koordinatenstandort oder die Personalisierung seiner Erlebnisbeinhalten.

• Analytics-Unterstützung — Verfolgen Sie Ihre erreichbare Zielgruppe und die Leistung Ihrer Benachrichtigungen im Creator-Dashboard.

Anforderungen an die Berechtigung

Um die APIs zum Senden von Benachrichtigungen zu verwenden, muss das Erlebnis die folgenden grundlegenden Kriterien erfüllen:

• Mindestens 100 Besuche seit dem starten.
• Die Erfahrung darf nicht moderiert werden.
• Du als Entwickler musst die Berechtigung haben, das Erlebnis zu verwalten.

Verwendungsrichtlinien

Umsetzung

Die Implementierung von Erfahrungsbenachrichtigungen beginnt mit der Erstellung einer Benachrichtigungsstring und der Einbeziehung des Pakets in dein Projekt.Sobald diese eingerichtet sind, kannst du Benachrichtigungen senden mit optionalen benutzerdefinierten Parametern.

Alternativ kannst du die Open Cloud API verwenden, um Benachrichtigungen durch frei formulierte API-Anfragen auszulösen.

Erstelle eine String

Wie bei Spieler-Einladungsaufforderungen musst du deine Benachrichtigungsstränge erstellen und bearbeiten im Creator-Dashboard. Es gibt keine String, daher ist dieser Schritt erforderlich.

1. Navigiere zum Creator-Dashboard.

2. Ähnlich wie Abzeichen, sind Benachrichtigungsstränge an ein bestimmtes Erlebnis gebunden. Lokalisieren Sie das Thumbnail dieses Erlebnisses und klicken Sie darauf.

3. In der linken Spalte, unter Beteiligung , klicken Sie auf Benachrichtigungen .

4. Klicke in der mittleren Region auf die Schaltfläche Erstelle eine Benachrichtigungsstring .

5. Füllen Sie einen Identifikationsnamen (nur für Sie sichtbar) und die benutzerdefinierte Stringaus; dies ist auf 99 Zeichen beschränkt und kann unbegrenzte benutzerdefinierte Parameter enthalten.Benachrichtigungen verwenden automatisch den Titel deiner Erfahrung als Benachrichtigungstitel, aber du kannst zusätzlich experienceName verwenden, um deine Erfahrung im Benachrichtigungskörpertext zu referenzieren.

   Beispielfernmeldezeilen:

   You're {numQuests} quests away from completing the weekly challenge!

   Your {eggName} hatched! Come meet your new pet.

   You won {numRaces} races this week and unlocked the {racetrackName} track!

   {userId-friend} just beat your record on the Tokyo Tour track! Time for revenge?

   Bevor Sie Benachrichtigungsstränge schreiben, überprüfen Sie bitte die Richtlinien für den Einsatz des Systems.

6. Wenn du bereit bist, klicke auf die Schaltfläche Erstellungsbenachrichtigungsstring .

7. Auf der Seite mit den Benachrichtigungen, in der Tabelle der Benachrichtigungen, klicke auf die Schaltfläche ⋯ in der Spalte Aktionen und wähle Kopiere Asset-ID .

8. Verwende die kopierte ID für den messageId Schlüsselwert in der payload Tabelle, wie im Beispielskript dargestellt.

Das Paket einbeziehen

Um Erlebnisbenachrichtigungen zu implementieren, musst du das Luau-Paket aus dem Creator-Store erhalten.

1. Von der Ansicht-Registerkarte öffne die Toolbox und wähle die Creator-Store -Registerkarte aus.

   

2. Stellen Sie sicher, dass die Sortierung der Modelle ausgewählt ist, dann klicken Sie auf die Schaltfläche Alle sehen für Kategorien .

   

3. Suchen und klicken Sie auf die Entwickler-Module -Kachel.

   

4. Suchen Sie das Open Cloud -Modul und klicken Sie darauf oder ziehen Sie es in die 3D-Ansicht.

   

5. In dem Explorer-Fenster verschiebe das gesamte OpenCloud -Modell in ServerScriptService .

   

Sende eine Benachrichtigungen

Sobald du eine Benachrichtigungsstring erstellt hast und das Paket in dein Projekt eingefügt hast, kannst du Benachrichtigungen von Server-Skripten senden.Benachrichtigungen werden an aktivierte Benutzer im Alter von 13+ Jahren durch ihren Streamgeliefert, bei dem sie sich der Erfahrung direkt über die Beitreten -Taste auf der Benachrichtigung und entsprechend Ihren Startdaten anschließen können.

Um eine grundlegende Benachrichtigung an einen bestimmten Benutzer zu senden, füge die Benachrichtigungsstring-Asset-ID in das Feld des Payloads ein, rufe dann die createUserNotification-Funktion mit den Daten des Empfängers und den Anforderungsdaten auf.

Sende eine Benachrichtigungen
local ServerScriptService = game:GetService("ServerScriptService")

local OCUserNotification = require(ServerScriptService.OpenCloud.V2.UserNotification)
local recipientPlayerID = 505306092

-- Im Payload ist "messageId" der Wert der Benachrichtigungs-Asset-ID
local userNotification = {
	payload = {
		messageId = "5dd7024b-68e3-ac4d-8232-4217f86ca244",
		type = "MOMENT"
	}
}

local result = OCUserNotification.createUserNotification(recipientPlayerID, userNotification)

if result.statusCode ~= 200 then
	print(result.statusCode)
	print(result.error.code)
	print(result.error.message)
end

Benutzerdefinierte Benachrichtigungen mit Parametern anpassen

Um die Benachrichtigung für jeden Empfänger anzupassen, kannst du Parameter in den Benachrichtigungsstring einfügen und die Parameter dann anpassen, wenn du die API aufrufst.Zum Beispiel können Sie die Benachrichtigungszeile als:

Dann legen Sie die userId-friend und points Parameter im Skript, das. PL: die Skriptsfest:

Benutzerdefinierte Benachrichtigung mit Parametern anpassen
local ServerScriptService = game:GetService("ServerScriptService")

local OCUserNotification = require(ServerScriptService.OpenCloud.V2.UserNotification)
local recipientPlayerID = 505306092

local userIdFriendParam = {int64Value = 3702832553}
local pointsParam = {stringValue = "5"}

-- Im Payload ist "messageId" der Wert der Benachrichtigungs-Asset-ID
-- In diesem Beispiel ist die Benachrichtigungszeile "{userId-friend} hat deinen Höchstscore um {points} Punkte übertroffen! Zeit, aufzustufen?"
local userNotification = {
	payload = {
		messageId = "ef0e0790-e2e8-4441-9a32-93f3a5783bf1",
		type = "MOMENT",
		parameters = {
			["userId-friend"] = userIdFriendParam,
			["points"] = pointsParam
		}
	}
}

local result = OCUserNotification.createUserNotification(recipientPlayerID, userNotification)

if result.statusCode ~= 200 then
	print(result.statusCode)
	print(result.error.code)
	print(result.error.message)
end

Auffordern Benutzer, Benachrichtigungen zu aktivieren

Um Benutzer zu ermutigen, Benachrichtigungen für ihr Erlebnis zu aktivieren, kannst du eine Erfahrungsberechtigungsaufforderung für Benutzer im Alter von 13+ Jahren mit der Methode ExperienceNotificationService:PromptOptIn() anzeigen.

Du kannst die Aufforderung in jedem geeigneten Kontext innerhalb deiner Erfahrung auslösen, die eine zukünftige Benachrichtigungenerfordert.Der Text der Eingabeaufforderung ist nicht anpassbar und wird über alle Erlebnisse standardisiert.

Die Modal wird nicht erscheinen, wenn der Benutzer:

• Ist unter dem Alter von 13.
• Hat bereits Benachrichtigungen für dein Erlebnis aktiviert.
• Hat bereits die Berechtigungsaufforderung für deine Erfahrung in den letzten 30 Tagen gesehen.

Um Benutzer zur Aktivierung von Benachrichtigungen zu veranlassen, solltest du zuerst feststellen, ob der Benutzer berechtigt ist.Sobald bestätigt, kannst du dem Benutzer die Berechtigungsaufforderung anzeigen.

1. Rufen Sie ExperienceNotificationService:CanPromptOptInAsync() an, eingepackt in eine pcall() da es sich um eine asynchrone Netzanruf handelt, der gelegentlich fehlschlagen kann.
2. Wenn der Benutzer gefragt werden kann, rufe ExperienceNotificationService:PromptOptIn() an.

LocalScript - Notifikationsberechtigungsaufforderung-Implementierung
local ExperienceNotificationService = game:GetService("ExperienceNotificationService")

-- Funktion, um zu überprüfen, ob der Spieler aufgefordert werden kann, Benachrichtigungen zu aktivieren
local function canPromptOptIn()
	local success, canPrompt = pcall(function()
		return ExperienceNotificationService:CanPromptOptInAsync()
	end)
	return success and canPrompt
end

local canPrompt = canPromptOptIn()
if canPrompt then
	local success, errorMessage = pcall(function()
		ExperienceNotificationService:PromptOptIn()
	end)
end

-- Hören Sie auf die Opt-in-Aufforderung zum geschlossenen Ereignis
ExperienceNotificationService.OptInPromptClosed:Connect(function()
	print("Opt-in prompt closed")
end)

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.Bitte beachten Sie auch das Spieler-Einladungs prompt-Beispiel, wie Startdaten festgelegt und verwendet werden können.

Einschließlich Startdaten und Analysedaten
local ServerScriptService = game:GetService("ServerScriptService")

local OCUserNotification = require(ServerScriptService.OpenCloud.V2.UserNotification)
local recipientPlayerID = 505306092

-- Im Payload ist "messageId" der Wert der Benachrichtigungs-Asset-ID
local userNotification = {
	payload = {
		messageId = "5dd7024b-68e3-ac4d-8232-4217f86ca244",
		type = "MOMENT",
		joinExperience = {
			launchData = "Test_Launch_Data"
		},
		analyticsData = {
			category = "Test_Analytics_Category"
		}
	}
}

local result = OCUserNotification.createUserNotification(recipientPlayerID, userNotification)

if result.statusCode ~= 200 then
	print(result.statusCode)
	print(result.error.code)
	print(result.error.message)
end

Lieferungssystem

Ein Spam-Präventionssystem existiert, um die Qualität von Benachrichtigungen für Benutzer zu gewährleisten und den gemeinsamen Benachrichtigungskanal für alle Entwickler zu schützen.Aus diesem Grund ist die Lieferung von Benachrichtigungen nicht garantiert.Dieses Spam-Präventionssystem wird direkt durch die Beteiligung der Benutzer informiert: Je mehr Benutzer mit Ihren Benachrichtigungen interagieren, desto mehr Reichweite werden sie erhalten.Du kannst die Engagement-Metriken transparent im Analytics-Dashboard verfolgen, wie unten erklärt.

Erlebnisbenachrichtigungen haben ein statisches Drossellimit; jeder Benutzer kann eine Benachrichtigung pro Tag von einem bestimmten Erlebnis erhalten, und du erhältst transparentes Feedback, wenn das Drossellimit eines Benutzers erreicht wird.

Zusätzlich listet die folgende Liste einige der speziellen Fälle auf, die zu einer Nichtlieferung einer Benachrichtigungenführen können:

• Die Erfahrungsanforderungen Eignungsvoraussetzungen werden nicht erfüllt.
• Empfänger ist nicht für Benachrichtigungen aus deiner Erlebnisangemeldet.
• Die Drosselgrenze des Empfängers für deine Erfahrung wurde erreicht.
• Das Gesamtdrossellimit des Empfängers wurde erreicht.
• Fehlende oder ungültige Anforderungsparameter.
• Die Benachrichtigungszeile wurde moderiert.
• Für Benachrichtigungen mit Benennungen von Benutzern tritt keine Lieferung nicht ein, wenn eine dieser Bedingungen erfüllt ist:

  • Empfänger und erwähnter Benutzer sind keine Freunde.
  • Der erwähnte Benutzer hat Nein für "Freunde über meine Aktivitäten aktualisieren?" unter Datenschutz → Andere Einstellungen in seinen Roblox-Kontoeinstellungen ausgewählt.

Analysen

Die Leistung deiner Benachrichtigungen und des ansprechbaren Publikums wird auf der Analytics -Registerkarte der Benachrichtigungen -Seite angezeigt, auf der du Benachrichtigungsstränge konfigurierst (einfach von Kreationen auf Analysen ).

1. Navigiere zum Creator-Dashboard.
2. Ähnlich wie Abzeichen, sind Benachrichtigungsstränge an ein bestimmtes Erlebnis gebunden. Lokalisieren Sie das Thumbnail dieses Erlebnisses und klicken Sie darauf.
3. In der linken Spalte, unter Beteiligung , klicken Sie auf Benachrichtigungen .
4. Klicke auf der Zielseite auf die Analytics -Registerkarte, um zum Analytics-Dashboard zu wechseln.

Zusammenfassung

Der Abschnitt Zusammenfassung dient als Schnappschuss der aggregierten Leistung deiner Benachrichtigungen.Ein Minimum von 100 aggregierten Impressionen ist erforderlich, um die Statistikanzuzeigen.

Zerlegte Statistiken

Die Erfahrungsbenachrichtigungen Tabelle zeigt detaillierte Leistungsstatistiken für jede Benachrichtigung mit mindestens 100 Impressionen an, sortiert nach dem Datum des ersten Eindrucks für diese Benachrichtigungen.

Die Name -Säule ist der Schlüssel-Identifikator für die Benachrichtigungen.Standardmäßig stimmt der Name dem Namen des Identifizierers überein, den du angegeben hast, als du die Benachrichtigungszeichenfolge erstellt hast , aber du kannst ihn durch das Feld in deinen API-Aufrufen überschreiben, in dem Fall wird der Name überschrieben.Die Änderung des Schnurnamens im Creator-Dashboard oder die Änderung der Zeichenfolge, auf die sich Ihre Nachricht-ID-Referenz im API-Aufruf bezieht, erzeugt eine neue Zeile in der Tabelle.

Wenn Sie die Leistung verschiedener Zeichenketten testen möchten, wird empfohlen, dass Sie eine völlig neue Benachrichtigungszeichenkette mit einem ähnlichen Namen erstellen, zum Beispiel:

• EggHatchA — "Dein Gold-Ei ist geschlüpft! Komm und triff dein neues Haustier."
• EggHatchB — "Es ist Brutzeit! Komm und triff dein neues Haustier."

API-Referenz

Funktionen

createUserNotification

Sendet eine Benachrichtigung von einem serverseitigen Skript, das. PL: die Skripts.Benötigt die Empfänger Player.UserId und eine Benutzerbenachrichtigung.Gibt eine Benutzerbenachrichtigungsresultat zurück.

Sende eine Benachrichtigungen
local ServerScriptService = game:GetService("ServerScriptService")

local OCUserNotification = require(ServerScriptService.OpenCloud.V2.UserNotification)
local recipientPlayerID = 505306092

-- Im Payload ist "messageId" der Wert der Benachrichtigungs-Asset-ID
local userNotification = {
	payload = {
		messageId = "5dd7024b-68e3-ac4d-8232-4217f86ca244",
		type = "MOMENT"
	}
}

local result = OCUserNotification.createUserNotification(recipientPlayerID, userNotification)

if result.statusCode ~= 200 then
	print(result.statusCode)
	print(result.error.code)
	print(result.error.message)
end

Arten

Benutzerbenachrichtigung

Tabelle mit Details zur Benachrichtigung, die an den Benutzer gesendet werden soll.Muss eine payload Tabelle mit erforderlichen messageId und type Zeichen und optionalen parameters , joinExperience und analyticsData Tabellen enthalten.

Benutzerbenachrichtigungsresultat

Ein Wrapper-Objekt, das die Antwort aus einer gesendeten Benachrichtigungenenthält. Enthält die folgenden Schlüssel-Wert-Paare: