Powiadomienia dla użytkowników

Powiadomienia o doświadczeniach to sposób dla użytkowników, którzy wyrazili zgodę w wieku 13+, aby na bieżąco śledzić swoje ulubione gry poprzez terminowe, spersonalizowane powiadomienia. Jako deweloper, możesz określić, jakie rodzaje aktywności w grze są najważniejsze, aby powiadomić swoich użytkowników, a także zdefiniować treść powiadomień.

Po otrzymaniu powiadomienia, użytkownicy mogą dołączyć do doświadczenia bezpośrednio za pomocą przycisku Dołącz i pojawić się zgodnie z Twoimi danymi startowymi.

Aby uzyskać więcej informacji na temat funkcji, wymagań dotyczących kwalifikacji, wytycznych dotyczących użytkowania oraz odpowiadającego API silnika, zobacz Podręcznik doświadczeń.

Wdrożenie

Zasób UserNotification pozwala na wysyłanie powiadomień o doświadczeniach do użytkowników. Przed jego użyciem musisz wygenerować klucz API lub skonfigurować OAuth 2.0 dla swojej aplikacji. Przykłady na tej stronie używają kluczy API.

Aby wysłać powiadomienie o doświadczeniu do użytkownika:

1. Utwórz ciąg powiadomienia w Creator Dashboard (ten krok musi być wykonany w Creator Dashboard; nie ma API Open Cloud dla tego).
2. Sformułuj żądanie:

   1. Skopiuj klucz API do nagłówka żądania x-api-key.
   2. Skopiuj identyfikator zasobu ciągu powiadomienia jako wartość właściwości payload.message_id.
   3. Ustaw payload.type na "MOMENT".
   4. Ustaw source.universe na URL zasobu wszechświata "universes/${UniverseID}".

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

Przykładowa odpowiedź, która zwraca identyfikator powiadomienia w polu id:

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

Dostosowywanie powiadomień za pomocą parametrów

Aby dostosować powiadomienie dla każdego odbiorcy, dołącz parametry do ciągu powiadomienia. Następnie dostosuj parametry przy wywoływaniu API. Na przykład, możesz zdefiniować ciąg powiadomienia jako:

Dodaj parametry userId-friend i points w skrypcie:

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

Dołącz dane uruchomienia i analizy

Aby dodatkowo poprawić doświadczenie użytkownika, możesz dołączyć dane uruchomienia do powiadomienia, co jest przydatne w scenariuszach, takich jak kierowanie użytkowników do współrzędnych lokalizacji lub personalizowanie doświadczenia dołączenia. Dodatkowo możesz dołączyć dane analizy, aby segmentować wyniki różnych kategorii powiadomień.

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

Limity liczby i dostarczenie

Każdy użytkownik może otrzymać jedno powiadomienie dziennie z danego doświadczenia, a Ty otrzymasz przejrzystą informację zwrotną, gdy osiągnięty zostanie limit throttle użytkownika.

Istnieje wiele innych powodów, dla których powiadomienie może nie zostać dostarczone. Aby uzyskać więcej informacji, zobacz System dostarczania w podręczniku silnika.