Manage advertiser entities and their associations with deals and campaigns
Advertisers
Advertisers represent the companies or entities purchasing advertising through the ADP platform. They are associated with Deals and campaigns.
Overview
An Advertiser entity contains:
- Identification - Name, contact information
- Settings - Configuration and preferences
- Associations - Links to deals and campaigns
Query Advertisers
Basic Query
query GetAdvertisers {
dream_adserver {
advertisers(limit: 10) {
edges {
advertiser_id
advertiser_name
advertiser_desc
}
total_count
}
}
}Filtered Query
query GetFilteredAdvertisers($filter: JSON, $sort: JSON) {
dream_adserver {
advertisers(
filter: $filter
sort: $sort
limit: 25
offset: 0
) {
edges {
advertiser_id
advertiser_name
advertiser_desc
advertiser_ext_id
advertiser_ext_ids
advertiser_modification_time
advertiser_modification_user
}
total_count
}
}
}Variables:
{
"filter": {
"advertiser_name": {"like": "%Corp%"}
},
"sort": {
"advertiser_name": "asc"
}
}{
"filter": {
"advertiser_id": {"=": 1001}
}
}Available Fields
The DASAdvertiser type contains only 6 fields. Contact information (email, phone, company name, address) is NOT stored in the advertiser object. Use custom fields or external CRM integration for contact data.
| Field | Type | Description |
|---|---|---|
advertiser_id | Int! | Unique identifier |
advertiser_name | String! | Advertiser name |
advertiser_desc | String | Descriptive information about the advertiser |
advertiser_ext_id | String | ID of the advertiser in external database |
advertiser_ext_ids | JSON | JSON string containing pairs of data sources and IDs |
advertiser_modification_time | String | Last modification time (format: yyyy-mm-ddThh:mm:ss.s+zzzzzz) |
advertiser_modification_user | String | Login of the user who last modified the advertiser data |
Mutations
Create/Update Advertiser
mutation SetAdvertiser($advertiser: DASAdvertiserInput!) {
dream_adserver {
set_advertiser(advertiser: $advertiser) {
status
hit {
advertiser_id
advertiser_name
}
}
}
}Variables (create, with provider mappings):
{
"advertiser": {
"advertiser_name": "Example Corp",
"advertiser_desc": "Digital advertising company",
"advertiser_provider_mappings": [
{ "provider_name": "CRM", "external_id": "EXT-12345" }
]
}
}Variables (edit an existing advertiser — pass advertiser_id):
{
"advertiser": {
"advertiser_id": 1001,
"advertiser_name": "Example Corp",
"advertiser_provider_mappings": [
{ "provider_name": "CRM", "external_id": "EXT-12345" }
]
}
}Required field:
advertiser_name. Omitadvertiser_idto create a new advertiser, provide it to edit an existing one.advertiser_provider_mappingsis the full desired set of external-system mappings, reconciled on every call (add/update/remove) — an empty list clears all mappings, omitting the field leaves existing mappings untouched. The mutation returnshit(the savedDASAdvertiser) alongsidestatus, kept for backward compatibility.
Legacy shape (still supported):
advertiser_external_id+advertiser_provider_name— a single external id, applied as an additive upsert rather than a full reconcile. Preferadvertiser_provider_mappingsfor new integrations.
Next Steps
- Reporting & Analytics - Generate campaign reports
- Line Items - Manage campaigns
- Deals - View deal hierarchy
- Filtering - Master query filters
Related
- Delivery APIs Overview - Campaign hierarchy
- Getting Started - Authentication and basics