EDS 매개 변수
쿼리 문자열 매개 변수
이러한 쿼리 매개 변수를 모든 엔터테인먼트 검색 서비스(EDS) API가 반드시 수락하는 것은 아니며 이 매개 변수 모두를 둘 이상의 API가 수락합니다.
| 매개 변수 | 형식 | 설명 |
|---|---|---|
| combinedContentRating | 문자열 | 선택 사항. GET (/media/{marketplaceId}/contentRating)를 참조하십시오. |
| continuationToken | 문자열 | 선택 사항. 연속 토큰은 특정 상황에서 서비스가 페이지 매김하는 데 필요한 정보가 포함된 불투명 blob입니다. 값이 생략되어 있는 경우 첫 번째 결과 페이지가 반환되며(여기서 페이지 크기는 maxItems 매개 변수를 통해 결정됨) 이와 함께 두 번째 결과 페이지를 얻는 데 사용할 수 있는 연속 토큰도 반환됩니다. 두 번째 페이지에는 세 번째 이후 결과 페이지에 대한 연속 토큰이 포함되어 있습니다. |
| 원하는 | 문자열 | 선택 사항. 결합된 필드 이름 API를 참조하십시오. |
| desiredMediaItemTypes | 문자열의 배열 | 선택 사항. 이 매개 변수는 응답에서 반환되는 항목의 유형을 결정합니다. |
| 도메인 | 문자열 | 선택 사항. 도메인 매개 변수는 클라이언트가 호출하는 게임 및 앱 마켓플레이스 컨텍스트를 결정합니다. 기본적으로 도메인은 "최신"인데, 이는 클라이언트가 Xbox One (이상의) 콘텐츠만 요청할 수 있음을 나타냅니다. 도메인을 전환하여 Xbox 360 콘텐츠를 표면화하고 싶은 클라이언트는 도메인을 "Xbox360"으로 지정해야 합니다. 교차 도메인 결과는 현재 지원되지 않습니다. 가능한 값은 다음과 같습니다.
|
| 필드 | 문자열 | 선택 사항. GET (/media/{marketplaceId}/fields)를 참조하세요. |
| firstPartyOnly | 부울 값 | 선택적 필터 매개 변수입니다. 쿼리에서 자사 콘텐츠만 반환할지 아니면 자사 및 타사 콘텐츠를 모두 반환할지 여부를 결정합니다. |
| freeOnly | 부울 값 | 선택적 필터 매개 변수입니다. 결과를 무료 콘텐츠로 제한합니다. |
| GroupBy | TK | groupBy 매개 변수를 사용하면 단일 결과 집합보다는 결과 집합을 그룹으로 분류하는 데 도움이 됩니다. 이 매개 변수를 지정하면 결과 집합이 수정되어 여러 항목 목록을 반환하는데, 여기서 각 버킷에 있는 항목의 수는 maxItems 매개 변수에 따라 결정됩니다.
|
| hasTrailer | 부울 값 | 선택적 필터 매개 변수입니다. 반환된 항목에 예고편이 반드시 있어야 하는지 또는 예고편이 선택적인지 여부를 결정합니다. 값이 true인 경우 모든 항목에 예고편이 있어야 합니다. |
| id | 문자열 | 선택 사항. 제공된 경우 해당 ID가 있는 항목의 하위로 결과를 제한합니다. 이 매개 변수가 제공되는 경우 MediaItemType도 지정해야 합니다. |
| ID | 문자열의 배열 | 필수. 세부 정보가 반환될 모든 ID(최대 10개)입니다. URL에 사용해서는 안 되는 문자가 포함된 모든 ID(ProviderContentId 유형 ID는 일반적으로 전체 URL 자체이므로 잘못된 문자가 포함되어 있음)는 EDS에 올바르게 전송되려면 URL 인코딩되어야 합니다. |
| idType | 문자열 | 선택 사항. ID 매개 변수로 전달되는 ID의 유형입니다. 유효한 값은 다음과 같습니다.
|
| latestOnly | 부울 값 | 선택적 필터 매개 변수입니다. 결과를 최신 릴리스 날짜가 있는 것으로 제한합니다. |
| maxItems | 32비트 부호 있는 정수 | 선택 사항. 호출에서 반환되어야 하는 항목의 최대 수를 결정합니다. 유효한 값은 1과 25(포함) 사이여야 합니다. 생략된 경우 매개 변수는 25로 기본값이 설정됩니다. |
| mediaGroup | 문자열 | 선택 사항. ID의 미디어 그룹입니다. 제공된 모든 ID는 같은 미디어 그룹을 공유해야 합니다. |
| MediaItemType | 문자열 | 선택 사항. ID 매개 변수에 ID가 지정된 항목의 유형입니다. ID 매개 변수가 제공되는 경우 이 파라미터도 지정해야 합니다. |
| orderBy | 문자열 | 필수. orderBy 매개 변수는 반환되고 있는 항목이 정렬되는 방식을 결정합니다. 이 필드에 대한 일반 값이 여기에 나열되어 있지만 일부 API에서는 추가 값을 지원할 수 있습니다.
|
| preferredProvider | 문자열 | 선택 사항. 사용자에게 Comcast Xfinity 또는 Verizon FIOS 같은 기본 콘텐츠 공급자가 있는 경우 이 공급자의 ID를 전달할 수 있습니다. 각 항목의 실제 순서가 변경되지 않는 동안 지정된 공급자의 정보가 각 항목에 대해 공급자 목록 맨 위에 표시됩니다(기본 콘텐츠 공급자에게 사용할 수 있는 항목이 있는 경우). |
| q | 문자열 | 필수. 검색에 사용된 쿼리 용어입니다. |
| queryRefiners | 문자열의 배열 | 선택 사항. EDS 쿼리 구체화 목록을 참조하십시오. |
| 관계 | 문자열 | 선택 사항. 지정된 관계 유형과 일치하는 다른 제품을 검색하기 위한 기본으로 ID 매개 변수를 사용하는 필터:
|
| ScopeId | 문자열 | 이 매개 변수는 역방향 조회 시나리오에서 비디오 미디어에 사용됩니다. |
| ScopeIdType | 문자열 | 이 매개 변수는 역방향 조회 시나리오에서 비디오 미디어에 사용됩니다. 가능한 값: 타이틀. |
| skipItems | 32비트 부호 있는 정수 | 선택 사항. 그룹 간 시나리오가 아닌 경우의 페이징에서는 skipItems 매개 변수를 사용해 몇 개의 항목이 이미 표시되었는지(따라서 결과 집합에서 어떤 항목을 표시해야 하는지 결정) 확인하는 데 사용됩니다. 값은 매우 0 기반이므로 skipItems = 0(또는 skipItems를 제공하지 않음)은 목록의 시작 부분에서 검색을 시작합니다. skipItems=3은 목록의 첫 세 항목을 건너뛰고 4번째 항목에서 검색을 시작합니다. |
| subscriptionLevel | 문자열의 배열 | 선택적 필터 매개 변수입니다. subscriptionLevel 매개 변수는 사용자가 보유한 구독의 유형을 결정합니다(예: 사용자에게 유료 구독 또는 무료 구독이 있는지 여부). 가능한 값은 다음과 같습니다.
|
| TargetDevices | 문자열 | EDS는 대상 장치에 대한 제안을 필터링할 수 있는 유연성을 제공합니다. 해당 항목에 반환된 제안(ProviderContent 또는 가용성)은 대상 장치로 제한될 수 있습니다. |
| topRatedOnly | 부울 값 | 선택적 필터 매개 변수입니다. 결과를 최고 등급 콘텐츠로 제한합니다. |