다음을 통해 공유


보조 EDS API

콘텐츠에 대한 정보를 직접 제공하지 않지만 서비스 이용 방법에 대한 일반적인 정보를 제공하거나 일반 UI 모델 구동에 도움을 주는 몇몇 EDS(엔터테인먼트 검색 서비스) API가 있습니다.

보조 API

API URI 설명
API 매개 변수 값 /{locale}/metadata 서비스에 대한 호출에 사용할 수 있는 매개 변수의 가능한 값 열거
결합된 콘텐츠 등급 생성기 /{locale}/contentRating 잠재적으로 불쾌하거나 성인 등급 가능성이 있는 콘텐츠를 걸러내기 위해 다른 API에서 사용할 수 있는 값을 만듭니다. 자세한 내용은 아래를 참조하세요.
결합된 필드 이름 생성기 /{locale}/fields 어떤 필드가 반환되는지 제어하기 위해 세부 정보 API에서 사용할 수 있는 값을 만듭니다. 자세한 내용은 아래를 참조하세요.

API 매개 변수 값

이 API는 서비스와 함께 사용할 수 있는 매개 변수를 설명합니다. 지역화된 텍스트가 각 매개 변수와 함께 제공되므로 반환된 정보를 클라이언트 UI에서 사용할 수 있습니다.

아래 API는 쿼리 매개 변수를 허용하지 않습니다.

API URI 설명
유형 /{locale}/metadata/mediaGroups 미디어 그룹의 전체 목록
미디어 그룹별 미디어 항목 유형 /{locale}/metadata/mediaGroups/{mediaItemTypeGroup}/mediaItemTypes 특정 미디어 그룹 안에 포함된 미디어 항목 유형의 목록입니다.
모든 미디어 항목 유형 /{locale}/metadata/mediaItemTypes 미디어 항목 유형의 전체 목록
미디어 유형별 필드 /{locale}/metadata/mediaItemTypes/{mediaItemType}/fields 단일 미디어 항목 유형의 필드 목록
쿼리 구체화 /{locale}/metadata/mediaItemTypes/{mediaItemType}/queryRefiners 특정 미디어 항목 유형에 대해 지원되는 쿼리 구체화 목록
모든 쿼리 구체화 값 /{locale}/metadata/mediaItemTypes/{mediaItemType}/queryRefiners/{queryRefiner} 특정 미디어 항목 유형에 대해 지정된 쿼리 구체화의 값
모든 쿼리 구체화 하위 값 /{locale}/metadata/mediaItemTypes/{mediaItemType}/queryRefiners/{queryRefiner}/subQueryRefinerValues 특정 쿼리 구체화 값(예: '특정 장르의 하위 장르')에 대한 하위 값 목록입니다. 쿼리 구체화 값은 'queryRefinerValue'라는 쿼리 문자열 매개 변수로 전달되며 URI 스템에서 금지된 문자가 포함된 쿼리 구체화 값을 전달할 수 있도록 허용합니다.
정렬 /{locale}/metadata/mediaItemTypes/{mediaItemType}/sortOrders 특정 미디어 항목 유형에 대해 지원되는 정렬 순서 목록

결합된 콘텐츠 등급 생성기

자녀가 볼 수 있는 콘텐츠에 대한 자녀 보호 기능을 적용하는 것은 복잡한 작업입니다. 각 미디어 항목 유형에는 자체 등급 시스템이 있으며, 해당 등급 시스템은 국가/지역마다 다를 수 있습니다. 즉, 모든 항목을 적절하게 필터링하기 위해 지정해야 하는 몇 가지 데이터가 있습니다.

모든 API 호출에서 모든 매개 변수를 지정하는 대신, 이 API는 다른 API의 combinedContentRating 매개 변수로 전달할 값을 생성하고 동일한 정보를 계속 전달합니다. 이 API에 전달된 여러 매개 변수가 다른 API에 대해 다시 사용할 수 있는 단일 값으로 축소되면서, 더욱 쉽게 API를 사용하고 유지 관리할 수 있도록 설계되었습니다.

이 API가 반환한 정확한 값은 변경될 수 있지만, 이러한 변경은 매우 드물게 발생하므로(예: EDS의 릴리스 사이) 장기간 동안 캐시될 수 있습니다. 전달된 값이 유효하지 않은 경우 combinedContentRating 매개 변수를 허용하는 API는 유의미한 오류 메시지를 제공하며, 이 메시지는 호출자가 업데이트된 값을 얻으려면 다시 이 API를 호출해야 한다는 의미를 나타냅니다. API가 combinedContentRating 매개 변수를 허용하지만 아무 것도 제공하지 않는 경우 자녀 보호 기능에 따라 콘텐츠 필터링이 수행되지 않습니다.

참고:
이는 "안전한" 콘텐츠만 반환된다는 의미는 아니며, 성인 등급 콘텐츠를 포함할 수 있는 모든 콘텐츠가 반환되었음을 의미합니다.

결합된 필드 이름

기본적으로 EDS API는 다음 각 항목에 대해 필드의 최소 집합을 반환합니다.

  • 미디어 항목 유형
  • 미디어 그룹
  • ID
  • 이름

추가 정보를 가져오기 위해 API는 추가 데이터를 반환해야 하는지 지정하는 'field' 매개 변수를 허용합니다. 가능한 필드가 많이 있으므로 각 API 호출에 대해 전체 이름을 지정하면 요청이 크게 증가합니다. 대신, 훨씬 작은 값을 생성하는 이 API로 이름을 전달하여 다른 API로 전달할 수 있습니다.

이 매개 변수를 허용하는 API의 경우 제공된 값은 지정된 모든 미디어 항목 유형에 있는 모든 필드의 상위 집합이어야 합니다. 다양한 미디어 항목 유형에 대해 다른 필드 집합을 지정할 수는 없습니다. 하지만 한 필드가 하나의 미디어 항목 유형에는 적용되지만 다른 필드 항목에는 적용되지 않는 경우 데이터가 있는 미디어 항목 유형에만 표시됩니다(예: 'AvatarBodyType'이 결합된 필드 이름 API에 대한 호출에 포함되는 경우 AvatarItems만 필드를 포함함).

이 API에서 반환된 값은 캐시할 수 있으며, EDS의 각 배포 간에만 변경할 수 있습니다. 캐싱이 필요한 경우 캐시는 사용자의 세션보다 오래 지속되지 않는 것이 좋습니다.

이 API는 실제 필드 이름을 승인하는 것 외에도 "all"을 유효한 값으로 허용합니다. 이에 따라 지정할 수 있는 각 필드가 포함된 값이 생성됩니다. 'all' 값은 개발, 디버깅, 테스트 목적으로만 사용될 가능성이 높습니다.

참고 항목

부모

추가 참조

추가 정보

마켓플레이스 URI