REST Resource: advertisers.lineItems

资源：LineItem

一个订单项。

JSON 表示法 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "lineItemId": string,
  "displayName": string,
  "lineItemType": enum (LineItemType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "flight": {
    object (LineItemFlight)
  },
  "budget": {
    object (LineItemBudget)
  },
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "partnerRevenueModel": {
    object (PartnerRevenueModel)
  },
  "conversionCounting": {
    object (ConversionCountingConfig)
  },
  "creativeIds": [
    string
  ],
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean,
  "youtubeAndPartnersSettings": {
    object (YoutubeAndPartnersSettings)
  }
}
字段
name

string

仅限输出。订单项的资源名称。
advertiserId

string (int64 format)

仅限输出。订单项所属广告客户的唯一 ID。
campaignId

string (int64 format)

仅限输出。订单项所属广告系列的唯一 ID。
insertionOrderId

string (int64 format)

必需。不可变。订单项所属广告订单的唯一 ID。
lineItemId

string (int64 format)

仅限输出。订单项的唯一 ID。由系统分配。
displayName

string

必需。订单项的显示名称。

必须采用 UTF-8 编码，大小不得超过 240 字节。
lineItemType

enum (LineItemType)

必需。不可变。订单项的类型。
entityStatus

enum (EntityStatus)

必需。控制订单项能否支出预算和出价购买广告资源。

  • 对于 lineItems.create 方法，仅允许使用 ENTITY_STATUS_DRAFT。要启用订单项，请使用 lineItems.patch 方法，并在创建后将状态更新为 ENTITY_STATUS_ACTIVE。
  • 无法将订单项从其他任何状态更改回“ENTITY_STATUS_DRAFT”状态。
  • 如果该订单项的父级广告订单未处于有效状态，那么即使该订单项的状态为 ENTITY_STATUS_ACTIVE，它也无法支出其预算。
updateTime

string (Timestamp format)

仅限输出。上次更新订单项时的时间戳。由系统分配。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
partnerCosts[]

object (PartnerCost)

与订单项关联的合作伙伴费用。

如果 lineItems.create 方法中不存在或为空，则新创建的订单项将从其父广告订单继承合作伙伴费用。
flight

object (LineItemFlight)

必需。订单项排期的开始时间和结束时间。
budget

object (LineItemBudget)

必需。订单项的预算分配设置。
pacing

object (Pacing)

必需。订单项的预算支出速度设置。
frequencyCap

object (FrequencyCap)

必需。订单项的展示次数频次上限设置。

如果要指定有限的上限，必须使用此设置对象中的 maxImpressions 字段。
partnerRevenueModel

object (PartnerRevenueModel)

必需。订单项的合作伙伴收入模式设置。
conversionCounting

object (ConversionCountingConfig)

订单项的转化跟踪设置。
creativeIds[]

string (int64 format)

与订单项相关联的广告素材的 ID。
bidStrategy

object (BiddingStrategy)

必需。订单项的出价策略。
integrationDetails

object (IntegrationDetails)

订单项的集成详情。
targetingExpansion

object (TargetingExpansionConfig)

订单项的优化型定位设置。

此配置仅适用于使用自动出价且正向定位到符合条件的受众群体名单的展示广告、视频广告或音频广告订单项。
warningMessages[]

enum (LineItemWarningMessage)

仅限输出。订单项生成的警告消息。这些警告不会阻止保存订单项，但有些警告可能会阻止订单项投放。
mobileApp

object (MobileApp)

订单项宣传的移动应用。

仅当 lineItemType 为 LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL 或 LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL 时，此方法才适用。
reservationType

enum (ReservationType)

仅限输出。订单项的预订类型。
excludeNewExchanges

boolean

是否将新的广告交易平台从订单项自动定位中排除。此字段的默认值为 false。
youtubeAndPartnersSettings

object (YoutubeAndPartnersSettings)

仅限输出。适用于 YouTube 及合作伙伴订单项的专用设置。

LineItemType

可能的订单项类型。

订单项的类型决定了适用的设置和选项，例如广告格式或定位选项。

枚举
LINE_ITEM_TYPE_UNSPECIFIED

此版本中未指定类型值或类型值未知。

您无法使用此 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_DISPLAY_DEFAULT 图片广告、HTML5 广告、原生广告或富媒体广告。
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL 提高应用安装量的展示广告。
LINE_ITEM_TYPE_VIDEO_DEFAULT 视频广告按每千次展示费用 (CPM) 出售，适合多种环境。
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL 提升应用安装量的视频广告。
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY

在移动应用广告资源上投放的展示广告。

无法使用 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY

在移动应用广告资源上投放的视频广告。

您无法使用此 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_AUDIO_DEFAULT 针对各种环境销售的实时出价音频广告。
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP OTT 广告订单中存在 OTT 服务广告。此类型仅适用于广告订单insertionOrderType OVER_THE_TOP 的订单项。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION

用于促成转化的 YouTube 视频广告。

无法使用 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE

不可跳过的 YouTube 视频广告（最长 15 秒）。

您无法使用此 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE

YouTube 视频广告，可混合使用各种格式，以特定顺序展示故事。

无法使用 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO

YouTube 音频广告。

无法使用 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH

YouTube 视频广告，可优化以更低的费用覆盖更多唯一身份用户。可以包含导视广告、可跳过的插播广告或两者兼用。

无法使用 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE

默认的 YouTube 视频广告。

您无法使用此 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP

不可跳过的联网电视 YouTube 视频广告（最长 15 秒）。

您无法使用此 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP

联网电视 YouTube 视频广告可优化覆盖面，以更低的费用覆盖更多唯一身份用户。可以包含导视广告、可跳过的插播广告或两者兼用。

您无法使用此 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP

联网电视默认 YouTube 视频广告。仅添加插播广告格式。

您无法使用此 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY

此类订单项的目标是在特定时间段内向同一用户展示 YouTube 广告定位条件的次数。

无法使用 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW

YouTube 视频广告，旨在通过各种广告格式吸引更多用户观看。

您无法使用此 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME

在数字户外广告资源上投放的展示广告。

您无法使用此 API 创建或更新此类订单项及其定位条件。
LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME

在数字户外广告资源上投放的视频广告。

无法使用 API 创建或更新此类订单项及其定位条件。

LineItemFlight

用于控制订单项有效时长的设置。

JSON 表示法 
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  }
}
字段
flightDateType

enum (LineItemFlightDateType)

必需。订单项的排期类型。
dateRange

object (DateRange)

订单项的广告投放开始日期和结束日期。这些时间戳会相对于父级广告客户的时区进行解析。

  • 当 flightDateType 为 LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM 时，必须设置此参数。否则仅输出。
  • 创建新广告投放时，startDate 和 endDate 都必须是将来的时间。
  • 过去具有 startDate 的现有航班具有可变的 endDate，但不可变的 startDate。
  • endDate 必须为 startDate 或更高版本，且均在 2037 年之前。

LineItemFlightDateType

订单项排期的可能类型。

枚举
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED 此版本中未指定类型值或类型值未知。
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED 订单项的排期会继承其父级广告订单的排期。
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM 订单项使用自己的自定义排期。

LineItemBudget

用于控制预算分配方式的设置。

JSON 表示法 
{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}
字段
budgetAllocationType

enum (LineItemBudgetAllocationType)

必需。预算分配的类型。

LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC 仅适用于为父级广告订单启用了自动分配预算功能时。
budgetUnit

enum (BudgetUnit)

仅限输出。预算单位用于指定预算是基于货币还是基于展示次数。此值会从父级广告订单继承。
maxAmount

string (int64 format)

该订单项将支出的预算金额上限。必须大于 0。

当 budgetAllocationType 为：

  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC，此字段是不可变的，由系统设置。
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED（如果 budgetUnit 为）：
    • BUDGET_UNIT_CURRENCY，此字段表示可支出的预算金额上限，以广告客户所用币种的微单位表示。例如，1500000 代表 1.5 个标准单位的货币。
    • BUDGET_UNIT_IMPRESSIONS，此字段表示要投放的展示次数上限。
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED，此字段不适用，系统将忽略该字段。

LineItemBudgetAllocationType

可能的预算分配类型。

枚举
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED 此版本中未指定类型值或类型值未知。
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC 为订单项启用了自动分配预算。
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED 为订单项分配固定的预算金额上限。
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED 该订单项未应用任何预算限制。

PartnerRevenueModel

用于控制合作伙伴收入计算方式的设置。

JSON 表示法 
{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
字段
markupType

enum (PartnerRevenueModelMarkupType)

必需。合作伙伴收入模式的加价类型。
markupAmount

string (int64 format)

必需。合作伙伴收入模式的加价金额。必须大于等于 0。

  • 当 markupType 设置为 PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM 时，此字段代表每千次展示费用加价（以广告客户币种的微单位表示）。例如，1500000 代表 1.5 个标准单位的货币。
  • 当 markupType 设置为 PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP 时，此字段表示媒体费用百分比加价（以毫秒计）。例如，100 表示 0.1%（十进制 0.001）。
  • 当 markupType 设置为 PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP 时，此字段表示总媒体费用百分比加价（以毫秒计）。例如，100 表示 0.1%（十进制 0.001）。

PartnerRevenueModelMarkupType

合作伙伴收入模式的可能标价类型。

枚举
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED 未指定类型值或此版本中的类型值未知。
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM 根据固定 CPM 计算合作伙伴收入。
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP

根据合作伙伴媒体费用的百分比附加费计算合作伙伴收入。
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP 根据合作伙伴总媒体费用（包括所有合作伙伴费用和数据费用）的百分比附加费计算合作伙伴收入。

ConversionCountingConfig

用于控制转化统计方式的设置。

系统会统计所有点击后转化。您可以为浏览后转化统计设置百分比值。

JSON 表示法 
{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}
字段
postViewCountPercentageMillis

string (int64 format)

要统计的浏览后转化次数所占的百分比，以毫秒为单位（百分之一的 1/1000）。必须介于 0 到 100000 之间（含 0 和 100000）。

例如，要跟踪 50% 的点击后转化，请将值设置为 50000。
floodlightActivityConfigs[]

object (TrackingFloodlightActivityConfig)

用于跟踪转化的 Floodlight 活动配置。

统计的转化次数是此字段中指定的所有 Floodlight 活动 ID 统计的所有转化次数的总和。

TrackingFloodlightActivityConfig

用于控制单项 Floodlight 活动配置行为的设置。

JSON 表示法 
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
字段
floodlightActivityId

string (int64 format)

必需。Floodlight 活动的 ID。
postClickLookbackWindowDays

integer

必需。用户点击广告后，系统可统计转化的天数。必须介于 0 到 90 之间（包括这两个数值）。
postViewLookbackWindowDays

integer

必需。转化可能被计为转化的天数。必须介于 0 到 90 之间（包括这两个数值）。

LineItemWarningMessage

订单项生成的警告消息。此类警告不会阻止订单项保存，但可能会阻止订单项投放。

枚举
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED 未指定或未知。
INVALID_FLIGHT_DATES 此订单项的排期无效。订单项将不会投放。
EXPIRED 此订单项的结束日期是过去的日期。
PENDING_FLIGHT 此订单项将于日后开始投放。
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED 所有已启用合作伙伴的广告交易平台均会被排除。订单项将不会投放。
INVALID_INVENTORY_SOURCE 未定位到任何有效的广告资源来源。订单项将不会投放。
APP_INVENTORY_INVALID_SITE_TARGETING 此订单项的应用和网址定位不包含任何移动应用。此订单项的类型要求您在渠道、网站列表或应用定位条件中添加移动应用。订单项将不会投放。
APP_INVENTORY_INVALID_AUDIENCE_LISTS 此订单项未定位任何移动设备用户。此订单项的类型要求您定位包含移动设备用户的用户名单。订单项将不会投放。
NO_VALID_CREATIVE 此订单项未包含任何有效的广告素材。订单项将不会投放。
PARENT_INSERTION_ORDER_PAUSED 此订单项的广告订单已暂停。订单项将不会投放。
PARENT_INSERTION_ORDER_EXPIRED 此订单项的广告订单的结束日期设置成了过去的日期。订单项将不会投放。
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

此订单项使用的 excludeFirstPartyAudience 设置已被弃用，并预定在 2023 年 3 月 25 日之后停用。

为应对 excludeFirstPartyAudience 字段的弃用，请在 2023 年 3 月 25 日之前更新您的 API 集成，以便直接排除使用受众群体定位的所有第一方受众群体。

MobileApp

由移动应用安装订单项宣传的移动应用。

JSON 表示法 
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
字段
appId

string

必需。平台商店提供的应用的 ID。

Android 应用通过 Android 的 Play 商店使用的软件包 ID（例如 com.google.android.gm）进行标识。

iOS 应用由 Apple App Store 使用的 9 位数应用 ID（例如 422689480）进行标识。
platform

enum (Platform)

仅限输出。应用平台。
displayName

string

仅限输出。应用名称。
publisher

string

仅限输出。应用发布商。

平台

可能的移动应用平台。

枚举
PLATFORM_UNSPECIFIED 未指定平台。
IOS iOS 平台。
ANDROID Android 平台。

YoutubeAndPartnersSettings

YouTube 及合作伙伴订单项的设置。

JSON 表示法 
{
  "biddingStrategy": {
    object (YoutubeAndPartnersBiddingStrategy)
  },
  "viewFrequencyCap": {
    object (FrequencyCap)
  },
  "thirdPartyMeasurementSettings": {
    object (YoutubeAndPartnersThirdPartyMeasurementSettings)
  },
  "inventorySourceSettings": {
    object (YoutubeAndPartnersInventorySourceConfig)
  },
  "contentCategory": enum (YoutubeAndPartnersContentCategory),
  "effectiveContentCategory": enum (YoutubeAndPartnersContentCategory),
  "targetFrequency": {
    object (TargetFrequency)
  },
  "linkedMerchantId": string,
  "relatedVideoIds": [
    string
  ],
  "leadFormId": string,
  "videoAdSequenceSettings": {
    object (VideoAdSequenceSettings)
  }
}
字段
biddingStrategy

object (YoutubeAndPartnersBiddingStrategy)

必需。YouTube 及合作伙伴订单项的出价策略。
viewFrequencyCap

object (FrequencyCap)

订单项的观看频次上限设置。

如果要分配有限上限，则必须使用此设置对象中的 maxViews 字段。
thirdPartyMeasurementSettings

object (YoutubeAndPartnersThirdPartyMeasurementSettings)

可选。订单项的第三方衡量设置。
inventorySourceSettings

object (YoutubeAndPartnersInventorySourceConfig)

用于控制订单项将定位到哪些 YouTube 及合作伙伴广告资源的设置。
contentCategory

enum (YoutubeAndPartnersContentCategory)

将在哪类内容中展示 YouTube 和合作伙伴广告。
effectiveContentCategory

enum (YoutubeAndPartnersContentCategory)

仅限输出。投放订单项时生效的内容分类。如果同时在订单项和广告客户中设置了内容类别，则投放订单项时，系统会应用其中较严格的类别。
targetFrequency

object (TargetFrequency)

您希望此订单项中的广告在特定时间段内向同一用户展示的平均次数。
linkedMerchantId

string (int64 format)

与商品 Feed 的订单项相关联的商家 ID。
relatedVideoIds[]

string

当广告在移动设备上的 YouTube 应用中播放时，视频的 ID 会显示在主视频广告下方。
leadFormId

string (int64 format)

用于生成潜在客户的表单的 ID。
videoAdSequenceSettings

object (VideoAdSequenceSettings)

与 VideoAdSequence 相关的设置。

YoutubeAndPartnersThirdPartyMeasurementSettings

用于控制第三方供应商衡量特定订单项指标的设置。

JSON 表示法 
{
  "viewabilityVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandSafetyVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "reachVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandLiftVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ]
}
字段
viewabilityVendorConfigs[]

object (ThirdPartyVendorConfig)

衡量可见度的第三方供应商。

以下第三方供应商适用：

  • THIRD_PARTY_VENDOR_MOAT
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_TELEMETRY
  • THIRD_PARTY_VENDOR_MEETRICS
brandSafetyVendorConfigs[]

object (ThirdPartyVendorConfig)

衡量品牌保障情况的第三方供应商。

以下第三方供应商适用：

  • THIRD_PARTY_VENDOR_ZERF
  • THIRD_PARTY_VENDOR_DOUBLE_VERIFY
  • THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE
reachVendorConfigs[]

object (ThirdPartyVendorConfig)

衡量覆盖面的第三方供应商。

以下第三方供应商适用：

  • THIRD_PARTY_VENDOR_NIELSEN
  • THIRD_PARTY_VENDOR_COMSCORE
  • THIRD_PARTY_VENDOR_KANTAR
brandLiftVendorConfigs[]

object (ThirdPartyVendorConfig)

衡量品牌提升效果的第三方供应商。

以下第三方供应商适用：

  • THIRD_PARTY_VENDOR_DYNATA
  • THIRD_PARTY_VENDOR_KANTAR

ThirdPartyVendorConfig

用于控制第三方衡量服务供应商配置方式的设置。

JSON 表示法 
{
  "vendor": enum (ThirdPartyVendor),
  "placementId": string
}
字段
vendor

enum (ThirdPartyVendor)

第三方衡量服务供应商。
placementId

string

第三方供应商的平台用于标识订单项的 ID。

ThirdPartyVendor

执行第三方衡量的供应商。

枚举
THIRD_PARTY_VENDOR_UNSPECIFIED 未知的第三方供应商。
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 遥测。
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

用于控制 YouTube 及合作伙伴订单项要定位到的 YouTube 相关广告资源的设置。

JSON 表示法 
{
  "includeYoutubeSearch": boolean,
  "includeYoutubeVideos": boolean,
  "includeGoogleTv": boolean,
  "includeYoutubeVideoPartners": boolean
}
字段
includeYoutubeVideos

boolean

是否定位到 YouTube 上的频道和视频广告资源，以及其他网站上嵌入的 YouTube 视频。
includeGoogleTv

boolean

可选。是否定位到适用于 Google TV 的视频应用中的广告资源。
includeYoutubeVideoPartners

boolean

是否将广告定位到与 YouTube 遵循相同品牌保障标准的合作伙伴网站和应用的集合。

YoutubeAndPartnersContentCategory

YouTube 和合作伙伴内容的品牌保障类别。

枚举
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED 此版本未指定或未知内容类别。
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD 包含适合大多数品牌的各种内容的类别。相关内容符合 YouTube 的“适合投放广告的内容”准则。
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED 一个类别，包括 YouTube 和视频合作伙伴上所有符合创收标准的内容。
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED 此类别包含符合更高要求（尤其是在不当用语和性暗示方面）的有限范围的内容。

TargetFrequency

用于控制在特定时间段内向同一用户展示广告的平均次数的设置。

JSON 表示法 
{
  "targetCount": string,
  "timeUnit": enum (TimeUnit),
  "timeUnitCount": integer
}
字段
targetCount

string (int64 format)

广告在由timeUnit和timeUnitCount指定的时间范围内的平均向同一用户展示的目标次数。
timeUnit

enum (TimeUnit)

目标频次的应用时间单位。

适用的时间单位如下：

  • TIME_UNIT_WEEKS
timeUnitCount

integer

目标频次将持续的 timeUnit 次数。

根据 timeUnit 的值，存在以下限制：

  • TIME_UNIT_WEEKS - 必须为 1

VideoAdSequenceSettings

与 VideoAdSequence 相关的设置。

JSON 表示法 
{
  "minimumDuration": enum (VideoAdSequenceMinimumDuration),
  "steps": [
    {
      object (VideoAdSequenceStep)
    }
  ]
}
字段
minimumDuration

enum (VideoAdSequenceMinimumDuration)

同一用户再次看到此序列的最短时间间隔。
steps[]

object (VideoAdSequenceStep)

序列包含的步骤。

VideoAdSequenceMinimumDuration

用于表示同一用户再次看到 VideoAdSequence 之前可能的最短间隔时间的枚举。

枚举
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED 未指定或未知。
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK 7 天。
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH 30 天。

VideoAdSequenceStep

VideoAdSequence 中单个步骤的详细信息。

JSON 表示法 
{
  "stepId": string,
  "adGroupId": string,
  "previousStepId": string,
  "interactionType": enum (InteractionType)
}
字段
stepId

string (int64 format)

步骤的 ID。
adGroupId

string (int64 format)

步骤的相应广告组的 ID。
previousStepId

string (int64 format)

上一步骤的 ID。第一个步骤没有上一步。
interactionType

enum (InteractionType)

观看者在上一步中进行的互动，会将观看者引导至该步骤。第一个步骤没有 engagementType。

InteractionType

步骤的互动类型。

枚举
INTERACTION_TYPE_UNSPECIFIED 未指定或未知
INTERACTION_TYPE_PAID_VIEW 付费观看。
INTERACTION_TYPE_SKIP 已被观看者跳过。
INTERACTION_TYPE_IMPRESSION 广告展示（已观看）。
INTERACTION_TYPE_ENGAGED_IMPRESSION 观看者未立即跳过，但也未能触发可结算事件的广告展示。

方法

bulkEditAssignedTargetingOptions

 批量修改多个订单项下的定位选项。

bulkListAssignedTargetingOptions

 列出为多种定位类型的多个订单项分配的定位选项。

bulkUpdate

 更新多个订单项。

create

 创建新的订单项。

delete

 删除订单项。

duplicate

 复制订单项。

generateDefault

 创建一个新的订单项，其设置（包括定位条件）会从广告订单和 ENTITY_STATUS_DRAFT entity_status 继承。

get

 获取订单项。

list

 列出广告客户中的订单项。

patch

 更新现有订单项。