POST /v3/bidlistsummary/query/adgroup/available → AdGroup.availableBidLists

Overview

Property	Value
REST endpoint	`POST /v3/bidlistsummary/query/adgroup/available`
GraphQL query	AdGroup.availableBidLists
Return type	`AdGroupAvailableBidListConnection`

Multi-step operations

REST endpoint	GraphQL equivalent	Notes
`POST /v3/bidlistsummary/query/adgroup/available`	`AdGroup.availableBidLists`	Paged list of bid lists available to associate with the ad group

Request and filter field mapping

REST request field	GraphQL argument	GraphQL type	Required	Notes
`EntityId`	`adGroup(id: $adGroupId)`	ID!	Required	Parent entity; not a field on `availableBidLists`
`PageStartIndex`	`after`	String	Optional	N/A
`PageSize`	`first`	Int	Optional	N/A
`MaximumLevel`	N/A	N/A	N/A	Not applicable at ad group scope; hierarchy is built into the resolver
`ReturnOnlyEnabledBidLists`	`where.isAssociated`	BooleanOperationFilterInput	Optional	When `true`, filter to bid lists already associated and enabled
`ReturnBidListsUnavailableForLibraryUse`	`where.bidList.isAvailableForLibraryUse`	BooleanOperationFilterInput	Optional	When `false` (default), excludes lists unavailable for library use
`BidListIds`	`where.bidList.id`	LongOperationFilterInput	Optional	Filter to specific bid list IDs
`DimensionDescriptorFilters`	`where.bidList.dimensions`	DimensionsFilterInput	Optional	Filter by bid list dimensions

Response field mapping

Connection nodes are IBidList objects. Per-row association metadata is on edges.associatedEntity.

REST response field	GraphQL field	GraphQL type	Nullable	Notes
`Result`	`nodes`	[IBidList!]	Nullable	N/A
`TotalFilteredCount`	`totalCount`	Int!	Not nullable	N/A
`ResultCount`	N/A	N/A	N/A	N/A
`TotalUnfilteredCount`	N/A	N/A	N/A	N/A
`AssociatedBidListsEntity`	`edges.associatedEntity` (via `__typename`)	AdGroupAvailableBidListAssociatedEntity	Nullable	Union of `AdGroup`, `Advertiser`, `Campaign`, `Partner`; null when not yet associated
`AssociatedBidListsEntityId`	`edges.associatedEntity.id`	ID	Nullable	Resolve via inline fragment on the union member
`BidListId`	`nodes.id`	ID!	Not nullable	N/A
`Name`	`nodes.name`	String!	Not nullable	N/A
`BidListSource`	`nodes.source`	BidListSource!	Not nullable	N/A
`BidListAdjustmentType`	`nodes.adjustmentType`	BidListAdjustmentType!	Not nullable	N/A
`ResolutionType`	`nodes.resolutionType`	MultipleMatchResolutionType!	Not nullable	N/A
`BidLinesCount`	`nodes.bidLinesCount`	Int!	Not nullable	N/A
`BidListOwner`	`nodes.ownerType`	BidListOwnerType!	Not nullable	N/A
`BidListOwnerId`	`nodes.owner`	BidListOwner	Nullable	Union
`IsGlobal`	N/A	N/A	N/A	Not currently available in GraphQL
`IsDeleted`	N/A	N/A	N/A	Not currently available in GraphQL
`BidListDimensions`	`nodes.dimensions`	[BidListDimension!]!	Not nullable	N/A
`IsAvailableForLibraryUse`	`nodes.isAvailableForLibraryUse`	Boolean!	Not nullable	N/A

Code examples

REST example

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

{
  "EntityId": "abc123",
  "PageStartIndex": 0,
  "PageSize": 25
}

GraphQL example

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

query Available($adGroupId: ID!, $first: Int) {
  adGroup(id: $adGroupId) {
    availableBidLists(first: $first) {
      nodes { id name source dimensions }
      edges {
        associatedEntity {
          __typename
          ... on AdGroup { id }
          ... on Campaign { id }
          ... on Advertiser { id }
          ... on Partner { id }
        }
      }
      totalCount
      pageInfo { hasNextPage endCursor }
    }
  }
}