Synup
Criar chave
v1Recursos/AEO/getObter campos de prompts AEO

Obter campos de prompts AEO

Retorna os campos personalizados dos prompts AEO monitorados de um site, incluindo os arquivados, com os valores de cada prompt, tudo em uma única resposta. Somente entidades do tipo site têm campos de prompt.

get/api/v1/aeo/prompts/fields
aeo:read
Parâmetros de consulta
locationIdstringobrigatório
O site cujos campos de prompt são retornados. Obrigatório.
Resposta
dataobjectopcional
Os campos personalizados e os valores armazenados de um tipo de registro em um escopo.
agencyIdstringopcional
O id do seu espaço de trabalho (agência).
userIdstringopcional
O id da pessoa em nome de quem a requisição é executada: o criador da chave de API.
recordTypestring (local_keyword | task | aeo_prompt | post | series | review_campaign | listing)opcional
O tipo de registro ao qual o conjunto pertence: local_keyword, task, aeo_prompt, post, series, review_campaign ou listing.
scopeIdstringopcional
O id do escopo ao qual o conjunto pertence: o local ou o cliente, o site para prompts AEO, ou o espaço de trabalho para tarefas.
canManagebooleanopcional
Se o criador da chave pode criar, renomear e arquivar campos neste conjunto.
fieldsarray of objectopcional
Todos os campos do conjunto, incluindo os arquivados, na ordem de exibição.
idstringopcional
O id do campo. Use-o como fieldId ao definir valores.
labelstringopcional
O nome exibido do campo. Os nomes são únicos dentro de um conjunto de campos, incluindo os arquivados.
typestring (text | number | date | single_select | multi_select)opcional
O tipo do campo: text, number, date, single_select ou multi_select.
optionsarray of objectopcional
As opções de um campo single_select ou multi_select. Vazio para outros tipos.
idstringobrigatório
O id da opção. Os valores de seleção armazenam este id, não o rótulo.
labelstringobrigatório
O nome exibido da opção, único dentro do campo.
archivedbooleanopcional
True quando a opção está retirada: valores que já a contêm a mantêm, mas ela não pode ser selecionada novamente.
versionintegeropcional
A versão atual do campo, incrementada a cada alteração. Passe-a como expectedVersion em field_update.
orderintegeropcional
A posição do campo no conjunto, começando em 0.
archivedAtstringopcional
Quando o campo foi arquivado, ou null enquanto estiver ativo. Campos arquivados continuam sendo retornados.
valuesobjectopcional
Valores armazenados, indexados por recordId e depois por fieldId, cada um com value e version. Somente registros sem valores armazenados ficam de fora; um valor limpo permanece como null com sua versão armazenada.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503O serviço está temporariamente indisponível. Siga as orientações de nova tentativa para esta operação.
get/api/v1/aeo/prompts/fields
Sua chave de API
locationId *
{}

Guias que usam este recurso