- 资源:LineItem
- LineItemType
- LineItemFlight
- LineItemFlightDateType
- LineItemBudget
- LineItemBudgetAllocationType
- PartnerRevenueModel
- PartnerRevenueModelMarkupType
- ConversionCountingConfig
- TrackingFloodlightActivityConfig
- LineItemWarningMessage
- MobileApp
- 平台
- YoutubeAndPartnersSettings
- ThirdPartyMeasurementConfigs
- ThirdPartyVendorConfig
- ThirdPartyVendor
- YoutubeAndPartnersInventorySourceConfig
- YoutubeAndPartnersContentCategory
- TargetFrequency
- VideoAdSequenceSettings
- VideoAdSequenceMinimumDuration
- VideoAdSequenceStep
- InteractionType
- VideoAdInventoryControl
- 方法
资源:LineItem
单个订单项。
JSON 表示法 |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "insertionOrderId": string, "lineItemId": string, "displayName": string, "lineItemType": enum ( |
字段 | |
---|---|
name |
仅限输出。相应订单项的资源名称。 |
advertiserId |
仅限输出。相应订单项所属广告客户的唯一 ID。 |
campaignId |
仅限输出。相应订单项所属广告系列的唯一 ID。 |
insertionOrderId |
必需。不可变。相应订单项所属广告订单的唯一 ID。 |
lineItemId |
仅限输出。相应订单项的唯一 ID。由系统分配。 |
displayName |
必需。相应订单项的显示名称。 必须采用 UTF-8 编码,大小上限为 240 字节。 |
lineItemType |
必需。不可变。相应订单项的类型。 |
entityStatus |
必需。控制订单项能否支出预算并对广告资源出价。
|
updateTime |
仅限输出。相应订单项上次更新时的时间戳。由系统分配。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
partnerCosts[] |
与相应专列项相关的合作伙伴费用。 如果 |
flight |
必需。相应订单项排期的开始时间和结束时间。 |
budget |
必需。相应订单项的预算分配设置。 |
pacing |
必需。相应订单项的预算支出速度设置。 |
frequencyCap |
必需。相应订单项的展示频次上限设置。 如果分配的是有限的上限,则必须使用此设置对象中的 |
partnerRevenueModel |
必需。相应订单项的合作伙伴收入模式设置。 |
conversionCounting |
相应订单项的转化跟踪设置。 |
creativeIds[] |
与相应订单项相关联的广告素材的 ID。 |
bidStrategy |
必需。相应订单项的出价策略。 |
integrationDetails |
相应订单项的集成详细信息。 |
targetingExpansion |
相应订单项的优化型定位设置。 此配置仅适用于使用自动出价并正向定位到符合条件的受众群体名单的展示广告、视频广告或音频广告订单项。 |
warningMessages[] |
仅限输出。订单项生成的警告消息。这些警告不会阻止您保存订单项,但有些警告可能会阻止订单项投放。 |
mobileApp |
相应订单项宣传的移动应用。 仅当 |
reservationType |
仅限输出。相应订单项的预订类型。 |
excludeNewExchanges |
是否排除新广告交易平台,以防止订单项自动定位到这些平台。此字段默认为 false。 |
youtubeAndPartnersSettings |
仅限输出。特定于 YouTube 及合作伙伴订单项的设置。 |
containsEuPoliticalAds |
相应订单项是否会投放欧盟政治广告。 如果父广告客户中的 |
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 |
通过 RTB 销售的音频广告,适用于各种环境。 |
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 ( |
字段 | |
---|---|
flightDateType |
必需。相应订单项的排期类型。 |
dateRange |
相应订单项的排期开始日期和结束日期。它们是根据父级广告客户的时区来确定的。
|
LineItemFlightDateType
订单项排期的可能类型。
枚举 | |
---|---|
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED |
此版本中未指定或未知类型值。 |
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED |
相应订单项的排期继承自其父级广告订单。 |
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM |
相应订单项使用自己的自定义排期。 |
LineItemBudget
用于控制预算分配方式的设置。
JSON 表示法 |
---|
{ "budgetAllocationType": enum ( |
字段 | |
---|---|
budgetAllocationType |
必需。预算分配的类型。
|
budgetUnit |
仅限输出。预算单位用于指定预算是基于币种还是基于展示次数。此值继承自父级插单。 |
maxAmount |
相应订单项将支出的预算金额上限。必须大于 0。 当
|
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 ( |
字段 | |
---|---|
markupType |
必需。合作伙伴收入模式的加价类型。 |
markupAmount |
必需。合作伙伴收入模式的加价金额。必须大于等于 0。
|
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 ( |
字段 | |
---|---|
postViewCountPercentageMillis |
要纳入统计的浏览后转化次数的百分比,以毫为单位(百分之一的千分之一)。必须在 0 到 100000 之间(含边界值)。 例如,如需跟踪 50% 的点击后转化,请将该值设置为 50000。 |
floodlightActivityConfigs[] |
用于跟踪转化的 Floodlight 活动配置。 统计的转化次数是此字段中指定的所有 Floodlight 活动 ID 统计的所有转化次数之和。 如果订单项已分配自定义出价算法,则无法更新此字段。如果您在同一请求中设置此字段并分配自定义出价算法,则 Floodlight 活动必须与自定义出价算法使用的活动一致。 |
TrackingFloodlightActivityConfig
用于控制单个 Floodlight 活动配置行为的设置。
JSON 表示法 |
---|
{ "floodlightActivityId": string, "postClickLookbackWindowDays": integer, "postViewLookbackWindowDays": integer } |
字段 | |
---|---|
floodlightActivityId |
必需。Floodlight 活动的 ID。 |
postClickLookbackWindowDays |
必需。用户点击广告后,系统可能会统计转化,此时间范围以天数计。必须介于 0 到 90 之间(含边界值)。 |
postViewLookbackWindowDays |
必需。观看广告后,系统可能会在多少天内统计转化。必须介于 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 |
相应订单项的广告订单的结束日期设置成了过去的日期。相应订单项将不会投放。 |
MobileApp
通过移动应用安装订单项宣传的移动应用。
JSON 表示法 |
---|
{
"appId": string,
"platform": enum ( |
字段 | |
---|---|
appId |
必需。平台商店提供的应用 ID。 Android 应用由 Android 的 Play 商店使用的软件包 ID 标识,例如 iOS 应用由 Apple App Store 使用的九位数应用 ID 标识,例如 |
platform |
仅限输出。应用平台。 |
displayName |
仅限输出。应用名称。 |
publisher |
仅限输出。应用发布商。 |
平台
可能的移动应用平台。
枚举 | |
---|---|
PLATFORM_UNSPECIFIED |
未指定平台。 |
IOS |
iOS 平台。 |
ANDROID |
Android 平台。 |
YoutubeAndPartnersSettings
YouTube 及合作伙伴订单项的设置。
JSON 表示法 |
---|
{ "viewFrequencyCap": { object ( |
字段 | |
---|---|
viewFrequencyCap |
查看订单项的观看频次上限设置。 如果分配的是有限的上限,则必须使用此设置对象中的 |
thirdPartyMeasurementConfigs |
可选。相应订单项的第三方衡量配置。 |
inventorySourceSettings |
用于控制订单项将定位到的 YouTube 和合作伙伴广告资源的设置。 |
contentCategory |
仅限输出。YouTube 和合作伙伴广告将展示在哪些类型的内容中。 |
effectiveContentCategory |
仅限输出。投放相应广告订单项时生效的内容类别。如果订单项和广告客户都设置了内容类别,则在投放订单项时,系统会采用更严格的设置。 新订单项将仅沿用广告客户级设置。 |
targetFrequency |
可选。您希望此订单项中的广告在特定时间段内向同一用户展示的平均次数。 |
linkedMerchantId |
可选。与商品目录 Feed 的订单项相关联的商家的 ID。 |
relatedVideoIds[] |
可选。当移动设备上的 YouTube 应用中播放主视频广告时,视频 ID 会在广告下方显示。 |
leadFormId |
可选。用于生成潜在客户的表单的 ID。 |
videoAdSequenceSettings |
可选。与 VideoAdSequence 相关的设置。 |
videoAdInventoryControl |
可选。用于控制允许此订单项投放的广告资源的设置。 |
ThirdPartyMeasurementConfigs
用于控制哪些第三方供应商可以衡量特定订单项指标的设置。
JSON 表示法 |
---|
{ "viewabilityVendorConfigs": [ { object ( |
字段 | |
---|---|
viewabilityVendorConfigs[] |
可选。衡量可见度的第三方供应商。 以下第三方供应商适用:
|
brandSafetyVendorConfigs[] |
可选。衡量品牌保障的第三方供应商。 以下第三方供应商适用:
|
reachVendorConfigs[] |
可选。衡量覆盖面的第三方供应商。 以下第三方供应商适用:
|
brandLiftVendorConfigs[] |
可选。衡量品牌提升效果的第三方供应商。 以下第三方供应商适用:
|
ThirdPartyVendorConfig
用于控制第三方衡量服务供应商配置方式的设置。
JSON 表示法 |
---|
{
"vendor": enum ( |
字段 | |
---|---|
vendor |
第三方衡量服务供应商。 |
placementId |
第三方供应商的平台用于标识相应订单项的 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。 |
THIRD_PARTY_VENDOR_TRANSUNION |
Transunion。 |
YoutubeAndPartnersInventorySourceConfig
用于控制 YouTube 及合作伙伴订单项将定位到哪些 YouTube 相关广告资源的设置。
JSON 表示法 |
---|
{ "includeYoutube": boolean, "includeGoogleTv": boolean, "includeYoutubeVideoPartners": boolean } |
字段 | |
---|---|
includeYoutube |
可选。是否定位到 YouTube 上的广告资源。这包括搜索、频道和视频。 |
includeGoogleTv |
可选。是否定位到适用于 Google TV 的视频应用中的广告资源。 |
includeYoutubeVideoPartners |
是否定位到与 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 ( |
字段 | |
---|---|
targetCount |
广告在 |
timeUnit |
应用目标频次的时间单位。 以下时间单位适用:
|
timeUnitCount |
目标频次将持续的 以下限制适用于基于
|
VideoAdSequenceSettings
与 VideoAdSequence 相关的设置。
JSON 表示法 |
---|
{ "minimumDuration": enum ( |
字段 | |
---|---|
minimumDuration |
同一用户再次看到此序列的最短时间间隔。 |
steps[] |
序列包含的步骤。 |
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 ( |
字段 | |
---|---|
stepId |
相应步骤的 ID。 |
adGroupId |
相应步骤的广告组的 ID。 |
previousStepId |
上一步的 ID。第一步没有上一步。 |
interactionType |
可将观看者从上一步骤引导至这一步骤的互动条件。第一个步骤没有 interactionType。 |
InteractionType
相应步骤的互动类型。
枚举 | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
未指定或未知 |
INTERACTION_TYPE_PAID_VIEW |
付费观看。 |
INTERACTION_TYPE_SKIP |
观看者跳过了广告。 |
INTERACTION_TYPE_IMPRESSION |
(已观看的)广告展示。 |
INTERACTION_TYPE_ENGAGED_IMPRESSION |
观看者未立即跳过,但未达到可计费事件的广告展示。 |
VideoAdInventoryControl
在某些 YouTube 订单项类型中使用的视频广告资源控制。
JSON 表示法 |
---|
{ "allowInStream": boolean, "allowInFeed": boolean, "allowShorts": boolean } |
字段 | |
---|---|
allowInStream |
可选。广告是否可以插播广告格式投放。 |
allowInFeed |
可选。广告是否可以信息流格式投放。 |
allowShorts |
可选。广告是否可以以 Shorts 格式投放。 |
方法 |
|
---|---|
|
批量修改多个订单项下的定位选项。 |
|
列出多种定位类型中为多个订单项分配的定位选项。 |
|
更新多个订单项。 |
|
创建新的订单项。 |
|
删除订单项。 |
|
复制订单项。 |
|
创建一个新订单项,其设置(包括定位)继承自广告订单,并具有 ENTITY_STATUS_DRAFT entity_status 。 |
|
获取订单项。 |
|
列出广告客户中的订单项。 |
|
更新现有订单项。 |