Stockage de données ordonné (Beta)
*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 la documentation de référence pour travailler avec des magasins de données ordonnés.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.
OrderedDataStores
Liste
Renvoie une liste d'entrées d'un boutiquede données ordonné.
Paramètres
L'identifiant de l'expérience avec des magasins de données commandés que vous souhaitez accès.Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.
Le nom du boutiquede données ciblé commandé.
Le nom du scope du magasin de données. Voir Scopes .
Le nombre maximum d'entrées à renvoyer.Le service peut retourner moins que cette valeur.La valeur par défaut est 10 .La valeur maximale est 100 , et toute entrée au-dessus de 100 est forcée à 100 .
Un jeton de page reçu d'un appel précédent List.Fournissez ceci pour récupérer la page suivante.Lors de la pagination, tous les autres paramètres fournis à List doivent correspondre à l'appel fournissant le jeton de page.
La direction d'énumeration. L'ordre par défaut est ascendant. Saisissez un suffixe desc pour descendre.
La gamme de valeurs qualifiantes des entrées à renvoyer. Voir filtres .
Requête
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
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).
Créer
Crée une nouvelle entrée avec la valeur de contenu fournie.
Paramètres
L'identifiant de l'expérience avec des magasins de données commandés que vous souhaitez accès.Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.
Le nom du boutiquede données commandé.
Le nom du scope du magasin de données. Voir Scopes .
Le nom de l'entrée.
Requête
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
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).
Obtenir
Obtient et renvoie l'entrée spécifiée.
Paramètres
L'identifiant de l'expérience avec des magasins de données commandés que vous souhaitez accès.Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.
Le nom du boutiquede données commandé.
Le nom du scope du magasin de données. Voir Scopes .
L'ID d'entrée.
Requête
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
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).
Supprimer
Supprime l'entrée spécifiée.
Paramètres
L'identifiant de l'expérience avec des magasins de données commandés que vous souhaitez accès.Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.
Le nom du boutiquede données commandé.
Le nom du scope du magasin de données. Voir Scopes .
L'ID d'entrée.
Requête
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
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).
Mise à jour
Mise à jour d'une valeur d'entrée et retour de l'entrée mise à jour.
Paramètres
L'identifiant de l'expérience avec des magasins de données commandés que vous souhaitez accès.Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.
Le nom du boutiquede données commandé.
Le nom du scope du magasin de données. Voir Scopes .
L'ID d'entrée.
Le drapeau pour permettre la création d'une entrée si l'entrée n'existe pas. Voir Autoriser les drapeaux manquants.
Requête
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
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).
Incrément
Augmente la valeur de la clé de la quantité fournie et renvoie l'entrée mise à jour.
Problème connu : les valeurs d'entrée peuvent augmenter au-delà de la plage valide et cela peut persister dans le backend. Les valeurs renvoyées s'ajustent à la plage valide.
Paramètres
L'identifiant de l'expérience avec des magasins de données commandés que vous souhaitez accès.Voir ID de l'univers sur la façon de le copier sur Tableau de bord du créateur.
Le nom du boutiquede données commandé.
Le nom du scope du magasin de données. Voir Scopes .
L'ID d'entrée.
Requête
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
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).
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
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 de 9,223,372,036,854,775,807, la demande échoue avec une erreur 400 Request Time-out.
Entry
Représente une entrée.
Attributs
Le nom de l'entrée
Le chemin de ressource de la demande.
La valeur de l'entrée.
IncrementEntryRequest
Augmente la valeur d'entrée d'incréments.
Attributs
Le montant à 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 de 9,223,372,036,854,775,807, la demande échoue avec une erreur 400 Request Time-out.
ListEntriesResponse
Une liste d'entrées dans la collectionsparent.
Attributs
Les entrées de la portée spécifiée.
Un jeton, qui peut être envoyé comme page_token pour récupérer la page suivante. 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
La valeur pour mettre à jour l'entrée.Si la valeur d'entrée dépasse la valeur maximale prise en charge par int64, qui est de 9,223,372,036,854,775,807, la demande échoue avec une erreur 400 Request Time-out.