通过

EDS 参数

  • 项目

查询字符串参数

不一定所有 Entertainment Discovery Services (EDS) API 都接受这些查询参数，但都有一个以上的 API 会接受。

参数 类型 说明
combinedContentRating 字符串 可选。 请参阅 GET (/media/{marketplaceId}/contentRating)。
continuationToken 字符串 可选。 延续令牌是一个不透明的 Blob，包含服务在某些场景中分页所需的信息。 如果忽略值，将返回结果的第一页（页面大小由 maxItems 参数确定），以及可用于获取结果的第二页的延续令牌。 第二页会包含结果第三页的延续令牌等。
需要 字符串 可选。 请参阅“组合字段名称 API”。
desiredMediaItemTypes 字符串数组 可选。 此参数确定将在响应中返回的项目的类型。
域 字符串 可选。 域参数确定客户端在其中发起需求的游戏和应用市场环境。 默认情况下，域是“Modern”，指示客户端只能请求 Xbox One (或更高版本) 内容。 如果客户端要将域切换到 Surface Xbox 360 内容，则必须将域指定为“Xbox360”。 当前，不支持跨域结果。 可能的值为：
  • Xbox360
  • 现代
仅 singleMediaGroupSearch 支持“Xbox360”值。 支持浏览和详细信息。 不支持 crossMediaGroupSearch，将返回 400 错误。
字段 字符串 可选。 请参阅 GET (/media/{marketplaceId}/fields)。
firstPartyOnly 布尔值 可选的 filter 参数。 确定查询是否只返回第一方内容，或是否返回第一方和第三方两方内容。
freeOnly 布尔值 可选的 filter 参数。 将结果限制为仅免费内容。
GroupBy TK groupBy 参数用于帮助将结果集分类到组中，而不是单个结果集。 指定此参数会将结果集修改为返回多个项目列表，每个存储桶中的项目数由 maxItems 参数确定。
  • MediaGroup - 结果由 MediaGroup 进行分组。
hasTrailer 布尔值 可选的 filter 参数。 确定返回的项目是否必须包含预告片，或包含预告片是否是可选的。 如果值为 true，所有项目都必须包含预告片。
id 字符串 可选。 如果提供，会将结果限制为仅具有给定 ID 的项目的儿童。 如果提供此参数，还必须指定 MediaItemType。
ids 字符串数组 必需。 将返回详细信息的所有 ID（最多 10 个）。 请注意，包含不能放入 URL 的非法字符的任何 ID（ProviderContentId 类型 ID 通常本身就是完整的 URL，因此包含非法字符）均必须进行 URL 编码以正确发送到 EDS。
idType 字符串 可选。 传入 ids 参数的 ID 的类型。 有效值包括：
  • Canonical（必应/市场）
  • XboxHexTitle（在主机上玩的应用）
提供的所有 ID 均必须共享相同的 idType。 如果忽略此值，所有 ID 都会假定为 Canonical。
latestOnly 布尔值 可选的 filter 参数。 将结果限制为仅具有最新发布日期的结果。
maxItems 32 位有符号整数 可选。 确定调用应返回的项目的最大数。 有效值为 1 到 25（包括这两者）的数字。 如果忽略，参数将默认为 25。
mediaGroup 字符串 可选。 ID 的媒体组。 提供的所有 ID 均必须共享相同的媒体组。
MediaItemType 字符串 可选。 在 ID 参数中指定其 ID 的项目的类型。 如果提供 ID 参数，也必须指定此参数。
orderBy 字符串 必需。 orderBy 参数确定应如何排序返回的项目。 此字段的常见值已在此处列出，但有些 API 可能支持更多值。
  • playCountDaily - 按最近一天媒体播放的次数。
  • freeAndPaidCountDaily - 按最近一天购买免费内容和付费内容的次数。
  • paidCountAllTime - 按所有时间购买付费内容的次数。
  • paidCountDaily - 按最近一天购买付费内容的次数。
  • digitalReleaseDate - 按可以下载的日期。
  • releaseDate - 按商店开始出售的日期，回退到数字发布日期（如果有）。
  • userRatings - 按平均用户评分。
preferredProvider 字符串 可选。 如果用户有首选内容提供商（如 Comcast Xfinity 或 Verizon FIOS），则可以传入该提供商的 ID。 虽然每个物品的实际顺序不会更改，但指定提供商的信息将显示在提供商列表的顶部（如果首选内容提供商有可用物品）。
q 字符串 必需。 搜索中使用的查询词。
queryRefiners 字符串数组 可选。 请参阅 EDS 查询优化器的列表。
关系 字符串 可选。 将 ID 参数用作搜索与指定关系类型匹配的其他产品的基础的筛选器：
  • bundledWith - 查找 ID 参数作为这些捆绑包的一部分包含的捆绑包产品。
  • bundledProducts - 查找包含在 ID 参数指定的捆绑包中的产品。
仅市场中可见的产品（可在浏览调用中返回）会随此参数返回。 如果捆绑包包含隐藏产品，隐藏产品仍然是捆绑包的一部分，但不会在这些结果中返回。
ScopeId 字符串 此参数用于视频媒体的反向查找场景。
ScopeIdType 字符串 此参数用于视频媒体的反向查找场景。 可能的值为：Title。
skipItems 32 位有符号整数 可选。 对于非跨组场景中的分页，skipItems 参数用于确定已经看到的项目数（以及结果集中应首先显示哪个项目）。 值为 0-based，因此，skipItems=0（或不提供 skipItems）将在列表开头开始检索。 skipItems=3 会跳过列表中的前三个项目，从第四个项目开始检索。
subscriptionLevel 字符串数组 可选的 filter 参数。 subscriptionLevel 参数确定用户所有的订阅的类型（如用户是否有付费订阅或免费订阅）。 可能的值如下。
  • gold：用户有付费订阅
  • silver：用户有免费订阅。
TargetDevices 字符串 EDS 提供为目标设备筛选优惠的灵活性。 返回的物品优惠（ProviderContent 或 Availability）可以限制为设备目标。
topRatedOnly 布尔值 可选的 filter 参数。 将结果限制为仅评分最高的内容。

另请参阅

父级

其他参考

补充信息

市场 URI