DocumentaciónExperience PlatformGuía de conectores de origen

Configuración y exploración de especificaciones para orígenes de autoservicio (SDK por lotes)

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Temas:

Creado para:

  • Desarrollador

Explorar especificaciones define los parámetros necesarios para explorar e inspeccionar los objetos contenidos en su origen. Explorar especificaciones también define el formato de respuesta devuelto cuando se exploran e inspeccionan los objetos.

TIP
Las especificaciones de exploración están codificadas y simplemente puede copiar y pegar la carga útil siguiente en la especificación de conexión.
"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 especificaciones
Descripción
Ejemplo
name
Define el nombre o el identificador de la especificación de exploración.
Resource
type
Define el tipo de especificación de exploración.
Resource
requestSpec
Contiene los parámetros necesarios para explorar objetos en la conexión.
requestSpec.type
Define el tipo de datos de la especificación de solicitud.
object
responseSpec
Contiene los parámetros que definen el formato del mensaje de respuesta devuelto en una llamada de exploración.
responseSpec.type
Define el tipo de datos de la especificación de respuesta.
object
responseSpec.properties
Contiene información sobre el formato del mensaje de respuesta.
responseSpec.properties.format
Define el formato del esquema de respuesta.
object
responseSpec.properties.format.type
Define el tipo de datos de las propiedades.
string
responseSpec.schema
Contiene información sobre el formato del esquema de respuesta.
responseSpec.schema.type
Define el tipo de datos del esquema.
object
responseSpec.schema.properties
Contiene información sobre las columnas, el tipo y los elementos contenidos en un esquema.
responseSpec.schema.properties.columns.items.properties.name
Muestra el nombre del archivo.
responseSpec.schema.properties.columns.items.properties.name.type
Define el tipo de datos del nombre del archivo.
string

Pasos siguientes

Una vez completadas las especificaciones de exploración, puede continuar creando una especificación de conexión completa mediante la API Flow Service. Consulte la guía de API de fuentes de autoservicio (SDK por lotes) para obtener más información.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089