Skip to content

fix: Remove redundant singular filter fields from creative-filters schema #845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bokelley merged 1 commit into from
Jan 22, 2026
Merged

fix: Remove redundant singular filter fields from creative-filters schema #845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changeset/simplify-filters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
---

31 changes: 14 additions & 17 deletions docs/media-buy/task-reference/list_creatives.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,8 @@ The `list_creatives` task provides comprehensive search and filtering capabiliti
```json
{
"filters": {
"format": "video", // Single format
"formats": ["video", "audio"], // Multiple formats
"status": "approved", // Single status
"statuses": ["approved", "pending_review"] // Multiple statuses
"formats": ["video"], // Filter by format types
"statuses": ["approved", "pending_review"] // Filter by statuses
}
}
```
Expand Down Expand Up @@ -94,8 +92,7 @@ The `list_creatives` task provides comprehensive search and filtering capabiliti
```json
{
"filters": {
"assigned_to_package": "pkg_ctv_001", // Assigned to specific package
"assigned_to_packages": ["pkg_001", "pkg_002"], // Assigned to any of these packages
"assigned_to_packages": ["pkg_ctv_001"], // Assigned to any of these packages
"media_buy_ids": ["mb_123", "mb_456"], // Assigned to any of these media buys
"buyer_refs": ["campaign_abc", "campaign_xyz"], // Assigned to media buys with these buyer references
"unassigned": true // Unassigned creatives only
Expand Down Expand Up @@ -206,8 +203,8 @@ List all approved video creatives:
```json
{
"filters": {
"format": "video",
"status": "approved"
"formats": ["video"],
"statuses": ["approved"]
},
"sort": {
"field": "created_date",
Expand Down Expand Up @@ -246,7 +243,7 @@ Get creatives ready for assignment to new campaigns:
{
"filters": {
"unassigned": true,
"status": "approved"
"statuses": ["approved"]
},
"sort": {
"field": "created_date",
Expand All @@ -265,7 +262,7 @@ Find all creatives assigned to a specific package:
```json
{
"filters": {
"assigned_to_package": "pkg_ctv_premium_001"
"assigned_to_packages": ["pkg_ctv_premium_001"]
},
"include_assignments": true,
"include_performance": true,
Expand All @@ -285,7 +282,7 @@ Find mobile-optimized creatives across multiple formats:
"filters": {
"formats": ["display_320x50", "video_9x16_mobile", "display_300x250"],
"tags_any": ["mobile_optimized", "responsive"],
"status": "approved"
"statuses": ["approved"]
},
"sort": {
"field": "updated_date",
Expand All @@ -303,7 +300,7 @@ Get minimal creative data for UI dropdown:
"fields": ["creative_id", "name", "format", "status"],
"include_assignments": false,
"filters": {
"status": "approved"
"statuses": ["approved"]
},
"sort": {
"field": "name",
Expand Down Expand Up @@ -358,7 +355,7 @@ Find all creatives used in specific media buys or campaigns:
{
"filters": {
"media_buy_ids": ["mb_summer_2025", "mb_spring_2025"],
"status": "approved"
"statuses": ["approved"]
},
"include_assignments": true,
"include_performance": true,
Expand Down Expand Up @@ -429,7 +426,7 @@ Search creatives across related campaigns by buyer reference:
```json
{
"filters": {
"status": "approved",
"statuses": ["approved"],
"unassigned": true
},
"sort": { "field": "created_date", "direction": "desc" }
Expand Down Expand Up @@ -502,7 +499,7 @@ For queries returning very large result sets:
// Get lightweight creative list for dropdown
const response = await adcp.list_creatives({
fields: ["creative_id", "name", "format"],
filters: { status: "approved" },
filters: { statuses: ["approved"] },
sort: { field: "name", direction: "asc" },
include_assignments: false
});
Expand All @@ -525,12 +522,12 @@ const response = await adcp.list_creatives({

### Assignment Management

```javascript
```javascript
// Find unassigned creatives ready for new campaigns
const response = await adcp.list_creatives({
filters: {
unassigned: true,
status: "approved",
statuses: ["approved"],
formats: ["video", "display"]
},
sort: { field: "created_date", direction: "desc" }
Expand Down
16 changes: 2 additions & 14 deletions static/schemas/source/core/creative-filters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,16 @@
"description": "Filter criteria for querying creative assets from the centralized library",
"type": "object",
"properties": {
"format": {
"type": "string",
"description": "Filter by creative format type (e.g., video, audio, display)"
},
"formats": {
"type": "array",
"description": "Filter by multiple creative format types",
"description": "Filter by creative format types (e.g., video, audio, display)",
"items": {
"type": "string"
}
},
"status": {
"$ref": "/schemas/enums/creative-status.json",
"description": "Filter by creative approval status"
},
"statuses": {
"type": "array",
"description": "Filter by multiple creative statuses",
"description": "Filter by creative approval statuses",
"items": {
"$ref": "/schemas/enums/creative-status.json"
}
Expand Down Expand Up @@ -73,10 +65,6 @@
"format": "date-time",
"description": "Filter creatives last updated before this date (ISO 8601)"
},
"assigned_to_package": {
"type": "string",
"description": "Filter creatives assigned to this specific package"
},
"assigned_to_packages": {
"type": "array",
"description": "Filter creatives assigned to any of these packages",
Expand Down
31 changes: 14 additions & 17 deletions v2.6-rc/docs/media-buy/task-reference/list_creatives.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,8 @@ The `list_creatives` task provides comprehensive search and filtering capabiliti
```json
{
"filters": {
"format": "video", // Single format
"formats": ["video", "audio"], // Multiple formats
"status": "approved", // Single status
"statuses": ["approved", "pending_review"] // Multiple statuses
"formats": ["video"], // Filter by format types
"statuses": ["approved", "pending_review"] // Filter by statuses
}
}
```
Expand Down Expand Up @@ -94,8 +92,7 @@ The `list_creatives` task provides comprehensive search and filtering capabiliti
```json
{
"filters": {
"assigned_to_package": "pkg_ctv_001", // Assigned to specific package
"assigned_to_packages": ["pkg_001", "pkg_002"], // Assigned to any of these packages
"assigned_to_packages": ["pkg_ctv_001"], // Assigned to any of these packages
"media_buy_ids": ["mb_123", "mb_456"], // Assigned to any of these media buys
"buyer_refs": ["campaign_abc", "campaign_xyz"], // Assigned to media buys with these buyer references
"unassigned": true // Unassigned creatives only
Expand Down Expand Up @@ -206,8 +203,8 @@ List all approved video creatives:
```json
{
"filters": {
"format": "video",
"status": "approved"
"formats": ["video"],
"statuses": ["approved"]
},
"sort": {
"field": "created_date",
Expand Down Expand Up @@ -246,7 +243,7 @@ Get creatives ready for assignment to new campaigns:
{
"filters": {
"unassigned": true,
"status": "approved"
"statuses": ["approved"]
},
"sort": {
"field": "created_date",
Expand All @@ -265,7 +262,7 @@ Find all creatives assigned to a specific package:
```json
{
"filters": {
"assigned_to_package": "pkg_ctv_premium_001"
"assigned_to_packages": ["pkg_ctv_premium_001"]
},
"include_assignments": true,
"include_performance": true,
Expand All @@ -285,7 +282,7 @@ Find mobile-optimized creatives across multiple formats:
"filters": {
"formats": ["display_320x50", "video_9x16_mobile", "display_300x250"],
"tags_any": ["mobile_optimized", "responsive"],
"status": "approved"
"statuses": ["approved"]
},
"sort": {
"field": "updated_date",
Expand All @@ -303,7 +300,7 @@ Get minimal creative data for UI dropdown:
"fields": ["creative_id", "name", "format", "status"],
"include_assignments": false,
"filters": {
"status": "approved"
"statuses": ["approved"]
},
"sort": {
"field": "name",
Expand Down Expand Up @@ -358,7 +355,7 @@ Find all creatives used in specific media buys or campaigns:
{
"filters": {
"media_buy_ids": ["mb_summer_2025", "mb_spring_2025"],
"status": "approved"
"statuses": ["approved"]
},
"include_assignments": true,
"include_performance": true,
Expand Down Expand Up @@ -429,7 +426,7 @@ Search creatives across related campaigns by buyer reference:
```json
{
"filters": {
"status": "approved",
"statuses": ["approved"],
"unassigned": true
},
"sort": { "field": "created_date", "direction": "desc" }
Expand Down Expand Up @@ -502,7 +499,7 @@ For queries returning very large result sets:
// Get lightweight creative list for dropdown
const response = await adcp.list_creatives({
fields: ["creative_id", "name", "format"],
filters: { status: "approved" },
filters: { statuses: ["approved"] },
sort: { field: "name", direction: "asc" },
include_assignments: false
});
Expand All @@ -525,12 +522,12 @@ const response = await adcp.list_creatives({

### Assignment Management

```javascript
```javascript
// Find unassigned creatives ready for new campaigns
const response = await adcp.list_creatives({
filters: {
unassigned: true,
status: "approved",
statuses: ["approved"],
formats: ["video", "display"]
},
sort: { field: "created_date", direction: "desc" }
Expand Down