https://api.nexscope.ai/amazonAds/sp/negativeKeywordsEjecutar 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/sp/negativeKeywords |
| 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. |
fetchAll | boolean | opcional | Girar páginas automáticamente; usar las listas de recursos principales SP y SB V4 `nextToken`, SB Target/PresupuestoUses de la Regla `nextToken` (La consulta sobre la regla presupuestaria debe contener `pageSize`), SB Keyword GET, SB V3 GET y SD `startIndex + count`. Ejemplo: true |
maxResults | integer | opcional | Página 1–100; SD corresponde a cuenta. Ejemplo: 100 |
skipDepCheck | boolean | opcional | No verifiques la dependencia. Ejemplo: false |
includeExtendedDataFields | boolean | opcional | Algunas entidades devuelven campos extendidos; SD se cambia a través de la ruta /extended. |
locale | string | opcional | Parámetros de localización (apoyados por algunos scripts de palabras clave). |
method | string | obligatorio | Métodos HTTP ascendentes: `POST` creación, `PUT` modificación. |
body | string | obligatorio | El contenido de la solicitud es obligatorio. La herramienta lo serializa y lo envía al proveedor. El token de acceso de Amazon debe quedar fuera de ese contenido. |
contentType | string | opcional | aplicación/vnd.spNegativeKeyword.v3+json. |
queryString | string | opcional | Pase los parámetros de la consulta previa cuando sea necesario. |
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 (9 campos)
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
success | boolean | opcional | Whether the API completed the call successfully. |
apiVersion | string | opcional | `V3` or `V4` (if provided by the script). |
amazonResourceVersion | string | opcional | The actual Amazon resource version (if provided by the script). |
negativeKeywords | array | opcional | Negative keyword array; the actual fields are returned by Amazon. |
total | integer | opcional | The number of aggregated entries (if provided by the script). |
pagesFetched | integer | opcional | Number of pages obtained. |
truncated | boolean | opcional | Whether it was truncated due to paging limit. |
name | string | opcional | Name (returned if supported by the entity). |
state | string | opcional | `ENABLED`, `PAUSED` or `ARCHIVED` (SD upstream may use lowercase). |
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 una clave API ausente o no válida (code 11209, incluida una copia incompleta o dañada) o una sesión web caducada (code 12001), 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.