Gestionar los tipos de campo

El Knowledge Graph admite varios tipos de campos, cada uno diseñado para diferentes tipos de datos.

Tipos de campo estándar

Cada campo está definido por un tipo. Estos son los tipos de campos estándar disponibles en la plataforma Yext.

Tipo de campo de archivo

El tipo de campo Archivo le permite almacenar los archivos directamente en sus entidades. Este tipo está disponible para su uso en campos personalizados y tipos de campos personalizados.

Propiedades

El tipo de campo Archivo se compone de las cinco propiedades siguientes:

Los tipos de campo de archivo pueden configurarse para admitir un archivo o admitir una lista de archivos. Esto creará automáticamente una validación de carga de archivo máxima de 1 o 5 000 respectivamente.

Proceso de

La validación predeterminada para los campos de archivo está a continuación. También puede configurar la validación para los campos personalizados del archivo y los tipos de campos personalizados del archivo.

Nota: Hay un problema conocido con JsonFormat.Printer  que afecta a Configuration as Code, por el cual la propiedad maxSize se devolverá como una cadena al recuperarla. Sin embargo, cuando se aplica, esta propiedad debe ser un número.

Cargando Archivos

Los archivos se pueden cargar utilizando todas las interfaces para editar entidades en el Knowledge Graph (es decir, Edición de entidades, Carga de entidades, Conectores, API y CaC).

Todas las interfaces admiten la carga de archivos haciendo referencia a una URL de origen. La carga desde un sistema de archivos local solo se admite en Entity Edit.

Para subir un archivo alojado en Internet, indique la URL alojada con la propiedad url. Esta URL proporcionada se propagará entonces a la propiedad sourceUrl, mientras que el campo URL cambiará para ser la URL alojada en Yext de este archivo.

Actualización de archivos

Para cambiar un archivo almacenado en un campo de una entidad, actualice el valor de la propiedad url para que sea la URL del nuevo archivo alojado. No se admite el envío de actualizaciones a la propiedad sourceUrl.

La cadena de agente de usuario utilizada para descargar archivos es YextBot YextFileDownloader/1.0.

Acceso a archivos almacenados

Se puede acceder a los archivos almacenados en las entidades a través de Edición de Entidad y a través de la API.

Edición de Entidad

Los archivos pueden descargarse desde la propiedad URL. El estado de edición de este campo mostrará todas las propiedades del campo Archivo. Las propiedades de un archivo no pueden editarse en Edición de Entidad, excepto por el nombre del archivo.

API

Abrir la URL almacenada en la propiedad url descargará el archivo en su dispositivo local. Este es un ejemplo de cómo podría ser en un Entities: GET.

Con los demás campos omitidos, la respuesta es la siguiente:

{
  "response": {
    "entities": [{
      "c_pdfFile": [{
  		"sourceUrl": "https://www.pdfs.com/123",
  		"url":"https://a.mktgcdn.com/f/3912636/123",
  		"mimeType": "application/pdf",
  		"name": "Instruction Manual",
  		"size": 2001
	}]
    }]
  }
}

Tipo de campo de fotografía

El tipo de campo Foto te permite almacenar fotos directamente en tus entidades. Este tipo está disponible para su uso en campos personalizados y tipos de campos personalizados.

Propiedades

El tipo de campo Photo está compuesto por las siguientes cinco propiedades:

Proceso de

Puede configurar la validación para campos personalizados de foto y tipos de campos personalizados de foto.

Limitaciones

Subiendo fotos

Las fotos se pueden subir a través de todas las interfaces de edición de las entidades del Knowledge Graph.

Todas las interfaces admiten la carga de fotos haciendo referencia a una URL de origen. Subir una foto desde un sistema de archivos local solo es posible en Edición de Entidad.

Para subir una foto alojada en línea, introduzca la URL de la foto en la propiedad url. Esta URL se propagará entonces a la propiedad sourceUrl, mientras que el campo URL será la URL alojada en Yext de la foto.
 

Actualización de fotos

Para cambiar la foto que está almacenada en un campo de foto dado, actualice el valor de la propiedad url para que sea la nueva URL de la foto alojada. No se admite el envío de actualizaciones directamente a la propiedad sourceUrl.

Acceso a Fotos

Una vez que se ha subido una imagen a una entidad, su URL alojada se guarda como referencia en el campo de la entidad. Puede acceder a la entidad a través de la API para recuperar directamente la URL de la foto, por ejemplo:

Con los demás campos omitidos, la respuesta es la siguiente:

{
  "response": {
    "entities": [{
      "photoGallery": [{
        "image": {
          "width": 314,
          "height": 366, 
          "url": "http://a.mktgcdn.com/p/Oua5ocwC7euaUFkJ-V8n3OpF76Xtfh_rdsDT9ki_laY/314x366.jpg"
      }]
    }]
  }
}

A cada imagen se le asigna un UUID largo (la cadena aleatoria larga de arriba), por lo que la URL tiene la forma: a.mktgcdn.com/p/UUID/WIDTHxHEIGHT.EXT.

Tanto HTTP como HTTPS son compatibles.