- Resource: LineItem
- LineItemType
- LineItemFlight
- LineItemFlightDateType
- LineItemBudget
- LineItemBudgetAllocationType
- PartnerRevenueModel
- PartnerRevenueModelMarkupType
- ConversionCountingConfig
- TrackingFloodlightActivityConfig
- TargetingExpansionConfig
- TargetingExpansionLevel
- LineItemWarningMessage
- MobileApp
- Platform
- Methods
Resource: LineItem
A single line item.
JSON representation |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "insertionOrderId": string, "lineItemId": string, "displayName": string, "lineItemType": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the line item. |
advertiserId |
Output only. The unique ID of the advertiser the line item belongs to. |
campaignId |
Output only. The unique ID of the campaign that the line item belongs to. |
insertionOrderId |
Required. Immutable. The unique ID of the insertion order that the line item belongs to. |
lineItemId |
Output only. The unique ID of the line item. Assigned by the system. |
displayName |
Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. |
lineItemType |
Required. Immutable. The type of the line item. |
entityStatus |
Required. Controls whether or not the line item can spend its budget and bid on inventory.
|
updateTime |
Output only. The timestamp when the line item was last updated. Assigned by the system. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
partnerCosts[] |
The partner costs associated with the line item. If absent or empty in |
flight |
Required. The start and end time of the line item's flight. |
budget |
Required. The budget allocation setting of the line item. |
pacing |
Required. The budget spending speed setting of the line item. |
frequencyCap |
Required. The impression frequency cap settings of the line item. The |
partnerRevenueModel |
Required. The partner revenue model setting of the line item. |
conversionCounting |
The conversion tracking setting of the line item. |
creativeIds[] |
The IDs of the creatives associated with the line item. |
bidStrategy |
Required. The bidding strategy of the line item. |
integrationDetails |
Integration details of the line item. |
inventorySourceIds[] |
The IDs of the private inventory sources assigned to the line item. |
targetingExpansion |
The optimized targeting settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. |
warningMessages[] |
Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. |
mobileApp |
The mobile app promoted by the line item. This is applicable only when |
reservationType |
Output only. The reservation type of the line item. |
excludeNewExchanges |
Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. |
LineItemType
Possible types of a line item.
The type of the line item determines which settings and options are applicable, such as the format of the ads or targeting options.
Enums | |
---|---|
LINE_ITEM_TYPE_UNSPECIFIED |
Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_DISPLAY_DEFAULT |
Image, HTML5, native, or rich media ads. |
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL |
Display ads that drive installs of an app. |
LINE_ITEM_TYPE_VIDEO_DEFAULT |
Video ads sold on a CPM basis for a variety of environments. |
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL |
Video ads that drive installs of an app. |
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY |
Display ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY |
Video ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_AUDIO_DEFAULT |
RTB Audio ads sold for a variety of environments. |
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP |
Over-the-top ads present in OTT insertion orders. This type is only applicable to line items with an insertion order of insertionOrderType OVER_THE_TOP . |
LineItemFlight
Settings that control the active duration of a line item.
JSON representation |
---|
{ "flightDateType": enum ( |
Fields | |
---|---|
flightDateType |
Required. The type of the line item's flight dates. |
dateRange |
The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone.
|
triggerId |
The ID of the manual trigger associated with the line item.
Warning: Line Items using manual triggers no longer serve in Display & Video 360. This field will sunset on August 1, 2023. Read our feature deprecation announcement for more information. |
LineItemFlightDateType
Possible types of a line item's flight dates.
Enums | |
---|---|
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED |
Type value is not specified or is unknown in this version. |
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED |
The line item's flight dates are inherited from its parent insertion order. |
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM |
The line item uses its own custom flight dates. |
LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER |
The line item uses a trigger. Warning: Line Items using manual triggers no longer serve in Display & Video 360. This value will sunset on August 1, 2023. Read our feature deprecation announcement for more information. |
LineItemBudget
Settings that control how budget is allocated.
JSON representation |
---|
{ "budgetAllocationType": enum ( |
Fields | |
---|---|
budgetAllocationType |
Required. The type of the budget allocation.
|
budgetUnit |
Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. |
maxAmount |
The maximum budget amount the line item will spend. Must be greater than 0. When
|
LineItemBudgetAllocationType
Possible types of the budget allocation.
Enums | |
---|---|
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED |
Type value is not specified or is unknown in this version. |
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC |
Automatic budget allocation is enabled for the line item. |
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED |
A fixed max budget amount is allocated for the line item. |
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED |
No budget limit is applied to the line item. |
PartnerRevenueModel
Settings that control how partner revenue is calculated.
JSON representation |
---|
{
"markupType": enum ( |
Fields | |
---|---|
markupType |
Required. The markup type of the partner revenue model. |
markupAmount |
Required. The markup amount of the partner revenue model. Must be greater than or equal to 0.
|
PartnerRevenueModelMarkupType
Possible markup types of the partner revenue model.
Enums | |
---|---|
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED |
Type value is not specified or is unknown in this version. |
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM |
Calculate the partner revenue based on a fixed CPM. |
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP |
Calculate the partner revenue based on a percentage surcharge of its media cost. |
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP |
Calculate the partner revenue based on a percentage surcharge of its total media cost, which includes all partner costs and data costs. |
ConversionCountingConfig
Settings that control how conversions are counted.
All post-click conversions will be counted. A percentage value can be set for post-view conversions counting.
JSON representation |
---|
{
"postViewCountPercentageMillis": string,
"floodlightActivityConfigs": [
{
object ( |
Fields | |
---|---|
postViewCountPercentageMillis |
The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. |
floodlightActivityConfigs[] |
The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. |
TrackingFloodlightActivityConfig
Settings that control the behavior of a single Floodlight activity config.
JSON representation |
---|
{ "floodlightActivityId": string, "postClickLookbackWindowDays": integer, "postViewLookbackWindowDays": integer } |
Fields | |
---|---|
floodlightActivityId |
Required. The ID of the Floodlight activity. |
postClickLookbackWindowDays |
Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. |
postViewLookbackWindowDays |
Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive. |
TargetingExpansionConfig
Settings that control the optimized targeting settings of the line item.
JSON representation |
---|
{
"targetingExpansionLevel": enum ( |
Fields | |
---|---|
targetingExpansionLevel |
Required. Whether optimized targeting is turned on. This field supports the following values:
If this field is set to any other value, it will automatically be set to
|
excludeFirstPartyAudience |
Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of optimized targeting. This field will be set to |
TargetingExpansionLevel
The Optimized targeting setting.
Enums | |
---|---|
TARGETING_EXPANSION_LEVEL_UNSPECIFIED |
The optimized targeting setting is not specified or is unknown in this version. |
NO_EXPANSION |
Optimized targeting is off. |
LEAST_EXPANSION |
Optimized targeting is on. |
SOME_EXPANSION |
If used, will automatically be set to |
BALANCED_EXPANSION |
If used, will automatically be set to |
MORE_EXPANSION |
If used, will automatically be set to |
MOST_EXPANSION |
If used, will automatically be set to |
LineItemWarningMessage
The warning messages generated by a line item. These types of warnings do not block saving a line item, but may block a line item from running.
Enums | |
---|---|
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED |
Not specified or is unknown. |
INVALID_FLIGHT_DATES |
This line item has invalid flight dates. The line item will not run. |
EXPIRED |
This line item's end date is in the past. |
PENDING_FLIGHT |
This line item will begin running in the future. |
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED |
All partner enabled exchanges are negatively targeted. The line item will not run. |
INVALID_INVENTORY_SOURCE |
No active inventory sources are being targeted. The line item will not run. |
APP_INVENTORY_INVALID_SITE_TARGETING |
This line item's Apps & URLs targeting doesn't include any mobile apps. This line item's type requires you to include mobile apps in your channel, sitelist, or apps targeting. The line item will not run. |
APP_INVENTORY_INVALID_AUDIENCE_LISTS |
This line item isn't targeting any mobile users. This line item's type requires you to target a user list with mobile users. The line item will not run. |
NO_VALID_CREATIVE |
This line item does not contain any valid creative. The line item will not run. |
PARENT_INSERTION_ORDER_PAUSED |
The insertion order of this line item is paused. The line item will not run. |
PARENT_INSERTION_ORDER_EXPIRED |
The insertion order of this line item has its end date set in the past. The line item will not run. |
NO_POSITIVE_AUDIENCE_LIST_TARGETED |
This line item does not target any audience lists, which may result in spending your budget too quickly. |
APP_INSTALL_NO_CONVERSION_PIXEL |
This app install line item does not have any conversion pixel set up. |
TARGETING_REVOKED_OR_CLOSED_USER_LIST |
This line item targets one or more user lists that are no longer available. In the future, this will prevent the line item from serving, so consider removing these lists from your targeting. |
APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY |
This app install line item does not have an optimal bidding strategy. |
CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS |
Deals targeted by this line item accept creative sizes which are not in use. This may limit the line item's delivery or performance. |
NO_CREATIVE_FOR_TARGETED_DEALS |
This line item does not contain any creative for the targeted deals. |
TARGETING_DEPRECATED_GEO_TARGET |
This line item targets a geo target that is deprecated. |
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION |
This line item uses the Update your API integration to directly exclude any first-party audiences using audience targeting before March 25, 2023 to account for the sunset of the |
MobileApp
A mobile app promoted by a mobile app install line item.
JSON representation |
---|
{
"appId": string,
"platform": enum ( |
Fields | |
---|---|
appId |
Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as iOS apps are identified by a nine-digit app ID used by Apple's App store, such as |
platform |
Output only. The app platform. |
displayName |
Output only. The app name. |
publisher |
Output only. The app publisher. |
Platform
Possible mobile app platforms.
Enums | |
---|---|
PLATFORM_UNSPECIFIED |
Platform is not specified. |
IOS |
iOS platform. |
ANDROID |
Android platform. |
Methods |
|
---|---|
|
Bulk edits targeting options under a single line item. |
|
Lists assigned targeting options of a line item across targeting types. |
|
Creates a new line item. |
|
Deletes a line item. |
|
Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entity_status . |
|
Gets a line item. |
|
Lists line items in an advertiser. |
|
Updates an existing line item. |