Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview
On this page

campaign_plan_creative_list

List the Creatives of a Campaign Plan, and the Line Items that use each one.

Ask which Creatives a Campaign Plan has. A Campaign Plan holds a pool of Creatives of your Library, and each Line Item picks its Creatives from that pool.

“Which creatives are in the spring sale plan, and which line items use them?”

The agent calls campaign_plan_creative_list with the slug of the Campaign Plan. The answer is the whole pool, oldest first. The pool holds at most 50 Creatives, so the tool takes no cursor.

  • Each Creative has its name and the number of its Variations. To see the Variations, the agent calls library_creative_get.
  • lineItemIds names the Line Items that use the Creative. An empty list means that the Creative is not assigned to a Line Item yet.
  • The agent does not choose a Line Item for a Creative that is not assigned. It asks you which Line Item uses it.
  • A Creative that you deleted in the Library does not show.

The read of the Campaign Plan gives only the number of Creatives of the pool, in creativeCount.

Reference

List the pool of Creatives of a Campaign Plan, by the slug of the Campaign Plan, oldest first. A Campaign Plan holds a pool of Creatives of the Library, at most 50. Each Line Item picks its Creatives from the pool of its Campaign Plan, at most 20. A Line Item does not use the Creatives of the pool that it did not pick. Each Creative carries its name, the number of its Variations, and lineItemIds: the Line Items of the Campaign Plan that use it. The answer is the whole pool, so the Tool takes no cursor. A Creative of the pool that no Line Item uses is not assigned yet. Do not choose a Line Item for it: ask the user which Line Item uses it. To build the ads of a Line Item, use only the Creatives that line_item_get lists for that Line Item: library_creative_get gives the Variations of a Creative, and each Variation has one Asset. A Creative of your Library is an ad idea of your organization, with its Variations. It is not the creative of an ad account, which list_creatives lists.

Input

Argument Type Required Description
campaign_plan_name string yes The Campaign Plan slug — its stable per-organization handle.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
creatives array of object yes The Creatives of the pool, oldest first, at most 50: the whole pool, in one answer. A Creative that was deleted in the Library is not listed.
creatives[].id string yes The id of the Creative in the Library, crv_….
creatives[].name string or null yes The name of the Creative, or null when it has none.
creatives[].variationCount number yes The number of Variations of the Creative. library_creative_get gives them.
creatives[].lineItemIds array of string yes The ids of the Line Items of the Campaign Plan that use the Creative. Empty when the Creative is not assigned to a Line Item yet.

Failure codes

A failed call has isError set, and structuredContent.error holds one of these codes. Errors describes the shape of a failed call.

  • not_found
  • organization_unentitled
  • forbidden
  • invalid_request
  • internal_error

Scope

The token must hold campaign_plan:read. Auth & scopes lists each scope.

Annotations

A client reads these hints. A hint that the tool does not declare has the default value of the MCP specification.

  • Read-only. The tool changes nothing.
  • Closed world. The tool reads and writes the data of AdCrunch only.

Example

The arguments:

{
  "campaign_plan_name": "spring-sale"
}

The result, in structuredContent:

{
  "creatives": [
    {
      "id": "crv_8c2e47",
      "name": "Spring sale",
      "variationCount": 2,
      "lineItemIds": [
        "lni_2d9e77"
      ]
    }
  ]
}

Was this page helpful?