instagram_branded_content_ads_brand
GET request to the /{instagram-id}/branded_content_advertisable_medias endpoint where the {instagram-id} is your brand’s Instagram professional account ID.| Name | Description |
|---|---|
creator_username | Optional. To find branded content from a specific creator for your brand, include the creator_username field set to the username of the creator. |
permalinks | Optional. An array of Instagram media permalinks that can be obtained from the creator that you are working with. Example: [‘Cw7zyQ5BdEE’,’Cw7zyQ5BdEh’] |
only_fetch_allowlisted | Optional for Instagram partnership ads. Only retrieve media from creators that have been allowlisted. Note: The default value is false to allow you to fetch more data and for API performance. |
only_fetch_recommended_content | Optional for Instagram partnership ads.
Only retrieve recommended content to boost if set to true. The default value is false.Note: Recommended content to boost are organic partnership ads, which a brand has tagged as approved for promotion, that Meta predicts may perform well, including suggested ad campaign objectives. |
ad_code | Optional. The ad code shared by the creator you are working with. |
media_relationship | Optional for Instagram partnership ads.
Any array of value(s) that specifies whether to retrieve tagged and/or owned media. Note: When media_relationship=['OWNED'], the creator_username, only_fetch_allowlisted, and only_fetch_recommended_content parameters are disabled, since they are only applicable to tagged media. When media_relationship is specified, the ad_code and permalinks parameters are disabled.Values:
|
curl -i -X GET \
-d 'creator_username=<CREATOR_USERNAME>' \
-d 'access_token=<PAGE_ACCESS_TOKEN>' \
-d 'permalinks=[<’PERMALINK1’,’PERMALINK2’>]' \
-d 'only_fetch_allowlisted=<BOOLEAN>' \
-d 'only_fetch_recommended_content=<BOOLEAN>' \
-d 'ad_code=<CREATOR_AD_CODE>' \
'https://graph.facebook.com/v25.0/<INSTAGRAM_ACCOUNT_ID>/branded_content_advertisable_medias?fields=eligibility_errors,owner_id,permalink,id&access_token=<ACCESS_TOKEN>,has_permission_for_partnership_ad'
{ "data": [ { "eligibility_errors": [ "Cannot use Reels containing tappable elements can't be used for ads. Choose a different post to create an ad." ], "recommended_campaign_objectives": [ "OUTCOME_ENGAGEMENT", "OUTCOME_TRAFFIC", "OUTCOME_LEADS" ], "has_permission_for_partnership_ad":true, "owner_id": "16502228360082", "permalink": "https://www.instagram.com/reel/CzboAd3R91-/", "id": "16502230933174" }, { "owner_id": "90010135660647", "permalink": "https://www.instagram.com/p/CywLmKWu6Zs/", "id": "90013017840068", "has_permission_for_partnership_ad":true }, { "owner_id": "90010489752294", "permalink": "https://www.instagram.com/p/CyWe6-ExB7p/", "id": "90012928652981", "has_permission_for_partnership_ad":false }, { "eligibility_errors": [ "Can’t use GIF stickersRemove or choose a different sticker." ], "owner_id": "90010135660647", "permalink": "https://www.instagram.com/reel/CyEb6q4OuoN/", "id": "90012872006248" }, ... ], "paging": { "cursors": { "before": "QVFIUkR6amZAhLVVVWGpfTlRBenRsOUJCQ3lR==", "after": "QVFIUlhBX1hoQzI4SkVFaTRoeEpTdEpJMFdIUh==" }}
only_fetch_recommended_content request with recommended_campaign_objectives. When reviewing recommendations, remember that different ad objectives have distinct recommendations.| Ads Manager | Campaign Objectives |
|---|---|
Recommended for impressions | OUTCOME_AWARENESS |
Recommended for engagement | OUTCOME_ENGAGEMENTOUTCOME_TRAFFICOUTCOME_LEADS |
Recommended for conversion | OUTCOME_APP_PROMOTIONOUTCOME_SALES |
media_relationship parameter to fetch the owned and tagged media of an Instagram account.curl -i -X GET \
-F 'media_relationship=["IS_TAGGED"]' \
-F 'access_token=<ACCESS_TOKEN>' \
'https://graph.facebook.com/v25.0/<INSTAGRAM_ACCOUNT_ID>/branded_content_advertisable_medias'
curl -i -X GET \
-F 'media_relationship=["OWNED"]' \
-F 'access_token=<ACCESS_TOKEN>' \
'https://graph.facebook.com/v25.0/<INSTAGRAM_ACCOUNT_ID>/branded_content_advertisable_medias'
curl -i -X GET \
-F 'media_relationship=["OWNED","IS_TAGGED"]' \
-F 'access_token=<ACCESS_TOKEN>' \
'https://graph.facebook.com/v25.0/<INSTAGRAM_ACCOUNT_ID>/branded_content_advertisable_medias'
curl -i -X GET \
-F 'creator_username=<CREATOR_USERNAME>' \
-F 'media_relationship=["OWNED","IS_TAGGED"]' \
-F 'access_token=<ACCESS_TOKEN>' \
'https://graph.facebook.com/v25.0/<INSTAGRAM_ACCOUNT_ID>/branded_content_advertisable_medias'
| Name | Description |
|---|---|
branded_content
JSON object
| An object containing information about the partnership ad.
Values:
|
facebook_branded_content
JSON object
| An object containing the required parameters for Facebook partnership ads. |
instagram_branded_content
JSON object
| An object containing the required parameters for Instagram partnership ads. |
object_id
int
| The Facebook Page ID for the brand. |
source_instagram_media_id
numeric string or integer
| The Instagram media ID to use in the ad. Use this parameter when using an Instagram post to create the ad. |
POST request to the /act_{ad-account-id}/adcreatives endpoint with the object_id field set to your brand’s Facebook Page ID and the source_instagram_media_id field set to the Instagram post ID for the branded content you want to use in your ad.curl -X POST \
-F 'object_id=<PAGE_ID>' \
-F 'source_instagram_media_id=<IG_MEDIA_ID>' \
-F 'access_token=<ACCESS_TOKEN>' \
-F 'facebook_branded_content'={
"sponsor_page_id": "<ADVERTISER_FB_ID>"
} \
-F 'instagram_branded_content'={
"sponsor_id": "<ADVERTISER_IG_ID>"
} \
-F 'branded_content'={
"ad_format": "<AD_FORMAT_TYPE>"
} \
'https://graph.facebook.com/v25.0/act_<AD_ACCOUNT_ID>/adcreatives'
{
"id": "<CREATIVE_ID>"
}
POST request to the /act_{ad-account-id}/adcreatives endpoint with the object_id field set to your brand’s Facebook Page ID for your brand and the instagram_boost_post_access_token provided by the creator.
curl -X POST \
-F 'object_id=<BRAND_PAGE_ID>' \
-F 'branded_content ={
"instagram_boost_post_access_token": "<AD_CODE>",
"ad_format": "<AD_FORMAT_TYPE>"
}' \
-F 'access_token=<ACCESS_TOKEN>' \
-F 'facebook_branded_content'={
"sponsor_page_id": "<ADVERTISER_FB_ID>"
} \
-F 'instagram_branded_content'={
"sponsor_id": "<ADVERTISER_IG_ID>"
} \
'https://graph.facebook.com/v25.0/act_<AD_ACCOUNT_ID>/adcreatives'
{
"id": "<CREATIVE_ID>"
}
POST request to the /act_{ad-account-id}/ads endpoint with the name field set to the name for your ad, the adset_id field set to your ad set ID, the creative field with the creative_id parameter set to the ad creative ID you received, and the status initially set PAUSED.curl -X POST \
-F 'name": "Ad Name"' \
-F 'adset_id: <ADSET_ID>' \
-F 'creative: {"creative_id": <CREATIVE_ID>}' \
-F 'status: "PAUSED"' \
-F 'access_token=<ACCESS_TOKEN>' \
'https://graph.facebook.com/v25.0/act_<AD_ACCOUNT_ID>/ads'
{
"id": "<AD_ID>"
}
partnership_ad_ad_code parameter to upload the video asset to the Facebook video ad library, instead of resorting to source file information:partnership_ad_ad_code – Partnership ad code (numerical). Use this parameter to include a partnership ad code, bypassing the need to know source file information.is_partnership_ad – [Optional] Use this parameter to identify that the ad will be a partnership ad.curl -X POST \
-F 'source_instagram_media_id=<MEDIA-ID>' \
-F 'partnership_ad_ad_code=<PARTNERSHIP_AD_AD_CODE>' \
-F 'is_partnership_ad=true' \
'https://graph.facebook.com/v25.0/act_<AD_ACCOUNT_ID>/advideos'
{
"id": "<VIDEO-ID>"
}