Skip to main content

​
GET (/media//fields)

Obtém o token de campos. O domínio desses URIs é eds.xboxlive.com.

​
Comentários

Por padrão, as APIs do Entertainment Discovery Services (EDS) retornam um conjunto mínimo muito pequeno de campos para cada item:
  • Tipo de item de mídia
  • Grupo de mídia
  • ID
  • Nome
Para obter mais informações, as APIs aceitam um parâmetro fields que especifica quais dados adicionais devem ser retornados. Como há muitos campos possíveis, especificar o nome completo de cada um em cada chamada à API aumentaria muito o tamanho da solicitação. Em vez disso, os nomes podem ser passados para esta API, que gerará um valor muito menor que pode ser passado para as outras APIs. Para qualquer API que aceite esse parâmetro, o valor fornecido deve ser o superconjunto de todos os campos de todos os tipos de item de mídia especificados. Não é possível especificar conjuntos de campos diferentes para tipos de item de mídia diferentes. No entanto, se um campo se aplicar a um tipo de item de mídia, mas não a outro, ele só aparecerá nos tipos de item de mídia em que houver dados (por exemplo, se “AvatarBodyType” for incluído na chamada a GET (/media/{marketplaceId}/fields), somente AvatarItems conterão o campo). Os valores retornados por esta API são altamente armazenáveis em cache; na verdade, eles não devem mudar, exceto entre implantações do EDS. Se o armazenamento em cache for desejado, é recomendável que o cache não dure mais do que a sessão do usuário. Além de aceitar os nomes reais dos campos, esta API aceita “all” como valor válido. Isso gerará um valor que contém todos os campos que é possível especificar. O uso do valor “all” é recomendado apenas para fins de desenvolvimento, depuração e teste. Como alternativa, você pode enviar desired={list of fields separated by a '.'} para qualquer API que aceite o token fields. Não é possível passar desired e fields juntos.

​
Parâmetros de URI

​
Parâmetros da cadeia de consulta

| Parâmetro| Tipo| Descrição| | --- | --- | --- | --- | --- | --- | | desired| string| Obrigatório. A lista de campos separados por ’.’ que devem ser retornados além do conjunto mínimo. Não há garantia de que todos os campos especificados serão retornados para cada objeto (os dados podem simplesmente não existir para determinados itens), mas nenhum campo fora do conjunto mínimo que não esteja especificado aqui será retornado. |

​
Confira também

Pai
/media//fields
Mais informações
Cabeçalhos comuns do EDS Parâmetros do EDS Refinadores de consulta do EDS URIs do Marketplace Referência adicional
Last modified on October 6, 2026