GET (/media/{marketplaceId}/fields)
fields トークンを取得します。
これらの URI のドメインは eds.xboxlive.com です。
解説
Entertainment Discovery Services (EDS) の API は、既定では、どの項目についてもごく少数のフィールドのセットを返します。
- メディア項目タイプ
- メディア グループ
- Id
- 名前
より詳細な情報を取得するために、API は返される追加データを指定する fields パラメーターを受け入れます。 使用可能なフィールドは多数あるため、API 呼び出しごとにそれらの名前を完全に指定すると、要求が膨大なものになります。 代わりに、それらの名前をこの API に渡すと、かなりサイズの小さい値を生成して他の API に渡すことができます。
このパラメーターを受け入れる API では、提供される値は、指定されたすべてのメディア項目タイプの、すべてのフィールドのスーパーセットでなければなりません。 各メディア項目タイプで異なるフィールド セットを指定することはできません。 ただし、フィールドが 1 つのメディア項目タイプのみに該当する場合、そのフィールドはデータが存在するメディア項目タイプでのみ表示されます (例: GET (/media/{marketplaceId}/fields) の呼び出しに "AvatarBodyType" が含まれている場合、AvatarItems のみにそのフィールドが含まれます)。
この API から返される値はキャッシュ可能であり、実際に、EDS のデプロイメント間以外では変化しません。 キャッシュを行う場合は、キャッシュの持続時間がユーザーのセッションよりも長くならないようにすることをお勧めします。
実際のフィールド名を受け入れるだけでなく、この API は "all" も有効な値として受け入れます。 これにより、指定できる各フィールドを含む値が生成されます。 "all" 値は、開発、デバッグ、およびテストの目的にのみ使用することをお勧めします。
または、fields トークンを受け入れる API に desired={list of fields separated by a '.'} を送信できます。
desired と fields の両方を同時に渡すことはできません。
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| marketplaceId | 文字列 | 必須。 Windows.Xbox.ApplicationModel.Store.Configuration.MarketplaceId から取得される文字列値。 |
クエリ文字列パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| desired | 文字列 | 必須。 最小セットのほかに返す必要があるフィールドの '.' 区切りのリスト。 オブジェクトごとに指定したすべてのフィールドが返されることが保証されているわけではありません (単に特定の項目のデータが存在していないことがあります)。ただし、最小セット以外でここに指定していないフィールドは返されません。 |