- 资源:LineItem
- LineItemType
- LineItemFlight
- LineItemFlightDateType
- LineItemBudget
- LineItemBudgetAllocationType
- PartnerRevenueModel
- PartnerRevenueModelMarkupType
- ConversionCountingConfig
- TrackingFloodlightActivityConfig
- LineItemWarningMessage
- MobileApp
- 平台
- YoutubeAndPartnersSettings
- ThirdPartyMeasurementConfigs
- ThirdPartyVendorConfig
- ThirdPartyVendor
- YoutubeAndPartnersInventorySourceConfig
- YoutubeAndPartnersContentCategory
- TargetFrequency
- VideoAdSequenceSettings
- VideoAdSequenceMinimumDuration
- VideoAdSequenceStepVideoAdSequenceStep
- InteractionType
- 方法
资源: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 |
仅供输出。上次更新订单项的时间戳。由系统分配。 采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,采用纳秒级精度,最多包含九个小数位。示例: |
partnerCosts[] |
与订单项相关的合作伙伴费用。 如果 |
flight |
必需。订单项排期的开始时间和结束时间。 |
budget |
必需。订单项的预算分配设置。 |
pacing |
必需。订单项的预算支出速度设置。 |
frequencyCap |
必需。订单项的展示频次上限设置。 如需分配有限的上限,必须使用此设置对象中的 |
partnerRevenueModel |
必需。订单项的合作伙伴收入模式设置。 |
conversionCounting |
订单项的转化跟踪设置。 |
creativeIds[] |
与订单项相关联的广告素材的 ID。 |
bidStrategy |
必需。订单项的出价策略。 |
integrationDetails |
订单项的集成详情。 |
targetingExpansion |
订单项的优化型定位设置。 此配置仅适用于使用自动出价并正向定位到符合条件的受众群体名单的展示广告、视频广告或音频广告订单项。 |
warningMessages[] |
仅供输出。订单项生成的警告消息。这些警告不会阻止保存订单项,但有些警告可能会阻止订单项投放。 |
mobileApp |
订单项所宣传的移动应用。 这仅在 |
reservationType |
仅供输出。订单项的预订类型。 |
excludeNewExchanges |
是否排除新的广告交易平台,使其不被订单项自动定位。此字段默认为 false。 |
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 |
在各种环境中出售的 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 |
要统计的浏览后转化次数所占的百分比,以千分之一表示(即百分比的 1/1000)。必须介于 0 到 100,000 之间(含 0 和 100,000)。 例如,要跟踪 50% 的点击后转化次数,请将值设置为 50000。 |
floodlightActivityConfigs[] |
用于跟踪转化情况的 Floodlight 活动配置。 统计的转化次数是指根据此字段中指定的所有 Floodlight 活动 ID 统计的所有转化次数的总和。 |
TrackingFloodlightActivityConfig
用于控制单个 Floodlight 活动配置的行为的设置。
JSON 表示法 |
---|
{ "floodlightActivityId": string, "postClickLookbackWindowDays": integer, "postViewLookbackWindowDays": integer } |
字段 | |
---|---|
floodlightActivityId |
必需。Floodlight 活动的 ID。 |
postClickLookbackWindowDays |
必需。广告被点击后多少天(系统才会记录一次转化)。必须介于 0 和 90 之间(含 0 和 90)。 |
postViewLookbackWindowDays |
必需。广告获得观看后,系统可能在多少天内统计转化。必须介于 0 和 90 之间(含 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 使用的 9 位数应用 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 相关的设置。 |
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。 |
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 |
观看者没有立即跳过,但也没有进入可结算事件的广告展示。 |
方法 |
|
---|---|
|
批量修改多个订单项下的定位选项。 |
|
列出为多个订单项分配的定位选项(适用于各种定位类型)。 |
|
更新多个订单项。 |
|
创建新的订单项。 |
|
删除订单项。 |
|
复制订单项。 |
|
创建一个新的订单项,并为其采用继承自广告订单的设置(包括定位)和 ENTITY_STATUS_DRAFT entity_status 。 |
|
获取订单项。 |
|
列出广告客户中的订单项。 |
|
更新现有订单项。 |