Skip to content

Update format_id to structured object in docs #132

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 3 commits into from
Oct 17, 2025
Merged

Update format_id to structured object in docs #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d4afa6
Fix format_id structure: convert strings to structured objects
bokelley Oct 17, 2025
88e1562
Fix format_id in standard format schemas: use structured $ref
bokelley Oct 17, 2025
0d6b776
Remove redundant agent_url field from format objects
bokelley Oct 17, 2025
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
10 changes: 8 additions & 2 deletions docs/creative/asset-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,10 @@ When submitting creative assets, the orchestrator uses `asset_id` to map files:

```json
{
"format_id": "foundational_immersive_canvas",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "foundational_immersive_canvas"
},
"assets": {
"hero_image": "https://cdn.example.com/campaign123/hero.jpg",
"brand_logo": "https://cdn.example.com/brand/logo.png",
Expand All @@ -282,7 +285,10 @@ Creative formats specify their required assets using these standardized types:

```json
{
"format_id": "video_15s_hosted",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "video_15s_hosted"
},
"assets": [
{
"asset_id": "video_file",
Expand Down
5 changes: 4 additions & 1 deletion docs/creative/brand-manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,10 @@ Use brand manifest to inform creative generation:
```json
{
"message": "Create a native ad highlighting our new product launch",
"format_id": "display_native",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "display_native"
},
"brand_manifest": {
"url": "https://acmecorp.com",
"logos": [
Expand Down
35 changes: 28 additions & 7 deletions docs/creative/channels/audio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ Audio ads are typically non-skippable and play during natural content breaks.

```json
{
"format_id": "audio_30s",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "audio_30s"
},
"type": "audio",
"assets_required": [
{
Expand All @@ -45,7 +48,10 @@ Audio ads are typically non-skippable and play during natural content breaks.

```json
{
"format_id": "audio_30s_companion",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "audio_30s_companion"
},
"type": "audio",
"assets_required": [
{
Expand Down Expand Up @@ -79,7 +85,10 @@ Audio ads are typically non-skippable and play during natural content breaks.

```json
{
"format_id": "podcast_midroll_60s",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "podcast_midroll_60s"
},
"type": "audio",
"assets_required": [
{
Expand All @@ -104,7 +113,10 @@ Multi-segment audio assembled dynamically:

```json
{
"format_id": "audio_dynamic_30s",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "audio_dynamic_30s"
},
"type": "audio",
"assets_required": [
{
Expand Down Expand Up @@ -150,7 +162,10 @@ Multi-segment audio assembled dynamically:

```json
{
"format_id": "audio_30s",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "audio_30s"
},
"assets": {
"audio_file": {
"asset_type": "audio",
Expand All @@ -176,7 +191,10 @@ Multi-segment audio assembled dynamically:

```json
{
"format_id": "audio_30s_vast",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "audio_30s_vast"
},
"assets": {
"vast_url": {
"asset_type": "url",
Expand All @@ -191,7 +209,10 @@ Multi-segment audio assembled dynamically:

```json
{
"format_id": "audio_30s_companion",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "audio_30s_companion"
},
"assets": {
"audio_file": {
"asset_type": "audio",
Expand Down
45 changes: 36 additions & 9 deletions docs/creative/channels/carousels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ Carousel formats define a repeatable asset group containing the assets for each

```json
{
"format_id": "product_carousel_3_to_10",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "product_carousel_3_to_10"
},
"type": "display",
"dimensions": "300x250",
"assets_required": [
Expand Down Expand Up @@ -71,7 +74,10 @@ Carousel formats define a repeatable asset group containing the assets for each

```json
{
"format_id": "product_carousel_display",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "product_carousel_display"
},
"type": "display",
"dimensions": "300x600",
"assets_required": [
Expand Down Expand Up @@ -112,7 +118,10 @@ Carousel formats define a repeatable asset group containing the assets for each

```json
{
"format_id": "image_slideshow_5s_each",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "image_slideshow_5s_each"
},
"type": "display",
"dimensions": "728x90",
"assets_required": [
Expand Down Expand Up @@ -143,7 +152,10 @@ Carousel formats define a repeatable asset group containing the assets for each

```json
{
"format_id": "mobile_story_vertical",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "mobile_story_vertical"
},
"type": "display",
"dimensions": "1080x1920",
"assets_required": [
Expand Down Expand Up @@ -188,7 +200,10 @@ Carousel formats define a repeatable asset group containing the assets for each

```json
{
"format_id": "video_playlist_6s_bumpers",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "video_playlist_6s_bumpers"
},
"type": "video",
"assets_required": [
{
Expand Down Expand Up @@ -231,7 +246,10 @@ All assets for a given index must be provided together (you cannot have `product

```json
{
"format_id": "product_carousel_3_to_10",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "product_carousel_3_to_10"
},
"assets": {
"product_0_image": {
"asset_type": "image",
Expand Down Expand Up @@ -294,7 +312,10 @@ All assets for a given index must be provided together (you cannot have `product

```json
{
"format_id": "mobile_story_vertical",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "mobile_story_vertical"
},
"assets": {
"frame_0_background": {
"asset_type": "image",
Expand Down Expand Up @@ -508,7 +529,10 @@ https://track.brand.com/view?buy={MEDIA_BUY_ID}&item={CAROUSEL_INDEX}&total={CAR

```json
{
"format_id": "ecommerce_carousel_300x600",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "ecommerce_carousel_300x600"
},
"name": "E-commerce Product Carousel",
"type": "display",
"dimensions": "300x600",
Expand Down Expand Up @@ -566,7 +590,10 @@ https://track.brand.com/view?buy={MEDIA_BUY_ID}&item={CAROUSEL_INDEX}&total={CAR

```json
{
"format_id": "ecommerce_carousel_300x600",
"format_id": {
"agent_url": "https://creative.adcontextprotocol.org",
"id": "ecommerce_carousel_300x600"
},
"assets": {
"product_0_image": {
"asset_type": "image",
Expand Down
Loading