@adcp/sdk 16.0.0-beta.7 → 16.0.0-beta.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +3 -3
- package/README.md +20 -0
- package/bin/adcp.js +10 -13
- package/dist/lib/conformance/index.d.mts +2 -0
- package/dist/lib/conformance/index.d.ts +2 -0
- package/dist/lib/conformance/index.js +3 -0
- package/dist/lib/conformance/index.mjs +2 -0
- package/dist/lib/conformance/property-lists.d.mts +14 -0
- package/dist/lib/conformance/property-lists.d.ts +14 -0
- package/dist/lib/conformance/property-lists.js +45 -0
- package/dist/lib/conformance/property-lists.mjs +21 -0
- package/dist/lib/conformance/runConformance.js +20 -1
- package/dist/lib/conformance/runConformance.mjs +20 -1
- package/dist/lib/conformance/types.d.mts +3 -0
- package/dist/lib/conformance/types.d.ts +3 -0
- package/dist/lib/core/AgentClient.d.mts +8 -5
- package/dist/lib/core/AgentClient.d.ts +8 -5
- package/dist/lib/core/AgentClient.js +9 -4
- package/dist/lib/core/AgentClient.mjs +9 -4
- package/dist/lib/core/SingleAgentClient.d.mts +32 -115
- package/dist/lib/core/SingleAgentClient.d.ts +32 -115
- package/dist/lib/core/SingleAgentClient.js +379 -273
- package/dist/lib/core/SingleAgentClient.mjs +387 -275
- package/dist/lib/core/TaskExecutor.d.mts +1 -16
- package/dist/lib/core/TaskExecutor.d.ts +1 -16
- package/dist/lib/core/TaskExecutor.js +34 -51
- package/dist/lib/core/TaskExecutor.mjs +12 -29
- package/dist/lib/core/product-cache.d.mts +3 -1
- package/dist/lib/core/product-cache.d.ts +3 -1
- package/dist/lib/core/product-cache.js +2 -1
- package/dist/lib/core/product-cache.mjs +2 -1
- package/dist/lib/errors/index.d.mts +2 -8
- package/dist/lib/errors/index.d.ts +2 -8
- package/dist/lib/errors/index.js +4 -4
- package/dist/lib/errors/index.mjs +4 -4
- package/dist/lib/identifiers.d.mts +53 -0
- package/dist/lib/identifiers.d.ts +53 -0
- package/dist/lib/identifiers.js +212 -0
- package/dist/lib/identifiers.mjs +163 -0
- package/dist/lib/index.d.mts +7 -5
- package/dist/lib/index.d.ts +7 -5
- package/dist/lib/index.js +2 -14
- package/dist/lib/index.mjs +1 -14
- package/dist/lib/media-buy/compatibility.d.mts +1 -1
- package/dist/lib/media-buy/compatibility.d.ts +1 -1
- package/dist/lib/media-buy/compatibility.js +26 -45
- package/dist/lib/media-buy/compatibility.mjs +26 -45
- package/dist/lib/media-buy/index.d.mts +1 -1
- package/dist/lib/media-buy/index.d.ts +1 -1
- package/dist/lib/media-buy/legacy-purchase-continuation.d.mts +2 -2
- package/dist/lib/media-buy/legacy-purchase-continuation.d.ts +2 -2
- package/dist/lib/media-buy/property-policy.d.mts +15 -1
- package/dist/lib/media-buy/property-policy.d.ts +15 -1
- package/dist/lib/media-buy/property-policy.js +135 -3
- package/dist/lib/media-buy/property-policy.mjs +134 -3
- package/dist/lib/protocols/index.js +14 -22
- package/dist/lib/protocols/index.mjs +5 -13
- package/dist/lib/registry/index.d.mts +12 -0
- package/dist/lib/registry/index.d.ts +12 -0
- package/dist/lib/registry/index.js +159 -5
- package/dist/lib/registry/index.mjs +156 -4
- package/dist/lib/registry/types.d.mts +26 -2
- package/dist/lib/registry/types.d.ts +26 -2
- package/dist/lib/registry/types.generated.d.mts +51 -11
- package/dist/lib/registry/types.generated.d.ts +51 -11
- package/dist/lib/reporting/source/conformance.d.mts +8 -8
- package/dist/lib/reporting/source/conformance.d.ts +8 -8
- package/dist/lib/reporting/source/manifest.d.mts +27 -27
- package/dist/lib/reporting/source/manifest.d.ts +27 -27
- package/dist/lib/server/create-adcp-server.js +6 -0
- package/dist/lib/server/create-adcp-server.mjs +6 -0
- package/dist/lib/server/decisioning/specialisms/lists.d.mts +4 -4
- package/dist/lib/server/decisioning/specialisms/lists.d.ts +4 -4
- package/dist/lib/server/index.d.mts +3 -0
- package/dist/lib/server/index.d.ts +3 -0
- package/dist/lib/server/index.js +8 -1
- package/dist/lib/server/index.mjs +4 -0
- package/dist/lib/server/property-lists.d.mts +36 -0
- package/dist/lib/server/property-lists.d.ts +36 -0
- package/dist/lib/server/property-lists.js +154 -0
- package/dist/lib/server/property-lists.mjs +129 -0
- package/dist/lib/server/targeting-helpers.d.mts +2 -0
- package/dist/lib/server/targeting-helpers.d.ts +2 -0
- package/dist/lib/server/targeting-helpers.js +28 -1
- package/dist/lib/server/targeting-helpers.mjs +18 -1
- package/dist/lib/signing/parser.js +2 -2
- package/dist/lib/signing/parser.mjs +2 -2
- package/dist/lib/signing/server.d.mts +1 -1
- package/dist/lib/signing/server.d.ts +1 -1
- package/dist/lib/signing/server.mjs +5 -1
- package/dist/lib/signing/webhook-verifier.d.mts +11 -0
- package/dist/lib/signing/webhook-verifier.d.ts +11 -0
- package/dist/lib/signing/webhook-verifier.js +11 -3
- package/dist/lib/signing/webhook-verifier.mjs +11 -3
- package/dist/lib/supply-path/verify.js +12 -2
- package/dist/lib/supply-path/verify.mjs +2 -2
- package/dist/lib/testing/compliance/comply.js +0 -8
- package/dist/lib/testing/compliance/comply.mjs +0 -8
- package/dist/lib/testing/compliance/storyboard-tracks.js +11 -0
- package/dist/lib/testing/compliance/storyboard-tracks.mjs +11 -0
- package/dist/lib/testing/index.d.mts +2 -0
- package/dist/lib/testing/index.d.ts +2 -0
- package/dist/lib/testing/index.js +5 -0
- package/dist/lib/testing/index.mjs +3 -0
- package/dist/lib/testing/scenarios/capabilities.d.mts +2 -2
- package/dist/lib/testing/scenarios/capabilities.d.ts +2 -2
- package/dist/lib/testing/scenarios/capabilities.js +8 -41
- package/dist/lib/testing/scenarios/capabilities.mjs +9 -42
- package/dist/lib/testing/storyboard/creative-build-probe.d.mts +34 -0
- package/dist/lib/testing/storyboard/creative-build-probe.d.ts +34 -0
- package/dist/lib/testing/storyboard/creative-build-probe.js +395 -0
- package/dist/lib/testing/storyboard/creative-build-probe.mjs +373 -0
- package/dist/lib/testing/storyboard/index.d.mts +2 -0
- package/dist/lib/testing/storyboard/index.d.ts +2 -0
- package/dist/lib/testing/storyboard/index.js +5 -0
- package/dist/lib/testing/storyboard/index.mjs +3 -0
- package/dist/lib/testing/storyboard/loader.js +12 -0
- package/dist/lib/testing/storyboard/loader.mjs +12 -0
- package/dist/lib/testing/storyboard/property-list-reference.d.mts +15 -0
- package/dist/lib/testing/storyboard/property-list-reference.d.ts +15 -0
- package/dist/lib/testing/storyboard/property-list-reference.js +514 -0
- package/dist/lib/testing/storyboard/property-list-reference.mjs +487 -0
- package/dist/lib/testing/storyboard/runner.js +318 -58
- package/dist/lib/testing/storyboard/runner.mjs +322 -58
- package/dist/lib/testing/storyboard/types.d.mts +38 -16
- package/dist/lib/testing/storyboard/types.d.ts +38 -16
- package/dist/lib/testing/storyboard/types.js +1 -0
- package/dist/lib/testing/storyboard/types.mjs +1 -0
- package/dist/lib/testing/storyboard/validations.d.mts +1 -1
- package/dist/lib/testing/storyboard/validations.d.ts +1 -1
- package/dist/lib/testing/storyboard/validations.js +64 -0
- package/dist/lib/testing/storyboard/validations.mjs +67 -1
- package/dist/lib/testing/types.d.mts +15 -1
- package/dist/lib/testing/types.d.ts +15 -1
- package/dist/lib/types/schemas.generated.d.ts +65 -65
- package/dist/lib/types/wellknown-schemas.generated.d.mts +21 -21
- package/dist/lib/types/wellknown-schemas.generated.d.ts +21 -21
- package/dist/lib/utils/adcp-version-config.js +6 -0
- package/dist/lib/utils/adcp-version-config.mjs +6 -0
- package/dist/lib/utils/capabilities.d.mts +7 -9
- package/dist/lib/utils/capabilities.d.ts +7 -9
- package/dist/lib/utils/capabilities.js +14 -28
- package/dist/lib/utils/capabilities.mjs +14 -27
- package/dist/lib/utils/creative-adapter.d.mts +15 -113
- package/dist/lib/utils/creative-adapter.d.ts +15 -113
- package/dist/lib/utils/creative-adapter.js +7 -106
- package/dist/lib/utils/creative-adapter.mjs +7 -102
- package/dist/lib/utils/format-renders.d.mts +20 -80
- package/dist/lib/utils/format-renders.d.ts +20 -80
- package/dist/lib/utils/format-renders.js +7 -67
- package/dist/lib/utils/format-renders.mjs +7 -66
- package/dist/lib/utils/index.d.mts +1 -2
- package/dist/lib/utils/index.d.ts +1 -2
- package/dist/lib/utils/index.js +0 -7
- package/dist/lib/utils/index.mjs +0 -6
- package/dist/lib/utils/preview-normalizer.d.mts +31 -80
- package/dist/lib/utils/preview-normalizer.d.ts +31 -80
- package/dist/lib/utils/preview-normalizer.js +5 -50
- package/dist/lib/utils/preview-normalizer.mjs +5 -49
- package/dist/lib/utils/pricing-adapter.d.mts +2 -36
- package/dist/lib/utils/pricing-adapter.d.ts +2 -36
- package/dist/lib/utils/pricing-adapter.js +0 -105
- package/dist/lib/utils/pricing-adapter.mjs +0 -100
- package/dist/lib/utils/request-normalizer.d.mts +1 -2
- package/dist/lib/utils/request-normalizer.d.ts +1 -2
- package/dist/lib/v2/projection/creative-delivery.d.mts +2 -0
- package/dist/lib/v2/projection/creative-delivery.d.ts +2 -0
- package/dist/lib/v2/projection/creative-delivery.js +7 -0
- package/dist/lib/v2/projection/creative-delivery.mjs +6 -0
- package/dist/lib/v2/projection/legacy-metadata.d.mts +12 -0
- package/dist/lib/v2/projection/legacy-metadata.d.ts +12 -0
- package/dist/lib/v2/projection/legacy-metadata.js +41 -1
- package/dist/lib/v2/projection/legacy-metadata.mjs +37 -1
- package/dist/lib/v2/projection/legacy-normalization.d.mts +1 -1
- package/dist/lib/v2/projection/legacy-normalization.d.ts +1 -1
- package/dist/lib/v2/projection/v1-to-v2.js +13 -0
- package/dist/lib/v2/projection/v1-to-v2.mjs +14 -0
- package/dist/lib/validation/client-hooks.d.mts +1 -4
- package/dist/lib/validation/client-hooks.d.ts +1 -4
- package/dist/lib/validation/get-products-request.d.mts +1 -1
- package/dist/lib/validation/get-products-request.d.ts +1 -1
- package/dist/lib/validation/schema-loader.js +6 -0
- package/dist/lib/validation/schema-loader.mjs +6 -0
- package/dist/lib/validation/schema-validator.js +1 -26
- package/dist/lib/validation/schema-validator.mjs +1 -26
- package/dist/lib/version.d.mts +5 -5
- package/dist/lib/version.d.ts +5 -5
- package/dist/lib/version.js +3 -5
- package/dist/lib/version.mjs +3 -5
- package/docs/TYPE-SUMMARY.md +2 -2
- package/docs/development/PROTOCOL_DIFFERENCES.md +1 -1
- package/docs/guides/CONFORMANCE.md +25 -0
- package/docs/guides/CREATIVE-BUILD-PROBE.md +156 -0
- package/docs/guides/CREATIVE-DELIVERY.md +45 -6
- package/docs/guides/MEDIA-BUY-3.2-COMPATIBILITY.md +15 -18
- package/docs/guides/PROPERTY-LISTS.md +264 -0
- package/docs/guides/SIGNING-GUIDE.md +25 -0
- package/docs/guides/VALIDATE-YOUR-AGENT.md +5 -0
- package/docs/llms.txt +2 -2
- package/docs/migration-13-to-14.md +20 -16
- package/docs/migration-14.x-rc-worksheet.md +5 -5
- package/docs/migration-4.x-to-5.x.md +12 -7
- package/docs/migration-drop-adcp-2.md +25 -0
- package/package.json +3 -18
- package/skills/call-adcp-agent/SKILL.md +23 -25
- package/dist/lib/adapters/legacy/v2-5/create_media_buy.d.mts +0 -3
- package/dist/lib/adapters/legacy/v2-5/create_media_buy.d.ts +0 -3
- package/dist/lib/adapters/legacy/v2-5/create_media_buy.js +0 -33
- package/dist/lib/adapters/legacy/v2-5/create_media_buy.mjs +0 -9
- package/dist/lib/adapters/legacy/v2-5/get_products.d.mts +0 -8
- package/dist/lib/adapters/legacy/v2-5/get_products.d.ts +0 -8
- package/dist/lib/adapters/legacy/v2-5/get_products.js +0 -33
- package/dist/lib/adapters/legacy/v2-5/get_products.mjs +0 -9
- package/dist/lib/adapters/legacy/v2-5/index.d.mts +0 -34
- package/dist/lib/adapters/legacy/v2-5/index.d.ts +0 -34
- package/dist/lib/adapters/legacy/v2-5/index.js +0 -50
- package/dist/lib/adapters/legacy/v2-5/index.mjs +0 -25
- package/dist/lib/adapters/legacy/v2-5/list_creative_formats.d.mts +0 -8
- package/dist/lib/adapters/legacy/v2-5/list_creative_formats.d.ts +0 -8
- package/dist/lib/adapters/legacy/v2-5/list_creative_formats.js +0 -33
- package/dist/lib/adapters/legacy/v2-5/list_creative_formats.mjs +0 -9
- package/dist/lib/adapters/legacy/v2-5/preview_creative.d.mts +0 -3
- package/dist/lib/adapters/legacy/v2-5/preview_creative.d.ts +0 -3
- package/dist/lib/adapters/legacy/v2-5/preview_creative.js +0 -33
- package/dist/lib/adapters/legacy/v2-5/preview_creative.mjs +0 -9
- package/dist/lib/adapters/legacy/v2-5/sync_creatives.d.mts +0 -11
- package/dist/lib/adapters/legacy/v2-5/sync_creatives.d.ts +0 -11
- package/dist/lib/adapters/legacy/v2-5/sync_creatives.js +0 -32
- package/dist/lib/adapters/legacy/v2-5/sync_creatives.mjs +0 -8
- package/dist/lib/adapters/legacy/v2-5/types.d.mts +0 -39
- package/dist/lib/adapters/legacy/v2-5/types.d.ts +0 -39
- package/dist/lib/adapters/legacy/v2-5/types.js +0 -16
- package/dist/lib/adapters/legacy/v2-5/types.mjs +0 -0
- package/dist/lib/adapters/legacy/v2-5/update_media_buy.d.mts +0 -3
- package/dist/lib/adapters/legacy/v2-5/update_media_buy.d.ts +0 -3
- package/dist/lib/adapters/legacy/v2-5/update_media_buy.js +0 -35
- package/dist/lib/adapters/legacy/v2-5/update_media_buy.mjs +0 -11
- package/dist/lib/schemas-data/v2.5/_provenance.json +0 -8
- package/dist/lib/schemas-data/v2.5/adagents.json +0 -494
- package/dist/lib/schemas-data/v2.5/core/activation-key.json +0 -50
- package/dist/lib/schemas-data/v2.5/core/assets/audio-asset.json +0 -32
- package/dist/lib/schemas-data/v2.5/core/assets/css-asset.json +0 -21
- package/dist/lib/schemas-data/v2.5/core/assets/daast-asset.json +0 -87
- package/dist/lib/schemas-data/v2.5/core/assets/html-asset.json +0 -21
- package/dist/lib/schemas-data/v2.5/core/assets/image-asset.json +0 -38
- package/dist/lib/schemas-data/v2.5/core/assets/javascript-asset.json +0 -21
- package/dist/lib/schemas-data/v2.5/core/assets/markdown-asset.json +0 -31
- package/dist/lib/schemas-data/v2.5/core/assets/text-asset.json +0 -21
- package/dist/lib/schemas-data/v2.5/core/assets/url-asset.json +0 -26
- package/dist/lib/schemas-data/v2.5/core/assets/vast-asset.json +0 -87
- package/dist/lib/schemas-data/v2.5/core/assets/video-asset.json +0 -44
- package/dist/lib/schemas-data/v2.5/core/assets/webhook-asset.json +0 -71
- package/dist/lib/schemas-data/v2.5/core/async-response-data.json +0 -88
- package/dist/lib/schemas-data/v2.5/core/brand-manifest-ref.json +0 -33
- package/dist/lib/schemas-data/v2.5/core/brand-manifest.json +0 -409
- package/dist/lib/schemas-data/v2.5/core/context.json +0 -8
- package/dist/lib/schemas-data/v2.5/core/creative-asset.json +0 -125
- package/dist/lib/schemas-data/v2.5/core/creative-assignment.json +0 -31
- package/dist/lib/schemas-data/v2.5/core/creative-filters.json +0 -111
- package/dist/lib/schemas-data/v2.5/core/creative-manifest.json +0 -72
- package/dist/lib/schemas-data/v2.5/core/creative-policy.json +0 -27
- package/dist/lib/schemas-data/v2.5/core/delivery-metrics.json +0 -171
- package/dist/lib/schemas-data/v2.5/core/deployment.json +0 -93
- package/dist/lib/schemas-data/v2.5/core/destination.json +0 -53
- package/dist/lib/schemas-data/v2.5/core/error.json +0 -40
- package/dist/lib/schemas-data/v2.5/core/ext.json +0 -8
- package/dist/lib/schemas-data/v2.5/core/format-id.json +0 -47
- package/dist/lib/schemas-data/v2.5/core/format.json +0 -324
- package/dist/lib/schemas-data/v2.5/core/frequency-cap.json +0 -18
- package/dist/lib/schemas-data/v2.5/core/mcp-webhook-payload.json +0 -152
- package/dist/lib/schemas-data/v2.5/core/measurement.json +0 -48
- package/dist/lib/schemas-data/v2.5/core/media-buy.json +0 -62
- package/dist/lib/schemas-data/v2.5/core/package.json +0 -72
- package/dist/lib/schemas-data/v2.5/core/performance-feedback.json +0 -90
- package/dist/lib/schemas-data/v2.5/core/placement.json +0 -34
- package/dist/lib/schemas-data/v2.5/core/pricing-option.json +0 -35
- package/dist/lib/schemas-data/v2.5/core/product-filters.json +0 -102
- package/dist/lib/schemas-data/v2.5/core/product.json +0 -153
- package/dist/lib/schemas-data/v2.5/core/promoted-offerings.json +0 -115
- package/dist/lib/schemas-data/v2.5/core/promoted-products.json +0 -67
- package/dist/lib/schemas-data/v2.5/core/property-id.json +0 -14
- package/dist/lib/schemas-data/v2.5/core/property-tag.json +0 -16
- package/dist/lib/schemas-data/v2.5/core/property.json +0 -62
- package/dist/lib/schemas-data/v2.5/core/protocol-envelope.json +0 -146
- package/dist/lib/schemas-data/v2.5/core/publisher-property-selector.json +0 -92
- package/dist/lib/schemas-data/v2.5/core/push-notification-config.json +0 -48
- package/dist/lib/schemas-data/v2.5/core/reporting-capabilities.json +0 -71
- package/dist/lib/schemas-data/v2.5/core/response.json +0 -24
- package/dist/lib/schemas-data/v2.5/core/signal-filters.json +0 -35
- package/dist/lib/schemas-data/v2.5/core/start-timing.json +0 -18
- package/dist/lib/schemas-data/v2.5/core/sub-asset.json +0 -79
- package/dist/lib/schemas-data/v2.5/core/targeting.json +0 -50
- package/dist/lib/schemas-data/v2.5/core/tasks-get-request.json +0 -43
- package/dist/lib/schemas-data/v2.5/core/tasks-get-response.json +0 -166
- package/dist/lib/schemas-data/v2.5/core/tasks-list-request.json +0 -192
- package/dist/lib/schemas-data/v2.5/core/tasks-list-response.json +0 -183
- package/dist/lib/schemas-data/v2.5/creative/asset-types/index.json +0 -101
- package/dist/lib/schemas-data/v2.5/creative/list-creative-formats-request.json +0 -73
- package/dist/lib/schemas-data/v2.5/creative/list-creative-formats-response.json +0 -61
- package/dist/lib/schemas-data/v2.5/creative/preview-creative-request.json +0 -164
- package/dist/lib/schemas-data/v2.5/creative/preview-creative-response.json +0 -245
- package/dist/lib/schemas-data/v2.5/creative/preview-render.json +0 -225
- package/dist/lib/schemas-data/v2.5/enums/adcp-domain.json +0 -11
- package/dist/lib/schemas-data/v2.5/enums/asset-content-type.json +0 -22
- package/dist/lib/schemas-data/v2.5/enums/auth-scheme.json +0 -11
- package/dist/lib/schemas-data/v2.5/enums/available-metric.json +0 -18
- package/dist/lib/schemas-data/v2.5/enums/channels.json +0 -18
- package/dist/lib/schemas-data/v2.5/enums/co-branding-requirement.json +0 -12
- package/dist/lib/schemas-data/v2.5/enums/creative-action.json +0 -14
- package/dist/lib/schemas-data/v2.5/enums/creative-agent-capability.json +0 -13
- package/dist/lib/schemas-data/v2.5/enums/creative-sort-field.json +0 -15
- package/dist/lib/schemas-data/v2.5/enums/creative-status.json +0 -19
- package/dist/lib/schemas-data/v2.5/enums/daast-tracking-event.json +0 -20
- package/dist/lib/schemas-data/v2.5/enums/daast-version.json +0 -11
- package/dist/lib/schemas-data/v2.5/enums/delivery-type.json +0 -15
- package/dist/lib/schemas-data/v2.5/enums/dimension-unit.json +0 -13
- package/dist/lib/schemas-data/v2.5/enums/feed-format.json +0 -12
- package/dist/lib/schemas-data/v2.5/enums/feedback-source.json +0 -13
- package/dist/lib/schemas-data/v2.5/enums/format-category.json +0 -16
- package/dist/lib/schemas-data/v2.5/enums/format-id-parameter.json +0 -11
- package/dist/lib/schemas-data/v2.5/enums/frequency-cap-scope.json +0 -13
- package/dist/lib/schemas-data/v2.5/enums/history-entry-type.json +0 -11
- package/dist/lib/schemas-data/v2.5/enums/http-method.json +0 -11
- package/dist/lib/schemas-data/v2.5/enums/identifier-types.json +0 -34
- package/dist/lib/schemas-data/v2.5/enums/javascript-module-type.json +0 -12
- package/dist/lib/schemas-data/v2.5/enums/landing-page-requirement.json +0 -12
- package/dist/lib/schemas-data/v2.5/enums/markdown-flavor.json +0 -11
- package/dist/lib/schemas-data/v2.5/enums/media-buy-status.json +0 -19
- package/dist/lib/schemas-data/v2.5/enums/metric-type.json +0 -17
- package/dist/lib/schemas-data/v2.5/enums/notification-type.json +0 -13
- package/dist/lib/schemas-data/v2.5/enums/pacing.json +0 -17
- package/dist/lib/schemas-data/v2.5/enums/preview-output-format.json +0 -11
- package/dist/lib/schemas-data/v2.5/enums/pricing-model.json +0 -25
- package/dist/lib/schemas-data/v2.5/enums/property-type.json +0 -16
- package/dist/lib/schemas-data/v2.5/enums/publisher-identifier-types.json +0 -19
- package/dist/lib/schemas-data/v2.5/enums/reporting-frequency.json +0 -12
- package/dist/lib/schemas-data/v2.5/enums/signal-catalog-type.json +0 -12
- package/dist/lib/schemas-data/v2.5/enums/sort-direction.json +0 -11
- package/dist/lib/schemas-data/v2.5/enums/standard-format-ids.json +0 -103
- package/dist/lib/schemas-data/v2.5/enums/task-status.json +0 -29
- package/dist/lib/schemas-data/v2.5/enums/task-type.json +0 -27
- package/dist/lib/schemas-data/v2.5/enums/update-frequency.json +0 -13
- package/dist/lib/schemas-data/v2.5/enums/url-asset-type.json +0 -12
- package/dist/lib/schemas-data/v2.5/enums/validation-mode.json +0 -11
- package/dist/lib/schemas-data/v2.5/enums/vast-tracking-event.json +0 -25
- package/dist/lib/schemas-data/v2.5/enums/vast-version.json +0 -14
- package/dist/lib/schemas-data/v2.5/enums/webhook-response-type.json +0 -13
- package/dist/lib/schemas-data/v2.5/enums/webhook-security-method.json +0 -12
- package/dist/lib/schemas-data/v2.5/index.json +0 -604
- package/dist/lib/schemas-data/v2.5/media-buy/build-creative-request.json +0 -31
- package/dist/lib/schemas-data/v2.5/media-buy/build-creative-response.json +0 -65
- package/dist/lib/schemas-data/v2.5/media-buy/create-media-buy-async-response-input-required.json +0 -31
- package/dist/lib/schemas-data/v2.5/media-buy/create-media-buy-async-response-submitted.json +0 -16
- package/dist/lib/schemas-data/v2.5/media-buy/create-media-buy-async-response-working.json +0 -36
- package/dist/lib/schemas-data/v2.5/media-buy/create-media-buy-request.json +0 -126
- package/dist/lib/schemas-data/v2.5/media-buy/create-media-buy-response.json +0 -97
- package/dist/lib/schemas-data/v2.5/media-buy/get-media-buy-delivery-request.json +0 -54
- package/dist/lib/schemas-data/v2.5/media-buy/get-media-buy-delivery-response.json +0 -285
- package/dist/lib/schemas-data/v2.5/media-buy/get-products-async-response-input-required.json +0 -38
- package/dist/lib/schemas-data/v2.5/media-buy/get-products-async-response-submitted.json +0 -21
- package/dist/lib/schemas-data/v2.5/media-buy/get-products-async-response-working.json +0 -34
- package/dist/lib/schemas-data/v2.5/media-buy/get-products-request.json +0 -28
- package/dist/lib/schemas-data/v2.5/media-buy/get-products-response.json +0 -33
- package/dist/lib/schemas-data/v2.5/media-buy/list-authorized-properties-request.json +0 -26
- package/dist/lib/schemas-data/v2.5/media-buy/list-authorized-properties-response.json +0 -70
- package/dist/lib/schemas-data/v2.5/media-buy/list-creative-formats-request.json +0 -58
- package/dist/lib/schemas-data/v2.5/media-buy/list-creative-formats-response.json +0 -61
- package/dist/lib/schemas-data/v2.5/media-buy/list-creatives-request.json +0 -137
- package/dist/lib/schemas-data/v2.5/media-buy/list-creatives-response.json +0 -437
- package/dist/lib/schemas-data/v2.5/media-buy/package-request.json +0 -80
- package/dist/lib/schemas-data/v2.5/media-buy/provide-performance-feedback-request.json +0 -88
- package/dist/lib/schemas-data/v2.5/media-buy/provide-performance-feedback-response.json +0 -66
- package/dist/lib/schemas-data/v2.5/media-buy/sync-creatives-async-response-input-required.json +0 -25
- package/dist/lib/schemas-data/v2.5/media-buy/sync-creatives-async-response-submitted.json +0 -16
- package/dist/lib/schemas-data/v2.5/media-buy/sync-creatives-async-response-working.json +0 -46
- package/dist/lib/schemas-data/v2.5/media-buy/sync-creatives-request.json +0 -178
- package/dist/lib/schemas-data/v2.5/media-buy/sync-creatives-response.json +0 -149
- package/dist/lib/schemas-data/v2.5/media-buy/update-media-buy-async-response-input-required.json +0 -24
- package/dist/lib/schemas-data/v2.5/media-buy/update-media-buy-async-response-submitted.json +0 -16
- package/dist/lib/schemas-data/v2.5/media-buy/update-media-buy-async-response-working.json +0 -36
- package/dist/lib/schemas-data/v2.5/media-buy/update-media-buy-request.json +0 -129
- package/dist/lib/schemas-data/v2.5/media-buy/update-media-buy-response.json +0 -99
- package/dist/lib/schemas-data/v2.5/pricing-options/cpc-option.json +0 -52
- package/dist/lib/schemas-data/v2.5/pricing-options/cpcv-option.json +0 -52
- package/dist/lib/schemas-data/v2.5/pricing-options/cpm-auction-option.json +0 -81
- package/dist/lib/schemas-data/v2.5/pricing-options/cpm-fixed-option.json +0 -52
- package/dist/lib/schemas-data/v2.5/pricing-options/cpp-option.json +0 -73
- package/dist/lib/schemas-data/v2.5/pricing-options/cpv-option.json +0 -88
- package/dist/lib/schemas-data/v2.5/pricing-options/flat-rate-option.json +0 -93
- package/dist/lib/schemas-data/v2.5/pricing-options/vcpm-auction-option.json +0 -81
- package/dist/lib/schemas-data/v2.5/pricing-options/vcpm-fixed-option.json +0 -52
- package/dist/lib/schemas-data/v2.5/protocols/adcp-extension.json +0 -33
- package/dist/lib/schemas-data/v2.5/signals/activate-signal-request.json +0 -32
- package/dist/lib/schemas-data/v2.5/signals/activate-signal-response.json +0 -68
- package/dist/lib/schemas-data/v2.5/signals/get-signals-request.json +0 -59
- package/dist/lib/schemas-data/v2.5/signals/get-signals-response.json +0 -100
- package/dist/lib/types/v2-5/index.d.mts +0 -1
- package/dist/lib/types/v2-5/index.d.ts +0 -1
- package/dist/lib/types/v2-5/index.js +0 -22
- package/dist/lib/types/v2-5/index.mjs +0 -1
- package/dist/lib/types/v2-5/tools.generated.d.mts +0 -3568
- package/dist/lib/types/v2-5/tools.generated.d.ts +0 -3568
- package/dist/lib/types/v2-5/tools.generated.js +0 -16
- package/dist/lib/types/v2-5/tools.generated.mjs +0 -0
- package/dist/lib/utils/sync-creatives-adapter.d.mts +0 -33
- package/dist/lib/utils/sync-creatives-adapter.d.ts +0 -33
- package/dist/lib/utils/sync-creatives-adapter.js +0 -83
- package/dist/lib/utils/sync-creatives-adapter.mjs +0 -59
|
@@ -1,137 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"$id": "/schemas/media-buy/list-creatives-request.json",
|
|
4
|
-
"title": "List Creatives Request",
|
|
5
|
-
"description": "Request parameters for querying creative assets from the centralized library with filtering, sorting, and pagination",
|
|
6
|
-
"type": "object",
|
|
7
|
-
"properties": {
|
|
8
|
-
"filters": {
|
|
9
|
-
"$ref": "/schemas/core/creative-filters.json"
|
|
10
|
-
},
|
|
11
|
-
"sort": {
|
|
12
|
-
"type": "object",
|
|
13
|
-
"description": "Sorting parameters",
|
|
14
|
-
"properties": {
|
|
15
|
-
"field": {
|
|
16
|
-
"$ref": "/schemas/enums/creative-sort-field.json",
|
|
17
|
-
"default": "created_date",
|
|
18
|
-
"description": "Field to sort by"
|
|
19
|
-
},
|
|
20
|
-
"direction": {
|
|
21
|
-
"$ref": "/schemas/enums/sort-direction.json",
|
|
22
|
-
"default": "desc",
|
|
23
|
-
"description": "Sort direction"
|
|
24
|
-
}
|
|
25
|
-
},
|
|
26
|
-
"additionalProperties": true
|
|
27
|
-
},
|
|
28
|
-
"pagination": {
|
|
29
|
-
"type": "object",
|
|
30
|
-
"description": "Pagination parameters",
|
|
31
|
-
"properties": {
|
|
32
|
-
"limit": {
|
|
33
|
-
"type": "integer",
|
|
34
|
-
"minimum": 1,
|
|
35
|
-
"maximum": 100,
|
|
36
|
-
"default": 50,
|
|
37
|
-
"description": "Maximum number of creatives to return"
|
|
38
|
-
},
|
|
39
|
-
"offset": {
|
|
40
|
-
"type": "integer",
|
|
41
|
-
"minimum": 0,
|
|
42
|
-
"default": 0,
|
|
43
|
-
"description": "Number of creatives to skip"
|
|
44
|
-
}
|
|
45
|
-
},
|
|
46
|
-
"additionalProperties": true
|
|
47
|
-
},
|
|
48
|
-
"include_assignments": {
|
|
49
|
-
"type": "boolean",
|
|
50
|
-
"default": true,
|
|
51
|
-
"description": "Include package assignment information in response"
|
|
52
|
-
},
|
|
53
|
-
"include_performance": {
|
|
54
|
-
"type": "boolean",
|
|
55
|
-
"default": false,
|
|
56
|
-
"description": "Include aggregated performance metrics in response"
|
|
57
|
-
},
|
|
58
|
-
"include_sub_assets": {
|
|
59
|
-
"type": "boolean",
|
|
60
|
-
"default": false,
|
|
61
|
-
"description": "Include sub-assets (for carousel/native formats) in response"
|
|
62
|
-
},
|
|
63
|
-
"fields": {
|
|
64
|
-
"type": "array",
|
|
65
|
-
"description": "Specific fields to include in response (omit for all fields)",
|
|
66
|
-
"items": {
|
|
67
|
-
"type": "string",
|
|
68
|
-
"enum": [
|
|
69
|
-
"creative_id",
|
|
70
|
-
"name",
|
|
71
|
-
"format",
|
|
72
|
-
"status",
|
|
73
|
-
"created_date",
|
|
74
|
-
"updated_date",
|
|
75
|
-
"tags",
|
|
76
|
-
"assignments",
|
|
77
|
-
"performance",
|
|
78
|
-
"sub_assets"
|
|
79
|
-
]
|
|
80
|
-
}
|
|
81
|
-
},
|
|
82
|
-
"context": {
|
|
83
|
-
"$ref": "/schemas/core/context.json"
|
|
84
|
-
},
|
|
85
|
-
"ext": {
|
|
86
|
-
"$ref": "/schemas/core/ext.json"
|
|
87
|
-
}
|
|
88
|
-
},
|
|
89
|
-
"additionalProperties": true,
|
|
90
|
-
"examples": [
|
|
91
|
-
{
|
|
92
|
-
"description": "List all approved video creatives",
|
|
93
|
-
"data": {
|
|
94
|
-
"filters": {
|
|
95
|
-
"format": "video",
|
|
96
|
-
"status": "approved"
|
|
97
|
-
}
|
|
98
|
-
}
|
|
99
|
-
},
|
|
100
|
-
{
|
|
101
|
-
"description": "Search for Nike creatives with performance data",
|
|
102
|
-
"data": {
|
|
103
|
-
"filters": {
|
|
104
|
-
"name_contains": "nike",
|
|
105
|
-
"has_performance_data": true
|
|
106
|
-
},
|
|
107
|
-
"include_performance": true
|
|
108
|
-
}
|
|
109
|
-
},
|
|
110
|
-
{
|
|
111
|
-
"description": "Get unassigned creatives for assignment",
|
|
112
|
-
"data": {
|
|
113
|
-
"filters": {
|
|
114
|
-
"unassigned": true
|
|
115
|
-
},
|
|
116
|
-
"sort": {
|
|
117
|
-
"field": "created_date",
|
|
118
|
-
"direction": "desc"
|
|
119
|
-
},
|
|
120
|
-
"pagination": {
|
|
121
|
-
"limit": 20
|
|
122
|
-
}
|
|
123
|
-
}
|
|
124
|
-
},
|
|
125
|
-
{
|
|
126
|
-
"description": "Lightweight list with minimal fields",
|
|
127
|
-
"data": {
|
|
128
|
-
"fields": [
|
|
129
|
-
"creative_id",
|
|
130
|
-
"name",
|
|
131
|
-
"status"
|
|
132
|
-
],
|
|
133
|
-
"include_assignments": false
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
]
|
|
137
|
-
}
|
|
@@ -1,437 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"$id": "/schemas/media-buy/list-creatives-response.json",
|
|
4
|
-
"title": "List Creatives Response",
|
|
5
|
-
"description": "Response from creative library query with filtered results, metadata, and optional enriched data",
|
|
6
|
-
"type": "object",
|
|
7
|
-
"properties": {
|
|
8
|
-
"query_summary": {
|
|
9
|
-
"type": "object",
|
|
10
|
-
"description": "Summary of the query that was executed",
|
|
11
|
-
"properties": {
|
|
12
|
-
"total_matching": {
|
|
13
|
-
"type": "integer",
|
|
14
|
-
"description": "Total number of creatives matching filters (across all pages)",
|
|
15
|
-
"minimum": 0
|
|
16
|
-
},
|
|
17
|
-
"returned": {
|
|
18
|
-
"type": "integer",
|
|
19
|
-
"description": "Number of creatives returned in this response",
|
|
20
|
-
"minimum": 0
|
|
21
|
-
},
|
|
22
|
-
"filters_applied": {
|
|
23
|
-
"type": "array",
|
|
24
|
-
"description": "List of filters that were applied to the query",
|
|
25
|
-
"items": {
|
|
26
|
-
"type": "string"
|
|
27
|
-
}
|
|
28
|
-
},
|
|
29
|
-
"sort_applied": {
|
|
30
|
-
"type": "object",
|
|
31
|
-
"description": "Sort order that was applied",
|
|
32
|
-
"properties": {
|
|
33
|
-
"field": {
|
|
34
|
-
"type": "string"
|
|
35
|
-
},
|
|
36
|
-
"direction": {
|
|
37
|
-
"$ref": "/schemas/enums/sort-direction.json"
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
},
|
|
42
|
-
"required": [
|
|
43
|
-
"total_matching",
|
|
44
|
-
"returned"
|
|
45
|
-
],
|
|
46
|
-
"additionalProperties": true
|
|
47
|
-
},
|
|
48
|
-
"pagination": {
|
|
49
|
-
"type": "object",
|
|
50
|
-
"description": "Pagination information for navigating results",
|
|
51
|
-
"properties": {
|
|
52
|
-
"limit": {
|
|
53
|
-
"type": "integer",
|
|
54
|
-
"description": "Maximum number of results requested",
|
|
55
|
-
"minimum": 1
|
|
56
|
-
},
|
|
57
|
-
"offset": {
|
|
58
|
-
"type": "integer",
|
|
59
|
-
"description": "Number of results skipped",
|
|
60
|
-
"minimum": 0
|
|
61
|
-
},
|
|
62
|
-
"has_more": {
|
|
63
|
-
"type": "boolean",
|
|
64
|
-
"description": "Whether more results are available"
|
|
65
|
-
},
|
|
66
|
-
"total_pages": {
|
|
67
|
-
"type": "integer",
|
|
68
|
-
"description": "Total number of pages available",
|
|
69
|
-
"minimum": 0
|
|
70
|
-
},
|
|
71
|
-
"current_page": {
|
|
72
|
-
"type": "integer",
|
|
73
|
-
"description": "Current page number (1-based)",
|
|
74
|
-
"minimum": 1
|
|
75
|
-
}
|
|
76
|
-
},
|
|
77
|
-
"required": [
|
|
78
|
-
"limit",
|
|
79
|
-
"offset",
|
|
80
|
-
"has_more"
|
|
81
|
-
],
|
|
82
|
-
"additionalProperties": true
|
|
83
|
-
},
|
|
84
|
-
"creatives": {
|
|
85
|
-
"type": "array",
|
|
86
|
-
"description": "Array of creative assets matching the query",
|
|
87
|
-
"items": {
|
|
88
|
-
"type": "object",
|
|
89
|
-
"properties": {
|
|
90
|
-
"creative_id": {
|
|
91
|
-
"type": "string",
|
|
92
|
-
"description": "Unique identifier for the creative"
|
|
93
|
-
},
|
|
94
|
-
"name": {
|
|
95
|
-
"type": "string",
|
|
96
|
-
"description": "Human-readable creative name"
|
|
97
|
-
},
|
|
98
|
-
"format_id": {
|
|
99
|
-
"$ref": "/schemas/core/format-id.json",
|
|
100
|
-
"description": "Format identifier specifying which format this creative conforms to"
|
|
101
|
-
},
|
|
102
|
-
"status": {
|
|
103
|
-
"$ref": "/schemas/enums/creative-status.json",
|
|
104
|
-
"description": "Current approval status of the creative"
|
|
105
|
-
},
|
|
106
|
-
"created_date": {
|
|
107
|
-
"type": "string",
|
|
108
|
-
"format": "date-time",
|
|
109
|
-
"description": "When the creative was uploaded to the library"
|
|
110
|
-
},
|
|
111
|
-
"updated_date": {
|
|
112
|
-
"type": "string",
|
|
113
|
-
"format": "date-time",
|
|
114
|
-
"description": "When the creative was last modified"
|
|
115
|
-
},
|
|
116
|
-
"assets": {
|
|
117
|
-
"type": "object",
|
|
118
|
-
"description": "Assets for this creative, keyed by asset_role",
|
|
119
|
-
"patternProperties": {
|
|
120
|
-
"^[a-zA-Z0-9_-]+$": {
|
|
121
|
-
"oneOf": [
|
|
122
|
-
{
|
|
123
|
-
"$ref": "/schemas/core/assets/image-asset.json"
|
|
124
|
-
},
|
|
125
|
-
{
|
|
126
|
-
"$ref": "/schemas/core/assets/video-asset.json"
|
|
127
|
-
},
|
|
128
|
-
{
|
|
129
|
-
"$ref": "/schemas/core/assets/audio-asset.json"
|
|
130
|
-
},
|
|
131
|
-
{
|
|
132
|
-
"$ref": "/schemas/core/assets/text-asset.json"
|
|
133
|
-
},
|
|
134
|
-
{
|
|
135
|
-
"$ref": "/schemas/core/assets/html-asset.json"
|
|
136
|
-
},
|
|
137
|
-
{
|
|
138
|
-
"$ref": "/schemas/core/assets/css-asset.json"
|
|
139
|
-
},
|
|
140
|
-
{
|
|
141
|
-
"$ref": "/schemas/core/assets/javascript-asset.json"
|
|
142
|
-
},
|
|
143
|
-
{
|
|
144
|
-
"$ref": "/schemas/core/assets/vast-asset.json"
|
|
145
|
-
},
|
|
146
|
-
{
|
|
147
|
-
"$ref": "/schemas/core/assets/daast-asset.json"
|
|
148
|
-
},
|
|
149
|
-
{
|
|
150
|
-
"$ref": "/schemas/core/promoted-offerings.json"
|
|
151
|
-
},
|
|
152
|
-
{
|
|
153
|
-
"$ref": "/schemas/core/assets/url-asset.json"
|
|
154
|
-
}
|
|
155
|
-
]
|
|
156
|
-
}
|
|
157
|
-
}
|
|
158
|
-
},
|
|
159
|
-
"tags": {
|
|
160
|
-
"type": "array",
|
|
161
|
-
"description": "User-defined tags for organization and searchability",
|
|
162
|
-
"items": {
|
|
163
|
-
"type": "string"
|
|
164
|
-
}
|
|
165
|
-
},
|
|
166
|
-
"assignments": {
|
|
167
|
-
"type": "object",
|
|
168
|
-
"description": "Current package assignments (included when include_assignments=true)",
|
|
169
|
-
"properties": {
|
|
170
|
-
"assignment_count": {
|
|
171
|
-
"type": "integer",
|
|
172
|
-
"description": "Total number of active package assignments",
|
|
173
|
-
"minimum": 0
|
|
174
|
-
},
|
|
175
|
-
"assigned_packages": {
|
|
176
|
-
"type": "array",
|
|
177
|
-
"description": "List of packages this creative is assigned to",
|
|
178
|
-
"items": {
|
|
179
|
-
"type": "object",
|
|
180
|
-
"properties": {
|
|
181
|
-
"package_id": {
|
|
182
|
-
"type": "string",
|
|
183
|
-
"description": "Package identifier"
|
|
184
|
-
},
|
|
185
|
-
"package_name": {
|
|
186
|
-
"type": "string",
|
|
187
|
-
"description": "Human-readable package name"
|
|
188
|
-
},
|
|
189
|
-
"assigned_date": {
|
|
190
|
-
"type": "string",
|
|
191
|
-
"format": "date-time",
|
|
192
|
-
"description": "When this assignment was created"
|
|
193
|
-
},
|
|
194
|
-
"status": {
|
|
195
|
-
"type": "string",
|
|
196
|
-
"enum": [
|
|
197
|
-
"active",
|
|
198
|
-
"paused",
|
|
199
|
-
"ended"
|
|
200
|
-
],
|
|
201
|
-
"description": "Status of this specific assignment"
|
|
202
|
-
}
|
|
203
|
-
},
|
|
204
|
-
"required": [
|
|
205
|
-
"package_id",
|
|
206
|
-
"assigned_date",
|
|
207
|
-
"status"
|
|
208
|
-
],
|
|
209
|
-
"additionalProperties": true
|
|
210
|
-
}
|
|
211
|
-
}
|
|
212
|
-
},
|
|
213
|
-
"required": [
|
|
214
|
-
"assignment_count"
|
|
215
|
-
],
|
|
216
|
-
"additionalProperties": true
|
|
217
|
-
},
|
|
218
|
-
"performance": {
|
|
219
|
-
"type": "object",
|
|
220
|
-
"description": "Aggregated performance metrics (included when include_performance=true)",
|
|
221
|
-
"properties": {
|
|
222
|
-
"impressions": {
|
|
223
|
-
"type": "integer",
|
|
224
|
-
"description": "Total impressions across all assignments",
|
|
225
|
-
"minimum": 0
|
|
226
|
-
},
|
|
227
|
-
"clicks": {
|
|
228
|
-
"type": "integer",
|
|
229
|
-
"description": "Total clicks across all assignments",
|
|
230
|
-
"minimum": 0
|
|
231
|
-
},
|
|
232
|
-
"ctr": {
|
|
233
|
-
"type": "number",
|
|
234
|
-
"description": "Click-through rate (clicks/impressions)",
|
|
235
|
-
"minimum": 0,
|
|
236
|
-
"maximum": 1
|
|
237
|
-
},
|
|
238
|
-
"conversion_rate": {
|
|
239
|
-
"type": "number",
|
|
240
|
-
"description": "Conversion rate across all assignments",
|
|
241
|
-
"minimum": 0,
|
|
242
|
-
"maximum": 1
|
|
243
|
-
},
|
|
244
|
-
"performance_score": {
|
|
245
|
-
"type": "number",
|
|
246
|
-
"description": "Aggregated performance score (0-100)",
|
|
247
|
-
"minimum": 0,
|
|
248
|
-
"maximum": 100
|
|
249
|
-
},
|
|
250
|
-
"last_updated": {
|
|
251
|
-
"type": "string",
|
|
252
|
-
"format": "date-time",
|
|
253
|
-
"description": "When performance data was last updated"
|
|
254
|
-
}
|
|
255
|
-
},
|
|
256
|
-
"required": [
|
|
257
|
-
"last_updated"
|
|
258
|
-
],
|
|
259
|
-
"additionalProperties": true
|
|
260
|
-
},
|
|
261
|
-
"sub_assets": {
|
|
262
|
-
"type": "array",
|
|
263
|
-
"description": "Sub-assets for multi-asset formats (included when include_sub_assets=true)",
|
|
264
|
-
"items": {
|
|
265
|
-
"$ref": "/schemas/core/sub-asset.json"
|
|
266
|
-
}
|
|
267
|
-
}
|
|
268
|
-
},
|
|
269
|
-
"required": [
|
|
270
|
-
"creative_id",
|
|
271
|
-
"name",
|
|
272
|
-
"format_id",
|
|
273
|
-
"status",
|
|
274
|
-
"created_date",
|
|
275
|
-
"updated_date"
|
|
276
|
-
],
|
|
277
|
-
"additionalProperties": true
|
|
278
|
-
}
|
|
279
|
-
},
|
|
280
|
-
"format_summary": {
|
|
281
|
-
"type": "object",
|
|
282
|
-
"description": "Breakdown of creatives by format type",
|
|
283
|
-
"patternProperties": {
|
|
284
|
-
"^[a-zA-Z0-9_-]+$": {
|
|
285
|
-
"type": "integer",
|
|
286
|
-
"description": "Number of creatives with this format",
|
|
287
|
-
"minimum": 0
|
|
288
|
-
}
|
|
289
|
-
},
|
|
290
|
-
"additionalProperties": true
|
|
291
|
-
},
|
|
292
|
-
"status_summary": {
|
|
293
|
-
"type": "object",
|
|
294
|
-
"description": "Breakdown of creatives by status",
|
|
295
|
-
"properties": {
|
|
296
|
-
"approved": {
|
|
297
|
-
"type": "integer",
|
|
298
|
-
"description": "Number of approved creatives",
|
|
299
|
-
"minimum": 0
|
|
300
|
-
},
|
|
301
|
-
"pending_review": {
|
|
302
|
-
"type": "integer",
|
|
303
|
-
"description": "Number of creatives pending review",
|
|
304
|
-
"minimum": 0
|
|
305
|
-
},
|
|
306
|
-
"rejected": {
|
|
307
|
-
"type": "integer",
|
|
308
|
-
"description": "Number of rejected creatives",
|
|
309
|
-
"minimum": 0
|
|
310
|
-
},
|
|
311
|
-
"archived": {
|
|
312
|
-
"type": "integer",
|
|
313
|
-
"description": "Number of archived creatives",
|
|
314
|
-
"minimum": 0
|
|
315
|
-
}
|
|
316
|
-
},
|
|
317
|
-
"additionalProperties": true
|
|
318
|
-
},
|
|
319
|
-
"context": {
|
|
320
|
-
"$ref": "/schemas/core/context.json"
|
|
321
|
-
},
|
|
322
|
-
"ext": {
|
|
323
|
-
"$ref": "/schemas/core/ext.json"
|
|
324
|
-
}
|
|
325
|
-
},
|
|
326
|
-
"required": [
|
|
327
|
-
"query_summary",
|
|
328
|
-
"pagination",
|
|
329
|
-
"creatives"
|
|
330
|
-
],
|
|
331
|
-
"additionalProperties": true,
|
|
332
|
-
"examples": [
|
|
333
|
-
{
|
|
334
|
-
"description": "Successful library query with results",
|
|
335
|
-
"data": {
|
|
336
|
-
"query_summary": {
|
|
337
|
-
"total_matching": 3,
|
|
338
|
-
"returned": 3,
|
|
339
|
-
"filters_applied": [
|
|
340
|
-
"format=video",
|
|
341
|
-
"status=approved"
|
|
342
|
-
],
|
|
343
|
-
"sort_applied": {
|
|
344
|
-
"field": "created_date",
|
|
345
|
-
"direction": "desc"
|
|
346
|
-
}
|
|
347
|
-
},
|
|
348
|
-
"pagination": {
|
|
349
|
-
"limit": 50,
|
|
350
|
-
"offset": 0,
|
|
351
|
-
"has_more": false,
|
|
352
|
-
"total_pages": 1,
|
|
353
|
-
"current_page": 1
|
|
354
|
-
},
|
|
355
|
-
"creatives": [
|
|
356
|
-
{
|
|
357
|
-
"creative_id": "hero_video_30s",
|
|
358
|
-
"name": "Brand Hero Video 30s",
|
|
359
|
-
"format_id": {
|
|
360
|
-
"agent_url": "https://creative.adcontextprotocol.org",
|
|
361
|
-
"id": "video_30s_vast"
|
|
362
|
-
},
|
|
363
|
-
"status": "approved",
|
|
364
|
-
"created_date": "2024-01-15T10:30:00Z",
|
|
365
|
-
"updated_date": "2024-01-15T14:20:00Z",
|
|
366
|
-
"assets": {
|
|
367
|
-
"vast": {
|
|
368
|
-
"url": "https://vast.example.com/video/123",
|
|
369
|
-
"vast_version": "4.1"
|
|
370
|
-
}
|
|
371
|
-
},
|
|
372
|
-
"tags": [
|
|
373
|
-
"q1_2024",
|
|
374
|
-
"video",
|
|
375
|
-
"brand_awareness"
|
|
376
|
-
]
|
|
377
|
-
}
|
|
378
|
-
],
|
|
379
|
-
"format_summary": {
|
|
380
|
-
"video_30s_vast": 2,
|
|
381
|
-
"display_300x250": 1
|
|
382
|
-
},
|
|
383
|
-
"status_summary": {
|
|
384
|
-
"approved": 3,
|
|
385
|
-
"pending_review": 0,
|
|
386
|
-
"rejected": 0,
|
|
387
|
-
"archived": 0
|
|
388
|
-
}
|
|
389
|
-
}
|
|
390
|
-
},
|
|
391
|
-
{
|
|
392
|
-
"description": "Query with assignments and performance data",
|
|
393
|
-
"data": {
|
|
394
|
-
"query_summary": {
|
|
395
|
-
"total_matching": 1,
|
|
396
|
-
"returned": 1
|
|
397
|
-
},
|
|
398
|
-
"pagination": {
|
|
399
|
-
"limit": 50,
|
|
400
|
-
"offset": 0,
|
|
401
|
-
"has_more": false
|
|
402
|
-
},
|
|
403
|
-
"creatives": [
|
|
404
|
-
{
|
|
405
|
-
"creative_id": "hero_video_30s",
|
|
406
|
-
"name": "Brand Hero Video 30s",
|
|
407
|
-
"format_id": {
|
|
408
|
-
"agent_url": "https://creative.adcontextprotocol.org",
|
|
409
|
-
"id": "video_30s_vast"
|
|
410
|
-
},
|
|
411
|
-
"status": "approved",
|
|
412
|
-
"created_date": "2024-01-15T10:30:00Z",
|
|
413
|
-
"updated_date": "2024-01-15T14:20:00Z",
|
|
414
|
-
"assignments": {
|
|
415
|
-
"assignment_count": 2,
|
|
416
|
-
"assigned_packages": [
|
|
417
|
-
{
|
|
418
|
-
"package_id": "pkg_ctv_001",
|
|
419
|
-
"package_name": "CTV Prime Time",
|
|
420
|
-
"assigned_date": "2024-01-16T09:00:00Z",
|
|
421
|
-
"status": "active"
|
|
422
|
-
}
|
|
423
|
-
]
|
|
424
|
-
},
|
|
425
|
-
"performance": {
|
|
426
|
-
"impressions": 150000,
|
|
427
|
-
"clicks": 1200,
|
|
428
|
-
"ctr": 0.008,
|
|
429
|
-
"performance_score": 85.2,
|
|
430
|
-
"last_updated": "2024-01-20T12:00:00Z"
|
|
431
|
-
}
|
|
432
|
-
}
|
|
433
|
-
]
|
|
434
|
-
}
|
|
435
|
-
}
|
|
436
|
-
]
|
|
437
|
-
}
|
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"$id": "/schemas/media-buy/package-request.json",
|
|
4
|
-
"title": "Package Request",
|
|
5
|
-
"description": "Package configuration for media buy creation",
|
|
6
|
-
"type": "object",
|
|
7
|
-
"properties": {
|
|
8
|
-
"buyer_ref": {
|
|
9
|
-
"type": "string",
|
|
10
|
-
"description": "Buyer's reference identifier for this package"
|
|
11
|
-
},
|
|
12
|
-
"product_id": {
|
|
13
|
-
"type": "string",
|
|
14
|
-
"description": "Product ID for this package"
|
|
15
|
-
},
|
|
16
|
-
"format_ids": {
|
|
17
|
-
"type": "array",
|
|
18
|
-
"description": "Array of format IDs that will be used for this package - must be supported by the product. If omitted, defaults to all formats supported by the product.",
|
|
19
|
-
"items": {
|
|
20
|
-
"$ref": "/schemas/core/format-id.json"
|
|
21
|
-
},
|
|
22
|
-
"minItems": 1
|
|
23
|
-
},
|
|
24
|
-
"budget": {
|
|
25
|
-
"type": "number",
|
|
26
|
-
"description": "Budget allocation for this package in the media buy's currency",
|
|
27
|
-
"minimum": 0
|
|
28
|
-
},
|
|
29
|
-
"pacing": {
|
|
30
|
-
"$ref": "/schemas/enums/pacing.json"
|
|
31
|
-
},
|
|
32
|
-
"pricing_option_id": {
|
|
33
|
-
"type": "string",
|
|
34
|
-
"description": "ID of the selected pricing option from the product's pricing_options array"
|
|
35
|
-
},
|
|
36
|
-
"bid_price": {
|
|
37
|
-
"type": "number",
|
|
38
|
-
"description": "Bid price for auction-based CPM pricing (required if using cpm-auction-option)",
|
|
39
|
-
"minimum": 0
|
|
40
|
-
},
|
|
41
|
-
"impressions": {
|
|
42
|
-
"type": "number",
|
|
43
|
-
"description": "Impression goal for this package",
|
|
44
|
-
"minimum": 0
|
|
45
|
-
},
|
|
46
|
-
"paused": {
|
|
47
|
-
"type": "boolean",
|
|
48
|
-
"description": "Whether this package should be created in a paused state. Paused packages do not deliver impressions. Defaults to false.",
|
|
49
|
-
"default": false
|
|
50
|
-
},
|
|
51
|
-
"targeting_overlay": {
|
|
52
|
-
"$ref": "/schemas/core/targeting.json"
|
|
53
|
-
},
|
|
54
|
-
"creative_ids": {
|
|
55
|
-
"type": "array",
|
|
56
|
-
"description": "Creative IDs to assign to this package at creation time (references existing library creatives)",
|
|
57
|
-
"items": {
|
|
58
|
-
"type": "string"
|
|
59
|
-
}
|
|
60
|
-
},
|
|
61
|
-
"creatives": {
|
|
62
|
-
"type": "array",
|
|
63
|
-
"description": "Full creative objects to upload and assign to this package at creation time (alternative to creative_ids - creatives will be added to library). Supports both static and generative creatives.",
|
|
64
|
-
"items": {
|
|
65
|
-
"$ref": "/schemas/core/creative-asset.json"
|
|
66
|
-
},
|
|
67
|
-
"maxItems": 100
|
|
68
|
-
},
|
|
69
|
-
"ext": {
|
|
70
|
-
"$ref": "/schemas/core/ext.json"
|
|
71
|
-
}
|
|
72
|
-
},
|
|
73
|
-
"required": [
|
|
74
|
-
"buyer_ref",
|
|
75
|
-
"product_id",
|
|
76
|
-
"budget",
|
|
77
|
-
"pricing_option_id"
|
|
78
|
-
],
|
|
79
|
-
"additionalProperties": true
|
|
80
|
-
}
|