> ## 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.

# Dados de título

> Leia, defina e exclua dados de chave/valor de todo o título, legíveis pelo cliente ou internos.

Gerencie dados de chave/valor de todo o título. Os comandos têm como destino os dados de título legíveis pelo cliente, que
os clientes de jogo dos jogadores leem, a menos que você adicione `--internal` para ter como destino os dados de título internos
somente do servidor. Você precisa da permissão **Admin** no título; consulte
[Como a autenticação do PlayFab funciona](https://docs.xbox.com/pt-BR/tools/xbox-cli/authentication.md#how-playfab-authentication-works).

| Comando | Caminho da API do PlayFab | Descrição |
| - | - | - |
| `playfab title-data get` | `/Admin/GetTitleData` ou `/Admin/GetTitleInternalData` | Lê uma chave, várias chaves ou todas as chaves. |
| `playfab title-data set` | `/Admin/SetTitleData` ou `/Admin/SetTitleInternalData` | Define uma ou mais chaves. |
| `playfab title-data delete` | `/Admin/SetTitleData` ou `/Admin/SetTitleInternalData`, com valores `null` | Remove uma ou mais chaves. |

Os comandos `title-data` não aceitam `--output table`.

## `playfab title-data get`

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

| Argumento/opção | Descrição |
| - | - |
| `[key]` | Uma chave a ser lida. Equivale a `--key`; passe um ou outro. Uma chave em branco é recusada, em vez de ser interpretada como todas as chaves. |
| `--key <key>` | Uma chave a ser lida. |
| `--keys <a,b,c>` | Chaves separadas por vírgulas a serem lidas. Não pode ser combinada com uma chave única. |
| `--internal` | Lê os dados de título internos em vez dos dados de título legíveis pelo cliente. |

Omita a chave e `--keys` para ler todas as chaves.

Um `get` de uma chave imprime somente o valor da chave. Para obter JSON, passe `--output` para obter
o envelope completo ou `--data-only` para obter o `data` dele. A leitura de várias chaves ou de todas as chaves
sempre retorna JSON.

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

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

Quando a chave única não existe, `get` grava `Key 'MyKey' was not found.` em stderr e
sai com o código `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`

| Opção | Descrição |
| - | - |
| `--key <key>` | A chave a ser definida. Use com `--value`. |
| `--value <value>` | O valor de `--key`, armazenado como está. |
| `--data <data>` | Um objeto JSON de pares de chave/valor, para definir várias chaves de uma vez. Não pode ser combinada com `--key` e `--value`. |
| `--internal` | Grava os dados de título internos em vez dos dados de título legíveis pelo cliente. |

Definir uma chave:

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

Ou definir várias chaves de uma vez:

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

Se for bem-sucedido, `set` grava as chaves que definiu, como `{"applied":["MyKey","OtherKey"]}`.

## `playfab title-data delete`

| Opção | Obrigatória | Descrição |
| - | - | - |
| `--keys <a,b,c>` | Sim | Chaves separadas por vírgulas a serem removidas. |
| `--internal` | Não | Remove os dados de título internos em vez dos dados de título legíveis pelo cliente. |

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

Se for bem-sucedido, `delete` grava as chaves que removeu, como `{"applied":["MyKey","OldKey"]}`.

## Quando uma gravação de várias chaves é interrompida no meio

`set` e `delete` gravam uma chave por vez, em ordem, e param na primeira chave que
não é bem-sucedida. As chaves anteriores a ela foram gravadas; as posteriores não foram tentadas. O comando
sai com o código `1` e grava um resumo em stderr:

| Campo | Significado |
| - | - |
| `applied` | As chaves que foram gravadas. |
| `failed` | A chave que o PlayFab rejeitou, com o erro dela. Ela não foi gravada. |
| `unknown` | A chave cuja solicitação pode ter chegado ao PlayFab sem uma resposta conclusiva, por exemplo, após um tempo limite, Ctrl+C ou um erro HTTP 5xx. Ela pode ter sido gravada; portanto, verifique-a com `title-data get` antes de executar o comando novamente. |
| `notSent` | A chave cuja solicitação nunca foi enviada, por exemplo, quando a entrada falhou. Ela não foi gravada. |

```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

- [Dados de jogador](https://docs.xbox.com/pt-BR/tools/xbox-cli/commands/playfab/player-data.md)
- [Informações de migração de entidades](https://docs.xbox.com/pt-BR/services/playfab/live-service-management/game-configuration/entities/migration-information.md)
- [Início rápido de dados do jogador](https://docs.xbox.com/pt-BR/services/playfab/player-progression/player-data/quickstart.md)
- [Dados do título](https://docs.xbox.com/pt-BR/services/playfab/live-service-management/game-configuration/titledata/index.md)
- [Início rápido de dados do título](https://docs.xbox.com/pt-BR/services/playfab/live-service-management/game-configuration/titledata/quickstart.md)
