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

OrderedDataStoreEntry

Une entrée clé-valeur dans un magasin de données ordonné.

Attributs

pathstring

Le chemin de ressource de l'entrée de magasin de données commandée.

Format : universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{ordered_data_store_scope_id}/entries/{ordered_data_store_entry_id}.

valuenumber

La valeur de l'entrée.

Toujours arrondi au plus proche entier.

idstring
Sortie seule

Le nom de l'entrée.

URL de base
https://apis.roblox.com
La ressource OrderedDataStoreEntry
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

Liste des entrées du magasin de données ordonnées
Bêta

GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries

Renvoie une liste d'entrées d'un magasin de données ordonné.

Périmètres d'application
universe.ordered-data-store.scope.entry:read
RequêteParamètres du chemin
universe_idstring
Requis

L'ID de l'univers.

ordered_data_store_idstring
Requis

L'ID du magasin de données commandé.

scope_idstring
Requis

L'ID de la portée.

Paramètres de requête
maxPageSizenumber

Le nombre maximum d'entrées de stock de données commandées à retourner.Le service peut retourner moins que cette valeur.Si non spécifié, au maximum 10 entrées de magasin de données commandées sont retournées.La valeur maximale est de 100 et les valeurs plus élevées sont réglées sur 100.

pageTokenstring

Un jeton de page, reçu d'un appel précédent, pour récupérer une page suivante.

Lors de la pagination, tous les autres paramètres fournis à l'appel suivant doivent correspondre à l'appel qui a fourni le jeton de page.

orderBystring

Si spécifié, les résultats sont triés selon les champs spécifiés.

Les valeurs doivent être une liste séparée par une virgule de champs, avec un suffixe "desc" facultatif par champ pour trier par des valeurs décroissantes plutôt que par des valeurs ascendantes.Vous pouvez accéder à des sous-champs avec un opérateur ..

Les résultats peuvent être triés par les champs suivants : valeur.

Exemple : "value desc".

filterstring

Ce champ peut être défini afin de filtrer les ressources renvoyées.

Nous supportons deux opérateurs de comparaison pour cette opération : <= et >= .Ces opérateurs de comparaison agissent comme une valeur minimale et une valeur maximale pour les valeurs retournées.Si le filtrage est nécessaire pour une valeur entre une minValue et une maxValue, l'utilisateur peut utiliser l'opérateur logique &&.Tous les jetons de l'expression de filtre doivent être séparés par un seul espace.

Exemples de filtres : entry <= 10 ; entry >= 10 && entry <= 30.

Réponse

Une liste de entrées de données ordonnées dans la collection parent.

orderedDataStoreEntriesarray<OrderedDataStoreEntry>

Les entrées du magasin de données commandées de la portée spécifiée du magasin de données commandées.

nextPageTokenstring

Un jeton que vous pouvez envoyer en tant que pageToken paramètre pour récupérer la page suivante. Si ce champ est omis, il n'y a pas de pages suivantes.

GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries?maxPageSize=10&pageToken={string}&orderBy={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
Réponse
{

  "orderedDataStoreEntries": [

    {

      "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

      "value": "number",

      "id": "string"

    }

  ],

  "nextPageToken": "string"

}

OrderedDataStoreEntry

Créer une entrée de magasin de données ordonnée
Bêta

POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries

Crée une entrée avec l'ID et la valeur fournis.

Renvoie une mauvaise demande 400 si l'entrée existe.

Périmètres d'application
universe.ordered-data-store.scope.entry:write
RequêteParamètres du chemin
universe_idstring
Requis

L'ID de l'univers.

ordered_data_store_idstring
Requis

L'ID du magasin de données commandé.

scope_idstring
Requis

L'ID de la portée.

Paramètres de requête
idstring

L'ID à utiliser pour l'entrée du magasin de données commandée, qui deviendra le chemin de ressource final de l'entrée du magasin de données commandée.

Cette valeur doit être une chaîne de caractères A 1-63. Nous vous recommandons vivement d'utiliser uniquement des lettres minuscules, des chiffres numériques et des hyphens.

Corps de la requêteOrderedDataStoreEntry
RéponseOrderedDataStoreEntry
POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries?id=my-entry' \

  -H 'x-api-key: {your-api-key}' \

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

  --data '{

  "value": "number"

}'
Réponse
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

Obtenir une entrée de magasin de données ordonnée
Bêta

GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

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

Périmètres d'application
universe.ordered-data-store.scope.entry:read
RequêteParamètres du chemin
universe_idstring
Requis

L'ID de l'univers.

ordered_data_store_idstring
Requis

L'ID du magasin de données commandé.

scope_idstring
Requis

L'ID de la portée.

entry_idstring
Requis

L'ID d'entrée.

RéponseOrderedDataStoreEntry
GET /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}' \

  -H 'x-api-key: {your-api-key}'
Réponse
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

Supprimer l'entrée du magasin de données ordonné
Bêta

DELETE /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

Supprime l'entrée spécifiée.

En cas de succès, renvoie 200 OK. Si l'entrée n'existe pas, renvoie 404 Not Found.

Périmètres d'application
universe.ordered-data-store.scope.entry:write
RequêteParamètres du chemin
universe_idstring
Requis

L'ID de l'univers.

ordered_data_store_idstring
Requis

L'ID du magasin de données commandé.

scope_idstring
Requis

L'ID de la portée.

entry_idstring
Requis

L'ID d'entrée.

DELETE /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
curl -L -X DELETE 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}' \

  -H 'x-api-key: {your-api-key}'

OrderedDataStoreEntry

Mise à jour de l'entrée du magasin de données commandée
Bêta

PATCH /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}

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

Périmètres d'application
universe.ordered-data-store.scope.entry:write
RequêteParamètres du chemin
universe_idstring
Requis

L'ID de l'univers.

ordered_data_store_idstring
Requis

L'ID du magasin de données commandé.

scope_idstring
Requis

L'ID de la portée.

entry_idstring
Requis

L'ID d'entrée.

Paramètres de requête
allowMissingboolean

Si la valeur est définie sur vrai et que l'entrée de stockage de données commandée n'est pas trouvée, une entrée de stockage de données commandée est créée.

Corps de la requêteOrderedDataStoreEntry
RéponseOrderedDataStoreEntry
PATCH /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}?allowMissing={boolean}' \

  -H 'x-api-key: {your-api-key}' \

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

  --data '{

  "value": "number"

}'
Réponse
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}

OrderedDataStoreEntry

Entrée de magasin de données augmentée dans l'ordre
Bêta

POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment

Augmente la valeur de l'entrée spécifiée. La valeur existante et la quantité d'augmentation doivent être des entiers.

Si l'entrée n'existe pas, crée une entrée avec la valeur spécifiée.

Problème connu : la valeur peut être augmentée au-delà de la plage valide de valeurs.Lorsque cela se produit, la valeur retournée sera clampée à la plage valide, mais le backend peut persister la valeur originale.Ce comportement est maintenu pour des raisons de compatibilité avec les versions précédentes de cette API, mais peut changer dans une version future de cette API.

Périmètres d'application
universe.ordered-data-store.scope.entry:write
RequêteParamètres du chemin
universe_idstring
Requis

L'ID de l'univers.

ordered_data_store_idstring
Requis

L'ID du magasin de données commandé.

scope_idstring
Requis

L'ID de la portée.

entry_idstring
Requis

L'ID d'entrée.

Corps de la requête
amountnumber

Le montant par lequel augmenter la valeur d'entrée. La valeur existante et la quantité d'augmentation doivent être des entiers.

RéponseOrderedDataStoreEntry
POST /cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment' \

  -H 'x-api-key: {your-api-key}' \

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

  --data '{

  "amount": "number"

}'
Réponse
{

  "path": "universes/123/ordered-data-stores/some-ordered-data-store-id/scopes/some-ordered-data-store-scope-id/entries/some-ordered-data-store-entry-id",

  "value": "number",

  "id": "string"

}