Atividade Shopify Query no Jitterbit Studio

Introdução

Uma atividade Query do Shopify, usando sua conexão Shopify, consulta dados de objetos especificados no Shopify e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Limites de taxa

A API REST Admin do Shopify impõe um limite de taxa de 40 solicitações por aplicativo por loja por minuto. Essa cota é reabastecida a uma taxa de 2 solicitações por segundo. O limite de taxa é aumentado para lojas Shopify Plus. Para mais informações sobre o limite de taxa, consulte Limites de taxa da API REST Admin do Shopify.

Criar uma atividade Shopify Query

Uma instância de uma atividade Query do Shopify é criada a partir de uma conexão Shopify usando seu tipo de atividade Query.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, consulte Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade Query do Shopify existente pode ser editada a partir destes locais:

• A tela de design (consulte Menu de ações de componentes em Tela de design).
• A aba Componentes do painel de projeto (consulte Menu de ações de componentes em Aba Componentes do painel de projeto).

Configurar uma atividade Shopify Query

Siga estas etapas para configurar uma atividade Query do Shopify:

• Etapa 1: Insira um nome e selecione um objeto
  Forneça um nome para a atividade e selecione o objeto contendo os dados a serem consultados.

• Etapa 2: Selecione um sub-objeto
  Selecione um sub-objeto.

• Etapa 3: Revise os esquemas de dados
  Todos os esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.

Etapa 1: Insira um nome e selecione um objeto

Nesta etapa, forneça um nome para a atividade e selecione o objeto contendo os dados a serem consultados. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Menu de endpoint: Se você tiver vários endpoints do mesmo tipo de conector configurados, um menu na parte superior da tela exibe o nome do endpoint atual. Clique no menu para alternar para um endpoint diferente. Para mais informações, consulte Alterar o endpoint atribuído em Telas de configuração.

  • Editar endpoint: Aparece quando você passa o mouse sobre o nome do endpoint atual. Clique para editar a configuração de conexão do endpoint selecionado no momento.

• Nome: Insira um nome para identificar a atividade. O nome deve ser único para cada atividade Query do Shopify e não deve conter barras / ou dois-pontos :.

• Selecione um objeto: Esta seção exibe objetos disponíveis no endpoint do Shopify.

  • Objeto selecionado: Após um objeto ser selecionado, ele é listado aqui.

  • Pesquisa: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se objetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada digitação. Para recarregar objetos do endpoint ao pesquisar, insira critérios de pesquisa e depois atualize, conforme descrito abaixo.

• Atualizar: Clique no ícone de atualização ou na palavra Atualizar para recarregar objetos do endpoint do Shopify. Isso pode ser útil se objetos foram adicionados ao Shopify. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

• Selecionando um objeto: Na tabela, clique em qualquer lugar de uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas do endpoint do Shopify:

  • Nome: O nome do objeto do Shopify.

  • Descrição: A descrição do objeto do Shopify.

• Salvar e sair: Se habilitado, clique para salvar a configuração desta etapa e fechar a configuração da atividade.

• Próximo: Clique para armazenar temporariamente a configuração desta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

• Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Selecionar um subobjeto

Nesta etapa, selecione um subobjeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Selecionar um objeto: Esta seção exibe subobjetos disponíveis no endpoint do Shopify.

  • Objeto selecionado: O objeto selecionado na etapa anterior é listado aqui.

  • Subobjeto selecionado: Após um subobjeto ser selecionado, ele é listado aqui.

  • Pesquisar: Digite o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de subobjetos. A pesquisa não diferencia maiúsculas de minúsculas. Se subobjetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada digitação. Para recarregar subobjetos do endpoint ao pesquisar, digite os critérios de pesquisa e depois atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualização ou na palavra Atualizar para recarregar subobjetos do endpoint do Shopify. Isso pode ser útil se subobjetos foram adicionados ao Shopify. Esta ação atualiza todos os metadados usados para construir a tabela de subobjetos exibida na configuração.

  • Selecionando um subobjeto: Na tabela, clique em qualquer lugar de uma linha para selecionar um subobjeto. Apenas um subobjeto pode ser selecionado. As informações disponíveis para cada subobjeto são obtidas do endpoint do Shopify:

    • Nome: O nome do subobjeto do Shopify.

    • Descrição: A descrição do subobjeto do Shopify.

• Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.

• Próximo: Clique para armazenar temporariamente a configuração desta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

• Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Revisar os esquemas de dados

Todos os esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Esquemas de dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de dados.

• Se limit estiver definido (com máximo de 250), a atividade retornará uma página de resultados correspondentes à consulta como resposta. - O número de resultados retornados para a página corresponde ao limit. - Se o número total de resultados exceder o limit, você pode navegar manualmente e processar páginas adjacentes usando os valores Token_next_page ou Token_previous_page no campo page_info das solicitações subsequentes. - Se limit não estiver definido, a atividade anexará automaticamente todas as páginas de resultados correspondentes à consulta e as retornará como resposta.

  Para mais informações sobre os campos `limit` e `page_info` do esquema de solicitação, consulte a [documentação de paginação do Shopify](https://shopify.dev/docs/api/usage/pagination-rest).
  

  O conector Shopify usa a versão da API REST Admin do Shopify selecionada em uma conexão Shopify. Dependendo dos endpoints de API suportados pelo Shopify na versão de API sendo usada, os objetos e subobjetos disponíveis para seleção podem variar. Consulte a documentação da API para informações sobre os nós de esquema e campos.

  Importante

  O Shopify lança uma nova versão de API a cada três meses e mantém cada versão de lançamento por no mínimo doze meses. Quando uma versão de API é descontinuada, o Shopify não mantém mais essa versão e todas as chamadas de API solicitando essa versão serão automaticamente roteadas para a versão estável mais antiga atualmente suportada.

  O Shopify pode descontinuar certos endpoints com a introdução de uma nova versão de API. Como resultado, você pode precisar alterar seus aplicativos e configurações de atividade devido a recursos alterados ou descontinuados.

  As versões e endpoints de API descontinuados são anunciados no changelog do Shopify, onde detalhes adicionais e informações de migração relevantes estão disponíveis.

• Atualizar: Clique no ícone de atualização ou na palavra Atualizar para regenerar esquemas do endpoint do Shopify. Esta ação também regenera um esquema em outros locais do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

• Editar: Clique no ícone de edição acima do esquema de dados de resposta para entrar no editor. O editor permite adicionar, excluir e reorganizar nós e campos e alterar seus tipos de dados. Todos os nós e campos recém-adicionados são definidos como [0, 1] cardinalidade. As alterações feitas nos esquemas de dados devem ser aceitáveis para o endpoint e devem ser feitas apenas após consultar qualquer documentação disponível para o endpoint. Após fazer edições de esquema, uma data de última edição é exibida na parte superior do esquema aplicável para indicar que o esquema teve edições manuais. Atualizar os esquemas os redefinirá para suas estruturas padrão.

• Voltar: Clique para armazenar temporariamente a configuração desta etapa e retornar à etapa anterior.

• Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.

• Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Consulta do Shopify, conclua a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as definições da operação, que incluem a capacidade de encadear operações que estão no mesmo fluxo de trabalho ou em fluxos de trabalho diferentes.

As ações de menu para uma atividade são acessíveis no painel do projeto e na tela de design. Para detalhes, consulte Menu de ações da atividade em Noções básicas do conector.

As atividades Query do Shopify podem ser usadas como fonte com o padrão de duas transformações (apenas como segunda fonte).

Para usar a atividade com funções de script, escreva os dados em um local temporário e depois use esse local temporário na função de script.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.