Get

Gets one inventory item by ID

3 variables
39 variables

Gets one inventory item by ID

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 3 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

projectId INTEGER Required

Project ID for order documents

id INTEGER Required

Inventory item ID

Output

This building block provides 39 output parameters

  = Parameter name
  = Format

accountId INTEGER

Account ID of this inventory item

adSlots[] OBJECT

Ad Slot

adSlots[].comment STRING

Comment for this ad slot

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

adSlots[].height INTEGER

Height of this ad slot

adSlots[].linkedPlacementId INTEGER

ID of the placement from an external platform that is linked to this ad slot

adSlots[].name STRING

Name of this ad slot

adSlots[].paymentSourceType ENUMERATION

Payment source type of this ad slot

adSlots[].primary BOOLEAN

Primary ad slot of a roadblock inventory item

adSlots[].width INTEGER

Width of this ad slot

advertiserId INTEGER

Advertiser ID of this inventory item

contentCategoryId INTEGER

Content category ID of this inventory item

estimatedClickThroughRate INTEGER

Estimated click-through rate of this inventory item

estimatedConversionRate INTEGER

Estimated conversion rate of this inventory item

id INTEGER

ID of this inventory item

inPlan BOOLEAN

Whether this inventory item is in plan

kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem"

lastModifiedInfo OBJECT

Modification timestamp

lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

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

negotiationChannelId INTEGER

Negotiation channel ID of this inventory item

orderId INTEGER

Order ID of this inventory item

placementStrategyId INTEGER

Placement strategy ID of this inventory item

pricing OBJECT

Pricing Information

pricing.capCostType ENUMERATION

Cap cost type of this inventory item

pricing.endDate DATE

End date of this inventory item

pricing.flights[] OBJECT

Flight

pricing.flights[].endDate DATE

Inventory item flight end date

pricing.flights[].rateOrCost INTEGER

Rate or cost of this flight

pricing.flights[].startDate DATE

Inventory item flight start date

pricing.flights[].units INTEGER

Units of this flight

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

pricing.pricingType ENUMERATION

Pricing type of this inventory item

pricing.startDate DATE

Start date of this inventory item

projectId INTEGER

Project ID of this inventory item

rfpId INTEGER

RFP ID of this inventory item

siteId INTEGER

ID of the site this inventory item is associated with

subaccountId INTEGER

Subaccount ID of this inventory item

type ENUMERATION

Type of inventory item