主页文档代码示例API 参考公告模型发行说明常见问题GitHub视频
开发者中心API 状态支持
文档
开发者中心API 状态支持

Data Kiosk 架构资源管理器用户指南

如何使用 Data Kiosk 架构资源管理器。

Data Kiosk 是一个新的 REST API,支持用于动态报告功能的 GraphQL 查询操作。本教程详细介绍了如何使用 Data Kiosk 架构资源管理器浏览 Data Kiosk 数据集并构建 GraphQL 查询。本指南假定您熟悉创建、授权和使用销售伙伴 API 的方法。

使用架构资源管理器

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. 一个窗格,其中包含有关所选架构的查询、字段、数据类型和指令的信息。您可以单击任何字段、数据类型或输入参数来查看与您点击的内容相关的信息。

使用查询生成器

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

您可以使用查询生成器生成查询,您有:

  1. 用于在所选架构中选择查询的下拉选择器。
  2. 一个窗格,您可以在该窗格中为输入参数提供值(例如,aggregateBy: PARENTstartDate: "2023-11-15" marketplaceIds),并选择希望作为查询处理的一部分返回的字段。单击折叠字段时按住 ⌥Option / ALT 将选择其直接子字段。右侧的查询编辑器将自动进行填充,以匹配查询生成器所做的任何更改,反之亦然。
  3. 用于美化或最小化查询的按钮,分别用于格式化查询,使其更易于人们阅读,或删除不必要的信息。
  4. 分别用于复制、清除或生成已填充查询的可共享链接的按钮。

使用查询编辑器

您也可以通过使用查询编辑器手动键入查询来构建查询。

A cursor hovering over a field in the Schema Explorer.

将光标悬停在字段上,会显示该字段的高级信息。

The explorer pane.

按住 ⌘Command / CTRL 的同时点击编辑器中的字段,将打开资源管理器窗格并填充该字段的相关信息。

The auto-suggestion dropdown.

按下 ⌃Control / CTRL + SPACE 将打开一个自动建议下拉列表,您可以用它快速选择所需的字段。

若您对查询感到满意,您就可以将其与 Data Kiosk API 的createQuery 操作一起使用。有关如何使用 Data Kiosk API 的详细信息,请参阅 Data Kiosk 用例指南


此页面对您有帮助吗?