Hak untuk dilupakan (RTBF) untuk data store | Dokumentasi

Hak untuk dilupakan (RTBF) untuk data store memungkinkan Anda mendeklarasikan kunci mana dan store data mana yang menyimpan data pengguna. Ketika Roblox memproses permintaan RTBF untuk game Anda, sistem menggunakan template tersebut untuk menghapus data yang cocok secara otomatis. Anda dapat mengonfigurasi template secara visual melalui Data Stores Manager di Creator Hub, atau secara programatik melalui API Configs Open Cloud.

RTBF Otomatis

Untuk menggunakan pemrosesan RTBF otomatis, Anda harus mendefinisikan template penghapusan. Template ini memberi tahu Roblox store data atau kunci mana yang milik pengguna tertentu. Anda dapat memiliki hingga 100 template untuk mengidentifikasi data pengguna Anda.

Template penghapusan

RTBF otomatis bekerja dengan mencocokkan pola. Anda mendefinisikan template untuk data pengguna Anda menggunakan token {UserId}. Ketika Roblox menerima permintaan hak untuk dilupakan, sistem mengganti token tersebut dengan ID sesungguhnya dari pemohon dan memindai store data Anda untuk menemukan kecocokan yang akan dihapus.

Persyaratan kelayakan

Agar sebuah entri memenuhi syarat untuk penghapusan otomatis, ia harus memenuhi kriteria berikut:

Tipe penyimpanan — Data pengguna harus disimpan dalam store data standar atau store data terurut. Penghapusan seluruh store data hanya didukung untuk store data standar.
Identifikasi — ID pengguna harus menjadi bagian dari Name atau Scope dari store data atau kunci.
Format — ID harus dapat diidentifikasi melalui pola string statis (misalnya, User_{UserId}).

Konfigurasi RTBF otomatis melalui Data Stores Manager

Creator Hub menyediakan antarmuka visual untuk mengelola template RTBF Anda tanpa menggunakan baris perintah.

Untuk game grup, Anda harus menambahkan izin View Analytics untuk melihat konfigurasi, dan izin Edit and publish experience untuk melihat, mengedit, dan menerbitkan konfigurasi. Selain itu, pengguna itu sendiri harus layak untuk menerbitkan game.

Navigasikan ke Creator Hub.
Pilih game yang ingin Anda konfigurasikan.
Di menu navigasi sebelah kiri, pergi ke Configure ⟩ Data Stores Manager.
Pilih tab RTBF Deletion.
Klik Create Template.
Pilih Type (Standard Data Store, Standard Key, atau Ordered Key).
Masukkan kolom yang sesuai dengan template Anda menggunakan token {UserId} (misalnya, PlayerInventory_{UserId}). Token ini bersifat case-sensitive.
Cek ulang output contoh dan klik Create.

Konfigurasi RTBF otomatis melalui Configs API

Anda juga dapat mengelola template RTBF secara programatik menggunakan API Konfigurasi Open Cloud. Ini berguna untuk otomatisasi atau mengelola template dalam skala besar.

Di Dashboard Creator, buat atau edit kunci API untuk menyertakan izin universe:read dan universe:write untuk setiap universe di mana Anda ingin mengotomatiskan penghapusan RTBF. Untuk detail lebih lanjut, lihat Kelola kunci API.

Template disimpan sebagai konfigurasi JSON bernama user_data_templates. Ada dua jenis utama:

Template kunci — Mengidentifikasi kunci tertentu. Memerlukan data_store_type (STANDARD atau ORDERED), data_store_name, dan key_pattern. scope_pattern bersifat opsional namun disarankan.
Template store data — Mengidentifikasi seluruh store data. Memerlukan data_store_type (saat ini hanya mendukung STANDARD) dan data_store_pattern.

Untuk kedua jenis template, token {UserId} diganti dengan ID pengguna saat permintaan RTBF diproses.

Contoh Konfigurasi
{
	"user_data_templates": [
		{
			"key_template": {
				"data_store_type": "STANDARD",
				"data_store_name": "PlayerInventory",
				"key_pattern": "User_{UserId}",
				"scope_pattern": "Scope_{UserId}"
			}
		},
		{
			"key_template": {
				"data_store_type": "ORDERED",
				"data_store_name": "PlayerLeaderboard",
				"key_pattern": "User_{UserId}",
				"scope_pattern": "global"
			}
		},
		{
			"data_store_template": {
				"data_store_type": "STANDARD",
				"data_store_pattern": "Player_{UserId}_Save"
			}
		}
	]
}

Token {UserId} bersifat case-sensitive. Jika scope_pattern dihilangkan atau kosong, defaultnya adalah global.

Selanjutnya, kirim melalui API Configs Open Cloud. Dalam contoh berikut, ganti <API_KEY> dan <UNIVERSE_ID> di setiap permintaan, dan kirim semua permintaan ke repositori DataStoresConfig.

Untuk endpoint dan perilaku tambahan, lihat referensi API Cloud dan panduan konfigurasi pengalaman.

Buat draf melalui permintaan PUT yang mendefinisikan konfigurasi Anda. Jika draf sudah ada, permintaan ini akan menimpanya.


curl --location --request PUT 'https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/DataStoresConfig/draft:overwrite' \
	--header 'x-api-key: <API_KEY>' \
	--header 'Content-Type: application/json' \
	--data-raw '{
	"entries": {
		"user_data_templates": [
			{
				"key_template": {
					"data_store_type": "STANDARD",
					"data_store_name": "PlayerInventory",
					"key_pattern": "User_{UserId}",
					"scope_pattern": "Scope_{UserId}"
				}
			},
			{
				"key_template": {
					"data_store_type": "ORDERED",
					"data_store_name": "PlayerLeaderboard",
					"key_pattern": "User_{UserId}",
					"scope_pattern": "global"
				}
			},
			{
				"data_store_template": {
					"data_store_type": "STANDARD",
					"data_store_pattern": "Player_{UserId}_Save"
				}
			}
		]
	}
}'

Verifikasi draf Anda melalui permintaan GET untuk mengambil dan meninjau draf sebelum go live.


curl --location --request GET 'https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/DataStoresConfig/draft' \
	--header 'x-api-key: <API_KEY>'

Setelah verifikasi, kirim permintaan POST ini untuk menerbitkan. Satu-satunya cara untuk membatalkan tindakan ini adalah dengan mengembalikan versi sebelumnya. Tindakan ini juga memerlukan bahwa akun yang terkait dengan kunci API layak untuk menerbitkan game.


curl --location --request POST 'https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/DataStoresConfig/publish' \
	--header 'x-api-key: <API_KEY>' \
	--header 'Content-Type: application/json' \
	--data-raw '{
	"deploymentStrategy": "Immediate"
}'

Setelah diterbitkan, konfirmasikan bahwa konfigurasi sudah aktif dengan permintaan GET ini.


curl --location --request GET 'https://apis.roblox.com/creator-configs-public-api/v1/configs/universes/<UNIVERSE_ID>/repositories/DataStoresConfig/full' \
	--header 'x-api-key: <API_KEY>'

Praktik terbaik

Sensitivitas huruf besar-kecil — Gunakan token {UserId} yang tepat dalam pola Anda. Variasi seperti {userId} tidak diterima.
Verifikasi manual — Bandingkan pola Anda dengan penggunaan Luau langsung Anda menggunakan Data Stores Manager di Creator Hub sebelum Anda menerbitkan konfigurasi.
Scope default — Jika sebuah store data menggunakan scope default, atur scope_pattern ke "global" dalam template kunci.
Uji alur end-to-end di game tes — Untuk validasi penuh dari template Anda, pertimbangkan untuk membuat game tes dan akun dummy, mengisinya dengan data dummy untuk User ID akun itu, meminta RTBF pada akun dummy, dan memastikan data dihapus setelah akun diproses.
Konfirmasi penghapusan — Setelah onboarding di game langsung Anda, ketika permintaan RTBF muncul di pesan Roblox Anda, verifikasi bahwa data yang sesuai dihapus dalam waktu 30 hari.