- Resource: InventoryItem
- Pricing
- PlanningPlacementCapCostType
- PlanningPlacementPricingType
- Flight
- PlanningPlacementGroupType
- AdSlot
- PlanningPaymentSourceType
- PlanningPlacementType
- Methods
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 ( |
Fields | |
---|---|
id |
ID of this inventory item. |
accountId |
Account ID of this inventory item. |
subaccountId |
Subaccount ID of this inventory item. |
advertiserId |
Advertiser ID of this inventory item. |
projectId |
Project ID of this inventory item. |
orderId |
Order ID of this inventory item. |
siteId |
ID of the site this inventory item is associated with. |
inPlan |
Whether this inventory item is in plan. |
estimatedClickThroughRate |
Estimated click-through rate of this inventory item. |
estimatedConversionRate |
Estimated conversion rate of this inventory item. |
pricing |
Pricing of this inventory item. |
adSlots[] |
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 |
RFP ID of this inventory item. |
negotiationChannelId |
Negotiation channel ID of this inventory item. |
lastModifiedInfo |
Information about the most recent modification of this inventory item. |
contentCategoryId |
Content category ID of this inventory item. |
placementStrategyId |
Placement strategy ID of this inventory item. |
name |
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 |
Type of inventory item. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
Pricing
JSON representation |
---|
{ "startDate": string, "endDate": string, "capCostType": enum ( |
Fields | |
---|---|
startDate |
Start date of this inventory item. |
endDate |
End date of this inventory item. |
capCostType |
Cap cost type of this inventory item. |
pricingType |
Pricing type of this inventory item. |
flights[] |
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 |
Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups:
is a simple group of inventory items that acts as a single pricing point for a group of tags.
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. |
PlanningPlacementCapCostType
Enums | |
---|---|
PLANNING_PLACEMENT_CAP_COST_TYPE_NONE |
|
PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY |
|
PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE |
PlanningPlacementPricingType
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 |
Inventory item flight start date. |
endDate |
Inventory item flight end date. |
units |
Units of this flight. |
rateOrCost |
Rate or cost of this flight. |
PlanningPlacementGroupType
Enums | |
---|---|
PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE |
A placement package represents "package pricing": Pricing and flight information is defined on the package, not on its child placements. The placements in a package do not need to be on the same page. |
PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK |
A roadblock represents a set of placements that are all the same page. One of the child placements is designated as the "primary" placement for reporting purposes. |
AdSlot
Ad Slot
JSON representation |
---|
{ "linkedPlacementId": string, "name": string, "width": string, "height": string, "compatibility": enum ( |
Fields | |
---|---|
linkedPlacementId |
ID of the placement from an external platform that is linked to this ad slot. |
name |
Name of this ad slot. |
width |
Width of this ad slot. |
height |
Height of this ad slot. |
compatibility |
Ad slot compatibility.
and
refer to rendering either on desktop, mobile devices or in mobile apps for regular or interstitial ads respectively.
and
are for rendering in mobile apps.
refers to rendering in in-stream video ads developed with the VAST standard. |
paymentSourceType |
Payment source type of this ad slot. |
comment |
Comment for this ad slot. |
primary |
Primary ad slot of a roadblock inventory item. |
PlanningPaymentSourceType
Enums | |
---|---|
PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID |
|
PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID |
PlanningPlacementType
Enums | |
---|---|
PLANNING_PLACEMENT_TYPE_REGULAR |
|
PLANNING_PLACEMENT_TYPE_CREDIT |
Methods |
|
---|---|
|
Gets one inventory item by ID. |
|
Retrieves a list of inventory items, possibly filtered. |