Boutiques de données commandées (bêta)

*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 commandés. Pour plus d'informations sur l'utilisation de l'API, voir Gestion des demandes d'API pour les magasins de données et le Guide d'utilisation.

OrderedDataStores

https://apis.roblox.com/ordered-data-stores

Liste

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Renvoie une liste d'entrées d'un boutiquede données commandé.

Paramètres

universeId string

L'identifiant de l'expérience avec des données commandées que vous souhaitez accès. Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.

Path
Requis
orderedDataStore string

Nom de la boutique de données ciblée commandée.

Path
Requis
scope string

Nom de la portée de stockage des données. Voir Scopes .

Path
Requis
max_page_size number

Le nombre maximum d'entrées à renvoyer. Le service peut renvoyer moins de cette valeur. La valeur par défaut est 10 . La valeur maximum est 100 et tout entrée au-dessus de 100 est forcée à 100 .

page_token string

Un jeton de page reçu à partir d'un appel précédent List. Fournissez-le pour récupérer la page suivante. Lors du paiement, tous les autres paramètres fournis à List doivent correspondre à l'appel qui fournit le jeton de page.

order_by string

La direction d' enumeration. Le ordre par défaut est ascendant. Entrez un desc suffixe pour descendre.

filter string

La portée des valeurs de qualification des entrées à renvoyer. Voir Filters .

Requête

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries' \

 --header 'x-api-key: <insert-api-key>'

Réponse

200 - OK
OK
Renvoie une object
entries array<object>

Les entrées du champ de vision spécifié.

nextPageToken string

Un jeton, qui peut être envoyé comme page_token pour récupérer la prochaine page. Si ce champ est omis, il n'y a pas de pages suivantes.

Créer

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries

Crée une nouvelle entrée avec la valeur de contenu fournie.

Paramètres

universeId string

L'identifiant de l'expérience avec des données commandées que vous souhaitez accès. Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.

Path
Requis
orderedDataStore string

Nom de la boutique de données commandée.

Path
Requis
scope string

Nom de la portée de stockage des données. Voir Scopes .

Path
Requis
id string

Le nom de l'entrée.

Requis
CreateEntryRequest

Crée une nouvelle entrée avec la valeur fournie.

Body
Requis

Requête

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries?id=<id>' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "value": <long> 

}'

Réponse

200 - OK
OK
Renvoie une object
id string

Le nom de l'entrée

path string

Chemin de ressource de la demande.

value number

La valeur de l'entrée.

Obtenir

GET /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Obtient et renvoie l'entrée spécifiée.

Paramètres

universeId string

L'identifiant de l'expérience avec des données commandées que vous souhaitez accès. Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.

Path
Requis
orderedDataStore string

Nom de la boutique de données commandée.

Path
Requis
scope string

Nom de la portée de stockage des données. Voir Scopes .

Path
Requis
entry string

L'ID de l'entrée.

Path
Requis

Requête

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

 --header 'x-api-key: <insert-api-key>'

Réponse

200 - OK
OK
Renvoie une object
id string

Le nom de l'entrée

path string

Chemin de ressource de la demande.

value number

La valeur de l'entrée.

Supprimer

DELETE /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Supprime la entrée spécifiée.

Paramètres

universeId string

L'identifiant de l'expérience avec des données commandées que vous souhaitez accès. Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.

Path
Requis
orderedDataStore string

Nom de la boutique de données commandée.

Path
Requis
scope string

Nom de la portée de stockage des données. Voir Scopes .

Path
Requis
entry string

L'ID de l'entrée.

Path
Requis

Requête

curl
curl --location --request DELETE 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

 --header 'x-api-key: <insert-api-key>'

Réponse

Mettre à jour

PATCH /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}

Mise à jour une valeur d'entrée et restitution de la valeur mise à jour.

Paramètres

universeIdId string

L'identifiant de l'expérience avec des données commandées que vous souhaitez accès. Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.

Path
Requis
orderedDataStore string

Nom de la boutique de données commandée.

Path
Requis
scope string

Nom de la portée de stockage des données. Voir Scopes .

Path
Requis
entry string

L'ID de l'entrée.

Path
Requis
UpdateEntryRequest

Mise à jour de l'entrée fournie avec une nouvelle valeur.

Body
Requis
allow_missing boolean

Le drapeau pour permettre la création d'une entrée si l'entrée n'existe pas. Voir Permettre les drapeaux manquants .

Requête

curl
curl --location --request PATCH 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "value": <long> 

}'

Réponse

200 - OK
OK
Renvoie une object
id string

Le nom de l'entrée

path string

Chemin de ressource de la demande.

value number

La valeur de l'entrée.

Incrément

POST /v1/universes/{universeId}/orderedDataStores/{orderedDataStore}/scopes/{scope}/entries/{entry}:increment

Augmente la valeur de la clé de la quantité fournie et renvoie la valeur mise à jour.

Problème connu : Les valeurs d'entrée peuvent augmenter au-delà de la portée valide et cela peut persister dans le backend. Les valeurs renvoyées s'ajusteront à la portée valide.

Paramètres

universeId string

L'identifiant de l'expérience avec des données commandées que vous souhaitez accès. Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.

Path
Requis
orderedDataStore string

Nom de la boutique de données commandée.

Path
Requis
scope string

Nom de la portée de stockage des données. Voir Scopes .

Path
Requis
entry string

L'ID de l'entrée.

Path
Requis
incrementEntryRequest

Augmente la valeur de l'entrée.

Body
Requis

Requête

curl
curl --location 'https://apis.roblox.com/ordered-data-stores/v1/universes/<universeId>/orderedDataStores/<orderedDataStore>/scopes/<scope>/entries/<entry>:increment' \

--header 'x-api-key: <insert-api-key>' \

--header 'Content-Type: application/json' \

--data '{ 

    "amount": <long> 

}'

Réponse

200 - OK
OK
Renvoie une object
id string

Le nom de l'entrée

path string

Chemin de ressource de la demande.

value number

La valeur de l'entrée.

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.

CreateEntryRequest

Crée une nouvelle entrée avec la valeur fournie.

Attributs

value number

La valeur pour définir la nouvelle entrée. Si la valeur d'entrée dépasse la valeur maximale prise en charge par int64, qui est 9 223 372 036 854 775 807, la demande échoue avec une erreur de demande 400.

Entry

Représente une entrée.

Attributs

id string

Le nom de l'entrée

path string

Chemin de ressource de la demande.

value number

La valeur de l'entrée.

IncrementEntryRequest

Augmente la valeur de l'entrée.

Attributs

amount number

La quantité à augmenter par la valeur d'entrée. Si la valeur d'entrée dépasse la valeur maximale prise en charge par int64, qui est 9 223 372 036 854 775 807, la demande échoue avec une erreur de demande 400.

ListEntriesResponse

Une liste de entrées dans la collectionsparent.

Attributs

entries array<object>

Les entrées du champ de vision spécifié.

nextPageToken string

Un jeton, qui peut être envoyé comme page_token pour récupérer la prochaine page. Si ce champ est omis, il n'y a pas de pages suivantes.

UpdateEntryRequest

Mise à jour de l'entrée fournie avec une nouvelle valeur.

Attributs

value number

La valeur à mettre à jour l'entrée. Si la valeur d'entrée dépasse la valeur maximale prise en charge par int64, qui est 9 223 372 036 854 775 807, la demande échoue avec une erreur de demande 400.