Skip to main content

補助的な EDS API

コンテンツに関する情報を直接提供するのではなく、サービスの使用方法に関する一般的な情報を提供したり、一般的な UI モデルの実装を支援したりする Entertainment Discovery Services (EDS) API がいくつかあります。

補助 API

API パラメーター値

この API は、サービスで使用できるパラメーターについて説明します。返される情報にはローカライズされたテキストが各パラメーターに付随しているため、クライアント UI で使用できます。 以下の API はいずれもクエリ パラメーターを受け付けません。 | API| URI| 説明| | --- | --- | --- | --- | --- | --- | | Types| //metadata/mediaGroups| メディア グループの完全な一覧| | メディア グループごとのメディア アイテム タイプ| //metadata/mediaGroups//mediaItemTypes| 指定されたメディア グループに含まれるメディア アイテム タイプの一覧。| | すべてのメディア アイテム タイプ| //metadata/mediaItemTypes| メディア アイテム タイプの完全な一覧| | メディア アイテム タイプごとのフィールド| //metadata/mediaItemTypes//fields| 単一のメディア アイテム タイプ内のフィールドの一覧| | クエリ絞り込み| //metadata/mediaItemTypes//queryRefiners| 指定されたメディア アイテム タイプでサポートされているクエリ絞り込みの一覧| | すべてのクエリ絞り込み値| //metadata/mediaItemTypes//queryRefiners/| 指定されたメディア アイテム タイプに対する、指定されたクエリ絞り込みの値| | すべてのクエリ絞り込みサブ値| //metadata/mediaItemTypes//queryRefiners//subQueryRefinerValues| 指定されたクエリ絞り込み値に対するサブ値の一覧 (たとえば、「指定されたジャンル内のサブジャンル」)。クエリ絞り込み値は、“queryRefinerValue” という名前のクエリ文字列パラメーターとして渡されます。これは、URI ステムで禁止されている文字を含むクエリ絞り込み値を渡せるようにするためです。| | ソート| //metadata/mediaItemTypes//sortOrders| 指定されたメディア アイテム タイプに対する並べ替え順序の一覧|

結合コンテンツ レーティング ジェネレーター

子供が見ることを許可されているコンテンツに対する保護者による制限の適用は、複雑な作業です。各メディア アイテム タイプに独自のレーティング システムがあるだけでなく、それらのレーティング システムは国や地域ごとに異なる可能性があります。つまり、すべてのアイテムを適切にフィルターするためには、いくつかの異なるデータを指定する必要があります。 すべての API 呼び出しですべてのパラメーターを指定する代わりに、この API では、他の API の combinedContentRating パラメーターに渡す値を生成しつつ、同じ情報を伝えることができます。これは、この API に渡される複数のパラメーターを、他の API 用の単一の再利用可能な値にまとめることで、API を使いやすく、また保守しやすくすることを目的としています。 この API が返す正確な値は最終的に変更される可能性がありますが、変更は非常にまれ (EDS のリリース間など) であるため、長期間キャッシュできます。combinedContentRating パラメーターを受け付ける API は、渡された値が無効な場合、意味のあるエラー メッセージを返します。これは、呼び出し元が更新された値を取得するためにこの API を再度呼び出す必要があることを示します。API が combinedContentRating パラメーターを受け付けるが、指定されていない場合、保護者による制限に基づくコンテンツのフィルタリングは行われません。
注:
これは、「安全な」コンテンツのみが返されるという意味ではありません。むしろ、露骨なコンテンツを含むすべてのコンテンツが返されることを意味します。

結合フィールド名

EDS API は、既定では、各アイテムに対して次のような非常に小さな最小のフィールド セットを返します。
  • メディア アイテム タイプ
  • メディア グループ
  • Id
  • Name
より多くの情報を取得するために、API では “fields” パラメーターを受け付けており、これによって追加で返すべきデータを指定します。指定可能なフィールドが多いため、各 API 呼び出しでフィールド名をすべて完全に指定するとリクエストが大幅に肥大化します。代わりに、名前をこの API に渡すことで、他の API に渡せるより小さな値を生成できます。 このパラメーターを受け付ける API では、指定された値は、指定されたすべてのメディア アイテム タイプ内のすべてのフィールドのスーパーセットである必要があります。異なるメディア アイテム タイプに対して異なるフィールド セットを指定することはできません。ただし、あるメディア アイテム タイプにフィールドが適用され、別のメディア アイテム タイプに適用されない場合、そのフィールドはデータが存在するメディア アイテム タイプにのみ表示されます (たとえば、Combined Field Name API の呼び出しに “AvatarBodyType” を含めた場合、そのフィールドは AvatarItems にのみ含まれます)。 この API から返される値は非常にキャッシュ可能です。実際、EDS のデプロイ間以外は変更されません。キャッシュする場合、キャッシュはユーザーのセッションよりも長く維持しないことをお勧めします。 実際のフィールド名を受け付けることに加えて、この API は “all” を有効な値として受け付けます。これにより、指定可能なすべてのフィールドを含む値が生成されます。“all” 値は、開発、デバッグ、およびテストの目的でのみ使用される可能性が高いです。

関連項目

親
追加リファレンス
詳細情報
マーケットプレース URI
Last modified on October 19, 2026