API for placements by campaign and pause/activate operations
Ramu THAMMALI
Could you provide API endpoints for:
1. Getting placements by campaign ID
2. Endpoint for bulk pause/activate operations on selected placements within a specific campaign
Please include endpoint details, required permissions, and example requests.
Thanks!
Bryn Whitcomb
Hey Ramu,
Thanks for reaching out! I see you sent us two messages, so I will cover everything here.
The first thing to know is that we allow blocking traffic sources on two levels: by publisher (blocks all sections within that publisher) or by individual section (the most granular traffic source we have). You can choose to apply either block type from the marketer level, so that the block impacts all campaigns (existing and future), or at the individual campaign level.
Retrieving publisher/section reporting
To see which traffic sources your campaigns have served on so far, use one of our reporting endpoints. For example, to check which publishers your campaigns have served on, use the Publishers by Campaign endpoint:
Method: GET
URL: https://api.outbrain.com/amplify/v0.1/reports/marketers/MARKETER_ID/campaigns/publishers
In the response, you will see performance broken down by campaign by publisher, and you’ll notice each publisher has an ID associated with it. Save the IDs of any of the publishers you wish to pause for the next step.
Applying blocks
In order to apply blocks, you must first check if there are any current blocks. For example, if you want to apply publisher or section blocks on a single campaign, you’d use the Retrieve Campaign endpoint with “BlockedSites” as an extraField, like this:
Method: GET
URL: https://api.outbrain.com/amplify/v0.1/campaigns/CAMPAIGN_ID?extraFields=BlockedSites
Save all of the publisher and section IDs in the blockedSites object (if any), and then add any additional publisher/section IDs you saved in the last step to it. It is important to add the new blocks to any existing blocks, otherwise the existing blocks will be lost.
Then use the Update Campaign Endpoint to apply the blocks.
Method: PUT
URL: https://api.outbrain.com/amplify/v0.1/campaigns/CAMPAIGN_ID
Request Body:
{"blockedSites": {
"blockedPublishers": [
{"id": "00f4b02153ee75f3c9dc4fc128ab041962"},
{"id": "0095b3a4811c42fe570d1e730e7286adb4"}
],
"blockedSections": [
{"id": "01f4b02153ee75f3f9dc4fce28ab041g65"}
]
}
}
Please let me know if you have any questions!
Best,
Bryn
--
You received this message because you are subscribed to the Google Groups "Outbrain-AmplifyApi" group.
To unsubscribe from this group and stop receiving emails from it, send an email to outbrain-amplif...@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/outbrain-amplifyapi/de0b9422-4f02-4048-a14c-509f020371b9n%40googlegroups.com.
|
