brand_safety_third_party_partners capability grant.| Fields | Type | Required | Default | Description |
|---|---|---|---|---|
platform | enum | Y | Ads reporting platform type. Accepted values are: audience_network, facebook, instagram. | |
position | enum | Y | Ads reporting platform position type. Accepted values are: instream_video, facebook_reels_overlay, an_classic, rewarded_video. | |
sort_by | enum | Sort the result by a field. If omitted, sort the results by impressions_descending. Take in exactly one option.
Note: Only supported by an_classic and rewarded_video placements. | ||
name_contains | string | Filter results that contain the specified substring in the publisher name field.
| ||
publisher_status | enum | all | The publisher status. This parameter only applies to the instream_video placement. Accepted values are: all, partner, non_partner. If omitted, default to all. | |
start_date | datetime | Earliest date available | The start date for the delivery report in the format: YYYY-MM-DD. If both start_date and end_date are omitted, then te default value will be used. Default value = today - 29 days. | |
end_date | datetime | Latest date available | The end date for the delivery report in the format: YYYY-MM-DD. If both start_date and end_date are omitted, then the default value will be used. Default value = most recent date available. | |
platform | enum | Y | Filter results that contain the specified substring in the publisher name field.
|
| Field | Type | Default | Description |
|---|---|---|---|
url | string | Y | The URL of the publisher where the ad appeared. |
name | string | Y | Vanity name of the publisher where the ad. |
estimated_impressions* | integer | Y | Estimated number of users who have interacted with/viewed this ad |
content_types | list(enum) | Y | The list of content types. This field only applies to the instream_video placement. Possible values are: vod, live. |
status | enum | Y | The publisher status. This field only applies to the instream_video placement. Possible values are: all, partner, non_partner. |
| Field | Type | Default | Description |
|---|---|---|---|
start_date | datetime | Y | Oldest date from which data was gathered for this report |
end_date | datetime | Y | Most recent date from which data was gathered for this report. |
total_count | integer | Y | Total number of rows in the report. |
non_partner_count | integer | Y | The total count of non partners. This field only applies to the instream_video and facebook_reels_overlay placement. |
GET /publisher_delivery_report_date_ranges ?platform=facebook &position=instream_video &fields=start_date,end_date
{ "data": [ { "start_date": "2022-10-01", "end_date": "2022-10-28" }, { "start_date": "2022-09-28", "end_date": "2022-09-30" }, ] }
ad_set_id with the ad set ID for the report. And ensure the start_date and end_date is within the available range from above:GET /{ad_set_id}/publisher_delivery_report ?platform=facebook &position=instream_video &start_date=2022-07-31 &end_date=2022-08-31 &fields=url,name,status,content_types,estimated_impressions &summary=true
{ "data": [ { "url": "www.facebook.com/example1", "name": "Acme", "status": "partner", "content_types": [ "vod" ], "estimated_impressions": 4823 }, { "url": "www.facebook.com/example2", "name": "Widgets", "status": "partner", "content_types": [ "vod" ], "estimated_impressions": 4241 } ... ], ... "summary": { "total_count": 5168, "non_partner_count": 124, "start_date": "2022-07-31", "end_date": "2022-08-31" } }
| Code | Subcode | Description |
|---|---|---|
100 | Invalid Parameter | |
2349019 | Invalid Platform And Position Parameter Combination. | |
2349020 | Both Start Date And End Date Required. | |
2349022 | Start Date Out Of Range. | |
2349023 | End Date Out Of Range. | |
2349024 | Start Date Or End Date Out Of Range. | |
2349025 | Start Date Must Be Earlier Than End Date. | |
200 | Permissions error. | |
80011 | There have been too many calls to Brand Safety APIs. Wait a bit and try again. |
fbtrace_id: Internal support identifier. When reporting a bug related to a Graph API call, include the fbtrace_id to help us find log data for debugging| Placement | Default Page Size | Maximum Page Size |
|---|---|---|
an_classicrewarded_video | 25 | 5000 |
instream_videofacebook_reels_overlay | 100 | Not configurable. |
x-business-use-case-usage response header for every request.