Known Agent object
A known agent contains information that deterministically identifies and describes parties involved in buying and selling ad inventory in the open internet ecosystem across The Trade Desk products. By using known agents, all entities can accurately identify their counterparties and incorporate this information into their PDP API and Platform API integrations. Each known agent has a known agent ID (KAID) that's used to retrieve information such as the type of known agent and account preferences. The KnownAgent object specifies the classification as a buying or selling party.
NOTE: This is a read-only object. For details, see Known agents.
A seller can declare properties for a publisher and authorize other sellers to sell inventory, set requirements for creative assets, and declare advertiser categories for competitive separation.
Types of known agents
The KnownAgent object describes the parties available on the buy and supply side. It specifies the account's type—such as advertiser, agency, publisher, seller, or intermediary—and includes read-only information that reflects the account's preferences. The following table lists the descriptions of each supported known agent type.
| Known Agent Type | Description |
|---|---|
| Advertiser | A brand that acquires inventory through The Trade Desk platform. |
| Agency | An advertising agency that buys ad inventory on behalf of a brand. |
| Publisher | A content owner whose content or inventory is available for sale by a seller. |
| Seller | An entity that owns one or more publishers, and sells inventory created by those publishers. |
| Intermediary | An entity that facilitates ad inventory distribution but doesn't own inventory. |
Advertiser object
The KnownAgentAdvertiser object contains the details of a brand that acquires inventory through The Trade Desk platform. The following table lists the object fields.
| Attribute | Required? | Data Type | Description |
|---|---|---|---|
type |
Required | String | The type of known agent: Advertiser. |
id |
Required | String | The KAID of the advertiser. |
name |
Required | String | The name of the advertiser. |
isEnabled |
Required | Boolean | If set to true, indicates that the known agent is active. Otherwise, it's inactive.IMPORTANT: An inactive known agent can still participate in existing deals, but not new deals. |
domain |
Optional | String | The domain associated with the advertiser. |
logoUrl |
Optional | String | The URL that hosts the advertiser's lo |
Agency object
The KnownAgentAgency object contains the details of an advertising agency that buys ad inventory on behalf of a brand. The following table lists the object fields.
| Attribute | Required? | Data Type | Description |
|---|---|---|---|
type |
Required | String | The type of known agent: Agency. |
id |
Required | String | The KAID of the agency. |
name |
Required | String | The name of the agency. |
isEnabled |
Required | Boolean | If set to true, indicates that the known agent is active. Otherwise, it's inactive.IMPORTANT: An inactive known agent can still participate in existing deals, but not new deals. |
advertisers |
Optional | String array | A list of KAIDs of the advertisers on whose behalf the agency buys ad inventory. TIP: You can query this object to retrieve advertisers for deals. For details, see Known agents. |
Publisher object
The KnownAgentPublisher object contains the details of a content owner whose content or inventory is available for sale by a seller. The following table lists the object fields.
| Attribute | Required? | Data Type | Description |
|---|---|---|---|
type |
Required | String | The type of known agent: Publisher. |
id |
Required | String | The KAID of the publisher. |
name |
Required | String | The name of the publisher. |
isEnabled |
Required | Boolean | If set to true, indicates that the known agent is active. Otherwise, it is inactive.IMPORTANT: An inactive known agent can still participate in existing deals, but not new deals. |
logoUrl |
Optional | String | The URL that hosts the publisher's logo. |
seller |
Optional | String | The KAID of the selling party that owns the publisher. |
Seller object
The KnownAgentSeller object contains the details of an entity that owns one or more publishers, and sells inventory created by those publishers. The following table lists the object fields.
| Attribute | Required? | Data Type | Description |
|---|---|---|---|
type |
Required | String | The type of known agent: Seller. |
id |
Required | String | The KAID of the seller. |
name |
Required | String | The name of the seller. |
isEnabled |
Required | Boolean | If set to true, indicates that the known agent is active. Otherwise, it is inactive.IMPORTANT: An inactive known agent can still participate in existing deals, but not new deals. |
logoUrl |
Optional | String | The URL that hosts the seller's logo. |
domain |
Optional | String | The currently active domain of the seller. |
additionalDomains |
Optional | String array | A list of all other domains previously operated under or associated with the seller. |
publishers |
Optional | String array | A list of KAIDs of the publishers that the seller owns. TIP: You can query this object to retrieve its publishers. For details, see Known agents. |
Intermediary object
The KnownAgentIntermediary object contains the details of an entity that facilitates ad inventory distribution but doesn't own inventory. The following table lists the object fields.
| Attribute | Required? | Data Type | Description |
|---|---|---|---|
type |
Required | String | The type of known agent: Intermediary.IMPORTANT: Older versions may use the Reseller value. |
id |
Required | String | The KAID of the intermediary. |
name |
Required | String | The name of the intermediary. |
identifiers |
Optional | Object | The name and value identifiers for the intermediary as listed in their sellers.json file. |
isEnabled |
Required | Boolean | If set to true, indicates that the known agent is active. Otherwise, it is inactive.IMPORTANT: An inactive known agent can still participate in existing deals, but not new deals. |
logoUrl |
Optional | String | The URL that hosts the intermediary's logo. |