> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ScrapeCreators: Facebook Adlibrary Ad

> Retrieves detailed information about a specific Facebook ad by its ID or URL. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Retrieves detailed information about a specific Facebook ad by its ID or URL.

> [!NOTE]
>
> Tool ID: `scrapecreators_facebook_adlibrary_ad`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'scrapecreators_facebook_adlibrary_ad',
  {
    "id": "id_123",
    "url": "https://example.com",
    "allow_long_transcription": false
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute scrapecreators_facebook_adlibrary_ad --input '{
  "id": "id_123",
  "url": "https://example.com",
  "allow_long_transcription": false
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe scrapecreators_facebook_adlibrary_ad --json` for the complete live contract.

## Input reference

Retrieves detailed information about a specific Facebook ad by its ID or URL. Returns adArchiveID, pageName, isActive, startDate, endDate, and a snapshot containing body, images, videos, display\_format, link\_url, and cta\_text. Regulated ads may also include source-dependent aaa\_info using the structure shown below. Political and social issue delivery data is normalized to location\_audience and age\_country\_gender\_reach\_breakdown. Political location\_audience rows include reach, and political delivery values are fractional shares, so 0.08 means 8%. Regional transparency data may use absolute reach counts. For ads with multiple versions, the ad creative is found in the snapshot.cards array rather than snapshot.body. Transcription is opt-in via get\_transcript=true. Over 120 seconds, videos cannot be AI-transcribed by default. Empty AI results and errors incur no AI fee. The base scrape fee See the live schema below for the complete notes.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | No | — | Facebook Ad Id |
| `payload.url` | `string` | No | — | Facebook Ad URL |
| `payload.allow_long_transcription` | `boolean` | No | `false` | Paid opt-in, enabled only by the literal query value 'true' (allow\_long\_transcription=true). Defaults to false when omitted. other values do not enable paid mode. Over 120 seconds, videos cannot be AI-transcribed by default. This flag does not force AI and does not enable transcription or AI fallback by itself. Keep get\_transcript=true or use\_ai\_as\_fallback=true where required by the endpoint. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can See the live schema for the complete constraint. |
| `payload.get_transcript` | `boolean` | No | — | Transcription is opt-in via get\_transcript=true. Over 120 seconds, videos cannot be AI-transcribed by default. Empty AI results and errors incur no AI fee. The base scrape fee still applies when the detail scrape succeeds. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. |
| `payload.trim` | `boolean` | No | — | Set to true for a trimmed down version of the response |
| `payload.cache_max_age` | `"1d" \| "3d" \| "7d" \| "14d" \| "30d"` | No | — | If we have a response in the cache that is this many days old or newer, return the cached response. Otherwise, scrape a live result. [See the Caching page for details.](https://docs.scrapecreators.com/caching) Allowed: `1d`, `3d`, `7d`, `14d`, `30d`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves detailed information about a specific Facebook ad by its ID or URL. Returns adArchiveID, pageName, isActive, startDate, endDate, and a snapshot containing body, images, videos, display_format, link_url, and cta_text. Regulated ads may also include source-dependent aaa_info using the structure shown below. Political and social issue delivery data is normalized to location_audience and age_country_gender_reach_breakdown. Political location_audience rows include reach, and political delivery values are fractional shares, so 0.08 means 8%. Regional transparency data may use absolute reach counts. For ads with multiple versions, the ad creative is found in the snapshot.cards array rather than snapshot.body. Transcription is opt-in via get_transcript=true. Over 120 seconds, videos cannot be AI-transcribed by default. Empty AI results and errors incur no AI fee; the base scrape fee still applies when the detail scrape succeeds. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed.",
    "properties": {
      "id": {
        "type": "string",
        "description": "Facebook Ad Id"
      },
      "url": {
        "type": "string",
        "description": "Facebook Ad URL"
      },
      "allow_long_transcription": {
        "type": "boolean",
        "description": "Paid opt-in, enabled only by the literal query value 'true' (allow_long_transcription=true). Defaults to false when omitted; other values do not enable paid mode. Over 120 seconds, videos cannot be AI-transcribed by default. This flag does not force AI and does not enable transcription or AI fallback by itself. Keep get_transcript=true or use_ai_as_fallback=true where required by the endpoint. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed.",
        "default": false
      },
      "get_transcript": {
        "type": "boolean",
        "description": "Transcription is opt-in via get_transcript=true. Over 120 seconds, videos cannot be AI-transcribed by default. Empty AI results and errors incur no AI fee; the base scrape fee still applies when the detail scrape succeeds. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed."
      },
      "trim": {
        "type": "boolean",
        "description": "Set to true for a trimmed down version of the response"
      },
      "cache_max_age": {
        "type": "string",
        "description": "If we have a response in the cache that is this many days old or newer, return the cached response. Otherwise, scrape a live result. [See the Caching page for details.](https://docs.scrapecreators.com/caching)",
        "enum": [
          "1d",
          "3d",
          "7d",
          "14d",
          "30d"
        ]
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `unknown` | Yes | — | Provider response payload. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "description": "Provider response payload."
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.02` per pricing unit.

## Related documentation

* [ScrapeCreators provider guide](https://deepline.com/docs/providers/scrapecreators/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.