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

library_placement_group_create

Create a Placement group in your Library, with no Placement.

Ask for a new set of Placements. The agent creates a group with a name and, if you want, a description. The group is empty.

“Create a group called Stories for the vertical placements.”

The name must be unique among the groups that your organization sees. Your organization can hold 50 groups. To fill the group, the agent calls library_placement_group_add. The group stays in AdCrunch, and no ad account changes.

This tool is part of the job Bring your own creative.

Reference

Create a Placement group in your Library, with no Placement. Then add Placements with library_placement_group_add. A Placement group is a named set of Placements, for example all the Placements of one channel. A group has no channel and no rules. A group of your organization holds global Placements and Placements of your organization. A global group holds global Placements only. The name must be unique, ignoring case, among the groups that your organization sees. Your organization can hold 50 groups. The group stays in AdCrunch: this changes no ad account.

Input

Argument Type Required Description
description string or null no A free text. A blank text or null stores no description. On an update, leave it out to keep the description.
name string yes The name, 1 to 80 characters. AdCrunch trims it. It must be unique, ignoring case, among the ones that your organization sees: for a Placement, among the Placements of the same channel.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
group object yes The new group of your organization. isGlobal is false, and it holds no Placement yet.
group.createdAt number yes Milliseconds since the Unix epoch, UTC.
group.createdBy string or null yes The user who created the group. null on a global row.
group.deletedAt number or null yes Always null here. A deleted group is not answered.
group.description string or null yes A free text. null when the group has none.
group.id string yes The id of the group, plg_….
group.isGlobal boolean yes true on a row that AdCrunch holds for every organization. You read it, and you cannot change or delete it.
group.name string yes The name, 1 to 80 characters. It is unique, ignoring case, among the groups that the organization sees.
group.organizationId string or null yes The organization that owns the group. null on a global row.
group.updatedAt number or null yes When the group last changed. null until its first update.

Failure codes

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

  • invalid_name
  • name_taken
  • placement_group_limit
  • organization_unentitled
  • forbidden
  • invalid_request
  • internal_error

Scope

The token must hold library:write. 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.

  • Writes. The tool can change data.
  • Not destructive. The tool makes only additive changes.
  • Not idempotent. A second call with the same arguments can change more.
  • Closed world. The tool reads and writes the data of AdCrunch only.

Example

The arguments:

{
  "description": null,
  "name": "Vertical video"
}

The result, in structuredContent:

{
  "group": {
    "createdAt": 1790000600000,
    "createdBy": "usr_2e5b84",
    "deletedAt": null,
    "description": null,
    "id": "plg_9e1c53",
    "isGlobal": false,
    "name": "Vertical video",
    "organizationId": "org_3a7f10",
    "updatedAt": null
  }
}

Was this page helpful?