Skip to main content

APIs auxiliares do EDS

Há várias APIs do Entertainment Discovery Services (EDS) que não fornecem informações diretamente sobre o conteúdo, mas oferecem informações gerais sobre como usar o serviço ou ajudam a orientar modelos de interface do usuário comuns.

APIs auxiliares

Valores de parâmetros de API

Esta API descreve os parâmetros que podem ser usados com o serviço. As informações retornadas podem ser usadas pela interface do usuário do cliente, pois cada parâmetro é acompanhado de texto localizado. Nenhuma das APIs abaixo aceita parâmetros de consulta. | API| URI| Descrição| | --- | --- | --- | --- | --- | --- | | Tipos| //metadata/mediaGroups| A lista completa de grupos de mídia| | Tipos de item de mídia por grupo de mídia| //metadata/mediaGroups//mediaItemTypes| A lista de tipos de item de mídia contidos no grupo de mídia fornecido.| | Todos os tipos de item de mídia| //metadata/mediaItemTypes| A lista completa de tipos de item de mídia| | Campos por tipo de item de mídia| //metadata/mediaItemTypes//fields| A lista de campos em um único tipo de item de mídia| | Refinadores de consulta| //metadata/mediaItemTypes//queryRefiners| A lista de refinadores de consulta compatíveis com o tipo de item de mídia fornecido| | Todos os valores de refinadores de consulta| //metadata/mediaItemTypes//queryRefiners/| Os valores do refinador de consulta especificado para o tipo de item de mídia fornecido| | Todos os subvalores de refinadores de consulta| //metadata/mediaItemTypes//queryRefiners//subQueryRefinerValues| A lista de subvalores de um determinado valor de refinador de consulta (por exemplo, “subgêneros em um determinado gênero”). O valor do refinador de consulta é passado como um parâmetro de cadeia de consulta chamado “queryRefinerValue”, o que permite passar valores de refinadores de consulta com caracteres proibidos em radicais de URI.| | Classificações| //metadata/mediaItemTypes//sortOrders| A lista de ordens de classificação para o tipo de item de mídia fornecido|

Gerador de classificação de conteúdo combinada

Aplicar controles parentais sobre o conteúdo que as crianças podem ver é uma tarefa complicada. Além de cada tipo de item de mídia ter seu próprio sistema de classificação, esses sistemas de classificação podem variar de país/região para país/região. Isso significa que há várias informações diferentes que precisam ser especificadas para filtrar corretamente todos os itens. Em vez de especificar todos os parâmetros em todas as chamadas de API, esta API gera um valor a ser passado para os parâmetros combinedContentRating em outras APIs e ainda comunicar as mesmas informações. Isso foi projetado para tornar as APIs mais fáceis de usar e manter, pois os vários parâmetros passados para esta API são condensados em um único valor reutilizável para as outras APIs. Embora os valores exatos retornados por esta API possam mudar eventualmente, eles devem mudar com pouquíssima frequência (por exemplo, entre versões do EDS) e, portanto, podem ser armazenados em cache por longos períodos. Qualquer API que aceite um parâmetro combinedContentRating fornecerá uma mensagem de erro significativa se o valor passado for inválido, o que indica que o chamador só precisa chamar esta API novamente para obter um valor atualizado. Se uma API aceitar um parâmetro combinedContentRating, mas ele não for fornecido, nenhuma filtragem de conteúdo ocorrerá com base nos controles parentais
Observação:
Isso não significa que somente conteúdo “seguro” é retornado; significa que todo o conteúdo é retornado, incluindo conteúdo potencialmente explícito).

Nome de campo combinado

Por padrão, as APIs do EDS retornam um conjunto mínimo e bem 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 informações adicionais devem ser retornadas. Como há muitos campos possíveis, especificar o nome completo de cada um em todas as chamadas de 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 em todos os tipos de item de mídia especificados. Não é possível especificar conjuntos diferentes de campos 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 à API de nome de campo combinado, 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 de campo reais, esta API aceita “all” como um valor válido. Isso gerará um valor que contém todos os campos que é possível especificar. O valor “all” provavelmente será usado apenas para fins de desenvolvimento, depuração e teste.

Confira também

Pai
Referência adicional
Mais informações
URIs do Marketplace
Last modified on October 6, 2026