@adcp/client 4.22.1 → 4.23.0
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/dist/lib/index.d.ts +1 -1
- package/dist/lib/index.d.ts.map +1 -1
- package/dist/lib/index.js.map +1 -1
- package/dist/lib/testing/compliance/comply.d.ts +22 -5
- package/dist/lib/testing/compliance/comply.d.ts.map +1 -1
- package/dist/lib/testing/compliance/comply.js +242 -276
- package/dist/lib/testing/compliance/comply.js.map +1 -1
- package/dist/lib/testing/compliance/index.d.ts +1 -0
- package/dist/lib/testing/compliance/index.d.ts.map +1 -1
- package/dist/lib/testing/compliance/index.js +6 -1
- package/dist/lib/testing/compliance/index.js.map +1 -1
- package/dist/lib/testing/compliance/platform-storyboards.d.ts +44 -0
- package/dist/lib/testing/compliance/platform-storyboards.d.ts.map +1 -0
- package/dist/lib/testing/compliance/platform-storyboards.js +230 -0
- package/dist/lib/testing/compliance/platform-storyboards.js.map +1 -0
- package/dist/lib/testing/compliance/storyboard-tracks.d.ts +2 -9
- package/dist/lib/testing/compliance/storyboard-tracks.d.ts.map +1 -1
- package/dist/lib/testing/compliance/storyboard-tracks.js +4 -44
- package/dist/lib/testing/compliance/storyboard-tracks.js.map +1 -1
- package/dist/lib/testing/index.d.ts +1 -1
- package/dist/lib/testing/index.d.ts.map +1 -1
- package/dist/lib/testing/index.js +6 -1
- package/dist/lib/testing/index.js.map +1 -1
- package/dist/lib/types/core.generated.d.ts +241 -2
- package/dist/lib/types/core.generated.d.ts.map +1 -1
- package/dist/lib/types/core.generated.js +1 -1
- package/dist/lib/types/schemas.generated.d.ts +3380 -3154
- package/dist/lib/types/schemas.generated.d.ts.map +1 -1
- package/dist/lib/types/schemas.generated.js +220 -115
- package/dist/lib/types/schemas.generated.js.map +1 -1
- package/dist/lib/types/tools.generated.d.ts +267 -74
- package/dist/lib/types/tools.generated.d.ts.map +1 -1
- package/dist/lib/version.d.ts +3 -3
- package/dist/lib/version.js +3 -3
- package/docs/llms.txt +46 -30
- package/package.json +1 -1
- package/storyboards/audience_sync.yaml +18 -29
- package/storyboards/behavioral_analysis.yaml +40 -72
- package/storyboards/brand_rights.yaml +172 -75
- package/storyboards/campaign_governance_conditions.yaml +187 -0
- package/storyboards/campaign_governance_delivery.yaml +231 -0
- package/storyboards/campaign_governance_denied.yaml +135 -0
- package/storyboards/capability_discovery.yaml +106 -0
- package/storyboards/content_standards.yaml +251 -0
- package/storyboards/creative_ad_server.yaml +108 -16
- package/storyboards/creative_lifecycle.yaml +284 -0
- package/storyboards/creative_sales_agent.yaml +2 -6
- package/storyboards/creative_template.yaml +1 -5
- package/storyboards/error_compliance.yaml +105 -108
- package/storyboards/media_buy_catalog_creative.yaml +6 -4
- package/storyboards/media_buy_governance_escalation.yaml +9 -5
- package/storyboards/media_buy_guaranteed_approval.yaml +9 -7
- package/storyboards/media_buy_non_guaranteed.yaml +7 -6
- package/storyboards/media_buy_proposal_mode.yaml +9 -8
- package/storyboards/media_buy_seller.yaml +153 -165
- package/storyboards/media_buy_state_machine.yaml +100 -99
- package/storyboards/property_governance.yaml +239 -0
- package/storyboards/schema.yaml +2 -2
- package/storyboards/schema_validation.yaml +58 -51
- package/storyboards/si_session.yaml +99 -317
- package/storyboards/signal_marketplace.yaml +6 -5
- package/storyboards/signal_owned.yaml +5 -5
- package/storyboards/social_platform.yaml +274 -0
- package/storyboards/governance_content_standards.yaml +0 -213
- package/storyboards/governance_property_lists.yaml +0 -372
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// Provides pre-configured test agents for examples and quick testing
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
5
|
exports.testMediaBuyStateMachine = exports.testCreativeStateMachine = exports.testPackageLifecycle = exports.testTerminalStateEnforcement = exports.testMediaBuyLifecycle = exports.testSchemaCompliance = exports.resolveAccountForAudiences = exports.testSyncAudiences = exports.testCapabilityDiscovery = exports.testSIHandoff = exports.testSIAvailability = exports.testSISessionLifecycle = exports.testPropertyListFilters = exports.testGovernanceContentStandards = exports.testGovernancePropertyLists = exports.testResponseConsistency = exports.testBehaviorAnalysis = exports.testTemporalValidation = exports.testPricingEdgeCases = exports.testValidation = exports.testErrorHandling = exports.testSignalsFlow = exports.testCreativeFlow = exports.testCreativeInline = exports.testCreativeSync = exports.testReportingFlow = exports.testFullSalesFlow = exports.testCreateMediaBuy = exports.testDiscovery = exports.testHealthCheck = exports.runStep = exports.createTestClient = exports.getLogger = exports.setAgentTesterLogger = exports.formatTestResultsSummary = exports.formatTestResultsJSON = exports.formatTestResults = exports.runAgentTests = exports.creativeAgent = exports.TEST_AGENT_NO_AUTH_A2A_CONFIG = exports.TEST_AGENT_NO_AUTH_MCP_CONFIG = exports.testAgentNoAuthA2A = exports.testAgentNoAuth = exports.TEST_AGENT_A2A_CONFIG = exports.TEST_AGENT_MCP_CONFIG = exports.TEST_AGENT_TOKEN = exports.createTestAgent = exports.testAgentClient = exports.testAgentA2A = exports.testAgent = void 0;
|
|
6
|
-
exports.resolvePath = exports.runValidations = exports.injectContext = exports.extractContext = exports.executeStoryboardTask = exports.TASK_TO_METHOD = exports.listStoryboards = exports.getStoryboardsForPlatformType = exports.getStoryboardById = exports.loadBundledStoryboards = exports.loadStoryboardFile = exports.parseStoryboard = exports.getFirstStepPreview = exports.runStoryboardStep = exports.runStoryboard = exports.GovernanceAgentStub = exports.getPlatformTypesWithLabels = exports.getAllPlatformTypes = exports.getPlatformProfile = exports.getBriefsByVertical = exports.getBriefById = exports.SAMPLE_BRIEFS = exports.formatComplianceResultsJSON = exports.formatComplianceResults = exports.comply = exports.formatSuiteResultsJSON = exports.formatSuiteResults = exports.DEFAULT_SCENARIOS = exports.SCENARIO_REQUIREMENTS = exports.getApplicableScenarios = exports.testAllScenarios = exports.likelySupportsV3 = exports.hasSITools = exports.hasGovernanceTools = exports.hasBrandRightsTools = exports.testBrandRightsFlow = exports.testControllerValidation = exports.testBudgetSimulation = exports.testDeliverySimulation = exports.testSessionStateMachine = exports.testAccountStateMachine = void 0;
|
|
6
|
+
exports.resolvePath = exports.runValidations = exports.injectContext = exports.extractContext = exports.executeStoryboardTask = exports.TASK_TO_METHOD = exports.listStoryboards = exports.getStoryboardsForPlatformType = exports.getStoryboardById = exports.loadBundledStoryboards = exports.loadStoryboardFile = exports.parseStoryboard = exports.getFirstStepPreview = exports.runStoryboardStep = exports.runStoryboard = exports.GovernanceAgentStub = exports.filterToKnownScenarios = exports.extractScenariosFromStoryboard = exports.getStoryboardIdsForPlatform = exports.PLATFORM_STORYBOARDS = exports.getPlatformTypesWithLabels = exports.getAllPlatformTypes = exports.getPlatformProfile = exports.getBriefsByVertical = exports.getBriefById = exports.SAMPLE_BRIEFS = exports.formatComplianceResultsJSON = exports.formatComplianceResults = exports.comply = exports.formatSuiteResultsJSON = exports.formatSuiteResults = exports.DEFAULT_SCENARIOS = exports.SCENARIO_REQUIREMENTS = exports.getApplicableScenarios = exports.testAllScenarios = exports.likelySupportsV3 = exports.hasSITools = exports.hasGovernanceTools = exports.hasBrandRightsTools = exports.testBrandRightsFlow = exports.testControllerValidation = exports.testBudgetSimulation = exports.testDeliverySimulation = exports.testSessionStateMachine = exports.testAccountStateMachine = void 0;
|
|
7
7
|
var test_helpers_1 = require("./test-helpers");
|
|
8
8
|
// Test agents (with auth)
|
|
9
9
|
Object.defineProperty(exports, "testAgent", { enumerable: true, get: function () { return test_helpers_1.testAgent; } });
|
|
@@ -96,6 +96,11 @@ Object.defineProperty(exports, "getBriefsByVertical", { enumerable: true, get: f
|
|
|
96
96
|
Object.defineProperty(exports, "getPlatformProfile", { enumerable: true, get: function () { return compliance_1.getPlatformProfile; } });
|
|
97
97
|
Object.defineProperty(exports, "getAllPlatformTypes", { enumerable: true, get: function () { return compliance_1.getAllPlatformTypes; } });
|
|
98
98
|
Object.defineProperty(exports, "getPlatformTypesWithLabels", { enumerable: true, get: function () { return compliance_1.getPlatformTypesWithLabels; } });
|
|
99
|
+
// Platform storyboard mapping
|
|
100
|
+
Object.defineProperty(exports, "PLATFORM_STORYBOARDS", { enumerable: true, get: function () { return compliance_1.PLATFORM_STORYBOARDS; } });
|
|
101
|
+
Object.defineProperty(exports, "getStoryboardIdsForPlatform", { enumerable: true, get: function () { return compliance_1.getStoryboardIdsForPlatform; } });
|
|
102
|
+
Object.defineProperty(exports, "extractScenariosFromStoryboard", { enumerable: true, get: function () { return compliance_1.extractScenariosFromStoryboard; } });
|
|
103
|
+
Object.defineProperty(exports, "filterToKnownScenarios", { enumerable: true, get: function () { return compliance_1.filterToKnownScenarios; } });
|
|
99
104
|
// Test stubs for compliance testing
|
|
100
105
|
var stubs_1 = require("./stubs");
|
|
101
106
|
Object.defineProperty(exports, "GovernanceAgentStub", { enumerable: true, get: function () { return stubs_1.GovernanceAgentStub; } });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/testing/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,qEAAqE;;;;AAErE,+CAgBwB;AAftB,0BAA0B;AAC1B,yGAAA,SAAS,OAAA;AACT,4GAAA,YAAY,OAAA;AACZ,+GAAA,eAAe,OAAA;AACf,+GAAA,eAAe,OAAA;AACf,gHAAA,gBAAgB,OAAA;AAChB,qHAAA,qBAAqB,OAAA;AACrB,qHAAA,qBAAqB,OAAA;AACrB,mEAAmE;AACnE,+GAAA,eAAe,OAAA;AACf,kHAAA,kBAAkB,OAAA;AAClB,6HAAA,6BAA6B,OAAA;AAC7B,6HAAA,6BAA6B,OAAA;AAC7B,qDAAqD;AACrD,6GAAA,aAAa,OAAA;AAGf,8BAA8B;AAC9B,+CAwEwB;AAvEtB,6GAAA,SAAS,OAAiB;AAC1B,iHAAA,iBAAiB,OAAA;AACjB,qHAAA,qBAAqB,OAAA;AACrB,wHAAA,wBAAwB,OAAA;AACxB,oHAAA,oBAAoB,OAAA;AACpB,yGAAA,SAAS,OAAA;AACT,gHAAA,gBAAgB,OAAA;AAChB,uGAAA,OAAO,OAAA;AACP,uBAAuB;AACvB,+GAAA,eAAe,OAAA;AACf,6GAAA,aAAa,OAAA;AACb,kHAAA,kBAAkB,OAAA;AAClB,iHAAA,iBAAiB,OAAA;AACjB,iHAAA,iBAAiB,OAAA;AACjB,gHAAA,gBAAgB,OAAA;AAChB,kHAAA,kBAAkB,OAAA;AAClB,gHAAA,gBAAgB,OAAA;AAChB,+GAAA,eAAe,OAAA;AACf,iHAAA,iBAAiB,OAAA;AACjB,8GAAA,cAAc,OAAA;AACd,oHAAA,oBAAoB,OAAA;AACpB,sHAAA,sBAAsB,OAAA;AACtB,oHAAA,oBAAoB,OAAA;AACpB,uHAAA,uBAAuB,OAAA;AACvB,eAAe;AACf,2HAAA,2BAA2B,OAAA;AAC3B,8HAAA,8BAA8B,OAAA;AAC9B,uHAAA,uBAAuB,OAAA;AACvB,sHAAA,sBAAsB,OAAA;AACtB,kHAAA,kBAAkB,OAAA;AAClB,6GAAA,aAAa,OAAA;AACb,uHAAA,uBAAuB,OAAA;AACvB,iHAAA,iBAAiB,OAAA;AACjB,0HAAA,0BAA0B,OAAA;AAC1B,oHAAA,oBAAoB,OAAA;AACpB,2BAA2B;AAC3B,qHAAA,qBAAqB,OAAA;AACrB,4HAAA,4BAA4B,OAAA;AAC5B,oHAAA,oBAAoB,OAAA;AACpB,sCAAsC;AACtC,wHAAA,wBAAwB,OAAA;AACxB,wHAAA,wBAAwB,OAAA;AACxB,uHAAA,uBAAuB,OAAA;AACvB,uHAAA,uBAAuB,OAAA;AACvB,sHAAA,sBAAsB,OAAA;AACtB,oHAAA,oBAAoB,OAAA;AACpB,wHAAA,wBAAwB,OAAA;AACxB,eAAe;AACf,mHAAA,mBAAmB,OAAA;AACnB,mHAAA,mBAAmB,OAAA;AACnB,aAAa;AACb,kHAAA,kBAAkB,OAAA;AAClB,0GAAA,UAAU,OAAA;AACV,gHAAA,gBAAgB,OAAA;AAChB,qBAAqB;AACrB,gHAAA,gBAAgB,OAAA;AAChB,sHAAA,sBAAsB,OAAA;AACtB,qHAAA,qBAAqB,OAAA;AACrB,iHAAA,iBAAiB,OAAA;AACjB,kHAAA,kBAAkB,OAAA;AAClB,sHAAA,sBAAsB,OAAA;AAaxB,wBAAwB;AACxB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/testing/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,qEAAqE;;;;AAErE,+CAgBwB;AAftB,0BAA0B;AAC1B,yGAAA,SAAS,OAAA;AACT,4GAAA,YAAY,OAAA;AACZ,+GAAA,eAAe,OAAA;AACf,+GAAA,eAAe,OAAA;AACf,gHAAA,gBAAgB,OAAA;AAChB,qHAAA,qBAAqB,OAAA;AACrB,qHAAA,qBAAqB,OAAA;AACrB,mEAAmE;AACnE,+GAAA,eAAe,OAAA;AACf,kHAAA,kBAAkB,OAAA;AAClB,6HAAA,6BAA6B,OAAA;AAC7B,6HAAA,6BAA6B,OAAA;AAC7B,qDAAqD;AACrD,6GAAA,aAAa,OAAA;AAGf,8BAA8B;AAC9B,+CAwEwB;AAvEtB,6GAAA,SAAS,OAAiB;AAC1B,iHAAA,iBAAiB,OAAA;AACjB,qHAAA,qBAAqB,OAAA;AACrB,wHAAA,wBAAwB,OAAA;AACxB,oHAAA,oBAAoB,OAAA;AACpB,yGAAA,SAAS,OAAA;AACT,gHAAA,gBAAgB,OAAA;AAChB,uGAAA,OAAO,OAAA;AACP,uBAAuB;AACvB,+GAAA,eAAe,OAAA;AACf,6GAAA,aAAa,OAAA;AACb,kHAAA,kBAAkB,OAAA;AAClB,iHAAA,iBAAiB,OAAA;AACjB,iHAAA,iBAAiB,OAAA;AACjB,gHAAA,gBAAgB,OAAA;AAChB,kHAAA,kBAAkB,OAAA;AAClB,gHAAA,gBAAgB,OAAA;AAChB,+GAAA,eAAe,OAAA;AACf,iHAAA,iBAAiB,OAAA;AACjB,8GAAA,cAAc,OAAA;AACd,oHAAA,oBAAoB,OAAA;AACpB,sHAAA,sBAAsB,OAAA;AACtB,oHAAA,oBAAoB,OAAA;AACpB,uHAAA,uBAAuB,OAAA;AACvB,eAAe;AACf,2HAAA,2BAA2B,OAAA;AAC3B,8HAAA,8BAA8B,OAAA;AAC9B,uHAAA,uBAAuB,OAAA;AACvB,sHAAA,sBAAsB,OAAA;AACtB,kHAAA,kBAAkB,OAAA;AAClB,6GAAA,aAAa,OAAA;AACb,uHAAA,uBAAuB,OAAA;AACvB,iHAAA,iBAAiB,OAAA;AACjB,0HAAA,0BAA0B,OAAA;AAC1B,oHAAA,oBAAoB,OAAA;AACpB,2BAA2B;AAC3B,qHAAA,qBAAqB,OAAA;AACrB,4HAAA,4BAA4B,OAAA;AAC5B,oHAAA,oBAAoB,OAAA;AACpB,sCAAsC;AACtC,wHAAA,wBAAwB,OAAA;AACxB,wHAAA,wBAAwB,OAAA;AACxB,uHAAA,uBAAuB,OAAA;AACvB,uHAAA,uBAAuB,OAAA;AACvB,sHAAA,sBAAsB,OAAA;AACtB,oHAAA,oBAAoB,OAAA;AACpB,wHAAA,wBAAwB,OAAA;AACxB,eAAe;AACf,mHAAA,mBAAmB,OAAA;AACnB,mHAAA,mBAAmB,OAAA;AACnB,aAAa;AACb,kHAAA,kBAAkB,OAAA;AAClB,0GAAA,UAAU,OAAA;AACV,gHAAA,gBAAgB,OAAA;AAChB,qBAAqB;AACrB,gHAAA,gBAAgB,OAAA;AAChB,sHAAA,sBAAsB,OAAA;AACtB,qHAAA,qBAAqB,OAAA;AACrB,iHAAA,iBAAiB,OAAA;AACjB,kHAAA,kBAAkB,OAAA;AAClB,sHAAA,sBAAsB,OAAA;AAaxB,wBAAwB;AACxB,2CAoCsB;AAnCpB,oGAAA,MAAM,OAAA;AACN,qHAAA,uBAAuB,OAAA;AACvB,yHAAA,2BAA2B,OAAA;AAC3B,gBAAgB;AAChB,2GAAA,aAAa,OAAA;AACb,0GAAA,YAAY,OAAA;AACZ,iHAAA,mBAAmB,OAAA;AACnB,oBAAoB;AACpB,gHAAA,kBAAkB,OAAA;AAClB,iHAAA,mBAAmB,OAAA;AACnB,wHAAA,0BAA0B,OAAA;AAC1B,8BAA8B;AAC9B,kHAAA,oBAAoB,OAAA;AACpB,yHAAA,2BAA2B,OAAA;AAC3B,4HAAA,8BAA8B,OAAA;AAC9B,oHAAA,sBAAsB,OAAA;AAsBxB,oCAAoC;AACpC,iCAA8C;AAArC,4GAAA,mBAAmB,OAAA;AAG5B,4BAA4B;AAC5B,2CAiCsB;AAhCpB,SAAS;AACT,2GAAA,aAAa,OAAA;AACb,+GAAA,iBAAiB,OAAA;AACjB,iHAAA,mBAAmB,OAAA;AACnB,SAAS;AACT,6GAAA,eAAe,OAAA;AACf,gHAAA,kBAAkB,OAAA;AAClB,oHAAA,sBAAsB,OAAA;AACtB,+GAAA,iBAAiB,OAAA;AACjB,2HAAA,6BAA6B,OAAA;AAC7B,6GAAA,eAAe,OAAA;AACf,eAAe;AACf,4GAAA,cAAc,OAAA;AACd,mHAAA,qBAAqB,OAAA;AACrB,UAAU;AACV,4GAAA,cAAc,OAAA;AACd,2GAAA,aAAa,OAAA;AACb,cAAc;AACd,4GAAA,cAAc,OAAA;AACd,yGAAA,WAAW,OAAA"}
|
|
@@ -93,6 +93,18 @@ export type DevicePlatform = 'ios' | 'android' | 'windows' | 'macos' | 'linux' |
|
|
|
93
93
|
* Device form factor categories for targeting and reporting. Complements device-platform (operating system) with hardware classification. OpenRTB mapping: 1 (Mobile/Tablet General) → mobile, 2 (PC) → desktop, 4 (Phone) → mobile, 5 (Tablet) → tablet, 6 (Connected Device) → ctv, 7 (Set Top Box) → ctv. DOOH inventory uses dooh.
|
|
94
94
|
*/
|
|
95
95
|
export type DeviceType = 'desktop' | 'mobile' | 'tablet' | 'ctv' | 'dooh' | 'unknown';
|
|
96
|
+
/**
|
|
97
|
+
* Remedy types available when a performance standard or billing measurement threshold is breached.
|
|
98
|
+
*/
|
|
99
|
+
export type MakegoodRemedy = 'additional_delivery' | 'credit' | 'invoice_adjustment';
|
|
100
|
+
/**
|
|
101
|
+
* The performance metric this standard applies to.
|
|
102
|
+
*/
|
|
103
|
+
export type PerformanceStandardMetric = 'viewability' | 'ivt' | 'completion_rate' | 'brand_safety' | 'attention_score';
|
|
104
|
+
/**
|
|
105
|
+
* Measurement standard. Required when metric is 'viewability' (MRC and GroupM define materially different thresholds). Omit for other metrics.
|
|
106
|
+
*/
|
|
107
|
+
export type ViewabilityStandard = 'mrc' | 'groupm';
|
|
96
108
|
/**
|
|
97
109
|
* A single optimization target for a package. Packages accept an array of optimization_goals. When multiple goals are present, priority determines which the seller focuses on — 1 is highest priority (primary goal); higher numbers are secondary. Duplicate priority values result in undefined seller behavior.
|
|
98
110
|
*/
|
|
@@ -476,6 +488,11 @@ export interface Package {
|
|
|
476
488
|
*/
|
|
477
489
|
format_ids?: FormatID[];
|
|
478
490
|
targeting_overlay?: TargetingOverlay;
|
|
491
|
+
measurement_terms?: MeasurementTerms;
|
|
492
|
+
/**
|
|
493
|
+
* Agreed performance standards for this package. When any entry specifies a vendor, creatives assigned to this package MUST include corresponding tracker_script or tracker_pixel assets from that vendor.
|
|
494
|
+
*/
|
|
495
|
+
performance_standards?: PerformanceStandard[];
|
|
479
496
|
/**
|
|
480
497
|
* Creative assets assigned to this package
|
|
481
498
|
*/
|
|
@@ -894,6 +911,42 @@ export interface PropertyListReference {
|
|
|
894
911
|
*/
|
|
895
912
|
auth_token?: string;
|
|
896
913
|
}
|
|
914
|
+
/**
|
|
915
|
+
* Agreed billing measurement and makegood terms for this package. Reflects what was negotiated — may differ from the buyer's proposal or the product's defaults. When present, these terms are binding for the package's duration.
|
|
916
|
+
*/
|
|
917
|
+
export interface MeasurementTerms {
|
|
918
|
+
/**
|
|
919
|
+
* Which vendor's count of the billing metric governs invoicing. The billing metric is determined by the pricing_model on the selected pricing_option (e.g., impressions for CPM, completed views for CPCV).
|
|
920
|
+
*/
|
|
921
|
+
billing_measurement?: {
|
|
922
|
+
vendor: BrandReference;
|
|
923
|
+
/**
|
|
924
|
+
* Maximum acceptable variance between the billing vendor's count and the other party's count before resolution is triggered (e.g., 10 means a 10% divergence triggers review).
|
|
925
|
+
*/
|
|
926
|
+
max_variance_percent?: number;
|
|
927
|
+
};
|
|
928
|
+
/**
|
|
929
|
+
* Remedies available when a performance standard or billing measurement variance is breached. Seller declares which remedy types they support. When a breach occurs, the seller proposes a remedy from this menu; the buyer accepts or disputes.
|
|
930
|
+
*/
|
|
931
|
+
makegood_policy?: {
|
|
932
|
+
/**
|
|
933
|
+
* Remedy types the seller supports. Ordered by seller preference (first = preferred). Seller proposes from this list when a breach occurs; buyer accepts or disputes.
|
|
934
|
+
*/
|
|
935
|
+
available_remedies: MakegoodRemedy[];
|
|
936
|
+
};
|
|
937
|
+
}
|
|
938
|
+
/**
|
|
939
|
+
* A rate threshold for a performance metric, measured by a specified vendor. The threshold is a floor or ceiling depending on the metric: viewability, completion_rate, brand_safety, and attention_score are floors (must exceed); ivt is a ceiling (must not exceed).
|
|
940
|
+
*/
|
|
941
|
+
export interface PerformanceStandard {
|
|
942
|
+
metric: PerformanceStandardMetric;
|
|
943
|
+
/**
|
|
944
|
+
* Rate threshold as a decimal (e.g., 0.70 for 70%). Whether this is a floor or ceiling depends on the metric: for viewability, completion_rate, brand_safety, attention_score the actual rate must be >= threshold; for ivt the actual rate must be <= threshold.
|
|
945
|
+
*/
|
|
946
|
+
threshold: number;
|
|
947
|
+
standard?: ViewabilityStandard;
|
|
948
|
+
vendor: BrandReference;
|
|
949
|
+
}
|
|
897
950
|
/**
|
|
898
951
|
* Assignment of a creative asset to a package with optional placement targeting. Used in create_media_buy and update_media_buy requests. Note: sync_creatives does not support placement_ids - use create/update_media_buy for placement-level targeting.
|
|
899
952
|
*/
|
|
@@ -2002,6 +2055,12 @@ export interface Product {
|
|
|
2002
2055
|
*/
|
|
2003
2056
|
notes?: string;
|
|
2004
2057
|
};
|
|
2058
|
+
measurement_terms?: MeasurementTerms;
|
|
2059
|
+
/**
|
|
2060
|
+
* Seller's default performance standards for this product: viewability, IVT, completion rate, brand safety, attention score. Buyers may propose different standards at media buy creation. When absent, no structured performance standards apply.
|
|
2061
|
+
*/
|
|
2062
|
+
performance_standards?: PerformanceStandard[];
|
|
2063
|
+
cancellation_policy?: CancellationPolicy;
|
|
2005
2064
|
reporting_capabilities?: ReportingCapabilities;
|
|
2006
2065
|
creative_policy?: CreativePolicy;
|
|
2007
2066
|
/**
|
|
@@ -2748,6 +2807,29 @@ export interface OutcomeMeasurement {
|
|
|
2748
2807
|
*/
|
|
2749
2808
|
reporting: string;
|
|
2750
2809
|
}
|
|
2810
|
+
/**
|
|
2811
|
+
* Cancellation terms for this product. Declares the minimum notice period required before cancellation takes effect and any penalties for insufficient notice. Relevant for guaranteed delivery products. Buyers accept these terms by creating a media buy against the product.
|
|
2812
|
+
*/
|
|
2813
|
+
export interface CancellationPolicy {
|
|
2814
|
+
notice_period: Duration;
|
|
2815
|
+
/**
|
|
2816
|
+
* Fee applied when the notice period is not met.
|
|
2817
|
+
*/
|
|
2818
|
+
cancellation_fee: {
|
|
2819
|
+
/**
|
|
2820
|
+
* Fee calculation method. 'percent_remaining': percentage of remaining uncommitted spend. 'full_commitment': buyer owes the full committed budget regardless of delivery. 'fixed_fee': flat monetary amount. 'none': no financial fee (cancellation with notice is free).
|
|
2821
|
+
*/
|
|
2822
|
+
type: 'percent_remaining' | 'full_commitment' | 'fixed_fee' | 'none';
|
|
2823
|
+
/**
|
|
2824
|
+
* Fee rate as a decimal proportion of remaining committed spend. Required when type is 'percent_remaining' (e.g., 0.5 means 50% of remaining spend).
|
|
2825
|
+
*/
|
|
2826
|
+
rate?: number;
|
|
2827
|
+
/**
|
|
2828
|
+
* Fixed fee amount in the buy's currency. Required when type is 'fixed_fee'.
|
|
2829
|
+
*/
|
|
2830
|
+
amount?: number;
|
|
2831
|
+
};
|
|
2832
|
+
}
|
|
2751
2833
|
/**
|
|
2752
2834
|
* Reporting capabilities available for a product
|
|
2753
2835
|
*/
|
|
@@ -3598,7 +3680,7 @@ export interface InsertionOrder {
|
|
|
3598
3680
|
*/
|
|
3599
3681
|
io_id: string;
|
|
3600
3682
|
/**
|
|
3601
|
-
*
|
|
3683
|
+
* Summary fields echoed from the committed proposal for agent verification. Buyer agents use these to confirm the IO matches what was negotiated before a human signs. These are read-only summaries, not negotiation surfaces — deal terms live on products and packages.
|
|
3602
3684
|
*/
|
|
3603
3685
|
terms?: {
|
|
3604
3686
|
/**
|
|
@@ -3787,6 +3869,30 @@ export interface CreateMediaBuySuccess {
|
|
|
3787
3869
|
context?: ContextObject;
|
|
3788
3870
|
ext?: ExtensionObject;
|
|
3789
3871
|
}
|
|
3872
|
+
/**
|
|
3873
|
+
* Agreed billing measurement and makegood terms for this package. Reflects what was negotiated — may differ from the buyer's proposal or the product's defaults. When present, these terms are binding for the package's duration.
|
|
3874
|
+
*/
|
|
3875
|
+
export interface MeasurementTerms1 {
|
|
3876
|
+
/**
|
|
3877
|
+
* Which vendor's count of the billing metric governs invoicing. The billing metric is determined by the pricing_model on the selected pricing_option (e.g., impressions for CPM, completed views for CPCV).
|
|
3878
|
+
*/
|
|
3879
|
+
billing_measurement?: {
|
|
3880
|
+
vendor: BrandReference;
|
|
3881
|
+
/**
|
|
3882
|
+
* Maximum acceptable variance between the billing vendor's count and the other party's count before resolution is triggered (e.g., 10 means a 10% divergence triggers review).
|
|
3883
|
+
*/
|
|
3884
|
+
max_variance_percent?: number;
|
|
3885
|
+
};
|
|
3886
|
+
/**
|
|
3887
|
+
* Remedies available when a performance standard or billing measurement variance is breached. Seller declares which remedy types they support. When a breach occurs, the seller proposes a remedy from this menu; the buyer accepts or disputes.
|
|
3888
|
+
*/
|
|
3889
|
+
makegood_policy?: {
|
|
3890
|
+
/**
|
|
3891
|
+
* Remedy types the seller supports. Ordered by seller preference (first = preferred). Seller proposes from this list when a breach occurs; buyer accepts or disputes.
|
|
3892
|
+
*/
|
|
3893
|
+
available_remedies: MakegoodRemedy[];
|
|
3894
|
+
};
|
|
3895
|
+
}
|
|
3790
3896
|
/**
|
|
3791
3897
|
* The seller's interpreted delivery parameters. Describes what the seller will actually run -- geo, channels, flight dates, frequency caps, and budget. Present when the account has governance_agents or when the seller chooses to provide delivery transparency.
|
|
3792
3898
|
*/
|
|
@@ -4039,6 +4145,19 @@ export interface BuildCreativeSuccess {
|
|
|
4039
4145
|
expires_at: string;
|
|
4040
4146
|
};
|
|
4041
4147
|
preview_error?: Error;
|
|
4148
|
+
/**
|
|
4149
|
+
* Which rate card pricing option was applied for this build. Present when the creative agent charges for its services. Pass this in report_usage to identify which pricing option was applied.
|
|
4150
|
+
*/
|
|
4151
|
+
pricing_option_id?: string;
|
|
4152
|
+
/**
|
|
4153
|
+
* Cost incurred for this build, denominated in currency. May be 0 for CPM-priced creatives where cost accrues at serve time rather than build time.
|
|
4154
|
+
*/
|
|
4155
|
+
vendor_cost?: number;
|
|
4156
|
+
/**
|
|
4157
|
+
* ISO 4217 currency code for vendor_cost.
|
|
4158
|
+
*/
|
|
4159
|
+
currency?: string;
|
|
4160
|
+
consumption?: CreativeConsumption;
|
|
4042
4161
|
context?: ContextObject;
|
|
4043
4162
|
ext?: ExtensionObject;
|
|
4044
4163
|
}
|
|
@@ -4122,6 +4241,27 @@ export interface RightsConstraint {
|
|
|
4122
4241
|
verification_url?: string;
|
|
4123
4242
|
ext?: ExtensionObject;
|
|
4124
4243
|
}
|
|
4244
|
+
/**
|
|
4245
|
+
* Structured consumption details for this build. Informational — lets the buyer verify that vendor_cost is consistent with the rate card. vendor_cost is the billing source of truth.
|
|
4246
|
+
*/
|
|
4247
|
+
export interface CreativeConsumption {
|
|
4248
|
+
/**
|
|
4249
|
+
* LLM or generation tokens consumed during creative generation.
|
|
4250
|
+
*/
|
|
4251
|
+
tokens?: number;
|
|
4252
|
+
/**
|
|
4253
|
+
* Number of images produced during generation.
|
|
4254
|
+
*/
|
|
4255
|
+
images_generated?: number;
|
|
4256
|
+
/**
|
|
4257
|
+
* Number of render passes performed (video, animation).
|
|
4258
|
+
*/
|
|
4259
|
+
renders?: number;
|
|
4260
|
+
/**
|
|
4261
|
+
* Processing time billed, in seconds. For compute-time pricing models.
|
|
4262
|
+
*/
|
|
4263
|
+
duration_seconds?: number;
|
|
4264
|
+
}
|
|
4125
4265
|
/**
|
|
4126
4266
|
* Multi-format success response. Returned when the request used target_format_ids. Contains one manifest per requested format. Multi-format requests are atomic — all formats must succeed or the entire request fails with an error response. Array order corresponds to the target_format_ids request order.
|
|
4127
4267
|
*/
|
|
@@ -4185,6 +4325,19 @@ export interface BuildCreativeMultiSuccess {
|
|
|
4185
4325
|
expires_at: string;
|
|
4186
4326
|
};
|
|
4187
4327
|
preview_error?: Error;
|
|
4328
|
+
/**
|
|
4329
|
+
* Which rate card pricing option was applied for this build. Represents the total cost of the entire multi-format build call. Present when the creative agent charges for its services.
|
|
4330
|
+
*/
|
|
4331
|
+
pricing_option_id?: string;
|
|
4332
|
+
/**
|
|
4333
|
+
* Total cost incurred for this multi-format build, denominated in currency. May be 0 for CPM-priced creatives where cost accrues at serve time.
|
|
4334
|
+
*/
|
|
4335
|
+
vendor_cost?: number;
|
|
4336
|
+
/**
|
|
4337
|
+
* ISO 4217 currency code for vendor_cost.
|
|
4338
|
+
*/
|
|
4339
|
+
currency?: string;
|
|
4340
|
+
consumption?: CreativeConsumption;
|
|
4188
4341
|
context?: ContextObject;
|
|
4189
4342
|
ext?: ExtensionObject;
|
|
4190
4343
|
}
|
|
@@ -4260,7 +4413,7 @@ export interface SyncCreativesSuccess {
|
|
|
4260
4413
|
* Creative ID from the request
|
|
4261
4414
|
*/
|
|
4262
4415
|
creative_id: string;
|
|
4263
|
-
account?:
|
|
4416
|
+
account?: Account1;
|
|
4264
4417
|
action: CreativeAction;
|
|
4265
4418
|
/**
|
|
4266
4419
|
* Platform-specific ID assigned to the creative
|
|
@@ -4310,6 +4463,92 @@ export interface SyncCreativesSuccess {
|
|
|
4310
4463
|
context?: ContextObject;
|
|
4311
4464
|
ext?: ExtensionObject;
|
|
4312
4465
|
}
|
|
4466
|
+
/**
|
|
4467
|
+
* Account that owns this creative
|
|
4468
|
+
*/
|
|
4469
|
+
export interface Account1 {
|
|
4470
|
+
/**
|
|
4471
|
+
* Unique identifier for this account
|
|
4472
|
+
*/
|
|
4473
|
+
account_id: string;
|
|
4474
|
+
/**
|
|
4475
|
+
* Human-readable account name (e.g., 'Acme', 'Acme c/o Pinnacle')
|
|
4476
|
+
*/
|
|
4477
|
+
name: string;
|
|
4478
|
+
/**
|
|
4479
|
+
* The advertiser whose rates apply to this account
|
|
4480
|
+
*/
|
|
4481
|
+
advertiser?: string;
|
|
4482
|
+
/**
|
|
4483
|
+
* Optional intermediary who receives invoices on behalf of the advertiser (e.g., agency)
|
|
4484
|
+
*/
|
|
4485
|
+
billing_proxy?: string;
|
|
4486
|
+
status: AccountStatus;
|
|
4487
|
+
brand?: BrandReference;
|
|
4488
|
+
/**
|
|
4489
|
+
* Domain of the entity operating this account. When the brand operates directly, this is the brand's domain.
|
|
4490
|
+
*/
|
|
4491
|
+
operator?: string;
|
|
4492
|
+
/**
|
|
4493
|
+
* Who is invoiced on this account. operator: seller invoices the operator (agency or brand buying direct). agent: agent consolidates billing. advertiser: seller invoices the advertiser directly, even when a different operator places orders on their behalf. See billing_entity for the invoiced party's business details.
|
|
4494
|
+
*/
|
|
4495
|
+
billing?: 'operator' | 'agent' | 'advertiser';
|
|
4496
|
+
billing_entity?: BusinessEntity;
|
|
4497
|
+
/**
|
|
4498
|
+
* Identifier for the rate card applied to this account
|
|
4499
|
+
*/
|
|
4500
|
+
rate_card?: string;
|
|
4501
|
+
/**
|
|
4502
|
+
* Payment terms agreed for this account. Binding for all invoices when the account is active.
|
|
4503
|
+
*/
|
|
4504
|
+
payment_terms?: 'net_15' | 'net_30' | 'net_45' | 'net_60' | 'net_90' | 'prepay';
|
|
4505
|
+
/**
|
|
4506
|
+
* Maximum outstanding balance allowed
|
|
4507
|
+
*/
|
|
4508
|
+
credit_limit?: {
|
|
4509
|
+
amount: number;
|
|
4510
|
+
currency: string;
|
|
4511
|
+
};
|
|
4512
|
+
/**
|
|
4513
|
+
* Present when status is 'pending_approval'. Contains next steps for completing account activation.
|
|
4514
|
+
*/
|
|
4515
|
+
setup?: {
|
|
4516
|
+
/**
|
|
4517
|
+
* URL where the human can complete the required action (credit application, legal agreement, add funds).
|
|
4518
|
+
*/
|
|
4519
|
+
url?: string;
|
|
4520
|
+
/**
|
|
4521
|
+
* Human-readable description of what's needed.
|
|
4522
|
+
*/
|
|
4523
|
+
message: string;
|
|
4524
|
+
/**
|
|
4525
|
+
* When this setup link expires.
|
|
4526
|
+
*/
|
|
4527
|
+
expires_at?: string;
|
|
4528
|
+
};
|
|
4529
|
+
/**
|
|
4530
|
+
* How the seller scoped this account. operator: shared across all brands for this operator. brand: shared across all operators for this brand. operator_brand: dedicated to a specific operator+brand combination. agent: the agent's default account with no brand or operator association.
|
|
4531
|
+
*/
|
|
4532
|
+
account_scope?: 'operator' | 'brand' | 'operator_brand' | 'agent';
|
|
4533
|
+
/**
|
|
4534
|
+
* Governance agent endpoints registered on this account. Authentication credentials are write-only and not included in responses — use sync_governance to set or update credentials.
|
|
4535
|
+
*/
|
|
4536
|
+
governance_agents?: {
|
|
4537
|
+
/**
|
|
4538
|
+
* Governance agent endpoint URL. Must use HTTPS.
|
|
4539
|
+
*/
|
|
4540
|
+
url: string;
|
|
4541
|
+
/**
|
|
4542
|
+
* Governance categories this agent handles (e.g., ['budget_authority', 'strategic_alignment']). When omitted, the agent handles all categories.
|
|
4543
|
+
*/
|
|
4544
|
+
categories?: string[];
|
|
4545
|
+
}[];
|
|
4546
|
+
/**
|
|
4547
|
+
* When true, this is a sandbox account — no real platform calls, no real spend. For explicit accounts (require_operator_auth: true), sandbox accounts are pre-existing test accounts on the platform discovered via list_accounts. For implicit accounts, sandbox is part of the natural key: the same brand/operator pair can have both a production and sandbox account.
|
|
4548
|
+
*/
|
|
4549
|
+
sandbox?: boolean;
|
|
4550
|
+
ext?: ExtensionObject;
|
|
4551
|
+
}
|
|
4313
4552
|
/**
|
|
4314
4553
|
* Error response - operation failed completely, no creatives were processed
|
|
4315
4554
|
*/
|