library_placement_group_get
Read one Placement group of your Library with every Placement that it holds.
Ask what a group holds. The agent reads one group with each of its Placements, and each Placement comes with its rules. A group has no page: it holds the Placements that your organization sees.
“What is in the Stories group?”
The agent finds the group with library_placement_group_list, and calls this tool.
This tool is part of the job Bring your own creative.
Reference
Read one Placement group of your Library with every Placement that it holds, each with its rules. There is no page: a group holds the Placements that your organization sees. 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. A global row (isGlobal is true) is held by AdCrunch for each organization. You read it and use it. A change of a global row, and a delete of it, answer not_found.
Input
| Argument | Type | Required | Description |
|---|---|---|---|
group_id |
string | yes | The id of a Placement group (plg_…). library_placement_group_list gives it. |
Output
A successful call returns this object in structuredContent.
| Field | Type | Always present | Description |
|---|---|---|---|
group |
object | yes | The group, with isGlobal and every live Placement that it holds in placements, each with its rules. |
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. |
group.placements |
array of object | yes | Every live Placement that the group holds, with no page. A group holds at most the Placements that the organization sees. |
group.placements[].channel |
one of meta, tiktok, snapchat, google_search, google_pmax, google_display, youtube, programmatic_display, linkedin, x |
yes | The channel of a Line Item that the Placement belongs to. It never changes. |
group.placements[].createdAt |
number | yes | Milliseconds since the Unix epoch, UTC. |
group.placements[].createdBy |
string or null | yes | The user who created the Placement. null on a global row. |
group.placements[].deletedAt |
number or null | yes | Always null here. A deleted Placement is not answered. |
group.placements[].description |
string or null | yes | A free text. null when the Placement has none. |
group.placements[].id |
string | yes | The id of the Placement, plm_…. |
group.placements[].isGlobal |
boolean | yes | true on a row that AdCrunch holds for every organization. You read it, and you cannot change or delete it. |
group.placements[].name |
string | yes | The name, 1 to 80 characters. It is unique, ignoring case, among the Placements of the channel that the organization sees. |
group.placements[].organizationId |
string or null | yes | The organization that owns the Placement. null on a global row. |
group.placements[].params |
object | yes | |
group.placements[].params.type |
image or video |
yes | |
group.placements[].params.rules |
array of object, at most 20 items | yes | Only when type is image. |
group.placements[].params.rules[].type |
width or height or size or ratio or mime |
yes | |
group.placements[].params.rules[].operator |
object | yes | Only when type is width. |
group.placements[].params.rules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
group.placements[].params.rules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
group.placements[].params.rules[].operator |
object | yes | Only when type is height. |
group.placements[].params.rules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
group.placements[].params.rules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
group.placements[].params.rules[].operator |
object | yes | Only when type is size. |
group.placements[].params.rules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
group.placements[].params.rules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
group.placements[].params.rules[].operator |
object | yes | Only when type is ratio. |
group.placements[].params.rules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is lt. |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is lte. |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is gt. |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is gte. |
group.placements[].params.rules[].operator.value |
array of (array of any, 2 items), 1 to 50 items | yes | Only when condition is in. |
group.placements[].params.rules[].operator |
object | yes | Only when type is mime. |
group.placements[].params.rules[].operator.condition |
eq or ne or in |
yes | |
group.placements[].params.rules[].operator.value |
string, 1 to 255 characters | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
string, 1 to 255 characters | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
array of (string, 1 to 255 characters), 1 to 50 items | yes | Only when condition is in. |
group.placements[].params.rules |
array of object, at most 20 items | yes | Only when type is video. |
group.placements[].params.rules[].type |
width or height or size or ratio or mime or duration |
yes | |
group.placements[].params.rules[].operator |
object | yes | Only when type is width. |
group.placements[].params.rules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
group.placements[].params.rules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
group.placements[].params.rules[].operator |
object | yes | Only when type is height. |
group.placements[].params.rules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
group.placements[].params.rules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
group.placements[].params.rules[].operator |
object | yes | Only when type is size. |
group.placements[].params.rules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
group.placements[].params.rules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
group.placements[].params.rules[].operator |
object | yes | Only when type is ratio. |
group.placements[].params.rules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is lt. |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is lte. |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is gt. |
group.placements[].params.rules[].operator.value |
array of any, 2 items | yes | Only when condition is gte. |
group.placements[].params.rules[].operator.value |
array of (array of any, 2 items), 1 to 50 items | yes | Only when condition is in. |
group.placements[].params.rules[].operator |
object | yes | Only when type is mime. |
group.placements[].params.rules[].operator.condition |
eq or ne or in |
yes | |
group.placements[].params.rules[].operator.value |
string, 1 to 255 characters | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
string, 1 to 255 characters | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
array of (string, 1 to 255 characters), 1 to 50 items | yes | Only when condition is in. |
group.placements[].params.rules[].operator |
object | yes | Only when type is duration. |
group.placements[].params.rules[].operator.condition |
eq or ne or lt or lte or gt or gte or in |
yes | |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is eq. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is ne. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is lte. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gt. |
group.placements[].params.rules[].operator.value |
integer, at least 0 | yes | Only when condition is gte. |
group.placements[].params.rules[].operator.value |
array of (integer, at least 0), 1 to 50 items | yes | Only when condition is in. |
group.placements[].type |
one of image, video |
yes | The kind of Asset that the slot takes. It never changes, and it equals params.type. |
group.placements[].updatedAt |
number or null | yes | When the Placement 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.
not_foundorganization_unentitledforbiddeninvalid_requestinternal_error
Scope
The token must hold library: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:
{
"group_id": "plg_9e1c53"
}
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,
"placements": [
{
"channel": "meta",
"createdAt": 1790000500000,
"createdBy": "usr_2e5b84",
"deletedAt": null,
"description": "Our own cut for Reels, never over 30 seconds.",
"id": "plm_4b8d27",
"isGlobal": false,
"name": "Reels short cut",
"organizationId": "org_3a7f10",
"params": {
"rules": [
{
"operator": {
"condition": "eq",
"value": [
9,
16
]
},
"type": "ratio"
},
{
"operator": {
"condition": "lte",
"value": 30000
},
"type": "duration"
}
],
"type": "video"
},
"type": "video",
"updatedAt": null
},
{
"channel": "meta",
"createdAt": 1789000000000,
"createdBy": null,
"deletedAt": null,
"description": null,
"id": "plm_meta_stories_video",
"isGlobal": true,
"name": "Meta Stories video",
"organizationId": null,
"params": {
"rules": [
{
"operator": {
"condition": "eq",
"value": [
9,
16
]
},
"type": "ratio"
},
{
"operator": {
"condition": "gte",
"value": 250
},
"type": "width"
},
{
"operator": {
"condition": "in",
"value": [
"video/mp4",
"video/quicktime"
]
},
"type": "mime"
},
{
"operator": {
"condition": "gte",
"value": 1000
},
"type": "duration"
}
],
"type": "video"
},
"type": "video",
"updatedAt": null
}
]
}
}