Facebook広告詳細API
POST
APIの稼働状況
- 24時間の稼働状況
- 正常
- 24時間の平均応答時間
- —
- 良好/正常
- 利用可能
- 制限あり
- ほぼ停止
正常
過去24時間
過去30日間
リンクまたは広告ライブラリIDから、Facebook広告ライブラリの広告を1件開きます。配信中かどうか、開始日と終了日、広告テキスト、見出し、リンクとCTA、表示形式、配信された掲載面、画像または動画、すべてのクリエイティブバリエーション、広告主のページID・名前・いいね数・カテゴリを取得できます。費用、リーチ、ターゲティングは結果に含まれません。
料金は1,000リクエストあたり$0.96(1回あたり$0.000958)です。失敗した呼び出しと空の結果には課金されません。 同期処理です。時間のかかるジョブでは、ボディに"mode": "async"を追加し、job_idを取得してポーリングしてください。
AIプロンプト
EveryInfraのFacebook 広告詳細エンドポイント(facebook/ad_detail)を使ったデータ収集スクリプトの作成を手伝ってください。
エンドポイントの仕組み:
- リクエスト:ヘッダーにAuthorization: Bearer <API key>を指定して、https://api.everyinfra.com/api/v1/socialにPOSTします。APIキーは環境変数EVERYINFRA_API_KEYから読み込み、ハードコードしないでください。
- リクエストボディでplatformにfacebook、actionにad_detailを指定し、パラメータはparamsの中に入れます。
- 必須パラメータ:
- url: 対象の広告1件を、広告ライブラリのリンク(https://www.facebook.com/ads/library/?id=<Library ID>)または数値のライブラリID(adsの行のid)で指定します。
- 1つのオブジェクトを返します。主なフィールド: id、url、is_active、started_at、ended_at、text、title、caption、link_url、link_description、cta_text、display_format。フィールドは全部で22個です。一覧はhttps://api.everyinfra.com/api/v1/social/catalog?platform=facebookを参照してください。.
- リクエストボディの例:
{
"platform": "facebook",
"action": "ad_detail",
"params": {
"url": "https://www.facebook.com/ads/library/?id=900404412649714"
}
}
- 料金:1,000リクエストあたり$0.96。失敗時および結果が空の場合は課金されません。
- 対象が数十〜数百件ある場合は、ボディに"mode": "async"を追加します。すぐにjob_idが返されるので、GET https://api.everyinfra.com/api/v1/jobs/{job_id}をポーリングして結果を取得します。
- 422の場合は、エラーに含まれる推奨パラメータ名と指定可能な値を使ってリクエストを修正します。429または503の場合は、Retry-Afterの指定に従って待ってから再試行します。
コードを書く前に、必要な対象とその件数、必要なフィールド、希望する出力形式を私に質問してください。そのうえで、計画と概算費用を私に確認してください。リクエストパラメータ
| 名前 | 場所 | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|---|
Authorization | header | string | はい | - | Bearerの後にAPIキーを続けます。APIキーはコンソールで作成してください。URLやコードリポジトリには絶対に含めないでください。 |
platform | body | string | はい | facebook | プラットフォームの識別子です。値は固定です。 |
action | body | string | はい | ad_detail | 機能の識別子です。値は固定です。 |
url | body.params | string | はい | - | 対象の広告1件を、広告ライブラリのリンク(https://www.facebook.com/ads/library/?id=<Library ID>)または数値のライブラリID(adsの行のid)で指定します。 |
コードサンプル
bash
curl -X POST 'https://api.everyinfra.com/api/v1/social' \
-H "Authorization: Bearer $EVERYINFRA_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"platform": "facebook",
"action": "ad_detail",
"params": {
"url": "https://www.facebook.com/ads/library/?id=900404412649714"
}
}'OpenAPI定義(JSON)サンプルは環境変数EVERYINFRA_API_KEYからAPIキーを読み込みます。コピーしたコードにAPIキーが含まれることはありません。
レスポンス例
フィールドプレビュー
このパラメータのサンプルレスポンスはまだありません。このプレビューはAPI定義に基づくレスポンスの構造とフィールドを示したもので、値は…で表しています。実際の呼び出し結果ではありません。
json
{
"id": "req_…",
"platform": "facebook",
"action": "ad_detail",
"results": {
"id": …,
"url": …,
"is_active": …,
"started_at": …,
"ended_at": …,
"text": …,
"title": …,
"caption": …,
"link_url": …,
"link_description": …,
"cta_text": …,
"display_format": …,
"platforms": …,
"media": …,
"creatives": …,
"variant_count": …,
"advertiser_id": …,
"advertiser_name": …,
"advertiser_url": …,
"advertiser_likes": …,
"advertiser_avatar_url": …,
"advertiser_categories": …,
"platform": …
},
"billing": {
"charged": …,
"charged_usd": …,
"balance_after_usd": …,
…
},
"quota": { … }
}レスポンスフィールド
業務データはresultsに含まれます。この表はレコードに含まれうるフィールドの一覧です。プラットフォームに表示されない値を作り出すことはありません。
| フィールド | 意味 |
|---|---|
id | プラットフォーム上でのレコードの一意なIDです。一意性は1つのプラットフォーム内に限られ、プラットフォームが異なるとIDが重複する場合があります。 |
url | プラットフォーム上のレコードへのリンクです。 |
is_active | プラットフォーム上の意味のまま |
started_at | プラットフォーム上の意味のまま |
ended_at | プラットフォーム上の意味のまま |
text | HTMLを除去した本文です。省略されることなく全文が返されます(一部のプラットフォームでは一覧結果自体に抜粋しか含まれません。その場合は各プラットフォームのフィールドの注記に記載しています)。 |
title | タイトルです。プラットフォームにタイトルがない場合(テキストのみの投稿など)はnullになります。 |
caption | プラットフォーム上の意味のまま |
link_url | プラットフォーム上の意味のまま |
link_description | プラットフォーム上の意味のまま |
cta_text | プラットフォーム上の意味のまま |
display_format | プラットフォーム上の意味のまま |
platforms | プラットフォーム上の意味のまま |
media | プラットフォーム上の意味のまま |
creatives | プラットフォーム上の意味のまま |
variant_count | プラットフォーム上の意味のまま |
advertiser_id | プラットフォーム上の意味のまま |
advertiser_name | プラットフォーム上の意味のまま |
advertiser_url | プラットフォーム上の意味のまま |
advertiser_likes | プラットフォーム上の意味のまま |
advertiser_avatar_url | プラットフォーム上の意味のまま |
advertiser_categories | プラットフォーム上の意味のまま |
platform | 取得元プラットフォームの識別子で、リクエストのplatformと同じです(例:xiaohongshu、tiktok)。 |
エラーと課金
- 401
- キーが未指定か無効です。
- 402
- 残高が不足しています。先にチャージしてください。
- 422
- パラメータ名または値が無効です。エラーに含まれる候補を参考に修正してください。課金はされません。
- 429
- 1分あたりのリクエスト上限に達しました。Retry-Afterの指定に従って待ってから再試行してください。
- 503
- 処理を完了できませんでした。保留中の請求額は残高に戻されます。結果が不明な場合は、再試行する前に確認してください。
- 200(空)
- データがありません。課金はされません。