Parâmetros do EDS
Parâmetros de cadeia de consulta
Esses parâmetros de consulta não são necessariamente aceitos por todas as APIs do Entertainment Discovery Services (EDS), mas todos são aceitos por mais de uma API.| Parâmetro | Tipo | Descrição |
|---|---|---|
| combinedContentRating | string | Opcional. Consulte GET (/media//contentRating). |
| continuationToken | string | Opcional. O token de continuação é um blob opaco que contém informações de que o serviço precisa para a paginação em determinados cenários. Se o valor for omitido, a primeira página de resultados será retornada (em que o tamanho da página é determinado pelo parâmetro maxItems), junto com um token de continuação que pode ser usado para obter a segunda página de resultados. A segunda página conteria o token de continuação para a terceira página de resultados e assim por diante. |
| Desired | string | Opcional. Consulte a API de nome de campo combinado. |
| desiredMediaItemTypes | matriz de string | Opcional. Esse parâmetro determina os tipos de itens a serem retornados na resposta. |
| Domain | string | Opcional. O parâmetro Domain determina o contexto do marketplace de jogos e aplicativos para o qual o cliente está fazendo a chamada. Por padrão, o domínio é “Modern”, indicando que o cliente só pode solicitar conteúdo do XBOX One (ou posterior). Se o cliente quiser mudar o domínio para exibir conteúdo do XBOX 360, ele deverá especificar Domain como “Xbox360”. Atualmente, resultados entre domínios não são compatíveis. Os valores possíveis são:
|
| fields | string | Opcional. Consulte GET (/media//fields). |
| firstPartyOnly | Valor booliano | Parâmetro de filtro opcional. Determina se somente conteúdo primário é retornado ou se tanto o conteúdo primário quanto o de terceiros são retornados pela consulta. |
| freeOnly | Valor booliano | Parâmetro de filtro opcional. Restringe os resultados somente a conteúdo gratuito. |
| GroupBy | TK | O parâmetro groupBy é usado para ajudar a categorizar o conjunto de resultados em grupos, em vez de um único conjunto de resultados. Especificar esse parâmetro modificará o conjunto de resultados para retornar várias listas de itens, em que o número de itens em cada bucket é determinado pelo parâmetro maxItems.
|
| hasTrailer | Valor booliano | Parâmetro de filtro opcional. Determina se os itens retornados devem conter um trailer ou se ter um trailer é opcional. Se o valor for true, todos os itens deverão ter trailers. |
| id | string | Opcional. Se fornecido, restringe os resultados somente aos filhos do item com a ID fornecida. Se esse parâmetro for fornecido, MediaItemType também deverá ser especificado. |
| ids | matriz de string | Obrigatório. Todas as IDs (até 10) para as quais os detalhes serão retornados. Observe que qualquer ID que contenha caracteres não permitidos em uma URL (as IDs do tipo ProviderContentId normalmente são URLs completas e, portanto, contêm caracteres não permitidos) deve ser codificada como URL para ser enviada corretamente ao EDS. |
| idType | string | Opcional. O tipo das IDs passadas para o parâmetro ids. Os valores válidos incluem:
|
| latestOnly | Valor booliano | Parâmetro de filtro opcional. Restringe os resultados somente àqueles com a data de lançamento mais recente. |
| maxItems | inteiro com sinal de 32 bits | Opcional. Determina o número máximo de itens que devem ser retornados por uma chamada. Os valores válidos são números entre 1 e 25, inclusive. O parâmetro assume 25 como padrão se for omitido. |
| mediaGroup | string | Opcional. O grupo de mídia das IDs. Todas as IDs fornecidas devem compartilhar o mesmo grupo de mídia. |
| MediaItemType | string | Opcional. O tipo do item cuja ID foi especificada no parâmetro id. Se o parâmetro id for fornecido, esse parâmetro também deverá ser especificado. |
| orderBy | string | Obrigatório. O parâmetro orderBy determina como os itens retornados devem ser classificados. Os valores comuns para esse campo estão listados aqui, mas algumas APIs podem oferecer suporte a valores adicionais.
|
| preferredProvider | string | Opcional. Se o usuário tiver um provedor de conteúdo preferencial, como Comcast Xfinity ou Verizon FIOS, a ID desse provedor poderá ser passada. Embora a ordem real dos itens não mude, para cada item, as informações do provedor especificado serão exibidas no topo da lista de provedores (se o provedor de conteúdo preferencial tiver o item disponível). |
| q | string | Obrigatório. Termo de consulta usado na pesquisa. |
| queryRefiners | matriz de string | Opcional. Consulte a lista de refinadores de consulta do EDS. |
| relationship | string | Opcional. Filtro que usa o parâmetro ID como base para pesquisar outros produtos que correspondam ao tipo de relação especificado:
|
| ScopeId | string | Esse parâmetro é usado em cenários de pesquisa inversa para mídia de vídeo. |
| ScopeIdType | string | Esse parâmetro é usado em cenários de pesquisa inversa para mídia de vídeo. Valores possíveis: Title. |
| skipItems | inteiro com sinal de 32 bits | Opcional. Para paginação em cenários que não são entre grupos, o parâmetro skipItems é usado para determinar quantos itens já foram vistos (e, portanto, qual item deve ser exibido primeiro no conjunto de resultados). O valor é baseado em 0, portanto, skipItems=0 (ou simplesmente não fornecer skipItems) inicia a recuperação no início da lista. skipItems=3 ignoraria os três primeiros itens da lista e iniciaria a recuperação com o quarto item. |
| subscriptionLevel | matriz de string | Parâmetro de filtro opcional. O parâmetro subscriptionLevel determina o tipo de assinatura que o usuário tem (por exemplo, se o usuário tem uma assinatura paga ou uma assinatura gratuita). Os valores possíveis são os seguintes.
|
| TargetDevices | string | O EDS oferece a flexibilidade de filtrar ofertas para dispositivos de destino. As ofertas (ProviderContent ou Availability) retornadas para o item podem ser restritas a um dispositivo de destino. |
| topRatedOnly | Valor booliano | Parâmetro de filtro opcional. Restringe os resultados somente ao conteúdo mais bem avaliado. |