Datos y variantes
Docs/Datos y variantes

Definir parámetros de renderizado

Agregue campos, elija tipos, establezca valores predeterminados y use Payload para preparar datos de plantilla.

3 minutos de lectura4 secciones
En esta página

Para reutilizar una plantilla con datos diferentes, primero declara los campos que acepta. Parameters le permite nombrar cada campo, elegir su tipo y proporcionar un valor predeterminado.

Comience con un campo simple, conéctelo a HTML, luego abra Payload para inspeccionar la estructura de datos resultante.

1. Agregue un campo en Schema

Abra Parameters, seleccione Schema y elija Agregar. Cambie el nombre del nuevo campo por el nombre que desee utilizar, como recipient.

Tipo Datos adecuados
Texto Nombres, direcciones, referencias o cadenas formateadas.
Número Cantidades o valores numéricos.
Booleano true / false.
Objeto Un grupo de campos con nombre.
Matriz Una lista de elementos con la misma estructura.

Color y Recurso son tipos de Props únicamente en el editor actual, por lo que no aparecen en la lista de tipos Parameters.

Parameters+ Agregar
SchemaPayload
destinatarioTexto
PREDETERMINADOTembuilder{{ params.recipient }}
Parameters → Agregar → Schema

2. Establecer predeterminado y obligatorio

Ingrese Predeterminado en la tarjeta de campo para proporcionar un valor cuando la persona que llama omite el campo. El control requerido en el encabezado de la tarjeta alterna el estado Obligatorio del campo.

Utilice valores del tipo declarado: un Número usa 2 y un Booleano usa true o false. La cadena "2" no es un número. Una cadena vacía sigue siendo un valor proporcionado, no un campo omitido.

Agregue una descripción para explicar el propósito, las unidades o el formato esperado del valor a alguien que use la plantilla.

Schema
destinatario *Texto
PREDETERMINADOTembuilder{{ params.recipient }}
PredeterminadoSe utiliza cuando se omite el campo
RequeridoMarca un campo obligatorio
Nombre, tipo, Predeterminado y Obligatorio aparecen en la misma tarjeta de campo

3. Conecte el campo al contenido

Cada tarjeta incluye una expresión EMBED. Para recipient, inserte esto en el HTML de una sección:

<p>{{ params.recipient }}</p>

recipient debe coincidir con el nombre Schema. Si cambia el nombre del campo más adelante, actualice tanto la expresión HTML como los datos proporcionados a la plantilla.

destinatarioTexto
PREDETERMINADOTembuilder{{ params.recipient }}
{{ params.recipient }}
Copie la expresión EMBED en la sección HTML

4. Obtener la estructura de Payload

Cambie a Payload para inspeccionar el objeto creado a partir de los campos declarados y los valores predeterminados:

{
  "recipient": "Tembuilder",
  "copies": 2,
  "showNotes": true
}

Este es el objeto de datos de la plantilla. Utilice la misma estructura al ingresar datos en Run. Para la integración API, el objeto pertenece al campo parameters de la solicitud; consulte la Referencia de renderizado API para conocer los campos de solicitud y los puntos finales.

Para listas y campos anidados, continúe con Objetos, matrices y tablas.

Parameters
SchemaPayload
{ "recipient": "Tembuilder", "copies": 2, "showNotes": true}
Schema → Payload → Run

Buscar documentación