Stockage de données standard

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Cette page inclut une documentation de référence pour travailler avec des magasins de données standard.Pour plus d'informations sur l'utilisation de l'API, voir gérer les demandes d'API pour les magasins de données et le guide d'utilisation.

Datastores

https://apis.roblox.com/datastores

Les points de terminaison suivants sont disponibles à des chemins relatifs à l'URL de base.

Liste des magasins de données

GET /v1/universes/{universeId}/standard-datastores

Renvoie une liste des magasins de données d'une expérience.

Paramètres

universeId number

L'identifiant de l'expérience avec des magasins de données auxquels vous souhaitez accès.Vous pouvez copier l'ID de l'univers de votre expérience sur le tableau de bord du créateur .

Path

Requis

cursor string

Fournir pour demander la prochaine série de données. Voir curseurs .

limit number

Le nombre maximum d'éléments à renvoyer.Chaque appel ne lit qu'une seule partition, il peut donc retourner moins de la valeur donnée lorsqu'il n'a plus d'objectifs sur une seule partition.

prefix string

Fournir pour retourner uniquement des magasins de données avec ce préfixe.

Requête

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "prefix=Player" \
-d "limit=5"

Réponse

200 - OK

Renvoie une object

application/json

{
  "datastores": [
    {
      "name": "PlayerInventory",
      "createdTime": "2022-02-18T22:38:59.9244932Z"
    },
    {
      "name": "PlayerExperience",
      "createdTime": "2022-02-18T23:00:10.4773508Z"
    },
    {
      "name": "PlayerWeapons",
      "createdTime": "2022-02-18T23:00:22.3725681Z"
    },
    {
      "name": "PlayerArmor",
      "createdTime": "2022-02-18T22:59:33.8472882Z"
    },
    {
      "name": "PlayerHP",
      "createdTime": "2022-02-18T22:58:47.6904028Z"
    }
  ],
  "nextPageCursor": "..."
}

data array<object>

Une gamme de magasins de données dans l'expérience cible.

nextPageCursor string

Indique qu'il y a plus de données disponibles dans le configurerde résultats demandé. Voir curseurs .

Autorisations requises

Les autorisations suivantes de la clé API sont requises pour appeler ce point de terminaison. Pour plus d'informations sur la génération de clés appropriées, voir [Gestion des clés d'API] (/cloud/auth/api-keys).

Liste des datastores

Entries

https://apis.roblox.com/datastores

Les points de terminaison suivants sont disponibles à des chemins relatifs à l'URL de base.

Liste des entrées

GET /v1/universes/{universeId}/standard-datastores/datastore/entries

Renvoie une liste de clés d'entrée dans un boutiquede données.

Paramètres

universeId number

L'identifiant de l'expérience avec des magasins de données auxquels vous souhaitez accès.Vous pouvez copier l'ID de l'univers de votre expérience sur le tableau de bord du créateur .

Path

Requis

datastoreName string

Le nom du boutiquede données.

scope string

La valeur est global par défaut. Voir domaines .

allScopes boolean

Définir sur vrai pour retourner des clés de tous les scopes.

prefix string

Fournir pour retourner uniquement des clés avec ce préfixe.

cursor string

Fournir pour demander la prochaine série de données. Voir curseurs .

limit number

Le nombre maximum d'éléments à renvoyer.Chaque appel ne lit qu'une seule partition, il peut donc retourner moins de la valeur donnée lorsqu'il n'a plus d'objectifs sur une seule partition.

Requête

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "prefix=" \
-d "limit=5"

Réponse

200 - OK

Renvoie une object

application/json

{
  "keys": [
    {
      "key": "269323"
    }
  ],
  "nextPageCursor": "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIzIyJ9"
}

keys array<string>

Un ensemble de clés d'entrée dans le boutiquede données cible.

nextPageCursor string

Indique qu'il y a plus de données disponibles dans le configurerde résultats demandé. Voir curseurs .

Autorisations requises

Clés d'entrée de liste

Obtenir une entrée

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Renvoie la valeur et les métadonnées associées à une entrée.

Les métadonnées peuvent être trouvées dans les en-têtes de réponse comme le suivre:


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

| En-tête | Description | |---|---| | content-md5 | Le somme de contrôle MD5 codé en base-64 du contenu.Voir Contenu-MD5 .| | roblox-entry-version | La version de l'entrée retournée.| | roblox-entry-created-time | L'heure à laquelle l'entrée a été créée.| | roblox-entry-version-created-time | L'heure à laquelle cette version spécifique a été créée.| | roblox-entry-attributes | Attributes étiquetés avec l'entrée.objetde carte JSON sérialisé.| | roblox-entry-userids | Liste séparée par des virgules des ID d'utilisateur Roblox étiquetés avec l'entrée. |

Paramètres

universeId number

L'identifiant de l'expérience avec des magasins de données auxquels vous souhaitez accès.Vous pouvez copier l'ID de l'univers de votre expérience sur le tableau de bord du créateur .

Path

Requis

datastoreName string

Le nom du boutiquede données.

entryKey string

La clé qui identifie l'entrée.

scope string

La valeur est global par défaut. Voir domaines .

Requête

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323"

Réponse

200 - OK

Récupération de l'entrée réussie.

Renvoie une object

204 - No Content

Autorisations requises

Lecture de l'entrée

Définir l'entrée

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Définit la valeur, les métadonnées et les identifiants d'utilisateur associés à une entrée.

Paramètres

universeId number

L'identifiant de l'expérience avec des magasins de données auxquels vous souhaitez accès.Vous pouvez copier l'ID de l'univers de votre expérience sur le tableau de bord du créateur .

Path

Requis

datastoreName string

Le nom du boutiquede données.

entryKey string

La clé qui identifie l'entrée.

matchVersion string

Fournir à mettre à jour seulement si la version actuelle correspond à ceci.

exclusiveCreate boolean

Créez l'entrée seulement si elle n'existe pas.

scope string

La valeur est global par défaut. Voir domaines .

roblox-entry-attributes string

Attributs à associer à la nouvelle version de l'entrée. Sérialisés par des objets de carte JSON. S'ils ne sont pas fournis, les attributs existants sont effacés.

Header

roblox-entry-userids string

Liste séparée par des virgules des ID d'utilisateur Roblox étiquetés avec l'entrée. S'ils ne sont pas fournis, les ID d'utilisateur existants sont effacés.

Header

content-md5 string

Le somme de contrôle MD5 encodé en base-64 du contenu. Voir Contenu-MD5 .

Header

Requête

curl

curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry?datastoreName=Coins&entryKey=269323" \
--header "x-api-key: ${API_KEY}" \
--header "content-md5: IGPBYI1uC6+AJJxC4r5YBA==" \
--header "content-type: application/json" \
--header "roblox-entry-userids: [269323]" \
--header "roblox-entry-attributes: {}" \
--d "value"

Réponse

200 - OK

Renvoie une object

version string

Le nom de version de l'entrée qualifiée.

deleted boolean

Indique si l'entrée a été supprimée.

contentLength number

La longueur du contenu.

createdTime string

L'horodatage de la création de la version dans le format de temps ISO.

objectCreatedTime string

L'horodatage du moment de la création du magasin de données dans le format de temps ISO.

Autorisations requises

Créer une entrée
Mettre à jour l'entrée

Supprimer l'entrée

DELETE /v1/universes/{universeId}/standard-datastores/datastore/entries/entry

Marque l'entrée comme supprimée en créant une version de tombeau. Les entrées sont supprimées définitivement après 30 jours.

Paramètres

universeId number

L'identifiant de l'expérience avec des magasins de données auxquels vous souhaitez accès.Vous pouvez copier l'ID de l'univers de votre expérience sur le tableau de bord du créateur .

Path

Requis

datastoreName string

Le nom du boutiquede données.

entryKey string

La clé qui identifie l'entrée.

scope string

La valeur est global par défaut. Voir domaines .

Requête

curl

curl --include --location --request DELETE "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323"

Réponse

204 - No Content

Autorisations requises

Supprimer entrée

Entrée d'augmentation

POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment

Augmente la valeur d'une entrée d'un montant donné, ou crée une nouvelle entrée avec ce montant. Renvoie l'entrée et les métadonnées.

Les métadonnées peuvent être trouvées dans les en-têtes de réponse comme le suivre:


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

Paramètres

universeId number

L'identifiant de l'expérience avec des magasins de données auxquels vous souhaitez accès.Vous pouvez copier l'ID de l'univers de votre expérience sur le tableau de bord du créateur .

Path

Requis

datastoreName string

Le nom du boutiquede données.

entryKey string

La clé qui identifie l'entrée.

incrementBy number

Le montant par lequel l'entrée doit être augmentée, ou la valeur de départ si elle n'existe pas.

scope string

La valeur est global par défaut. Voir domaines .

roblox-entry-attributes string

Attributs à associer à la nouvelle version de l'entrée. Sérialisés par des objets de carte JSON. S'ils ne sont pas fournis, les attributs existants sont effacés.

Header

roblox-entry-userids string

Une liste séparée par des virgules des ID d'utilisateur Roblox avec lesquels l'entrée est étiquetée. S'il n'est pas fourni, les ID d'utilisateur existants sont effacés.

Header

Requête

curl

curl --include --location --request POST "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/increment" \
--header "x-api-key: ${API_KEY}" \
--header 'content-length: 0' \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "incrementBy=3"

Réponse

200 - OK

Renvoie la dernière version de l'entrée après qu'elle ait été augmentée.

Renvoie une object

204 - No Content

Autorisations requises

Créer une entrée
Mettre à jour l'entrée

Obtenir la version d'entrée

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version

Renvoie la valeur et les métadonnées d'une version spécifique d'une entrée.

Les métadonnées peuvent être trouvées dans les en-têtes de réponse comme le suivre:


content-md5: zuYxEhwuySMv0i8CitXImw==
roblox-entry-version: 08D9E6A3F2188CFF.0000000001.08D9E6A3F2188CFF.01
roblox-entry-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-version-created-time: 2022-02-02T23:30:06.5388799+00:00
roblox-entry-attributes: { "myAttribute": "myValue" }
roblox-entry-userids: [1, 2, 3]

Paramètres

universeId number

L'identifiant de l'expérience avec des magasins de données auxquels vous souhaitez accès.Vous pouvez copier l'ID de l'univers de votre expérience sur le tableau de bord du créateur .

Path

Requis

datastoreName string

Le nom du boutiquede données.

entryKey string

La clé qui identifie l'entrée.

versionId string

La version à inspecter.

scope string

La valeur est global par défaut. Voir domaines .

Requête

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions/version" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "versionId=08D9E6A3F2188CFF.0000000003.08D9E6DE485A7680.01"

Réponse

200 - OK

Récupération de l'entrée réussie.

Renvoie une object

Autorisations requises

Lire la version

Limitations

Par clé API : 5000 demande toutes les 60 secondes par adresse IP

Versions d'entrée de liste

GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions

Renvoie une liste de versions pour une entrée.

Paramètres

universeId number

L'identifiant de l'expérience avec des magasins de données auxquels vous souhaitez accès.Vous pouvez copier l'ID de l'univers de votre expérience sur le tableau de bord du créateur .

Path

Requis

datastoreName string

Le nom du boutiquede données.

entryKey string

La clé qui identifie l'entrée.

scope string

La valeur est global par défaut. Voir domaines .

cursor string

Fournir pour demander la prochaine série de données (voir curseurs).

startTime string

Fournir pour ne pas inclure de versions antérieures à cette date de timestamp.

endTime string

Fournir pour ne pas inclure de versions antérieures à cette date de timestamp.

sortOrder string

Soit Ascending (premières versions d'abord) ou Descending (versions ultérieures d'abord).

limit number

Le nombre maximum d'éléments à renvoyer.Chaque appel ne lit qu'une seule partition, il peut donc retourner moins de la valeur donnée lorsqu'il n'a plus d'objectifs sur une seule partition.

Requête

curl

curl --include --location --request GET "https://apis.roblox.com/datastores/v1/universes/3310576216/standard-datastores/datastore/entries/entry/versions" \
--header "x-api-key: ${API_KEY}" \
--get \
-d "datastoreName=Coins" \
-d "entryKey=269323" \
-d "limit=5"

Réponse

200 - OK

Renvoie une object

version string

Le nom de version de l'entrée qualifiée.

deleted boolean

Indique si l'entrée a été supprimée.

contentLength number

La longueur du contenu.

createdTime string

L'horodatage de la création de la version dans le format de temps ISO.

objectCreatedTime string

L'horodatage du moment de la création du magasin de données dans le format de temps ISO.

Autres codes de statut

Autorisations requises

Lister les versions

Objets

Les objets suivants décrivent les charges utiles qui sont acceptées ou renvoyées. Voir chaque point de terminaison individuel pour plus d'informations sur l'utilisation de ces objets.

DataStore

L'objet de stockage de données avec son nom et son temps de création.

Attributs

name string

Le nom de votre boutiquede données.

createdTime string

L'horodatage du moment de la création du magasin de données dans le format de temps ISO.

EntryVersion

L'objet de version d'entrée retourné par la méthode List Entry Versions.

Attributs

version string

Le nom de version de l'entrée qualifiée.

deleted boolean

Indique si l'entrée a été supprimée.

contentLength number

La longueur du contenu.

createdTime string

L'horodatage de la création de la version dans le format de temps ISO.

objectCreatedTime string

L'horodatage du moment de la création du magasin de données dans le format de temps ISO.

Stockage de données standard

Datastores

Liste des magasins de données

Paramètres

Requête

Réponse

Autorisations requises

Entries

Liste des entrées

Paramètres

Requête

Réponse

Autorisations requises

Obtenir une entrée

Paramètres

Requête

Réponse

Autorisations requises

Définir l'entrée

Paramètres

Requête

Réponse

Autorisations requises

Supprimer l'entrée

Paramètres

Requête

Réponse

Autorisations requises

Entrée d'augmentation

Paramètres

Requête

Réponse

Autorisations requises

Obtenir la version d'entrée

Paramètres

Requête

Réponse

Autorisations requises

Limitations

Versions d'entrée de liste

Paramètres

Requête

Réponse

Autorisations requises

Objets

DataStore

Attributs

EntryVersion

Attributs

Sur cette page