@adcp/client API Reference - v3.11.2
Documentation
GitHub
npm
Preparing search index...
@adcp/client API Reference - v3.11.2
Classes
ContentStandardsAdapter
PropertyListAdapter
ProposalManager
AIProposalManager
SISessionManager
AISISessionManager
Agent
AgentCollection
ADCPMultiAgentClient
AgentClient
AsyncHandler
ConfigurationManager
CreativeAgentClient
ProtocolResponseParser
ResponseValidator
UnsupportedFeatureError
SingleAgentClient
InputRequiredError
TaskExecutor
PropertyCrawler
PropertyIndex
ADCPError
TaskTimeoutError
MaxClarificationError
DeferredTaskError
TaskAbortedError
AgentNotFoundError
UnsupportedTaskError
ProtocolError
ADCPValidationError
MissingInputHandlerError
InvalidContextError
ConfigurationError
AuthenticationRequiredError
ProtocolClient
MemoryStorage
Interfaces
ContentEvaluationResult
IContentStandardsAdapter
ResolvedProperty
IPropertyListAdapter
ProposalContext
IProposalManager
SISession
ISISessionManager
WebhookMetadata
NotificationMetadata
MediaBuyDeliveryNotification
Activity
AsyncHandlerConfig
Message
InputRequest
ConversationContext
TaskOptions
TaskState
TaskResult
ConversationConfig
CreativeAgentClientConfig
CreativeFormat
ValidationResult
ValidationOptions
SingleAgentClientConfig
BaseTaskEvent
ProtocolRequestEvent
ProtocolResponseEvent
TaskStatusEvent
ObjectEvent
TaskEventCallbacks
AgentInfo
CrawlResult
PropertyMatch
AgentAuthorization
PropertyIdentifier
Property
AdAgentsJson
OAuthMetadataInfo
FieldHandlerConfig
Storage
AgentCapabilities
ConversationState
DeferredTaskState
StorageConfig
StorageFactory
BatchStorage
PatternStorage
MediaBuy
CreativeSubAsset
AdvertisingProduct
InventoryDetails
Targeting
GeographicTargeting
DemographicTargeting
BehavioralTargeting
ContextualTargeting
DeviceTargeting
FrequencyCap
DeliverySchedule
DayParting
AgentOAuthTokens
AgentOAuthClient
AgentConfig
TestRequest
TestResult
ApiResponse
AgentListResponse
TestResponse
CreativeLibraryItem
CreativePerformanceMetrics
CreativeComplianceData
ManageCreativeAssetsRequest
CreativeFilters
PaginationOptions
ManageCreativeAssetsResponse
FormatID
GetProductsRequest
BrandManifest
GetProductsResponse
Product
CreativePolicy
Proposal
ProductAllocation
ListCreativeFormatsRequest
ListCreativeFormatsResponse
Format
CreateMediaBuyRequest
PackageRequest
CreativeAsset
Account
SyncCreativesRequest
ListCreativesRequest
ListCreativesResponse
GetMediaBuyDeliveryRequest
GetMediaBuyDeliveryResponse
GetSignalsRequest
GetSignalsResponse
ActivateSignalRequest
CreatePropertyListRequest
PropertyListFilters
CreatePropertyListResponse
PropertyList
UpdatePropertyListRequest
UpdatePropertyListResponse
GetPropertyListRequest
GetPropertyListResponse
ListPropertyListsRequest
ListPropertyListsResponse
DeletePropertyListRequest
DeletePropertyListResponse
ListContentStandardsRequest
ContentStandards
Artifact
GetContentStandardsRequest
CreateContentStandardsRequest
UpdateContentStandardsRequest
UpdateContentStandardsResponse
CalibrateContentRequest
ValidateContentDeliveryRequest
SIGetOfferingRequest
SIGetOfferingResponse
SIInitiateSessionRequest
SIIdentity
SICapabilities
SIInitiateSessionResponse
SISendMessageResponse
SITerminateSessionRequest
SITerminateSessionResponse
GetAdCPCapabilitiesRequest
GetAdCPCapabilitiesResponse
ListAccountsRequest
ListAccountsResponse
MediaBuyFeatures
AdcpCapabilities
ToolInfo
CreativeAssignment
RenderDimensions
FormatRender
PreviewRenderV3
Type Aliases
TaskResponseTypeMap
AdcpTaskName
GetProductsStatusChangeHandler
CreateMediaBuyStatusChangeHandler
UpdateMediaBuyStatusChangeHandler
SyncCreativesStatusChangeHandler
InputHandlerResponse
InputHandler
TaskStatus
CreativeFormatType
ADCPStatus
TaskEvent
PropertyIdentifierType
PropertyType
StorageMiddleware
AsyncResponseByTask
AsyncResponseFor
CreateMediaBuyAsyncResponseData
GetProductsAsyncResponseData
UpdateMediaBuyAsyncResponseData
SyncCreativesAsyncResponseData
BrandManifestReference
CreateMediaBuyResponse
SyncCreativesResponse
UpdateMediaBuyRequest
UpdateMediaBuyResponse
ProvidePerformanceFeedbackRequest
ProvidePerformanceFeedbackResponse
ActivateSignalResponse
ListContentStandardsResponse
GetContentStandardsResponse
CreateContentStandardsResponse
CalibrateContentResponse
ValidateContentDeliveryResponse
SISendMessageRequest
AdcpMajorVersion
AdcpProtocol
Variables
ContentStandardsErrorCodes
defaultContentStandardsAdapter
PropertyListErrorCodes
defaultPropertyListAdapter
ProposalErrorCodes
defaultProposalManager
SIErrorCodes
defaultSISessionManager
STANDARD_CREATIVE_AGENTS
ADCP_STATUS
responseParser
responseValidator
autoApproveHandler
deferAllHandler
AdCPClient
TEST_AGENT_TOKEN
TEST_AGENT_MCP_CONFIG
TEST_AGENT_A2A_CONFIG
TEST_AGENT_NO_AUTH_MCP_CONFIG
TEST_AGENT_NO_AUTH_A2A_CONFIG
testAgent
testAgentA2A
testAgentNoAuth
testAgentNoAuthA2A
testAgentClient
creativeAgent
MediaBuyStatusSchema
PacingSchema
MetroAreaSystemSchema
PostalCodeSystemSchema
ExtensionObjectSchema
AccountSchema
CreativeAssignmentSchema
FormatIDSchema
FrequencyCapSchema
PropertyListReferenceSchema
JavaScriptModuleTypeSchema
VASTVersionSchema
VASTTrackingEventSchema
VASTVersion1Schema
DAASTVersionSchema
DAASTTrackingEventSchema
DAASTVersion1Schema
AssetContentTypeSchema
URLAssetTypeSchema
CreativeStatusSchema
ImageAssetSchema
VideoAssetSchema
AudioAssetSchema
TextAssetSchema
HTMLAssetSchema
CSSAssetSchema
JavaScriptAssetSchema
VASTAssetSchema
DAASTAssetSchema
URLAssetSchema
PromotedProductsSchema
OfferingSchema
BrandManifestSchema
PropertyIDSchema
PropertyTagSchema
DeliveryTypeSchema
ReportingFrequencySchema
AvailableMetricSchema
CoBrandingRequirementSchema
LandingPageRequirementSchema
PublisherPropertySelectorSchema
PlacementSchema
MeasurementSchema
ReportingCapabilitiesSchema
CreativePolicySchema
FormatID1Schema
FormatID2Schema
PriceGuidanceSchema
PriceGuidance1Schema
PriceGuidance2Schema
PriceGuidance3Schema
PriceGuidance4Schema
PriceGuidance5Schema
PriceGuidance6Schema
PropertyTypeSchema
PropertyIdentifierTypesSchema
PropertySchema
TaskTypeSchema
AdCPDomainSchema
TaskStatusSchema
CreativeActionSchema
ErrorSchema
ContextObjectSchema
ProductAllocationSchema
GetProductsAsyncWorkingSchema
GetProductsAsyncSubmittedSchema
CreateMediaBuyErrorSchema
CreateMediaBuyAsyncWorkingSchema
CreateMediaBuyAsyncInputRequiredSchema
CreateMediaBuyAsyncSubmittedSchema
UpdateMediaBuyErrorSchema
UpdateMediaBuyAsyncWorkingSchema
UpdateMediaBuyAsyncInputRequiredSchema
UpdateMediaBuyAsyncSubmittedSchema
SyncCreativesSuccessSchema
Account1Schema
SyncCreativesErrorSchema
SyncCreativesAsyncWorkingSchema
SyncCreativesAsyncInputRequiredSchema
SyncCreativesAsyncSubmittedSchema
BrandManifestReferenceSchema
FormatCategorySchema
MediaChannelSchema
GeographicTargetingLevelSchema
MediaBuyFeaturesSchema
CPMPricingOptionSchema
VCPMPricingOptionSchema
CPCPricingOptionSchema
CPCVPricingOptionSchema
CPVPricingOptionSchema
CPPPricingOptionSchema
FlatRatePricingOptionSchema
ProposalSchema
PricingOptionSchema
ListCreativeFormatsRequestSchema
FormatIDParameterSchema
AssetContentType1Schema
CreativeAgentCapabilitySchema
FormatID3Schema
BrandManifestReference1Schema
StartTimingSchema
AuthenticationSchemeSchema
ReportingWebhookSchema
TargetingOverlaySchema
CreativeAssetSchema
PromotedOfferingsSchema
PackageSchema
ValidationModeSchema
PushNotificationConfigSchema
SyncCreativesResponseSchema
CreativeSortFieldSchema
SortDirectionSchema
CreativeFiltersSchema
SubAssetSchema
ListCreativesResponseSchema
PackageUpdateSchema
UpdateMediaBuySuccessSchema
GetMediaBuyDeliveryRequestSchema
PricingModelSchema
PricingModel1Schema
DeliveryMetricsSchema
MetricTypeSchema
FeedbackSourceSchema
ProvidePerformanceFeedbackSuccessSchema
ProvidePerformanceFeedbackErrorSchema
HTTPMethodSchema
WebhookResponseTypeSchema
WebhookSecurityMethodSchema
CreativeManifestSchema
WebhookAssetSchema
BuildCreativeSuccessSchema
BuildCreativeErrorSchema
PreviewOutputFormatSchema
CreativeManifest1Schema
PreviewOutputFormat1Schema
PreviewOutputFormat2Schema
PreviewRenderSchema
PreviewCreativeSingleResponseSchema
PreviewBatchResultSuccessSchema
PreviewBatchResultErrorSchema
DestinationSchema
SignalCatalogTypeSchema
SignalFiltersSchema
ActivationKeySchema
ActivationKey1Schema
DeploymentSchema
ActivateSignalRequestSchema
ActivateSignalSuccessSchema
ActivateSignalErrorSchema
PublisherTagsSourceSchema
PublisherPropertyIDsSourceSchema
IdentifierSchema
FeatureRequirementSchema
PropertyListFiltersSchema
GetPropertyListRequestSchema
ListPropertyListsRequestSchema
DeletePropertyListRequestSchema
DeletePropertyListResponseSchema
ListContentStandardsRequestSchema
AssetAccessSchema
AssetAccess1Schema
AssetAccess2Schema
ArtifactSchema
GetContentStandardsRequestSchema
ContentStandardsSchema
Artifact1Schema
CreateContentStandardsResponseSchema
UpdateContentStandardsRequestSchema
UpdateContentStandardsResponseSchema
CalibrateContentRequestSchema
CalibrateContentResponseSchema
ValidateContentDeliveryRequestSchema
ValidateContentDeliveryResponseSchema
GetMediaBuyArtifactsRequestSchema
GetMediaBuyArtifactsResponseSchema
SIGetOfferingRequestSchema
SIGetOfferingResponseSchema
SIIdentitySchema
SICapabilitiesSchema
SIUIElementSchema
SIInitiateSessionResponseSchema
SISendMessageRequestSchema
A2UIComponentSchema
SITerminateSessionRequestSchema
SITerminateSessionResponseSchema
GetAdCPCapabilitiesRequestSchema
GetAdCPCapabilitiesResponseSchema
ListAccountsRequestSchema
ListAccountsResponseSchema
MediaBuySchema
ProductSchema
GetProductsResponseSchema
GetProductsAsyncInputRequiredSchema
UpdateMediaBuyResponseSchema
CreateMediaBuySuccessSchema
ProductFiltersSchema
FormatSchema
PackageRequestSchema
CreateMediaBuyResponseSchema
SyncCreativesRequestSchema
ListCreativesRequestSchema
UpdateMediaBuyRequestSchema
GetMediaBuyDeliveryResponseSchema
ProvidePerformanceFeedbackRequestSchema
ProvidePerformanceFeedbackResponseSchema
BuildCreativeRequestSchema
BuildCreativeResponseSchema
PreviewCreativeRequestSchema
PreviewCreativeBatchResponseSchema
GetSignalsRequestSchema
GetSignalsResponseSchema
ActivateSignalResponseSchema
DirectIdentifiersSourceSchema
BasePropertySourceSchema
PropertyListSchema
UpdatePropertyListRequestSchema
UpdatePropertyListResponseSchema
GetPropertyListResponseSchema
ListPropertyListsResponseSchema
ListContentStandardsResponseSchema
GetContentStandardsResponseSchema
CreateContentStandardsRequestSchema
SIInitiateSessionRequestSchema
A2UISurfaceSchema
AdCPAsyncResponseDataSchema
MCPWebhookPayloadSchema
GetProductsRequestSchema
ListCreativeFormatsResponseSchema
CreateMediaBuyRequestSchema
PreviewCreativeResponseSchema
CreatePropertyListRequestSchema
CreatePropertyListResponseSchema
SISendMessageResponseSchema
MEDIA_BUY_TOOLS
SIGNALS_TOOLS
GOVERNANCE_TOOLS
CREATIVE_TOOLS
PROTOCOL_TOOLS
REQUEST_TIMEOUT
MAX_CONCURRENT
STANDARD_FORMATS
LIBRARY_VERSION
ADCP_VERSION
COMPATIBLE_ADCP_VERSIONS
VERSION_INFO
Functions
isContentStandardsError
isPropertyListError
getAuthToken
createAdCPHeaders
createAuthenticatedFetch
createMCPAuthHeaders
createADCPMultiAgentClient
createAsyncHandler
createCreativeAgentClient
createOperationId
getPropertyIndex
resetPropertyIndex
is401Error
isADCPError
isErrorOfType
extractErrorInfo
createFieldHandler
createConditionalHandler
createRetryHandler
createSuggestionHandler
createValidatedHandler
combineHandlers
isDeferResponse
isAbortResponse
normalizeHandlerResponse
createAdCPClient
createAdCPClientFromEnv
callA2ATool
createMCPClient
createA2AClient
callMCPTool
createMemoryStorage
createMemoryStorageConfig
createTestAgent
buildSyntheticCapabilities
parseCapabilitiesResponse
supportsV3
supportsProtocol
supportsPropertyListFiltering
supportsContentStandards
adaptPackageRequestForV2
adaptCreateMediaBuyRequestForV2
adaptUpdateMediaBuyRequestForV2
normalizePackageResponse
normalizeMediaBuyResponse
usesV2CreativeIds
usesV3CreativeAssignments
getCreativeIds
getCreativeAssignments
getFormatAssets
getRequiredAssets
getOptionalAssets
getIndividualAssets
getRepeatableGroups
usesDeprecatedAssetsField
getAssetCount
hasAssets
normalizeFormatRenders
normalizeFormatsResponse
getFormatRenders
getPrimaryRender
getCompanionRenders
isMultiRenderFormat
usesV2Dimensions
usesV3Renders
getFormatDimensions
getStandardFormats
normalizePreviewRender
normalizePreview
normalizePreviewCreativeResponse
usesV2RenderFields
usesV3RenderFields
getRenderId
getRenderRole
getPrimaryPreviewRender
getPreviewUrl
getPreviewHtml
detectProtocol
detectProtocolWithTimeout
unwrapProtocolResponse
isAdcpError
isAdcpSuccess
isStatusCompleted
isStatusWorking
isStatusInputRequired
isStatusSubmitted
isStatusFailed
isStatusRejected
isGetProductsCompleted
isGetProductsWorking
isGetProductsInputRequired
isGetProductsSubmitted
isGetProductsFailed
isCreateMediaBuyCompleted
isCreateMediaBuyWorking
isCreateMediaBuyInputRequired
isCreateMediaBuySubmitted
isCreateMediaBuyFailed
isUpdateMediaBuyCompleted
isUpdateMediaBuyWorking
isUpdateMediaBuyInputRequired
isUpdateMediaBuySubmitted
isUpdateMediaBuyFailed
isSyncCreativesCompleted
isSyncCreativesWorking
isSyncCreativesInputRequired
isSyncCreativesSubmitted
isSyncCreativesFailed
getExpectedSchema
validateAgentUrl
validateAdCPResponse
handleAdCPResponse
getAdcpVersion
getLibraryVersion
isCompatibleWith
getCompatibleVersions
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Classes
Content
Standards
Adapter
Property
List
Adapter
Proposal
Manager
AI
Proposal
Manager
SI
Session
Manager
AISI
Session
Manager
Agent
Agent
Collection
ADCP
Multi
Agent
Client
Agent
Client
Async
Handler
Configuration
Manager
Creative
Agent
Client
Protocol
Response
Parser
Response
Validator
Unsupported
Feature
Error
Single
Agent
Client
Input
Required
Error
Task
Executor
Property
Crawler
Property
Index
ADCP
Error
Task
Timeout
Error
Max
Clarification
Error
Deferred
Task
Error
Task
Aborted
Error
Agent
Not
Found
Error
Unsupported
Task
Error
Protocol
Error
ADCP
Validation
Error
Missing
Input
Handler
Error
Invalid
Context
Error
Configuration
Error
Authentication
Required
Error
Protocol
Client
Memory
Storage
Interfaces
Content
Evaluation
Result
I
Content
Standards
Adapter
Resolved
Property
I
Property
List
Adapter
Proposal
Context
I
Proposal
Manager
SI
Session
ISI
Session
Manager
Webhook
Metadata
Notification
Metadata
Media
Buy
Delivery
Notification
Activity
Async
Handler
Config
Message
Input
Request
Conversation
Context
Task
Options
Task
State
Task
Result
Conversation
Config
Creative
Agent
Client
Config
Creative
Format
Validation
Result
Validation
Options
Single
Agent
Client
Config
Base
Task
Event
Protocol
Request
Event
Protocol
Response
Event
Task
Status
Event
Object
Event
Task
Event
Callbacks
Agent
Info
Crawl
Result
Property
Match
Agent
Authorization
Property
Identifier
Property
Ad
Agents
Json
O
Auth
Metadata
Info
Field
Handler
Config
Storage
Agent
Capabilities
Conversation
State
Deferred
Task
State
Storage
Config
Storage
Factory
Batch
Storage
Pattern
Storage
Media
Buy
Creative
Sub
Asset
Advertising
Product
Inventory
Details
Targeting
Geographic
Targeting
Demographic
Targeting
Behavioral
Targeting
Contextual
Targeting
Device
Targeting
Frequency
Cap
Delivery
Schedule
Day
Parting
Agent
O
Auth
Tokens
Agent
O
Auth
Client
Agent
Config
Test
Request
Test
Result
Api
Response
Agent
List
Response
Test
Response
Creative
Library
Item
Creative
Performance
Metrics
Creative
Compliance
Data
Manage
Creative
Assets
Request
Creative
Filters
Pagination
Options
Manage
Creative
Assets
Response
Format
ID
Get
Products
Request
Brand
Manifest
Get
Products
Response
Product
Creative
Policy
Proposal
Product
Allocation
List
Creative
Formats
Request
List
Creative
Formats
Response
Format
Create
Media
Buy
Request
Package
Request
Creative
Asset
Account
Sync
Creatives
Request
List
Creatives
Request
List
Creatives
Response
Get
Media
Buy
Delivery
Request
Get
Media
Buy
Delivery
Response
Get
Signals
Request
Get
Signals
Response
Activate
Signal
Request
Create
Property
List
Request
Property
List
Filters
Create
Property
List
Response
Property
List
Update
Property
List
Request
Update
Property
List
Response
Get
Property
List
Request
Get
Property
List
Response
List
Property
Lists
Request
List
Property
Lists
Response
Delete
Property
List
Request
Delete
Property
List
Response
List
Content
Standards
Request
Content
Standards
Artifact
Get
Content
Standards
Request
Create
Content
Standards
Request
Update
Content
Standards
Request
Update
Content
Standards
Response
Calibrate
Content
Request
Validate
Content
Delivery
Request
SI
Get
Offering
Request
SI
Get
Offering
Response
SI
Initiate
Session
Request
SI
Identity
SI
Capabilities
SI
Initiate
Session
Response
SI
Send
Message
Response
SI
Terminate
Session
Request
SI
Terminate
Session
Response
Get
Ad
CP
Capabilities
Request
Get
Ad
CP
Capabilities
Response
List
Accounts
Request
List
Accounts
Response
Media
Buy
Features
Adcp
Capabilities
Tool
Info
Creative
Assignment
Render
Dimensions
Format
Render
Preview
Render
V3
Type Aliases
Task
Response
Type
Map
Adcp
Task
Name
Get
Products
Status
Change
Handler
Create
Media
Buy
Status
Change
Handler
Update
Media
Buy
Status
Change
Handler
Sync
Creatives
Status
Change
Handler
Input
Handler
Response
Input
Handler
Task
Status
Creative
Format
Type
ADCP
Status
Task
Event
Property
Identifier
Type
Property
Type
Storage
Middleware
Async
Response
By
Task
Async
Response
For
Create
Media
Buy
Async
Response
Data
Get
Products
Async
Response
Data
Update
Media
Buy
Async
Response
Data
Sync
Creatives
Async
Response
Data
Brand
Manifest
Reference
Create
Media
Buy
Response
Sync
Creatives
Response
Update
Media
Buy
Request
Update
Media
Buy
Response
Provide
Performance
Feedback
Request
Provide
Performance
Feedback
Response
Activate
Signal
Response
List
Content
Standards
Response
Get
Content
Standards
Response
Create
Content
Standards
Response
Calibrate
Content
Response
Validate
Content
Delivery
Response
SI
Send
Message
Request
Adcp
Major
Version
Adcp
Protocol
Variables
Content
Standards
Error
Codes
default
Content
Standards
Adapter
Property
List
Error
Codes
default
Property
List
Adapter
Proposal
Error
Codes
default
Proposal
Manager
SI
Error
Codes
default
SI
Session
Manager
STANDARD_
CREATIVE_
AGENTS
ADCP_
STATUS
response
Parser
response
Validator
auto
Approve
Handler
defer
All
Handler
Ad
CP
Client
TEST_
AGENT_
TOKEN
TEST_
AGENT_
MCP_
CONFIG
TEST_
AGENT_
A2
A_
CONFIG
TEST_
AGENT_
NO_
AUTH_
MCP_
CONFIG
TEST_
AGENT_
NO_
AUTH_
A2
A_
CONFIG
test
Agent
test
Agent
A2
A
test
Agent
No
Auth
test
Agent
No
Auth
A2
A
test
Agent
Client
creative
Agent
Media
Buy
Status
Schema
Pacing
Schema
Metro
Area
System
Schema
Postal
Code
System
Schema
Extension
Object
Schema
Account
Schema
Creative
Assignment
Schema
Format
ID
Schema
Frequency
Cap
Schema
Property
List
Reference
Schema
Java
Script
Module
Type
Schema
VAST
Version
Schema
VAST
Tracking
Event
Schema
VAST
Version1
Schema
DAAST
Version
Schema
DAAST
Tracking
Event
Schema
DAAST
Version1
Schema
Asset
Content
Type
Schema
URL
Asset
Type
Schema
Creative
Status
Schema
Image
Asset
Schema
Video
Asset
Schema
Audio
Asset
Schema
Text
Asset
Schema
HTML
Asset
Schema
CSS
Asset
Schema
Java
Script
Asset
Schema
VAST
Asset
Schema
DAAST
Asset
Schema
URL
Asset
Schema
Promoted
Products
Schema
Offering
Schema
Brand
Manifest
Schema
Property
ID
Schema
Property
Tag
Schema
Delivery
Type
Schema
Reporting
Frequency
Schema
Available
Metric
Schema
Co
Branding
Requirement
Schema
Landing
Page
Requirement
Schema
Publisher
Property
Selector
Schema
Placement
Schema
Measurement
Schema
Reporting
Capabilities
Schema
Creative
Policy
Schema
Format
ID1
Schema
Format
ID2
Schema
Price
Guidance
Schema
Price
Guidance1
Schema
Price
Guidance2
Schema
Price
Guidance3
Schema
Price
Guidance4
Schema
Price
Guidance5
Schema
Price
Guidance6
Schema
Property
Type
Schema
Property
Identifier
Types
Schema
Property
Schema
Task
Type
Schema
Ad
CP
Domain
Schema
Task
Status
Schema
Creative
Action
Schema
Error
Schema
Context
Object
Schema
Product
Allocation
Schema
Get
Products
Async
Working
Schema
Get
Products
Async
Submitted
Schema
Create
Media
Buy
Error
Schema
Create
Media
Buy
Async
Working
Schema
Create
Media
Buy
Async
Input
Required
Schema
Create
Media
Buy
Async
Submitted
Schema
Update
Media
Buy
Error
Schema
Update
Media
Buy
Async
Working
Schema
Update
Media
Buy
Async
Input
Required
Schema
Update
Media
Buy
Async
Submitted
Schema
Sync
Creatives
Success
Schema
Account1
Schema
Sync
Creatives
Error
Schema
Sync
Creatives
Async
Working
Schema
Sync
Creatives
Async
Input
Required
Schema
Sync
Creatives
Async
Submitted
Schema
Brand
Manifest
Reference
Schema
Format
Category
Schema
Media
Channel
Schema
Geographic
Targeting
Level
Schema
Media
Buy
Features
Schema
CPM
Pricing
Option
Schema
VCPM
Pricing
Option
Schema
CPC
Pricing
Option
Schema
CPCV
Pricing
Option
Schema
CPV
Pricing
Option
Schema
CPP
Pricing
Option
Schema
Flat
Rate
Pricing
Option
Schema
Proposal
Schema
Pricing
Option
Schema
List
Creative
Formats
Request
Schema
Format
ID
Parameter
Schema
Asset
Content
Type1
Schema
Creative
Agent
Capability
Schema
Format
ID3
Schema
Brand
Manifest
Reference1
Schema
Start
Timing
Schema
Authentication
Scheme
Schema
Reporting
Webhook
Schema
Targeting
Overlay
Schema
Creative
Asset
Schema
Promoted
Offerings
Schema
Package
Schema
Validation
Mode
Schema
Push
Notification
Config
Schema
Sync
Creatives
Response
Schema
Creative
Sort
Field
Schema
Sort
Direction
Schema
Creative
Filters
Schema
Sub
Asset
Schema
List
Creatives
Response
Schema
Package
Update
Schema
Update
Media
Buy
Success
Schema
Get
Media
Buy
Delivery
Request
Schema
Pricing
Model
Schema
Pricing
Model1
Schema
Delivery
Metrics
Schema
Metric
Type
Schema
Feedback
Source
Schema
Provide
Performance
Feedback
Success
Schema
Provide
Performance
Feedback
Error
Schema
HTTP
Method
Schema
Webhook
Response
Type
Schema
Webhook
Security
Method
Schema
Creative
Manifest
Schema
Webhook
Asset
Schema
Build
Creative
Success
Schema
Build
Creative
Error
Schema
Preview
Output
Format
Schema
Creative
Manifest1
Schema
Preview
Output
Format1
Schema
Preview
Output
Format2
Schema
Preview
Render
Schema
Preview
Creative
Single
Response
Schema
Preview
Batch
Result
Success
Schema
Preview
Batch
Result
Error
Schema
Destination
Schema
Signal
Catalog
Type
Schema
Signal
Filters
Schema
Activation
Key
Schema
Activation
Key1
Schema
Deployment
Schema
Activate
Signal
Request
Schema
Activate
Signal
Success
Schema
Activate
Signal
Error
Schema
Publisher
Tags
Source
Schema
Publisher
Property
I
Ds
Source
Schema
Identifier
Schema
Feature
Requirement
Schema
Property
List
Filters
Schema
Get
Property
List
Request
Schema
List
Property
Lists
Request
Schema
Delete
Property
List
Request
Schema
Delete
Property
List
Response
Schema
List
Content
Standards
Request
Schema
Asset
Access
Schema
Asset
Access1
Schema
Asset
Access2
Schema
Artifact
Schema
Get
Content
Standards
Request
Schema
Content
Standards
Schema
Artifact1
Schema
Create
Content
Standards
Response
Schema
Update
Content
Standards
Request
Schema
Update
Content
Standards
Response
Schema
Calibrate
Content
Request
Schema
Calibrate
Content
Response
Schema
Validate
Content
Delivery
Request
Schema
Validate
Content
Delivery
Response
Schema
Get
Media
Buy
Artifacts
Request
Schema
Get
Media
Buy
Artifacts
Response
Schema
SI
Get
Offering
Request
Schema
SI
Get
Offering
Response
Schema
SI
Identity
Schema
SI
Capabilities
Schema
SIUI
Element
Schema
SI
Initiate
Session
Response
Schema
SI
Send
Message
Request
Schema
A2
UI
Component
Schema
SI
Terminate
Session
Request
Schema
SI
Terminate
Session
Response
Schema
Get
Ad
CP
Capabilities
Request
Schema
Get
Ad
CP
Capabilities
Response
Schema
List
Accounts
Request
Schema
List
Accounts
Response
Schema
Media
Buy
Schema
Product
Schema
Get
Products
Response
Schema
Get
Products
Async
Input
Required
Schema
Update
Media
Buy
Response
Schema
Create
Media
Buy
Success
Schema
Product
Filters
Schema
Format
Schema
Package
Request
Schema
Create
Media
Buy
Response
Schema
Sync
Creatives
Request
Schema
List
Creatives
Request
Schema
Update
Media
Buy
Request
Schema
Get
Media
Buy
Delivery
Response
Schema
Provide
Performance
Feedback
Request
Schema
Provide
Performance
Feedback
Response
Schema
Build
Creative
Request
Schema
Build
Creative
Response
Schema
Preview
Creative
Request
Schema
Preview
Creative
Batch
Response
Schema
Get
Signals
Request
Schema
Get
Signals
Response
Schema
Activate
Signal
Response
Schema
Direct
Identifiers
Source
Schema
Base
Property
Source
Schema
Property
List
Schema
Update
Property
List
Request
Schema
Update
Property
List
Response
Schema
Get
Property
List
Response
Schema
List
Property
Lists
Response
Schema
List
Content
Standards
Response
Schema
Get
Content
Standards
Response
Schema
Create
Content
Standards
Request
Schema
SI
Initiate
Session
Request
Schema
A2
UI
Surface
Schema
Ad
CP
Async
Response
Data
Schema
MCP
Webhook
Payload
Schema
Get
Products
Request
Schema
List
Creative
Formats
Response
Schema
Create
Media
Buy
Request
Schema
Preview
Creative
Response
Schema
Create
Property
List
Request
Schema
Create
Property
List
Response
Schema
SI
Send
Message
Response
Schema
MEDIA_
BUY_
TOOLS
SIGNALS_
TOOLS
GOVERNANCE_
TOOLS
CREATIVE_
TOOLS
PROTOCOL_
TOOLS
REQUEST_
TIMEOUT
MAX_
CONCURRENT
STANDARD_
FORMATS
LIBRARY_
VERSION
ADCP_
VERSION
COMPATIBLE_
ADCP_
VERSIONS
VERSION_
INFO
Functions
is
Content
Standards
Error
is
Property
List
Error
get
Auth
Token
create
Ad
CP
Headers
create
Authenticated
Fetch
create
MCP
Auth
Headers
create
ADCP
Multi
Agent
Client
create
Async
Handler
create
Creative
Agent
Client
create
Operation
Id
get
Property
Index
reset
Property
Index
is401
Error
is
ADCP
Error
is
Error
Of
Type
extract
Error
Info
create
Field
Handler
create
Conditional
Handler
create
Retry
Handler
create
Suggestion
Handler
create
Validated
Handler
combine
Handlers
is
Defer
Response
is
Abort
Response
normalize
Handler
Response
create
Ad
CP
Client
create
Ad
CP
Client
From
Env
call
A2
A
Tool
create
MCP
Client
create
A2
A
Client
call
MCP
Tool
create
Memory
Storage
create
Memory
Storage
Config
create
Test
Agent
build
Synthetic
Capabilities
parse
Capabilities
Response
supports
V3
supports
Protocol
supports
Property
List
Filtering
supports
Content
Standards
adapt
Package
Request
For
V2
adapt
Create
Media
Buy
Request
For
V2
adapt
Update
Media
Buy
Request
For
V2
normalize
Package
Response
normalize
Media
Buy
Response
uses
V2
Creative
Ids
uses
V3
Creative
Assignments
get
Creative
Ids
get
Creative
Assignments
get
Format
Assets
get
Required
Assets
get
Optional
Assets
get
Individual
Assets
get
Repeatable
Groups
uses
Deprecated
Assets
Field
get
Asset
Count
has
Assets
normalize
Format
Renders
normalize
Formats
Response
get
Format
Renders
get
Primary
Render
get
Companion
Renders
is
Multi
Render
Format
uses
V2
Dimensions
uses
V3
Renders
get
Format
Dimensions
get
Standard
Formats
normalize
Preview
Render
normalize
Preview
normalize
Preview
Creative
Response
uses
V2
Render
Fields
uses
V3
Render
Fields
get
Render
Id
get
Render
Role
get
Primary
Preview
Render
get
Preview
Url
get
Preview
Html
detect
Protocol
detect
Protocol
With
Timeout
unwrap
Protocol
Response
is
Adcp
Error
is
Adcp
Success
is
Status
Completed
is
Status
Working
is
Status
Input
Required
is
Status
Submitted
is
Status
Failed
is
Status
Rejected
is
Get
Products
Completed
is
Get
Products
Working
is
Get
Products
Input
Required
is
Get
Products
Submitted
is
Get
Products
Failed
is
Create
Media
Buy
Completed
is
Create
Media
Buy
Working
is
Create
Media
Buy
Input
Required
is
Create
Media
Buy
Submitted
is
Create
Media
Buy
Failed
is
Update
Media
Buy
Completed
is
Update
Media
Buy
Working
is
Update
Media
Buy
Input
Required
is
Update
Media
Buy
Submitted
is
Update
Media
Buy
Failed
is
Sync
Creatives
Completed
is
Sync
Creatives
Working
is
Sync
Creatives
Input
Required
is
Sync
Creatives
Submitted
is
Sync
Creatives
Failed
get
Expected
Schema
validate
Agent
Url
validate
Ad
CP
Response
handle
Ad
CP
Response
get
Adcp
Version
get
Library
Version
is
Compatible
With
get
Compatible
Versions
Documentation
GitHub
npm
@adcp/client API Reference - v3.11.2
Loading...