Synup
Crear clave
v1Recursos/AEO/getObtener campos de prompts AEO

Obtener campos de prompts AEO

Devuelve los campos personalizados de los prompts AEO con seguimiento de un sitio web, incluidos los archivados, con los valores de cada prompt, todo en una sola respuesta. Solo las entidades de sitio web tienen campos de prompt.

get/api/v1/aeo/prompts/fields
aeo:read
Parámetros de consulta
locationIdstringobligatorio
El sitio web cuyos campos de prompt se devuelven. Obligatorio.
Respuesta
dataobjectopcional
Los campos personalizados y los valores guardados de un tipo de registro en un ámbito.
agencyIdstringopcional
El id de su espacio de trabajo (agencia).
userIdstringopcional
El id de la persona en cuyo nombre se ejecuta la solicitud: el creador de la clave de API.
recordTypestring (local_keyword | task | aeo_prompt | post | series | review_campaign | listing)opcional
El tipo de registro al que pertenece el conjunto: local_keyword, task, aeo_prompt, post, series, review_campaign o listing.
scopeIdstringopcional
El id del ámbito al que pertenece el conjunto: la ubicación o el cliente, el sitio web para prompts AEO, o el espacio de trabajo para tareas.
canManagebooleanopcional
Si el creador de la clave puede crear, renombrar y archivar campos en este conjunto.
fieldsarray of objectopcional
Todos los campos del conjunto, incluidos los archivados, en orden de visualización.
idstringopcional
El id del campo. Úselo como fieldId al establecer valores.
labelstringopcional
El nombre visible del campo. Los nombres son únicos dentro de un conjunto de campos, incluidos los archivados.
typestring (text | number | date | single_select | multi_select)opcional
El tipo de campo: text, number, date, single_select o multi_select.
optionsarray of objectopcional
Las opciones de un campo single_select o multi_select. Vacío para otros tipos.
idstringobligatorio
El id de la opción. Los valores de selección guardan este id, no la etiqueta.
labelstringobligatorio
El nombre visible de la opción, único dentro del campo.
archivedbooleanopcional
True cuando la opción está retirada: los valores que ya la tienen la conservan, pero no se puede volver a seleccionar.
versionintegeropcional
La versión actual del campo, que aumenta con cada cambio. Pásela como expectedVersion en field_update.
orderintegeropcional
La posición del campo en el conjunto, empezando en 0.
archivedAtstringopcional
Cuándo se archivó el campo, o null mientras está activo. Los campos archivados se siguen devolviendo.
valuesobjectopcional
Valores guardados, indexados por recordId y luego por fieldId, cada uno con value y version. Solo se omiten los registros sin valores guardados; un valor borrado permanece como null con su versión guardada.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
503El servicio no está disponible temporalmente. Siga las indicaciones de reintento para esta operación.
get/api/v1/aeo/prompts/fields
Su clave de API
locationId *
{}

Guías que usan este recurso