> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Données de titre

> Lisez, définissez et supprimez des données clé-valeur à l'échelle du titre, lisibles par le client ou internes.

Gérer les données clé-valeur à l'échelle du titre. Les commandes ciblent les données de titre lisibles par le client, que
lisent les clients de jeu des joueurs, sauf si vous ajoutez `--internal` pour cibler les données de titre internes,
réservées au serveur. Vous avez besoin de l'autorisation **Admin** sur le titre; consultez
[Fonctionnement de l'authentification PlayFab](https://docs.xbox.com/fr-CA/tools/xbox-cli/authentication.md#how-playfab-authentication-works).

| Commande | Chemin de l'API PlayFab | Description |
| - | - | - |
| `playfab title-data get` | `/Admin/GetTitleData` ou `/Admin/GetTitleInternalData` | Lit une clé, plusieurs clés ou toutes les clés. |
| `playfab title-data set` | `/Admin/SetTitleData` ou `/Admin/SetTitleInternalData` | Définit une ou plusieurs clés. |
| `playfab title-data delete` | `/Admin/SetTitleData` ou `/Admin/SetTitleInternalData`, avec des valeurs `null` | Retire une ou plusieurs clés. |

Les commandes `title-data` n'acceptent pas `--output table`.

## `playfab title-data get`

```text theme={null}
xbox --playfab-title-id ABC123 playfab title-data get [key] [flags]
```

| Argument / option | Description |
| - | - |
| `[key]` | Une clé à lire. Équivaut à `--key`; transmettez l'un ou l'autre. Une clé vide est refusée, au lieu d'être interprétée comme toutes les clés. |
| `--key <key>` | Une clé à lire. |
| `--keys <a,b,c>` | Clés à lire, séparées par des virgules. Ne peut pas être combinée avec une seule clé. |
| `--internal` | Lire les données de titre internes au lieu des données de titre lisibles par le client. |

Omettez la clé et `--keys` pour lire toutes les clés.

Un `get` pour une seule clé affiche la valeur brute de la clé. Pour obtenir plutôt du JSON, transmettez `--output` pour
obtenir l'enveloppe complète, ou `--data-only` pour obtenir son champ `data`. La lecture de plusieurs clés ou de toutes les clés
retourne toujours du JSON.

```bash theme={null}
xbox --playfab-title-id ABC123 playfab title-data get MyKey
```

```text theme={null}
my-value
```

Lorsque la clé demandée n'existe pas, `get` écrit `Key 'MyKey' was not found.` sur stderr et
se termine avec le code `1`.

```bash theme={null}
xbox --playfab-title-id ABC123 playfab title-data get MyKey --internal
xbox --playfab-title-id ABC123 playfab title-data get MyKey --output json
xbox --playfab-title-id ABC123 playfab title-data get --keys MyKey,OtherKey
xbox --playfab-title-id ABC123 playfab title-data get
```

## `playfab title-data set`

| Option | Description |
| - | - |
| `--key <key>` | La clé à définir. À utiliser avec `--value`. |
| `--value <value>` | La valeur de `--key`, stockée telle quelle. |
| `--data <data>` | Un objet JSON de paires clé-valeur, pour définir plusieurs clés à la fois. Ne peut pas être combinée avec `--key` et `--value`. |
| `--internal` | Écrire les données de titre internes au lieu des données de titre lisibles par le client. |

Définir une clé :

```bash theme={null}
xbox --playfab-title-id ABC123 playfab title-data set --key MyKey --value my-value
```

Ou définir plusieurs clés à la fois :

```bash theme={null}
xbox --playfab-title-id ABC123 playfab title-data set --data '{"MyKey":"my-value","OtherKey":"2"}'
```

En cas de réussite, `set` écrit les clés qu'elle a définies, comme `{"applied":["MyKey","OtherKey"]}`.

## `playfab title-data delete`

| Option | Obligatoire | Description |
| - | - | - |
| `--keys <a,b,c>` | Oui | Clés à retirer, séparées par des virgules. |
| `--internal` | Non | Retirer des données de titre internes au lieu de données de titre lisibles par le client. |

```bash theme={null}
xbox --playfab-title-id ABC123 playfab title-data delete --keys MyKey,OldKey
```

En cas de réussite, `delete` écrit les clés qu'elle a retirées, comme `{"applied":["MyKey","OldKey"]}`.

## Lorsqu'une écriture de plusieurs clés s'arrête en cours de route

`set` et `delete` écrivent une clé à la fois, dans l'ordre, et s'arrêtent à la première clé qui
ne réussit pas. Les clés précédentes ont été écrites; les clés suivantes n'ont pas été tentées. La commande
se termine avec le code `1` et écrit un résumé sur stderr :

| Champ | Signification |
| - | - |
| `applied` | Les clés qui ont été écrites. |
| `failed` | La clé que PlayFab a rejetée, avec son erreur. Elle n'a pas été écrite. |
| `unknown` | La clé dont la requête pourrait avoir atteint PlayFab sans réponse concluante, par exemple après un délai d'attente expiré, Ctrl+C ou une erreur HTTP 5xx. Elle pourrait avoir été écrite; vérifiez-la donc avec `title-data get` avant d'exécuter la commande de nouveau. |
| `notSent` | La clé dont la requête n'est jamais partie, par exemple lorsque la connexion a échoué. Elle n'a pas été écrite. |

```json theme={null}
{
  "applied": ["MyKey"],
  "unknown": {
    "key": "OtherKey",
    "error": "The operation was canceled.",
    "outcomeUnknown": "/Admin/SetTitleData may have reached PlayFab, but the request was canceled, so its outcome is unknown. Check whether it was applied before retrying."
  }
}
```


## Related topics

- [Données de titre](https://docs.xbox.com/fr-CA/services/playfab/live-service-management/game-configuration/titledata/index.md)
- [Démarrage rapide des données de titre](https://docs.xbox.com/fr-CA/services/playfab/live-service-management/game-configuration/titledata/quickstart.md)
- [Données de joueur](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/playfab/player-data.md)
- [Stockage de titre](https://docs.xbox.com/fr-CA/services/xbox-services/storage/title-storage/index.md)
- [Stockage connecté et stockage de titre](https://docs.xbox.com/fr-CA/services/xbox-services/storage/live-connected-storage-vs-title-storage.md)
