GET (/media/{marketplaceId}/fields)

获取字段令牌。 这些 URI 的域是 eds.xboxlive.com

备注

默认情况下,Entertainment Discovery Services (EDS) API 为每个项目返回一组很少(最少)的字段:

  • 媒体项类型
  • 媒体组
  • Id
  • 名称

为获取更多信息,API 接受指定哪些其他数据片段应返回的 fields 参数。 因为有很多可能的字段,为每个 API 调用指定完整名称会使请求大大膨胀。 而名称可以传入此 API,这将生成要小很多的值,其可以传入其他 API。

对于接受此参数的任何 API,提供的值必须是所有指定媒体项类型中的所有字段的超集。 不能为不同媒体项类型指定不同的字段集。 但是,如果某个字段适用于一个媒体项类型,但不适用于另一个,它只会显示在数据所在的媒体项类型中(例如,如果“AvatarBodyType”包含在对 GET (/media/{marketplaceId}/fields) 的调用中,则仅 AvatarItems 将包含此字段)。

从此 API 返回的值是高度可缓存的 - 实际上,除非在两次 EDS 部署之间,否则它们应该不会更改。 如果需要缓存,建议缓存持续的时间不要超过用户的会话时间。

除了接受实际字段名称外,此 API 还会作为有效值接受“所有”。 这将生成一个包含可以指定的每个字段的值。 建议仅将“所有”值用于开发、调试和测试目的。

或者,你可以向接受 fields 令牌的任何 API 发送 desired={list of fields separated by a '.'}

不能同时传入 desiredfields

URI 参数

参数 类型 说明
marketplaceId 字符串 必需。 从 Windows.Xbox.ApplicationModel.Store.Configuration.MarketplaceId 获取的字符串值。

查询字符串参数

参数 类型 说明
desired 字符串 必需。 除最小集外应返回的字段的‘.’分隔列表。 并不能保证为每个对象返回所有指定的字段(某些项目的数据可能根本不存在),但是不会返回最小集之外的未在此处指定的字段。

另请参阅

父级

/media/{marketplaceId}/fields

补充信息

EDS 通用标头

EDS 参数

EDS 查询优化器

市场 URI

其他参考