DELETE /v3/advertiser/bidlist → advertiserAssociateBidList
Overview
| Property |
Value |
| REST endpoint |
DELETE /v3/advertiser/bidlist |
| GraphQL operation |
advertiserAssociateBidList |
| Input type |
AdvertiserAssociateBidListInput |
| Output type |
PayloadWithErrorsOfAdvertiser (data: Advertiser, userErrors: [UserError!]!) |
Input field mapping
Input type: AdvertiserAssociateBidListInput
| REST field |
GraphQL field |
GraphQL type |
Required |
Notes |
AdvertiserId |
advertiserId |
ID! |
Required |
N/A |
BidList |
bidListIdsToRemove |
[ID!] |
Required |
REST BidList wrapper disassociates via bidListIdsToRemove |
BidList.BidListId |
bidListIdsToRemove[] |
ID! |
Required |
REST BidList.BidListId maps to a single entry in bidListIdsToRemove |
BidList.IsEnabled |
N/A |
Boolean |
Optional |
Not used on DELETE; disassociation is by bid list ID only |
BidList.IsDefaultForDimension |
N/A |
Boolean |
Optional |
Not used on DELETE |
BidList.BidListSource |
N/A |
BidListSource |
Optional |
Read-only |
BidList.BidListAdjustmentType |
N/A |
BidListAdjustmentType |
Optional |
Read-only |
BidList.BidListDimensions |
N/A |
[BidListDimension!] |
Optional |
Read-only |
Output field mapping
Output type: Advertiser (returned as data)
| REST response field |
GraphQL field |
GraphQL type |
Nullable |
Notes |
AdvertiserId |
id |
ID! |
Not nullable |
N/A |
AssociatedBidLists |
associatedBidLists |
AssociatedBidListsConnection |
Nullable |
N/A |
AssociatedBidLists[].BidListId |
associatedBidLists.nodes[].bidList.id |
ID! |
Not nullable |
Via nested bidList on AssociatedBidList |
AssociatedBidLists[].IsEnabled |
associatedBidLists.nodes[].isEnabled |
Boolean! |
Not nullable |
N/A |
AssociatedBidLists[].IsDefaultForDimension |
N/A |
Boolean |
Nullable |
Not currently available in GraphQL |
AssociatedBidLists[].BidListSource |
associatedBidLists.nodes[].bidList.source |
BidListSource! |
Not nullable |
N/A |
AssociatedBidLists[].BidListAdjustmentType |
associatedBidLists.nodes[].bidList.adjustmentType |
BidListAdjustmentType! |
Not nullable |
N/A |
AssociatedBidLists[].BidListDimensions |
associatedBidLists.nodes[].bidList.dimensions |
[BidListDimension!]! |
Not nullable |
N/A |
Code examples
REST example
DELETE /v3/advertiser/bidlist HTTP/1.1
Content-Type: application/json
TTD-Auth: AUTH_TOKEN_PLACEHOLDER
{
"AdvertiserId": "adv123",
"BidList": {
"BidListId": "bl456"
}
}
GraphQL example
POST /graphql HTTP/1.1
Content-Type: application/json
TTD-Auth: AUTH_TOKEN_PLACEHOLDER
mutation {
advertiserAssociateBidList(
input: {
advertiserId: "adv123"
bidListIdsToRemove: ["bl456"]
}
) {
data {
id
associatedBidLists {
nodes {
isEnabled
bidList { id }
}
}
}
userErrors {
message
field
}
}
}