POST /v3/adgroup/query/campaign/template → Campaign.adGroups

Overview

Request and filter field mapping

Response field mapping

Endpoint-specific nested types and enums

AdGroupCategory → industryCategory

RTBAttributes → Budget & pacing

RTBAttributes → Bids

RTBAttributes → Audience targeting

RTBAttributes → ROI goal

REST exposes a discriminated ROIGoal object with many optional metric fields. GraphQL models goals uniformly:

RTBAttributes → Frequency

RTBAttributes → Creatives

RTBAttributes → Dimension bid adjustments

REST inlines dimension adjustments (geo, browser, device, video, language, etc.) under RTBAttributes. GraphQL models these through bid lists and bid factors instead of a flat adjustment object on AdGroup.

RTBAttributes → Auto-optimization & KOA

RTBAttributes → Contract / private marketplace targeting

RTBAttributes → Viewability

RTBAttributes → Site quality providers (Integral / DoubleVerify / Peer39)

REST returns large provider-specific fee and rating trees inline. GraphQL does not mirror those trees on AdGroup; brand-safety, contextual, and viewability provider settings are bid-list and dimension backed.

RTBAttributes → Nielsen / Comscore / Miaozhen

AssociatedBidLists

HighFillAttributes (REST-only envelope)

Code examples

The following are examples of querying ad group templates for a campaign with REST and GraphQL.

Paged ad group templates for a campaign:

REST example

POST /v3/adgroup/query/campaign/template HTTP/1.1
Content-Type: application/json
TTD-Auth: AUTH_TOKEN_PLACEHOLDER

{
  "CampaignId": "cmp123",
  "PageStartIndex": 0,
  "PageSize": 25
}

GraphQL example

POST /graphql HTTP/1.1
Content-Type: application/json
TTD-Auth: AUTH_TOKEN_PLACEHOLDER

query CampaignAdGroupTemplates($campaignId: ID!) {
  campaign(id: $campaignId) {
    adGroups(first: 25, where: { isTemplate: { eq: true } }) {
      totalCount
      nodes {
        id
        name
        campaign { id }
        isEnabled
        description
        status
        channel
        industryCategory {
          id
          name
        }
        associatedBidLists {
          nodes {
            isEnabled
            isDefaultForUI
            bidList {
              id
              name
            }
          }
        }
      }
    }
  }
}

Budget, bids, audience, and viewability (rTBAttributes equivalents):

GraphQL example

POST /graphql HTTP/1.1
Content-Type: application/json
TTD-Auth: AUTH_TOKEN_PLACEHOLDER

query CampaignAdGroupTemplatesTargeting($campaignId: ID!) {
  campaign(id: $campaignId) {
    adGroups(first: 25, where: { isTemplate: { eq: true } }) {
      nodes {
        id
        budgetInAdvertiserCurrency
        budgetInImpressions
        budget {
          total
          spendPriority
        }
        currentFlight {
          dailyTargetInAdvertiserCurrency
          dailyTargetInImpressions
          budgetInAdvertiserCurrency
          allocationType
        }
        baseBidCPMInAdvertiserCurrency
        maxBidCPMInAdvertiserCurrency
        audience { id }
        targetHighValueUsers
        excludeLowValueUsers
        audienceSettings {
          recencyExclusionWindowInMinutes
          strategy
        }
        dataSettings {
          audienceBooster { isEnabled }
          audienceAssistant { isEnabled }
          crossDevice { isEnabled vendor { id name } }
        }
        roiGoal {
          type
          target
        }
        displayViewabilityStandardIntegral
        videoViewabilityStandardIntegral
        qualityAllianceViewabilityProfile
        nielsenTrackingAttributes {
          gender
          startAge
          endAge
          countries
          enhancedNielsenReportingOptions
        }
        analyticsReport {
          nielsenEnabled
          comscoreEnabled
        }
      }
    }
  }
}