- 资源:订单项
- LineItemType
- LineItemFlight
- LineItemFlightDateType
- LineItemBudget
- LineItemBudgetAllocationType
- PartnerRevenueModel
- PartnerRevenueModelMarkupType
- ConversionCountingConfig
- TrackingFloodlightActivityConfig
- LineItemWarningMessage
- MobileApp
- 平台
- YoutubeAndPartnersSettings
- ThirdPartyMeasurementConfigs
- ThirdPartyVendorConfig
- ThirdPartyVendor
- YoutubeAndPartnersInventorySourceConfig
- YoutubeAndPartnersContentCategory
- TargetFrequency
- VideoAdSequenceSettings
- VideoAdSequenceMinimumDuration
- VideoAdSequenceStep
- 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 |
针对各种环境销售的实时出价音频广告。 |
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 到 100000 之间(含边界值)。 例如,若要跟踪 50% 的点击后转化,请将值设置为 50000。 |
floodlightActivityConfigs[] |
用于跟踪转化情况的 Floodlight 活动配置。 统计的转化次数是此字段中指定的所有 Floodlight 活动 ID 统计的所有转化次数的总和。 |
TrackingFloodlightActivityConfig
用于控制单个 Floodlight 活动配置行为的设置。
JSON 表示法 |
---|
{ "floodlightActivityId": string, "postClickLookbackWindowDays": integer, "postViewLookbackWindowDays": integer } |
字段 | |
---|---|
floodlightActivityId |
必需。Floodlight 活动的 ID。 |
postClickLookbackWindowDays |
必需。广告获得点击后的可记录转化的天数。必须介于 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 |
观看者在上一步中进行的互动,会将观看者引导至该步骤。第一个步骤没有 engagementType。 |
InteractionType
步骤上的互动类型。
枚举 | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
未指定或未知 |
INTERACTION_TYPE_PAID_VIEW |
付费观看。 |
INTERACTION_TYPE_SKIP |
已被观看者跳过。 |
INTERACTION_TYPE_IMPRESSION |
广告展示(已观看)。 |
INTERACTION_TYPE_ENGAGED_IMPRESSION |
观看者未立即跳过的广告展示,但未达到可计费事件。 |
方法 |
|
---|---|
|
批量修改多个订单项下的定位选项。 |
|
列出为多种定位类型的多个订单项分配的定位选项。 |
|
更新多个订单项。 |
|
创建新的订单项。 |
|
删除订单项。 |
|
复制订单项。 |
|
创建一个新的订单项,其设置(包括定位条件)会从广告订单和 ENTITY_STATUS_DRAFT entity_status 继承。 |
|
获取订单项。 |
|
列出某个广告客户中的订单项。 |
|
更新现有订单项。 |