@adcp/client API Reference - v3.3.3
Documentation
GitHub
npm
Preparing search index...
@adcp/client API Reference - v3.3.3
Classes
Agent
AgentCollection
ADCPMultiAgentClient
AgentClient
AsyncHandler
ConfigurationManager
CreativeAgentClient
ProtocolResponseParser
ResponseValidator
SingleAgentClient
InputRequiredError
TaskExecutor
PropertyCrawler
PropertyIndex
ADCPError
TaskTimeoutError
MaxClarificationError
DeferredTaskError
TaskAbortedError
AgentNotFoundError
UnsupportedTaskError
ProtocolError
ADCPValidationError
MissingInputHandlerError
InvalidContextError
ConfigurationError
MemoryStorage
Interfaces
WebhookMetadata
NotificationMetadata
MediaBuyDeliveryNotification
Activity
AsyncHandlerConfig
WebhookPayload
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
FieldHandlerConfig
Storage
AgentCapabilities
ConversationState
DeferredTaskState
StorageConfig
StorageFactory
BatchStorage
PatternStorage
MediaBuy
CreativeSubAsset
AdvertisingProduct
InventoryDetails
Targeting
GeographicTargeting
DemographicTargeting
BehavioralTargeting
ContextualTargeting
DeviceTargeting
FrequencyCap
DeliverySchedule
DayParting
AgentConfig
TestRequest
TestResult
ApiResponse
AgentListResponse
TestResponse
CreativeLibraryItem
CreativePerformanceMetrics
CreativeComplianceData
ManageCreativeAssetsRequest
CreativeFilters
PaginationOptions
ManageCreativeAssetsResponse
FormatID
GetProductsRequest
BrandManifest
GetProductsResponse
Product
CreativePolicy
ListCreativeFormatsRequest
ListCreativeFormatsResponse
Format
CreateMediaBuyRequest
PackageRequest
CreativeAsset
SyncCreativesRequest
ListCreativesRequest
ListCreativesResponse
GetMediaBuyDeliveryRequest
GetMediaBuyDeliveryResponse
ListAuthorizedPropertiesRequest
ListAuthorizedPropertiesResponse
GetSignalsRequest
GetSignalsResponse
ActivateSignalRequest
Type Aliases
TaskResponseTypeMap
AdcpTaskName
InputHandlerResponse
InputHandler
TaskStatus
CreativeFormatType
ADCPStatus
TaskEvent
PropertyIdentifierType
PropertyType
StorageMiddleware
BrandManifestReference
CreateMediaBuyResponse
SyncCreativesResponse
UpdateMediaBuyRequest
UpdateMediaBuyResponse
ProvidePerformanceFeedbackRequest
ProvidePerformanceFeedbackResponse
ActivateSignalResponse
Variables
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
ExtensionObjectSchema
CreativeAssignmentSchema
FormatIDSchema
FrequencyCapSchema
DimensionsSchema
VideoAssetSchema
VASTVersionSchema
VASTTrackingEventSchema
VASTVersion1Schema
DAASTVersionSchema
DAASTTrackingEventSchema
DAASTVersion1Schema
ImageAssetSchema
AudioAssetSchema
TextAssetSchema
HTMLAssetSchema
CSSAssetSchema
VASTAssetSchema
DAASTAssetSchema
JavaScriptModuleTypeSchema
PromotedProductsSchema
AssetContentTypeSchema
URLAssetTypeSchema
DeliveryTypeSchema
CPMFixedRatePricingOptionSchema
CPMAuctionPricingOptionSchema
VCPMFixedRatePricingOptionSchema
VCPMAuctionPricingOptionSchema
CPCPricingOptionSchema
CPCVPricingOptionSchema
CPVPricingOptionSchema
CPPPricingOptionSchema
FlatRatePricingOptionSchema
PlacementSchema
PricingOptionSchema
MeasurementSchema
FormatID1Schema
FormatID2Schema
ReportingFrequencySchema
AvailableMetricSchema
CoBrandingRequirementSchema
LandingPageRequirementSchema
PropertyIdentifierTypesSchema
PropertyIDSchema
PropertyTypeSchema
PropertyTagSchema
BrandManifestSchema
BrandManifestReferenceSchema
ContextObjectSchema
ErrorSchema
PublisherPropertySelectorSchema
ReportingCapabilitiesSchema
CreativePolicySchema
FormatCategorySchema
CreativeAgentCapabilitySchema
FormatIDParameterSchema
AssetContentType1Schema
FormatID3Schema
BrandManifestReference1Schema
StartTimingSchema
TargetingOverlaySchema
JavaScriptAssetSchema
PromotedOfferingsSchema
URLAssetSchema
AuthenticationSchemeSchema
PackageSchema
CreativeAssetSchema
ValidationModeSchema
PushNotificationConfigSchema
CreativeActionSchema
CreativeSortFieldSchema
SortDirectionSchema
CreativeStatusSchema
CreativeStatus1Schema
SubAssetSchema
ListCreativesResponseSchema
UpdateMediaBuyRequest1Schema
UpdateMediaBuyResponseSchema
GetMediaBuyDeliveryRequestSchema
PricingModelSchema
DeliveryMetricsSchema
PricingModel1Schema
ListAuthorizedPropertiesRequestSchema
AdvertisingChannelsSchema
MetricTypeSchema
FeedbackSourceSchema
ProvidePerformanceFeedbackRequest1Schema
ProvidePerformanceFeedbackResponseSchema
HTTPMethodSchema
WebhookResponseTypeSchema
WebhookSecurityMethodSchema
PreviewOutputFormatSchema
PreviewOutputFormat1Schema
PreviewOutputFormat2Schema
PreviewRenderSchema
DestinationSchema
ActivationKeySchema
ActivationKey1Schema
SignalCatalogTypeSchema
DeploymentSchema
ActivateSignalRequestSchema
ActivateSignalResponseSchema
MediaBuySchema
ProductSchema
PropertySchema
ProductFiltersSchema
GetProductsResponseSchema
ListCreativeFormatsRequestSchema
FormatSchema
PackageRequestSchema
CreateMediaBuyResponseSchema
SyncCreativesRequestSchema
SyncCreativesResponseSchema
CreativeFiltersSchema
UpdateMediaBuyRequestSchema
GetMediaBuyDeliveryResponseSchema
ListAuthorizedPropertiesResponseSchema
ProvidePerformanceFeedbackRequestSchema
WebhookAssetSchema
CreativeManifestSchema
CreativeManifest1Schema
PreviewCreativeResponseSchema
SignalFiltersSchema
GetSignalsResponseSchema
GetProductsRequestSchema
ListCreativeFormatsResponseSchema
CreateMediaBuyRequestSchema
ListCreativesRequestSchema
BuildCreativeRequestSchema
BuildCreativeResponseSchema
PreviewCreativeRequestSchema
GetSignalsRequestSchema
REQUEST_TIMEOUT
MAX_CONCURRENT
STANDARD_FORMATS
LIBRARY_VERSION
ADCP_VERSION
VERSION_INFO
Functions
getAuthToken
createAdCPHeaders
createAuthenticatedFetch
createMCPAuthHeaders
createADCPMultiAgentClient
createAsyncHandler
createCreativeAgentClient
createOperationId
getPropertyIndex
resetPropertyIndex
isADCPError
isErrorOfType
extractErrorInfo
createFieldHandler
createConditionalHandler
createRetryHandler
createSuggestionHandler
createValidatedHandler
combineHandlers
isDeferResponse
isAbortResponse
normalizeHandlerResponse
createAdCPClient
createAdCPClientFromEnv
createMemoryStorage
createMemoryStorageConfig
createTestAgent
getStandardFormats
detectProtocol
detectProtocolWithTimeout
unwrapProtocolResponse
isAdcpError
isAdcpSuccess
getExpectedSchema
validateAgentUrl
validateAdCPResponse
handleAdCPResponse
getAdcpVersion
getLibraryVersion
isCompatibleWith
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Classes
Agent
Agent
Collection
ADCP
Multi
Agent
Client
Agent
Client
Async
Handler
Configuration
Manager
Creative
Agent
Client
Protocol
Response
Parser
Response
Validator
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
Memory
Storage
Interfaces
Webhook
Metadata
Notification
Metadata
Media
Buy
Delivery
Notification
Activity
Async
Handler
Config
Webhook
Payload
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
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
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
List
Creative
Formats
Request
List
Creative
Formats
Response
Format
Create
Media
Buy
Request
Package
Request
Creative
Asset
Sync
Creatives
Request
List
Creatives
Request
List
Creatives
Response
Get
Media
Buy
Delivery
Request
Get
Media
Buy
Delivery
Response
List
Authorized
Properties
Request
List
Authorized
Properties
Response
Get
Signals
Request
Get
Signals
Response
Activate
Signal
Request
Type Aliases
Task
Response
Type
Map
Adcp
Task
Name
Input
Handler
Response
Input
Handler
Task
Status
Creative
Format
Type
ADCP
Status
Task
Event
Property
Identifier
Type
Property
Type
Storage
Middleware
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
Variables
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
Extension
Object
Schema
Creative
Assignment
Schema
Format
ID
Schema
Frequency
Cap
Schema
Dimensions
Schema
Video
Asset
Schema
VAST
Version
Schema
VAST
Tracking
Event
Schema
VAST
Version1
Schema
DAAST
Version
Schema
DAAST
Tracking
Event
Schema
DAAST
Version1
Schema
Image
Asset
Schema
Audio
Asset
Schema
Text
Asset
Schema
HTML
Asset
Schema
CSS
Asset
Schema
VAST
Asset
Schema
DAAST
Asset
Schema
Java
Script
Module
Type
Schema
Promoted
Products
Schema
Asset
Content
Type
Schema
URL
Asset
Type
Schema
Delivery
Type
Schema
CPM
Fixed
Rate
Pricing
Option
Schema
CPM
Auction
Pricing
Option
Schema
VCPM
Fixed
Rate
Pricing
Option
Schema
VCPM
Auction
Pricing
Option
Schema
CPC
Pricing
Option
Schema
CPCV
Pricing
Option
Schema
CPV
Pricing
Option
Schema
CPP
Pricing
Option
Schema
Flat
Rate
Pricing
Option
Schema
Placement
Schema
Pricing
Option
Schema
Measurement
Schema
Format
ID1
Schema
Format
ID2
Schema
Reporting
Frequency
Schema
Available
Metric
Schema
Co
Branding
Requirement
Schema
Landing
Page
Requirement
Schema
Property
Identifier
Types
Schema
Property
ID
Schema
Property
Type
Schema
Property
Tag
Schema
Brand
Manifest
Schema
Brand
Manifest
Reference
Schema
Context
Object
Schema
Error
Schema
Publisher
Property
Selector
Schema
Reporting
Capabilities
Schema
Creative
Policy
Schema
Format
Category
Schema
Creative
Agent
Capability
Schema
Format
ID
Parameter
Schema
Asset
Content
Type1
Schema
Format
ID3
Schema
Brand
Manifest
Reference1
Schema
Start
Timing
Schema
Targeting
Overlay
Schema
Java
Script
Asset
Schema
Promoted
Offerings
Schema
URL
Asset
Schema
Authentication
Scheme
Schema
Package
Schema
Creative
Asset
Schema
Validation
Mode
Schema
Push
Notification
Config
Schema
Creative
Action
Schema
Creative
Sort
Field
Schema
Sort
Direction
Schema
Creative
Status
Schema
Creative
Status1
Schema
Sub
Asset
Schema
List
Creatives
Response
Schema
Update
Media
Buy
Request1
Schema
Update
Media
Buy
Response
Schema
Get
Media
Buy
Delivery
Request
Schema
Pricing
Model
Schema
Delivery
Metrics
Schema
Pricing
Model1
Schema
List
Authorized
Properties
Request
Schema
Advertising
Channels
Schema
Metric
Type
Schema
Feedback
Source
Schema
Provide
Performance
Feedback
Request1
Schema
Provide
Performance
Feedback
Response
Schema
HTTP
Method
Schema
Webhook
Response
Type
Schema
Webhook
Security
Method
Schema
Preview
Output
Format
Schema
Preview
Output
Format1
Schema
Preview
Output
Format2
Schema
Preview
Render
Schema
Destination
Schema
Activation
Key
Schema
Activation
Key1
Schema
Signal
Catalog
Type
Schema
Deployment
Schema
Activate
Signal
Request
Schema
Activate
Signal
Response
Schema
Media
Buy
Schema
Product
Schema
Property
Schema
Product
Filters
Schema
Get
Products
Response
Schema
List
Creative
Formats
Request
Schema
Format
Schema
Package
Request
Schema
Create
Media
Buy
Response
Schema
Sync
Creatives
Request
Schema
Sync
Creatives
Response
Schema
Creative
Filters
Schema
Update
Media
Buy
Request
Schema
Get
Media
Buy
Delivery
Response
Schema
List
Authorized
Properties
Response
Schema
Provide
Performance
Feedback
Request
Schema
Webhook
Asset
Schema
Creative
Manifest
Schema
Creative
Manifest1
Schema
Preview
Creative
Response
Schema
Signal
Filters
Schema
Get
Signals
Response
Schema
Get
Products
Request
Schema
List
Creative
Formats
Response
Schema
Create
Media
Buy
Request
Schema
List
Creatives
Request
Schema
Build
Creative
Request
Schema
Build
Creative
Response
Schema
Preview
Creative
Request
Schema
Get
Signals
Request
Schema
REQUEST_
TIMEOUT
MAX_
CONCURRENT
STANDARD_
FORMATS
LIBRARY_
VERSION
ADCP_
VERSION
VERSION_
INFO
Functions
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
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
create
Memory
Storage
create
Memory
Storage
Config
create
Test
Agent
get
Standard
Formats
detect
Protocol
detect
Protocol
With
Timeout
unwrap
Protocol
Response
is
Adcp
Error
is
Adcp
Success
get
Expected
Schema
validate
Agent
Url
validate
Ad
CP
Response
handle
Ad
CP
Response
get
Adcp
Version
get
Library
Version
is
Compatible
With
Documentation
GitHub
npm
@adcp/client API Reference - v3.3.3
Loading...