Configurar as especificações de exploração para Fontes de autoatendimento (SDK em lote)

Última atualização: 16 de julho de 2024
  • Tópicos:

Criado para:

  • Desenvolvedor

Explorar especificações define os parâmetros necessários para explorar e inspecionar objetos contidos na sua origem. Explorar especificações também define o formato de resposta retornado quando os objetos são explorados e inspecionados.

TIP
As especificações do Explore são codificadas e você pode simplesmente copiar e colar o conteúdo abaixo na especificação da sua conexão.
"exploreSpec": {
  "name": "Resource",
  "type": "Resource",
  "requestSpec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object"
  },
  "responseSpec": {
    "$schema": "http: //json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
      "format": {
        "type": "string"
      },
      "schema": {
        "type": "object",
        "properties": {
          "columns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "data": {
        "type": "array",
        "items": {
          "type": "object"
        }
      }
    }
  }
}
Explorar especificaçõesDescriçãoExemplo
nameDefine o nome ou identificador da especificação de exploração.Resource
typeDefine o tipo da especificação de exploração.Resource
requestSpecContém os parâmetros necessários para explorar objetos na conexão.
requestSpec.typeDefine o tipo de dados da especificação da solicitação.object
responseSpecContém os parâmetros que definem o formato da mensagem de resposta retornada em relação a uma chamada de exploração.
responseSpec.typeDefine o tipo de dados da especificação da resposta.object
responseSpec.propertiesContém informações relacionadas a como a mensagem de resposta está formatada.
responseSpec.properties.formatDefine a formatação do schema de resposta.object
responseSpec.properties.format.typeDefine o tipo de dados das propriedades.string
responseSpec.schemaContém informações relacionadas a como o esquema de resposta é formatado.
responseSpec.schema.typeDefine o tipo de dados do esquema.object
responseSpec.schema.propertiesContém informações sobre as colunas, o tipo e os itens mantidos em um esquema.
responseSpec.schema.properties.columns.items.properties.nameExibe o nome do arquivo.
responseSpec.schema.properties.columns.items.properties.name.typeDefine o tipo de dados do nome do arquivo.string

Próximas etapas

Com suas especificações de exploração preenchidas, você pode prosseguir para criar uma especificação de conexão completa usando a API Flow Service. Consulte o Guia da API de Fontes de Autoatendimento (SDK em Lote) para obter mais informações.

Página anteriorConfigurar especificação de origem
Próxima páginaVisão geral da API de Fontes de autoatendimento (SDK em lote)

Experience Platform