The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Dec 24th, 2021. All users must migrate to a newer API version by that date.

REST Resource: inventoryItems

Resource: InventoryItem

Represents a buy from the Planning inventory store.

JSON representation
{
  "id": string,
  "accountId": string,
  "subaccountId": string,
  "advertiserId": string,
  "projectId": string,
  "orderId": string,
  "siteId": string,
  "inPlan": boolean,
  "estimatedClickThroughRate": string,
  "estimatedConversionRate": string,
  "pricing": {
    object (Pricing)
  },
  "adSlots": [
    {
      object (AdSlot)
    }
  ],
  "rfpId": string,
  "negotiationChannelId": string,
  "lastModifiedInfo": {
    object (LastModifiedInfo)
  },
  "contentCategoryId": string,
  "placementStrategyId": string,
  "name": string,
  "type": enum (Type),
  "kind": string
}
Fields
id

string (int64 format)

ID of this inventory item.

accountId

string (int64 format)

Account ID of this inventory item.

subaccountId

string (int64 format)

Subaccount ID of this inventory item.

advertiserId

string (int64 format)

Advertiser ID of this inventory item.

projectId

string (int64 format)

Project ID of this inventory item.

orderId

string (int64 format)

Order ID of this inventory item.

siteId

string (int64 format)

ID of the site this inventory item is associated with.

inPlan

boolean

Whether this inventory item is in plan.

estimatedClickThroughRate

string (int64 format)

Estimated click-through rate of this inventory item.

estimatedConversionRate

string (int64 format)

Estimated conversion rate of this inventory item.

pricing

object (Pricing)

Pricing of this inventory item.

adSlots[]

object (AdSlot)

Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.

rfpId

string (int64 format)

RFP ID of this inventory item.

negotiationChannelId

string (int64 format)

Negotiation channel ID of this inventory item.

lastModifiedInfo

object (LastModifiedInfo)

Information about the most recent modification of this inventory item.

contentCategoryId

string (int64 format)

Content category ID of this inventory item.

placementStrategyId

string (int64 format)

Placement strategy ID of this inventory item.

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.

type

enum (Type)

Type of inventory item.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#inventoryItem"

.

Pricing

Pricing Information

JSON representation
{
  "startDate": string,
  "endDate": string,
  "capCostType": enum (CapCostType),
  "pricingType": enum (PricingType),
  "flights": [
    {
      object (Flight)
    }
  ],
  "groupType": enum (GroupType)
}
Fields
startDate

string

Start date of this inventory item.

endDate

string

End date of this inventory item.

capCostType

enum (CapCostType)

Cap cost type of this inventory item.

pricingType

enum (PricingType)

Pricing type of this inventory item.

flights[]

object (Flight)

Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.

groupType

enum (GroupType)

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.

CapCostType

Enums
PLANNING_PLACEMENT_CAP_COST_TYPE_NONE
PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY
PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE

PricingType

Enums
PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS
PLANNING_PLACEMENT_PRICING_TYPE_CPM
PLANNING_PLACEMENT_PRICING_TYPE_CLICKS
PLANNING_PLACEMENT_PRICING_TYPE_CPC
PLANNING_PLACEMENT_PRICING_TYPE_CPA
PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS
PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS
PLANNING_PLACEMENT_PRICING_TYPE_CPM_ACTIVEVIEW

Flight

Flight

JSON representation
{
  "startDate": string,
  "endDate": string,
  "units": string,
  "rateOrCost": string
}
Fields
startDate

string

Inventory item flight start date.

endDate

string

Inventory item flight end date.

units

string (int64 format)

Units of this flight.

rateOrCost

string (int64 format)

Rate or cost of this flight.

GroupType

Enums
PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE
PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK

AdSlot

Ad Slot

JSON representation
{
  "linkedPlacementId": string,
  "name": string,
  "width": string,
  "height": string,
  "compatibility": enum (Compatibility),
  "paymentSourceType": enum (PaymentSourceType),
  "comment": string,
  "primary": boolean
}
Fields
linkedPlacementId

string (int64 format)

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

name

string

Name of this ad slot.

width

string (int64 format)

Width of this ad slot.

height

string (int64 format)

Height of this ad slot.

compatibility

enum (Compatibility)

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.

paymentSourceType

enum (PaymentSourceType)

Payment source type of this ad slot.

comment

string

Comment for this ad slot.

primary

boolean

Primary ad slot of a roadblock inventory item.

Compatibility

Enums
DISPLAY
DISPLAY_INTERSTITIAL
APP
APP_INTERSTITIAL
IN_STREAM_VIDEO
IN_STREAM_AUDIO

PaymentSourceType

Enums
PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID
PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID

Type

Enums
PLANNING_PLACEMENT_TYPE_REGULAR
PLANNING_PLACEMENT_TYPE_CREDIT

Methods

get

Gets one inventory item by ID.

list

Retrieves a list of inventory items, possibly filtered.