Guia do usuário do Schema Explorer do Data Kiosk

Como usar o Data Kiosk Schema Explorer.

O Data Kiosk é uma nova API REST que dá suporte às operações de consulta GraphQL para recursos de relatórios dinâmicos. Este tutorial detalha como usar o Data Kiosk Schema Explorer para explorar conjuntos de dados do Data Kiosk e criar consultas GraphQL. Este guia pressupõe que você esteja familiarizado com a criação, autorização e uso de APIs de parceiros de vendas.

Uso do 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. Uma barra de pesquisa em que você pode buscar campos específicos dentro do esquema selecionado.
  5. Trilhas de navegação dos campos que você explorou anteriormente. Clique em qualquer uma das trilhas de navegação destacadas para ser redirecionado para as informações desse campo.
  6. Um painel que contém informações sobre consultas, campos, tipos de dados e diretrizes sobre o esquema selecionado. Clique em qualquer campo, tipo de dados ou parâmetro de entrada para ver informações relevantes sobre o item.

Usar o Criador de Consultas

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

Você pode criar consultas usando o Query Builder, onde você tem:

  1. Um seletor suspenso para selecionar uma consulta dentro do esquema selecionado.
  2. Um painel no qual você pode fornecer valores para os parâmetros de entrada (por exemplo, aggregateBy: PARENT, startDate: "2023-11-15" marketplaceIds) e selecionar os campos que você deseja que sejam retornados como parte do processamento da consulta. Pressionar ⌥Option / ALT enquanto clica em um campo fechado selecionará seus filhos imediatos. O editor de consultas à direita será preenchido automaticamente para corresponder às alterações feitas pelo criador de consultas e vice-versa.
  3. Botões para formatar sua consulta para torná-la mais legível para humanos ("embelezar") ou para remover informações desnecessárias ("minimizar").
  4. Botões para copiar, limpar ou gerar um link compartilhável para a consulta preenchida, respectivamente.

Uso do editor de consultas

É possível criar consultas digitando-as manualmente utilizando o editor de consultas.

A cursor hovering over a field in the Schema Explorer.

Ao passar o cursor sobre um campo, informações de alto nível sobre o campo serão reveladas.

The explorer pane.

Pressionar ⌘Command / CTRL enquanto clica em um campo no editor fará o painel do explorador abrir e o preencherá com informações sobre o campo.

The auto-suggestion dropdown.

Pressionar ⌃Control / CTRL + SPACE fará abrir uma lista suspensa de sugestões automáticas que você pode usar para selecionar rapidamente os campos desejados.

Ao estar satisfeito com sua consulta, é possível usá-la com a operação createQuery da API do Data Kiosk. Encontre detalhes de como usar a API do Data Kiosk no Guia de casos de uso do Data Kiosk.


Esta página ajudou você?