- Resource: LineItem
- LineItemType
- LineItemFlight
- LineItemFlightDateType
- LineItemBudget
- LineItemBudgetAllocationType
- PartnerRevenueModel
- PartnerRevenueModelMarkupType
- ConversionCountingConfig
- TrackingFloodlightActivityConfig
- LineItemWarningMessage
- MobileApp
- Platform
- YoutubeAndPartnersSettings
- ThirdPartyMeasurementConfigs
- ThirdPartyVendorConfig
- ThirdPartyVendor
- YoutubeAndPartnersInventorySourceConfig
- YoutubeAndPartnersContentCategory
- TargetFrequency
- VideoAdSequenceSettings
- VideoAdSequenceMinimumDuration
- VideoAdSequenceStep
- InteractionType
- 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. |
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. |
youtubeAndPartnersSettings |
Output only. Settings specific to YouTube and Partners line items. |
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 . |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION |
YouTube video ads that promote conversions. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE |
YouTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE |
YouTube video ads that show a story in a particular sequence using a mix of formats. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO |
YouTube audio ads. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH |
YouTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE |
Default YouTube video ads. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP |
Connected TV youTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP |
Connected TV youTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP |
Connected TV default YouTube video ads. Only include in-stream ad-format. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY |
The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW |
YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME |
Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API. |
LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME |
Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API. |
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.
|
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. |
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. |
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. |
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. |
YoutubeAndPartnersSettings
Settings for YouTube and Partners line items.
JSON representation |
---|
{ "viewFrequencyCap": { object ( |
Fields | |
---|---|
viewFrequencyCap |
The view frequency cap settings of the line item. The |
thirdPartyMeasurementConfigs |
Optional. The third-party measurement configs of the line item. |
inventorySourceSettings |
Settings that control what YouTube and Partners inventories the line item will target. |
contentCategory |
The kind of content on which the YouTube and Partners ads will be shown. |
effectiveContentCategory |
Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item. |
targetFrequency |
The average number of times you want ads from this line item to show to the same person over a certain period of time. |
linkedMerchantId |
The ID of the merchant which is linked to the line item for product feed. |
relatedVideoIds[] |
The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. |
leadFormId |
The ID of the form to generate leads. |
videoAdSequenceSettings |
The settings related to VideoAdSequence. |
ThirdPartyMeasurementConfigs
Settings that control what third-party vendors are measuring specific line item metrics.
JSON representation |
---|
{ "viewabilityVendorConfigs": [ { object ( |
Fields | |
---|---|
viewabilityVendorConfigs[] |
Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable:
|
brandSafetyVendorConfigs[] |
Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable:
|
reachVendorConfigs[] |
Optional. The third-party vendors measuring reach. The following third-party vendors are applicable:
|
brandLiftVendorConfigs[] |
Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable:
|
ThirdPartyVendorConfig
Settings that control how third-party measurement vendors are configured.
JSON representation |
---|
{
"vendor": enum ( |
Fields | |
---|---|
vendor |
The third-party measurement vendor. |
placementId |
The ID used by the platform of the third-party vendor to identify the line item. |
ThirdPartyVendor
Vendors who perform third-party measurement.
Enums | |
---|---|
THIRD_PARTY_VENDOR_UNSPECIFIED |
Unknown third-party vendor. |
THIRD_PARTY_VENDOR_MOAT |
Moat. |
THIRD_PARTY_VENDOR_DOUBLE_VERIFY |
DoubleVerify. |
THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE |
Integral Ad Science. |
THIRD_PARTY_VENDOR_COMSCORE |
Comscore. |
THIRD_PARTY_VENDOR_TELEMETRY |
Telemetry. |
THIRD_PARTY_VENDOR_MEETRICS |
Meetrics. |
THIRD_PARTY_VENDOR_ZEFR |
ZEFR. |
THIRD_PARTY_VENDOR_NIELSEN |
Nielsen. |
THIRD_PARTY_VENDOR_KANTAR |
Kantar. |
THIRD_PARTY_VENDOR_DYNATA |
Dynata. |
YoutubeAndPartnersInventorySourceConfig
Settings that control what YouTube related inventories the YouTube and Partners line item will target.
JSON representation |
---|
{ "includeYoutube": boolean, "includeGoogleTv": boolean, "includeYoutubeVideoPartners": boolean } |
Fields | |
---|---|
includeYoutube |
Optional. Whether to target inventory on YouTube. This includes both search, channels and videos. |
includeGoogleTv |
Optional. Whether to target inventory in video apps available with Google TV. |
includeYoutubeVideoPartners |
Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. |
YoutubeAndPartnersContentCategory
Brand safety categories for YouTube and Partners content.
Enums | |
---|---|
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED |
Content category is not specified or is unknown in this version. |
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD |
A category consisting of a wide range of content appropriate for most brands. The content is based off of YouTube's advertiser-friendly content guidelines. |
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED |
A category including all content across YouTube and video partners that meets standards for monetization. |
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED |
A category consisting of a reduced range of content that meets heightened requirements, especially regarding inappropriate language and sexual suggestiveness. |
TargetFrequency
Setting that controls the average number of times the ads will show to the same person over a certain period of time.
JSON representation |
---|
{
"targetCount": string,
"timeUnit": enum ( |
Fields | |
---|---|
targetCount |
The target number of times, on average, the ads will be shown to the same person in the timespan dictated by |
timeUnit |
The unit of time in which the target frequency will be applied. The following time unit is applicable:
|
timeUnitCount |
The number of The following restrictions apply based on the value of
|
VideoAdSequenceSettings
Settings related to VideoAdSequence.
JSON representation |
---|
{ "minimumDuration": enum ( |
Fields | |
---|---|
minimumDuration |
The minimum time interval before the same user sees this sequence again. |
steps[] |
The steps of which the sequence consists. |
VideoAdSequenceMinimumDuration
The enum for possible minimum interval time before the same user sees the VideoAdSequence again.
Enums | |
---|---|
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED |
Unspecified or unknown. |
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK |
7 days. |
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH |
30 days. |
VideoAdSequenceStep
The detail of a single step in a VideoAdSequence.
JSON representation |
---|
{
"stepId": string,
"adGroupId": string,
"previousStepId": string,
"interactionType": enum ( |
Fields | |
---|---|
stepId |
The ID of the step. |
adGroupId |
The ID of the corresponding ad group of the step. |
previousStepId |
The ID of the previous step. The first step does not have previous step. |
interactionType |
The interaction on the previous step that will lead the viewer to this step. The first step does not have interactionType. |
InteractionType
The types of the interaction on a step.
Enums | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
Unspecified or unknown |
INTERACTION_TYPE_PAID_VIEW |
A paid view. |
INTERACTION_TYPE_SKIP |
Skipped by the viewer. |
INTERACTION_TYPE_IMPRESSION |
A (viewed) ad impression. |
INTERACTION_TYPE_ENGAGED_IMPRESSION |
An ad impression that was not immediately skipped by the viewer, but didn't reach the billable event either. |
Methods |
|
---|---|
|
Bulk edits targeting options under multiple line items. |
|
Lists assigned targeting options for multiple line items across targeting types. |
|
Updates multiple line items. |
|
Creates a new line item. |
|
Deletes a line item. |
|
Duplicates 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. |