Skip to Content
Tool referenceGet ad sheet schema

Get ad sheet schema (adsap_get_ad_sheet_schema)

Platform: Meta · Read or write: Read · Plan: All plans · Consumes a task: No · Preview supported: No

What it does

Returns the column schema of one ad sheet: the columns, their constraints, and how they depend on each other. Use it to read or explain the structure of a sheet. The copilot can only read sheets; you create and edit rows in the Adsap web app.

When to use it

  • Use it to explain a sheet’s columns: what each one means, which are required, and which depend on the ad format.
  • It needs a sheet_id. Get it from adsap_list_ad_sheets.
  • It returns column definitions and a row count. It does not return the rows.
  • Sheets are read-only for the assistant. You create and edit rows in the Adsap web app.
  • A sheet outside your current workspace, or on an ad account you cannot reach, comes back as not found.

Worked example

You ask

“Explain the columns in my Spring sale launch ad sheet. Which ones depend on the ad format?”

The assistant calls adsap_get_ad_sheet_schema

{ "sheet_id": "3f2a9c1e-5b7d-4e8a-9c21-7d4f6a1b2c3d" }

Adsap returns

The field names are the ones Adsap returns. The values are examples.

{ "sheet_id": "3f2a9c1e-5b7d-4e8a-9c21-7d4f6a1b2c3d", "sheet_name": "Spring sale launch", "ad_account_id": "act_1234567890", "ad_platform": "Meta Ads", "visible_columns": ["display_link", "descriptions"], "catalog_id": null, "columns": [ { "column_id": "square_creative", "name": "square_creative", "label": "Square Creative (1080x1080)", "description": "Creative asset for feed placements (square format). Select from uploaded assets.", "type": "ASSET_REF", "required": false, "group": "creative", "default_value": null, "examples": null, "depends_on": { "field": "ad_format", "values": ["Single Image or Video"], "effect": "relevant" }, "constraints": { "asset_types": ["IMAGE", "VIDEO"], "format_requirements": "1080x1080" }, "meta_field": "creative.image_hash or creative.video_id" } ], "row_count": 12, "column_count": 67 }

How to read it

columns holds one entry per column, 67 in all. The example shows one. type is the kind of value, such as STRING, ENUM, URL or ASSET_REF. group sorts columns into areas such as setup, creative, copy and catalog. constraints carries limits such as allowed_values or max_length.

depends_on links a column to another one. Here square_creative is relevant when ad_format is Single Image or Video. Other columns use the effect required. row_count is the number of rows in the sheet. visible_columns lists the optional columns switched on for it.

Parameters

Descriptions are shortened from the tool schema. Your assistant sees the full text.

NameTypeRequiredDescription
sheet_idstringYes

Example prompts

  • “Explain the columns in my Spring Launch ad sheet.”
  • “What does each column in this ad sheet require, and which ones depend on the ad format?”

Guide

Read Ad sheets for the workflow around this tool, and the Tool reference for every tool.

The Meta Ads MCP server  page shows how to connect Meta Ads to Claude, ChatGPT or Perplexity.

Last updated on