Data Kiosk Schema Explorerユーザーガイド

Data Kiosk Schema Explorerの使用方法。

Data Kioskは、GraphQLクエリーオペレーションをサポートして動的レポート機能を実現する新しいREST APIです。このチュートリアルでは、Data Kiosk Schema Explorerを使ってData Kioskのデータセットを探索し、GraphQLクエリーを作成する方法を説明します。このガイドは、Selling Partner APIの作成、承認、使用に精通していることを前提としています。

Schema Explorerの使用

The Data Kiosk Schema Explorer, which the schema dropdown and the right pane.

When you open the Schema Explorer you have:

  1. A dropdown selector to select the schema you want to explore and build queries from. The explorer pane on the far right automatically populates with information about the selected schema.
  2. An icon that, when selected, downloads the GraphQL schema.
  3. Hyperlinks to the SP-API Documentation and Developer Support.
  4. 選択したスキーマ内の特定のフィールドを検索できる検索バー。
  5. これまで参照したフィールドのブレッドクラム。ハイライトされているブレッドクラムのいずれかをクリックすると、そのフィールドの情報が表示されます。
  6. 選択したスキーマのクエリー、フィールド、データタイプ、ディレクティブに関する情報を表示するペイン。いずれかのフィールド、データタイプ、または入力パラメーターをクリックすると、それに関連する情報が表示されます。

Query Builderの使用

The Data Kiosk Schema Explorer, which highlights the query builder.

クエリは、次のような場合にクエリービルダーを使用して作成できます。

  1. 選択したスキーマ内のクエリーを選択するためのドロップダウンセレクター。
  2. 入力パラメーターの値(たとえば、 aggregateBy: PARENTstartDate: "2023-11-15"marketplaceIdsなど)を指定したり、クエリー処理の一部として返したいフィールドを選択できるペイン。⌥Option / ALTを押しながら折りたたまれたフィールドをクリックすると、その直下の子が選択されます。右側のクエリーエディターには、Query Builderでの変更に合わせて自動的にデータが入力されます(その逆も同様)。
  3. クエリーを簡略化または縮小するためのボタン。それぞれ、ユーザーが読みやすいようにクエリーをフォーマットし、不要な情報を削除します。
  4. 入力されたクエリーの共有可能なリンクをそれぞれコピー、クリア、または生成するためのボタン。

クエリーエディターの使用

クエリーエディターを使用してクエリーを手動で入力して作成することもできます。

A cursor hovering over a field in the Schema Explorer.

カーソルをフィールドに合わせると、そのフィールドに関する概要情報が表示されます。

The explorer pane.

⌘Command / CTRLを押しながら、エディター内のフィールドをクリックすると、エクスプローラーペインが開き、そのフィールドに関する情報が表示されます。

The auto-suggestion dropdown.

⌃Control / CTRLSPACEを押すと、自動補完ドロップダウンが開き、必要なフィールドをすばやく選択できます。

クエリーが完成したら、Data Kiosk APIのcreateQueryオペレーションで使用できます。Data Kiosk APIの使用方法の詳細については、 「Data Kioskユースケースガイド」を参照してください。


このページは役に立ちましたか?