https://api.nexscope.ai/amazonAds/adsApi/v1/create/reportsEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/amazonAds/adsApi/v1/create/reports |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
connectionId | integer | obligatorio | Una conexión de Amazon Ads propiedad de la autentificada Nexscope usuario. |
method | string | obligatorio | Las tres etapas de Ads v1 son todas `POST`. |
body | string | obligatorio | JSON string; la consulta de la cuenta puede ser `{}`, creación de informes/polling véase referencia específica, respectivamente. |
contentType | string | opcional | Normalmente `application/json`. |
pollInterval | integer | opcional | 5–300 segundos; recomendación oficial es hacer encuestas cada minuto. Ejemplo: 60 |
maxAttempts | integer | opcional | 1–120, ventana de espera predeterminada de aproximadamente 10 minutos. Ejemplo: 10 |
reportId | string | opcional | Después de pasar, la asignación de cuentas y la creación se saltarán, y los informes existentes sólo se encuestarán. |
confirmationToken | string | opcional | Para mutaciones, primero previsualice sin un token, luego confirme usando el token de uso único devuelto. |
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
No hay un ejemplo de respuesta publicado para esta API. Consulta los campos de respuesta siguientes.
Campos de respuesta
Referencia de campos de respuesta (15 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
success | boolean | opcional | Si el script de entrada completa el procesamiento de informes. |
status | string | opcional | `PENDING`, `PROCESSING`, `COMPLETED`, `FAILED` o `STILL_PROCESSING`. |
reportId | string | opcional | Identifíquese. |
reportKind | string | opcional | `audience` o `search-impression-share`. |
profileId | number | opcional | Perfil de anuncios usado. |
advertiserAccountId | string | opcional | El ID de la cuenta de Ads v1 asignado. |
fields | array | opcional | La combinación real de campo fijo (según se devolvió). |
totalRows | integer | opcional | El número total de líneas después de la fusión; 0 es un informe legalmente vacío. |
dataFiles[] | array | opcional | Archivo de corte CSV local y número de fila. |
preview[] | array | opcional | Previsualización de resultados. |
resumeHint | object | opcional | Continuar los parámetros durante STILL_PROCESSING. |
_cacheable | boolean | opcional | Los resultados exitosos se guardan en caché durante 24 horas; fallida/incompleta es falsa. |
part | integer | opcional | Número de serie del fragmento. |
path | string | opcional | Ruta local del archivo CSV. |
rowCount | integer | opcional | El número de filas en este fragmento. |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como la ausencia de una clave API (code 11209), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |
Fuente de datos, vigencia y limitaciones
La fuente, la vigencia, la cobertura, los límites de frecuencia y las notas de estimación no se especifican en esta definición de API salvo que aparezcan en la documentación de campos de solicitud o respuesta anterior. No supongas datos oficiales del mercado ni actualización en tiempo real cuando no estén documentados explícitamente.