Parámetros de EDS
Parámetros de cadena de consulta
Estos parámetros de consulta no se aceptan necesariamente en todas las API de Entertainment Discovery Services (EDS), pero todos se aceptan en más de una API.| Parámetro | Tipo | Descripción |
|---|---|---|
| combinedContentRating | string | Opcional. Consulte GET (/media//contentRating). |
| continuationToken | string | Opcional. El token de continuación es un blob opaco que contiene información que el servicio necesita para la paginación en determinados escenarios. Si se omite el valor, se devuelve la primera página de resultados (donde el tamaño de página lo determina el parámetro maxItems), junto con un token de continuación que se puede usar para obtener la segunda página de resultados. La segunda página contendría el token de continuación para la tercera página de resultados, y así sucesivamente. |
| Desired | string | Opcional. Consulte la API de nombres de campo combinados. |
| desiredMediaItemTypes | array of string | Opcional. Este parámetro determina los tipos de elementos que se devolverán en la respuesta. |
| Domain | string | Opcional. El parámetro Domain determina el contexto de marketplace de juegos y aplicaciones para el que llama el cliente. De forma predeterminada, el dominio es “Modern”, lo que indica que el cliente solo puede solicitar contenido de XBOX One (o posterior). Si el cliente quiere cambiar el dominio para mostrar contenido de XBOX 360, debe especificar Domain como “Xbox360”. Actualmente, no se admiten resultados entre dominios. Los valores posibles son:
|
| fields | string | Opcional. Consulte GET (/media//fields). |
| firstPartyOnly | Boolean value | Parámetro de filtro opcional. Determina si la consulta devuelve solo contenido propio o si devuelve tanto contenido propio como de terceros. |
| freeOnly | Boolean value | Parámetro de filtro opcional. Restringe los resultados solo al contenido gratuito. |
| GroupBy | TK | El parámetro groupBy se usa para ayudar a clasificar el conjunto de resultados en grupos, en lugar de un único conjunto de resultados. Al especificar este parámetro, el conjunto de resultados se modifica para devolver varias listas de elementos, donde el número de elementos de cada grupo lo determina el parámetro maxItems.
|
| hasTrailer | Boolean value | Parámetro de filtro opcional. Determina si los elementos devueltos deben contener un tráiler o si tener un tráiler es opcional. Si el valor es true, todos los elementos deben tener tráiler. |
| id | string | Opcional. Si se proporciona, restringe los resultados a los elementos secundarios del elemento con el identificador especificado. Si se proporciona este parámetro, también debe especificarse MediaItemType. |
| ids | array of string | Obligatorio. Todos los identificadores (hasta 10) de los que se devolverán detalles. Tenga en cuenta que cualquier identificador que contenga caracteres no permitidos en una dirección URL (los identificadores de tipo ProviderContentId suelen ser direcciones URL completas y, por tanto, contienen caracteres no permitidos) debe codificarse como URL para enviarse correctamente a EDS. |
| idType | string | Opcional. El tipo de los identificadores que se pasan al parámetro ids. Los valores válidos incluyen:
|
| latestOnly | Boolean value | Parámetro de filtro opcional. Restringe los resultados solo a los que tienen la fecha de lanzamiento más reciente. |
| maxItems | 32-bit signed integer | Opcional. Determina el número máximo de elementos que debe devolver una llamada. Los valores válidos son números entre 1 y 25, ambos incluidos. El parámetro tiene el valor predeterminado 25 si se omite. |
| mediaGroup | string | Opcional. El grupo multimedia de los identificadores. Todos los identificadores proporcionados deben compartir el mismo grupo multimedia. |
| MediaItemType | string | Opcional. El tipo del elemento cuyo identificador se especificó en el parámetro id. Si se proporciona el parámetro id, también debe especificarse este parámetro. |
| orderBy | string | Obligatorio. El parámetro orderBy determina cómo deben ordenarse los elementos devueltos. Aquí se enumeran los valores comunes para este campo, pero algunas API pueden admitir valores adicionales.
|
| preferredProvider | string | Opcional. Si el usuario tiene un proveedor de contenido preferido, como Comcast Xfinity o Verizon FIOS, se puede pasar el identificador de ese proveedor. Aunque el orden real de los elementos no cambiará, para cada elemento, la información del proveedor especificado se mostrará al principio de la lista de proveedores (si el proveedor de contenido preferido tiene el elemento disponible). |
| q | string | Obligatorio. Término de consulta usado en la búsqueda. |
| queryRefiners | array of string | Opcional. Consulte la lista de refinadores de consulta de EDS. |
| relationship | string | Opcional. Filtro que usa el parámetro ID como base para buscar otros productos que coincidan con el tipo de relación especificado:
|
| ScopeId | string | Este parámetro se usa en escenarios de búsqueda inversa para contenido multimedia de vídeo. |
| ScopeIdType | string | Este parámetro se usa en escenarios de búsqueda inversa para contenido multimedia de vídeo. Valores posibles: Title. |
| skipItems | 32-bit signed integer | Opcional. Para la paginación en escenarios que no son entre grupos, el parámetro skipItems se usa para determinar cuántos elementos ya se han visto (y, por tanto, qué elemento debe mostrarse primero en el conjunto de resultados). El valor está basado en 0, por lo que skipItems=0 (o simplemente no proporcionar skipItems) inicia la recuperación al principio de la lista. skipItems=3 omitiría los tres primeros elementos de la lista e iniciaría la recuperación con el cuarto elemento. |
| subscriptionLevel | array of string | Parámetro de filtro opcional. El parámetro subscriptionLevel determina el tipo de suscripción que tiene el usuario (por ejemplo, si un usuario tiene una suscripción de pago o una suscripción gratuita). Los valores posibles son los siguientes.
|
| TargetDevices | string | EDS proporciona la flexibilidad de filtrar ofertas para dispositivos de destino. Las ofertas (ProviderContent o Availability) devueltas para el elemento pueden restringirse a un dispositivo de destino. |
| topRatedOnly | Boolean value | Parámetro de filtro opcional. Restringe los resultados solo al contenido mejor valorado. |