Synup
Schlüssel erstellen
v1Ressourcen/AEO/getAEO-Prompt-Felder abrufen

AEO-Prompt-Felder abrufen

Gibt die benutzerdefinierten Felder der getrackten AEO-Prompts einer Website zurück, archivierte Felder eingeschlossen, zusammen mit den Werten jedes Prompts, alles in einer Antwort. Nur Website-Entitäten haben Prompt-Felder.

get/api/v1/aeo/prompts/fields
aeo:read
Query-Parameter
locationIdstringerforderlich
Die Website, deren Prompt-Felder zurückgegeben werden. Erforderlich.
Antwort
dataobjectoptional
Die benutzerdefinierten Felder und gespeicherten Werte für einen Datensatztyp in einem Bereich.
agencyIdstringoptional
Die ID Ihres Workspace (Ihrer Agentur).
userIdstringoptional
Die ID der Person, als die die Anfrage ausgeführt wird: der Ersteller des API-Schlüssels.
recordTypestring (local_keyword | task | aeo_prompt | post | series | review_campaign | listing)optional
Die Art von Datensatz, zu der der Satz gehört: local_keyword, task, aeo_prompt, post, series, review_campaign oder listing.
scopeIdstringoptional
Die ID des Bereichs, dem der Satz gehört: der Standort oder Kunde, die Website bei AEO-Prompts oder der Workspace bei Aufgaben.
canManagebooleanoptional
Ob der Ersteller des Schlüssels in diesem Satz Felder erstellen, umbenennen und archivieren darf.
fieldsarray of objectoptional
Alle Felder des Satzes, archivierte eingeschlossen, in Anzeigereihenfolge.
idstringoptional
Die ID des Felds. Verwenden Sie sie als fieldId beim Setzen von Werten.
labelstringoptional
Der Anzeigename des Felds. Namen sind innerhalb eines Feldsatzes eindeutig, archivierte Felder eingeschlossen.
typestring (text | number | date | single_select | multi_select)optional
Der Feldtyp: text, number, date, single_select oder multi_select.
optionsarray of objectoptional
Die Auswahlmöglichkeiten eines single_select- oder multi_select-Felds. Bei anderen Typen leer.
idstringerforderlich
Die ID der Option. Auswahlwerte speichern diese ID, nicht das Label.
labelstringerforderlich
Der Anzeigename der Option, innerhalb des Felds eindeutig.
archivedbooleanoptional
True, wenn die Option stillgelegt ist: Werte, die sie bereits enthalten, behalten sie, aber sie kann nicht neu ausgewählt werden.
versionintegeroptional
Die aktuelle Version des Felds, die bei jeder Änderung steigt. Übergeben Sie sie als expectedVersion in field_update.
orderintegeroptional
Die Position des Felds im Satz, beginnend bei 0.
archivedAtstringoptional
Zeitpunkt der Archivierung des Felds oder null, solange es aktiv ist. Archivierte Felder werden weiterhin zurückgegeben.
valuesobjectoptional
Gespeicherte Werte, nach recordId und dann nach fieldId geordnet, jeweils mit value und version. Nur Datensätze ohne gespeicherte Werte fehlen; ein gelöschter Wert bleibt als null mit seiner gespeicherten Version erhalten.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
503Der Dienst ist vorübergehend nicht verfügbar. Befolgen Sie die Hinweise zur Wiederholung für diesen Vorgang.
get/api/v1/aeo/prompts/fields
Ihr API-Schlüssel
locationId *
{}

Anleitungen, die diese Ressource verwenden