List
|
|||||
|
|
||||
Retrieves a list of inventory items, possibly filtered. This method supports paging
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 11 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
projectId Required |
INTEGER |
Project ID for order documents |
ids |
INTEGER |
Select only inventory items with these IDs |
inPlan |
BOOLEAN |
Select only inventory items that are in plan |
maxResults |
INTEGER |
Maximum number of results to return |
orderId |
INTEGER |
Select only inventory items that belong to specified orders |
pageToken |
STRING |
Value of the nextPageToken from the previous result page |
siteId |
INTEGER |
Select only inventory items that are associated with these sites |
sortField |
ENUMERATION |
Field by which to sort the list |
sortOrder |
ENUMERATION |
Order of sorted results |
type |
ENUMERATION |
Select only inventory items with this type |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
projectId INTEGER Required Project ID for order documents |
|
ids INTEGER Select only inventory items with these IDs |
|
inPlan BOOLEAN Select only inventory items that are in plan |
|
maxResults INTEGER Maximum number of results to return |
|
orderId INTEGER Select only inventory items that belong to specified orders |
|
pageToken STRING Value of the nextPageToken from the previous result page |
|
siteId INTEGER Select only inventory items that are associated with these sites |
|
sortField ENUMERATION Field by which to sort the list |
|
sortOrder ENUMERATION Order of sorted results |
|
type ENUMERATION Select only inventory items with this type |
Output
This building block provides 38 output parameters
| Name | Format | Description |
|---|---|---|
inventoryItems[] |
OBJECT |
Represents a buy from the Planning inventory store |
inventoryItems[].accountId |
INTEGER |
Account ID of this inventory item |
inventoryItems[].adSlots[] |
OBJECT |
Ad Slot |
inventoryItems[].adSlots[].comment |
STRING |
Comment for this ad slot |
inventoryItems[].adSlots[].compatibility |
ENUMERATION |
Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard |
inventoryItems[].adSlots[].height |
INTEGER |
Height of this ad slot |
inventoryItems[].adSlots[].linkedPlacementId |
INTEGER |
ID of the placement from an external platform that is linked to this ad slot |
inventoryItems[].adSlots[].name |
STRING |
Name of this ad slot |
inventoryItems[].adSlots[].paymentSourceType |
ENUMERATION |
Payment source type of this ad slot |
inventoryItems[].adSlots[].primary |
BOOLEAN |
Primary ad slot of a roadblock inventory item |
inventoryItems[].adSlots[].width |
INTEGER |
Width of this ad slot |
inventoryItems[].advertiserId |
INTEGER |
Advertiser ID of this inventory item |
inventoryItems[].contentCategoryId |
INTEGER |
Content category ID of this inventory item |
inventoryItems[].estimatedClickThroughRate |
INTEGER |
Estimated click-through rate of this inventory item |
inventoryItems[].estimatedConversionRate |
INTEGER |
Estimated conversion rate of this inventory item |
inventoryItems[].id |
INTEGER |
ID of this inventory item |
inventoryItems[].inPlan |
BOOLEAN |
Whether this inventory item is in plan |
inventoryItems[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem" |
inventoryItems[].lastModifiedInfo |
OBJECT |
Modification timestamp |
inventoryItems[].lastModifiedInfo.time |
INTEGER |
Timestamp of the last change in milliseconds since epoch |
inventoryItems[].name |
STRING |
Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots |
inventoryItems[].negotiationChannelId |
INTEGER |
Negotiation channel ID of this inventory item |
inventoryItems[].orderId |
INTEGER |
Order ID of this inventory item |
inventoryItems[].placementStrategyId |
INTEGER |
Placement strategy ID of this inventory item |
inventoryItems[].pricing |
OBJECT |
Pricing Information |
inventoryItems[].pricing.capCostType |
ENUMERATION |
Cap cost type of this inventory item |
inventoryItems[].pricing.endDate |
DATE |
End date of this inventory item |
inventoryItems[].pricing.flights[] |
OBJECT |
Flight |
inventoryItems[].pricing.groupType |
ENUMERATION |
Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary |
inventoryItems[].pricing.pricingType |
ENUMERATION |
Pricing type of this inventory item |
inventoryItems[].pricing.startDate |
DATE |
Start date of this inventory item |
inventoryItems[].projectId |
INTEGER |
Project ID of this inventory item |
inventoryItems[].rfpId |
INTEGER |
RFP ID of this inventory item |
inventoryItems[].siteId |
INTEGER |
ID of the site this inventory item is associated with |
inventoryItems[].subaccountId |
INTEGER |
Subaccount ID of this inventory item |
inventoryItems[].type |
ENUMERATION |
Type of inventory item |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
= Parameter name
= Format
|
inventoryItems[] OBJECT Represents a buy from the Planning inventory store |
|
inventoryItems[].accountId INTEGER Account ID of this inventory item |
|
inventoryItems[].adSlots[] OBJECT Ad Slot |
|
inventoryItems[].adSlots[].comment STRING Comment for this ad slot |
|
inventoryItems[].adSlots[].compatibility ENUMERATION Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard |
|
inventoryItems[].adSlots[].height INTEGER Height of this ad slot |
|
inventoryItems[].adSlots[].linkedPlacementId INTEGER ID of the placement from an external platform that is linked to this ad slot |
|
inventoryItems[].adSlots[].name STRING Name of this ad slot |
|
inventoryItems[].adSlots[].paymentSourceType ENUMERATION Payment source type of this ad slot |
|
inventoryItems[].adSlots[].primary BOOLEAN Primary ad slot of a roadblock inventory item |
|
inventoryItems[].adSlots[].width INTEGER Width of this ad slot |
|
inventoryItems[].advertiserId INTEGER Advertiser ID of this inventory item |
|
inventoryItems[].contentCategoryId INTEGER Content category ID of this inventory item |
|
inventoryItems[].estimatedClickThroughRate INTEGER Estimated click-through rate of this inventory item |
|
inventoryItems[].estimatedConversionRate INTEGER Estimated conversion rate of this inventory item |
|
inventoryItems[].id INTEGER ID of this inventory item |
|
inventoryItems[].inPlan BOOLEAN Whether this inventory item is in plan |
|
inventoryItems[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem" |
|
inventoryItems[].lastModifiedInfo OBJECT Modification timestamp |
|
inventoryItems[].lastModifiedInfo.time INTEGER Timestamp of the last change in milliseconds since epoch |
|
inventoryItems[].name STRING Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots |
|
inventoryItems[].negotiationChannelId INTEGER Negotiation channel ID of this inventory item |
|
inventoryItems[].orderId INTEGER Order ID of this inventory item |
|
inventoryItems[].placementStrategyId INTEGER Placement strategy ID of this inventory item |
|
inventoryItems[].pricing OBJECT Pricing Information |
|
inventoryItems[].pricing.capCostType ENUMERATION Cap cost type of this inventory item |
|
inventoryItems[].pricing.endDate DATE End date of this inventory item |
|
inventoryItems[].pricing.flights[] OBJECT Flight |
|
inventoryItems[].pricing.groupType ENUMERATION Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned inventory items to be marked as primary |
|
inventoryItems[].pricing.pricingType ENUMERATION Pricing type of this inventory item |
|
inventoryItems[].pricing.startDate DATE Start date of this inventory item |
|
inventoryItems[].projectId INTEGER Project ID of this inventory item |
|
inventoryItems[].rfpId INTEGER RFP ID of this inventory item |
|
inventoryItems[].siteId INTEGER ID of the site this inventory item is associated with |
|
inventoryItems[].subaccountId INTEGER Subaccount ID of this inventory item |
|
inventoryItems[].type ENUMERATION Type of inventory item |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse" |
|
nextPageToken STRING Pagination token to be used for the next list operation |