Archived Ad
An ad Facebook stores in the Ad Library. You can perform keyword searches or search by Page ID of ads stored in the Ad Library. See Ad Library and Ad Library API.
Reading
An archived ad.
Example
GET v18.0/...?fields={fieldname_of_type_ArchivedAd} HTTP/1.1
Host: graph.facebook.com/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->get(
'...?fields={fieldname_of_type_ArchivedAd}',
'{access-token}'
);
} catch(Facebook\Exceptions\FacebookResponseException $e) {
echo 'Graph returned an error: ' . $e->getMessage();
exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
echo 'Facebook SDK returned an error: ' . $e->getMessage();
exit;
}
$graphNode = $response->getGraphNode();
/* handle the result *//* make the API call */
FB.api(
"...?fields={fieldname_of_type_ArchivedAd}",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"...?fields={fieldname_of_type_ArchivedAd}",
null,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"...?fields={fieldname_of_type_ArchivedAd}"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];Parameters
This endpoint doesn't have any parameters.Fields
| Field | Description |
|---|---|
idnumeric string | The Library ID of the ad object. |
ad_creation_timestring | The UTC date and time when someone created the ad. This is not the same time as when the ad ran. Includes date and time separated by |
ad_creative_bodieslist<string> | A list of the text which displays in each unique ad card of the ad. Some ads run with multiple ad versions or carousel cards each with their own unique text. See Reference, Ad Creative. |
ad_creative_link_captionslist<string> | A list of the captions which appear in the call to action section for each unique ad card of the ad. Some ads run with multiple ad versions or carousel cards each with their own unique text that appears in the link. |
ad_creative_link_descriptionslist<string> | A list of text descriptions which appear in the call to action section for each unique ad card of the ad. Some ads run with multiple ad versions or carousel cards each with their own unique text describing the link. |
ad_creative_link_titleslist<string> | A list of titles which appear in the call to action section for each unique ad card of the ad. Some ads run with multiple ad versions or carousel cards each with their own unique title text about the link. |
ad_delivery_start_timestring | Date and time when an advertiser wants to start delivering an ad. Provided in UTC as in |
ad_delivery_stop_timestring | The time when an advertiser wants to stop delivery of their ad. If this is blank, the ad will run until the advertiser stops it or they spend their entire campaign budget. In UTC. |
ad_snapshot_urlstring | String with URL link which displays the archived ad. This displays uncompressed images and videos from the ad. While you cannot currently download a batch of archived ads, you can download ad creative such as images and text for an individual ad. If you do so, it must be for analysis and you must comply with the data storage terms in our Terms of Service. |
age_country_gender_reach_breakdown | The demographic distribution of Accounts Center accounts in the EU reached by the ad. Available only for ads delivered to the EU |
beneficiary_payers | The reported beneficiaries and payers for this ad. Available only for ads delivered to the EU |
bylinesstring | A string containing the name of the person, company, or entity that provided funding for the ad. Provided by the purchaser of the ad. Available only for POLITICAL_AND_ISSUE_ADS |
currencystring | The currency used to pay for the ad, as an ISO currency code. Available only for POLITICAL_AND_ISSUE_ADS |
delivery_by_region | Regional distribution of Accounts Center accounts reached by the ad. Provided as a percentage and where regions are at a sub-country level. Available only for POLITICAL_AND_ISSUE_ADS |
demographic_distribution | The demographic distribution of Accounts Center accounts reached by the ad. Provided as age ranges and gender. |
estimated_audience_size | Estimated Audience Size generally estimates how many Accounts Center accounts meet the targeting and ad placement criteria that advertisers select while creating an ad. Learn more. Available only for POLITICAL_AND_ISSUE_ADS |
eu_total_reachint32 | The estimated combined ad reach for all locations inside the European Union. Available only for ads delivered to the EU |
impressions | A string containing the number of times the ad created an impression. In ranges of: <1000, 1K-5K, 5K-10K, 10K-50K, 50K-100K, 100K-200K, 200K-500K, >1M. Available only for POLITICAL_AND_ISSUE_ADS |
languageslist<string> | The list of languages contained within the ad. These are displayed in ISO 639-1 language codes. |
page_idnumeric string | ID of the Facebook Page that ran the ad. |
page_namestring | Name of the Facebook Page which ran the ad. |
publisher_platformslist<enum> | A list of Meta technologies where the archived ad appeared, such as Facebook or Instagram. |
spend | A string showing the amount of money spent running the ad, as specified in |
target_ageslist<numeric string> | The age ranges selected for ad targeting in the EU. The lowest age that can be returned is 13; the highest is 65+. Available only for ads delivered to the EU |
target_genderenum | The genders selected for ad targeting in the EU. Possible values: “Women”, “Men” or “All”. Available only for ads delivered to the EU |
target_locations | The locations included or excluded for ad targeting in the EU. Available only for ads delivered to the EU |