Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions api-usage-docs/service-amazon-advertising-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,3 +242,24 @@ Authorization: Bearer <jwt>
}
}
```

---

### Marketing Stream S3

Product `110` registers Amazon Marketing Stream datasets for delivery through shared, regional S3 and SQS resources managed by Openbridge. Authenticate each request with an Openbridge bearer token.

| Method | Endpoint | Success |
|---|---|---|
| GET | `/service/amzadv/list-adv-v2/{remote_identity_id}` | `200 OK` with an array of advertiser accounts. Supports the optional `advertiser_id` query filter. |
| GET | `/service/amzadv/stream-s3/list-datasets` | `200 OK` with the dataset list at `attributes.datasets`. |
| POST | `/service/amzadv/stream-s3/{remote_identity_id}` | `200 OK` with the Amazon subscription IDs. |
| PATCH | `/service/amzadv/stream-s3/update/{remote_identity_id}/{subscription_id}` | `200 OK` with replacement Amazon subscription IDs. |
| DELETE | `/service/amzadv/stream-s3/delete/{remote_identity_id}/{subscription_id}` | `204 No Content` after archiving the Amazon streams stored on the Openbridge subscription. |
| DELETE | `/service/amzadv/stream-s3/delete-orphaned/{remote_identity_id}/{advertiser_id}` | `204 No Content` after archiving the advertiser's streams eligible for cleanup. Requires that the remote identity have no active product `110` subscriptions. |

Create and update run synchronously. Send the advertiser ID and full dataset list in `data.attributes.advertiser_id` and `data.attributes.datasets`. Both operations return a top-level `advertiser_id` and a dataset-to-ID map at `attributes.amz_subscription_ids`. Update archives the old Amazon streams before registering the requested datasets.

Store `advertiser_id` and the JSON-stringified `amz_subscription_ids` map in the product `110` pipeline's `product_parameters`. See the [Marketing Stream S3 tutorial](../tutorials/amazon-advertising-marketing-stream-pipeline.md) for request examples and the full pipeline lifecycle.

For the `/stream-v2` customer-managed AWS workflow, see the [legacy tutorial](../tutorials/amazon-advertising-marketing-stream-pipeline-legacy.md).
Loading
Loading