メインコンテンツへスキップ

XStoreQueryAssociatedProductsAsync

現在のゲーム内からユーザーが購入できる製品のストア登録情報を取得します。

構文

パラメーター

storeContextHandle   _In_
Type: XStoreContextHandle
XStoreCreateContext から返される、ユーザーのストア コンテキスト ハンドル。 productKinds   _In_
Type: XStoreProductKind
返す製品の種類。 maxItemsToRetrievePerPage   _In_
Type: uint32_t
1 ページあたりに取得する項目の最大数。 1 ページあたりに返される項目の数は、0 から maxItemsToRetrievePerPage まで異なる場合があります。 詳細については、ページングを参照してください。 async   _Inout_
Type: XAsyncBlock*
実行中の非同期処理を定義する XAsyncBlock。 XAsyncBlock を使用して、呼び出しの状態のポーリングと呼び出し結果の取得を行います。 詳細については、XAsyncBlock を参照してください。

戻り値

Type: HRESULT HRESULT の成功またはエラー コード。

解説

この関数のストア登録情報と実行結果を取得するには、この関数を呼び出した後に XStoreQueryAssociatedProductsResult を呼び出します。 XStoreQueryAssociatedProductsResult には、XStoreEnumerateProductsQuery を呼び出して列挙する XStoreProductQueryHandle が含まれます。 このクエリが返す製品の数を事前に知ることはできません。 この API は、ユーザーが Microsoft Store で参照できる、またはゲーム内で購入できる製品のみを返します。 結果には、非表示、期限切れ、またはストアから削除された製品は含まれません。 そのような製品の詳細が必要な場合は、XStoreQueryProductsAsync を使用し、製品のストア ID を渡します。

ページング

この関数は、複数のページにわたって製品を返します (1 ページに最大 maxItemsToRetrievePerPage 個の項目)。 XStoreProductsQueryHasMorePages と XStoreProductsQueryNextPageAsync/XStoreProductsQueryNextPageResult を使用して、ページング化されたすべての結果を処理します。 ページングは、XStoreProductsQueryHasMorePages が false を返すまで完了しません。
ページングは、サンドボックスと RETAIL の間で動作が異なる場合があります。 サンドボックスでは、項目が maxItemsToRetrievePerPage に達するまで蓄積されてからページが返されます。 RETAIL では、ページあたり 0~1 個の項目が返されるのが一般的です。この API を使用するすべてのゲームは、リリース前にページングを実装してテストすることが重要です。サンドボックスでページング動作をテストするには、maxItemsToRetrievePerPage を一時的にサンドボックスに公開された製品数より小さい値に設定します。 ゲームのリリース前に RETAIL でテストするには、パートナー センターの [価格と提供状況] ページで [プライベート対象ユーザーを有効にする] オプションを使用して製品を公開します。 ゲームのリリース後に RETAIL でテストするには、パッケージ フライトを使用します。
次のコードは、複数のページにわたる製品クエリ結果を取得する方法を示しています。 リークを避けるため、クエリ ハンドルがページングの再帰処理を通じて確実に受け渡されるようにします。

要件

ヘッダー: XStore.h (XGameRuntime.h に含まれる) ライブラリ: xgameruntime.lib サポートされているプラットフォーム: Windows、XBOX One ファミリ本体、および XBOX Series 本体

関連概念ドキュメント

関連項目

XStore
XStoreQueryAssociatedProductsResult
XStoreEnumerateProductsQuery
XStoreProductsQueryHasMorePages
XStoreProductsQueryNextPageAsync
ストアの基本操作
プレイヤーにアドオン コンテンツへのアクセス権を付与する
最終更新日 2026年10月19日