https://api.nexscope.ai/amazonAds/sp/campaignsRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/amazonAds/sp/campaigns |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId | integer | required | An Amazon Ads connection owned by the authenticated Nexscope user. |
fetchAll | boolean | optional | Automatic page turning; SP and SB V4 main resource lists use `nextToken`, SB Target/BudgetRule uses `nextToken` (BudgetRule query must contain `pageSize`), SB Keyword GET, SB V3 GET and SD use `startIndex + count`. Example: true |
maxResults | integer | optional | Single page 1–100; SD corresponds to count. Example: 100 |
skipDepCheck | boolean | optional | Skip dependency checking. Example: false |
includeExtendedDataFields | boolean | optional | Some entities return extended fields; SD is switched through the /extended path. |
locale | string | optional | Localization parameters (supported by some keyword scripts). |
method | string | required | Upstream HTTP methods: `POST` creation, `PUT` modification. |
body | string | required | The payload must be provided; the API will serialize it and forward it to the upstream, and the Amazon access token cannot be put into the payload. |
contentType | string | optional | application/vnd.spCampaign.v3+json。 |
queryString | string | optional | Pass upstream query parameters when needed. |
confirmationToken | string | optional | For mutations, first preview without a token, then confirm using the returned single-use token. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (9 fields)
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | optional | Whether the API completed the call successfully. |
apiVersion | string | optional | `V3` or `V4` (if provided by the script). |
amazonResourceVersion | string | optional | The actual Amazon resource version (if provided by the script). |
campaigns | array | optional | Campaign array; actual fields returned by Amazon. |
total | integer | optional | The number of aggregated entries (if provided by the script). |
pagesFetched | integer | optional | Number of pages obtained. |
truncated | boolean | optional | Whether it was truncated due to paging limit. |
name | string | optional | Name (returned if supported by the entity). |
state | string | optional | `ENABLED`, `PAUSED` or `ARCHIVED` (SD upstream may use lowercase). |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.