GET(/media/{marketplaceId}/fields)
필드 토큰을 가져옵니다.
이 URI의 도메인은 eds.xboxlive.com입니다.
설명
기본적으로 엔터테인먼트 검색 서비스(EDS) API는 다음 각 항목에 대해 필드의 최소 집합을 반환합니다.
- 미디어 항목 유형
- 미디어 그룹
- ID
- 이름
추가 정보를 가져오려면 API는 필드 매개 변수를 허용하여 추가 데이터를 반환해야 하는지 지정합니다. 가능한 필드가 많이 있으므로 각 API 호출에 대해 전체 이름을 지정하면 요청이 크게 증가합니다. 대신, 훨씬 작은 값을 생성하는 이 API로 이름을 전달하여 다른 API로 전달할 수 있습니다.
이 매개 변수를 허용하는 API의 경우 제공된 값은 지정된 모든 미디어 항목 유형에 있는 모든 필드의 상위 집합이어야 합니다. 다양한 미디어 항목 유형에 대해 다른 필드 집합을 지정할 수는 없습니다. 하지만 한 필드가 하나의 미디어 항목 유형에는 적용되지만 다른 필드 항목에는 적용되지 않는 경우 데이터가 있는 미디어 항목 유형에만 표시됩니다(예를 들어 "AvatarBodyType"이 GET (/media/{marketplaceId}/fields)의 호출에 포함되는 경우 AvatarItems만 필드를 포함함).
이 API에서 반환된 값은 캐시할 수 있으며, EDS의 각 배포 간에만 변경할 수 있습니다. 캐싱이 필요한 경우 캐시는 사용자의 세션보다 오래 지속되지 않는 것이 좋습니다.
이 API는 실제 필드 이름을 승인하는 것 외에도 "all"을 유효한 값으로 허용합니다. 이에 따라 지정할 수 있는 각 필드가 포함된 값이 생성됩니다. "all" 값은 개발, 디버깅 및 테스트 목적으로만 사용하는 것이 좋습니다.
또는 desired={list of fields separated by a '.'}를 fields 토큰을 허용하는 API로 전송할 수 있습니다.
desired 및 fields에서 모두 전달할 수는 없습니다.
URI 매개 변수
| 매개 변수 | 형식 | 설명 |
|---|---|---|
| marketplaceId | 문자열 | 필수. Windows.Xbox.ApplicationModel.Store.Configuration.MarketplaceId에서 획득한 문자열 값입니다. |
쿼리 문자열 매개 변수
| 매개 변수 | 형식 | 설명 |
|---|---|---|
| desired | 문자열 | 필수. 최소 집합 이외에 반환되어야 하는 '.' 분리 필드 목록입니다. 지정된 모든 필드가 각 개체에 대해 반환되는 것은 아니지만(데이터는 특정 항목에 대해 존재하지 않을 수도 있음), 여기에 지정되지 않은 최소 집합 외부 필드는 반환되지 않습니다. |