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

# EDS Parameters

> EDS Parameters

# EDS 参数

## 查询字符串参数

这些查询参数不一定被所有 [娱乐发现服务 (EDS) API](https://docs.xbox.com/zh-CN/reference/live/rest/uri/marketplace/atoc-reference-marketplace.md) 接受，但都被多个 API 接受。

| 参数 | 类型 | 说明 |
| - | - | - |
| combinedContentRating | string | 可选。参见 [GET (/media/{marketplaceId}/contentRating)](https://docs.xbox.com/zh-CN/reference/live/rest/uri/marketplace/uri-medialocalecontentratingget.md)。 |
| continuationToken | string | 可选。continuation token 是一个不透明的数据块，包含服务在某些分页场景下所需的信息。如果省略该值，则返回第一页结果（页大小由 maxItems 参数决定），并附带一个可用于获取第二页结果的 continuation token。第二页会包含用于获取第三页结果的 continuation token，依此类推。 |
| Desired | string | 可选。参见组合字段名 API。 |
| desiredMediaItemTypes | array of string | 可选。此参数决定响应中要返回的项类型。 |
| Domain | string | 可选。Domain 参数决定客户端调用所处的游戏和应用市场上下文。默认情况下，域为 "Modern"，表示客户端只能请求 XBOX One（或更新版本）内容。如果客户端希望切换域以显示 XBOX 360 内容，则必须将 Domain 指定为 "Xbox360"。目前不支持跨域结果。可能的值为：<ul><li>Xbox360</li><li>Modern</li></ul> "Xbox360" 值仅对 singleMediaGroupSearch 支持。支持 Browse 和 Details。不支持 crossMediaGroupSearch，将返回 400 错误。 |
| fields | string | 可选。参见 [GET (/media/{marketplaceId}/fields)](https://docs.xbox.com/zh-CN/reference/live/rest/uri/marketplace/uri-medialocalefieldsget.md)。 |
| firstPartyOnly | Boolean 值 | 可选筛选参数。决定是仅返回第一方内容，还是同时返回第一方和第三方内容。 |
| freeOnly | Boolean 值 | 可选筛选参数。将结果限制为仅免费内容。 |
| GroupBy | TK | groupBy 参数用于帮助将结果集分类为多个分组，而不是单一结果集。指定此参数将修改结果集，返回多个项列表，每个分组中的项数由 maxItems 参数决定。<ul><li>MediaGroup - 结果按 MediaGroup 分组。</li></ul> |
| hasTrailer | Boolean 值 | 可选筛选参数。决定返回的项是否必须包含预告片，或者预告片是可选的。如果该值为 true，则所有项都必须包含预告片。 |
| id | string | 可选。如果提供，则将结果限制为具有指定 ID 项的子项。如果提供此参数，则还必须指定 MediaItemType。 |
| ids | array of string | 必需。要返回详细信息的所有 ID（最多 10 个）。请注意，任何包含在 URL 中非法字符的 ID（ProviderContentId 类型的 ID 通常本身就是完整的 URL，因此包含非法字符）必须进行 URL 编码，才能正确发送到 EDS。 |
| idType | string | 可选。传入 ids 参数的 ID 的类型。有效值包括：<ul><li>Canonical（Bing/市场）</li><li>XboxHexTitle（在主机上运行的应用）</li></ul>  所有提供的 ID 都必须共享相同的 idType。如果省略此值，则假定所有 ID 均为 Canonical。 |
| latestOnly | Boolean 值 | 可选筛选参数。将结果限制为仅具有最新发行日期的项。 |
| maxItems | 32 位有符号整数 | 可选。决定一次调用应返回的最大项数。有效值为 1 到 25（含）之间的数字。如果省略，则该参数默认为 25。 |
| mediaGroup | string | 可选。ID 的媒体组。所有提供的 ID 都必须共享相同的媒体组。 |
| MediaItemType | string | 可选。id 参数中指定 ID 项的类型。如果提供了 id 参数，则也必须指定此参数。 |
| orderBy | string | 必需。orderBy 参数决定所返回项的排序方式。此字段常见的取值在此处列出，但某些 API 可能支持其他值。<ul><li>playCountDaily - 按媒体播放次数（最近一天）。</li><li>freeAndPaidCountDaily - 按免费和付费购买次数（最近一天）。</li><li>paidCountAllTime - 按付费购买次数（所有时间）。</li><li>paidCountDaily - 按付费购买次数（最近一天）。</li><li>digitalReleaseDate - 按可下载日期。</li><li>releaseDate - 按可在商店购买的日期，回退到数字发行日期（如果可用）。</li><li>userRatings - 按平均用户评分。</li></ul> |
| preferredProvider | string | 可选。如果用户有首选内容提供商（例如 Comcast Xfinity 或 Verizon FIOS），则可以传入该提供商的 ID。虽然项目的实际排序不会改变，但对于每一项，该指定提供商的信息将显示在提供商列表的顶部（前提是该首选内容提供商拥有该项）。 |
| q | string | 必需。搜索中使用的查询词。 |
| queryRefiners | array of string | 可选。请参阅 [EDS 查询精简器](https://docs.xbox.com/zh-CN/reference/live/rest/additional/edsqueryrefiners.md) 列表。 |
| relationship | string | 可选。以 ID 参数为基础的筛选器，用于查找与所指定关系类型相匹配的其他产品：<ul><li>bundledWith - 查找包含该 ID 参数作为其组成部分的捆绑产品。</li><li>bundledProducts - 查找由 ID 参数指定的捆绑包中包含的产品。</li></ul>  只有在市场中可见的产品（可以通过浏览调用返回）才会随此参数一起返回。如果某个捆绑包中有隐藏产品，它仍属于该捆绑包，但不会出现在这些结果中。 |
| ScopeId | string | 此参数用于视频媒体的反向查找场景。 |
| ScopeIdType | string | 此参数用于视频媒体的反向查找场景。可能的值：Title。 |
| skipItems | 32 位有符号整数 | 可选。在非跨分组场景下的分页时，skipItems 参数用于确定已经看到了多少项（从而决定结果集中首先显示哪一项）。该值从 0 开始，因此 skipItems=0（或不提供 skipItems）表示从列表开头开始检索。skipItems=3 将跳过列表中的前三项，从第四项开始检索。 |
| subscriptionLevel | array of string | 可选筛选参数。subscriptionLevel 参数决定用户所拥有订阅的类型（例如用户是付费订阅还是免费订阅）。可能的值如下：<ul><li>gold：用户拥有付费订阅</li><li>silver：用户拥有免费订阅。</li></ul> |
| TargetDevices | string | EDS 提供针对目标设备筛选优惠的灵活性。该项返回的 Offers（ProviderContent 或 Availability）可以限制为某个目标设备。 |
| topRatedOnly | Boolean 值 | 可选筛选参数。将结果限制为仅评分最高的内容。 |

## 另请参阅

### 上级

[附加参考](https://docs.xbox.com/zh-CN/reference/live/rest/additional/atoc-xboxlivews-reference-additional.md)

### 更多信息

[市场 URI](https://docs.xbox.com/zh-CN/reference/live/rest/uri/marketplace/atoc-reference-marketplace.md)


## Related topics

- [EDS Authorization](https://docs.xbox.com/zh-CN/reference/live/rest/additional/edsauthorization.md)
- [EDS 表](https://docs.xbox.com/zh-CN/reference/live/rest/additional/edstables.md)
- [Auxiliary EDS APIs](https://docs.xbox.com/zh-CN/reference/live/rest/additional/eds-apis.md)
- [EDS Common Headers](https://docs.xbox.com/zh-CN/reference/live/rest/additional/edscommonheaders.md)
- [EDS Query Refiners](https://docs.xbox.com/zh-CN/reference/live/rest/additional/edsqueryrefiners.md)