REST Resource: advertisers.lineItems

{
  "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)
  }
}

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

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

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

enum (LineItemType)

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

enum (EntityStatus)

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

• 对于 lineItems.create 方法，仅允许使用 ENTITY_STATUS_DRAFT。如需激活订单项，请使用 lineItems.patch 方法，并在创建后将状态更新为 ENTITY_STATUS_ACTIVE。
• 订单项无法从任何其他状态更改回 ENTITY_STATUS_DRAFT 状态。
• 如果订单项的父广告订单处于无效状态，则该订单项无法支出预算，即使其自身状态为 ENTITY_STATUS_ACTIVE 也是如此。

string (Timestamp format)

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

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

object (PartnerCost)

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

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

object (LineItemFlight)

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

object (LineItemBudget)

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

object (Pacing)

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

object (FrequencyCap)

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

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

object (PartnerRevenueModel)

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

object (ConversionCountingConfig)

订单项的转化跟踪设置。

string (int64 format)

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

object (BiddingStrategy)

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

object (IntegrationDetails)

订单项的集成详细信息。

object (TargetingExpansionConfig)

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

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

enum (LineItemWarningMessage)

仅限输出。订单项生成的警告消息。这些警告不会阻止保存订单项，但其中一些警告可能会阻止订单项运行。

object (MobileApp)

订单项宣传的移动应用。

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

enum (ReservationType)

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

boolean

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

object (YoutubeAndPartnersSettings)

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

{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  }
}

enum (LineItemFlightDateType)

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

object (DateRange)

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

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

{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}

enum (LineItemBudgetAllocationType)

必需。预算分配的类型。

仅当已为父级广告订单启用“自动分配预算”功能时，LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC 才适用。

enum (BudgetUnit)

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

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，此字段不适用，系统将忽略该字段。

{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}

enum (PartnerRevenueModelMarkupType)

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

string (int64 format)

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

• 当 markupType 设置为 PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM 时，此字段表示 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）。

{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}

string (int64 format)

要统计的浏览后转化次数所占的百分比，以千分之一表示 (1/1000%)。必须介于 0 到 100000（含）之间。

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

object (TrackingFloodlightActivityConfig)

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

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

{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}

string (int64 format)

必需。Floodlight 活动的 ID。

integer

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

integer

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

{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}

string

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

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

iOS 应用由 Apple 的 App Store 使用的 9 位数应用 ID 标识，例如 422689480。

enum (Platform)

仅限输出。应用平台。

string

仅限输出。应用名称。

string

仅限输出。应用发布商。

{
  "viewFrequencyCap": {
    object (FrequencyCap)
  },
  "thirdPartyMeasurementConfigs": {
    object (ThirdPartyMeasurementConfigs)
  },
  "inventorySourceSettings": {
    object (YoutubeAndPartnersInventorySourceConfig)
  },
  "contentCategory": enum (YoutubeAndPartnersContentCategory),
  "effectiveContentCategory": enum (YoutubeAndPartnersContentCategory),
  "targetFrequency": {
    object (TargetFrequency)
  },
  "linkedMerchantId": string,
  "relatedVideoIds": [
    string
  ],
  "leadFormId": string,
  "videoAdSequenceSettings": {
    object (VideoAdSequenceSettings)
  }
}

object (FrequencyCap)

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

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

object (ThirdPartyMeasurementConfigs)

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

object (YoutubeAndPartnersInventorySourceConfig)

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

enum (YoutubeAndPartnersContentCategory)

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

enum (YoutubeAndPartnersContentCategory)

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

object (TargetFrequency)

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

string (int64 format)

可选。与商品 Feed 的订单项相关联的商家的 ID。

string

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

string (int64 format)

可选。用于发掘潜在客户的表单的 ID。

object (VideoAdSequenceSettings)

可选。与 VideoAdSequence 相关的设置。

{
  "viewabilityVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandSafetyVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "reachVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ],
  "brandLiftVendorConfigs": [
    {
      object (ThirdPartyVendorConfig)
    }
  ]
}

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

object (ThirdPartyVendorConfig)

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

以下第三方供应商适用：

• THIRD_PARTY_VENDOR_ZERF
• THIRD_PARTY_VENDOR_DOUBLE_VERIFY
• THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE

object (ThirdPartyVendorConfig)

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

以下第三方供应商适用：

• THIRD_PARTY_VENDOR_NIELSEN
• THIRD_PARTY_VENDOR_COMSCORE
• THIRD_PARTY_VENDOR_KANTAR

object (ThirdPartyVendorConfig)

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

以下第三方供应商适用：

• THIRD_PARTY_VENDOR_DYNATA
• THIRD_PARTY_VENDOR_KANTAR

{
  "vendor": enum (ThirdPartyVendor),
  "placementId": string
}

enum (ThirdPartyVendor)

第三方衡量服务供应商。

string

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

{
  "includeYoutube": boolean,
  "includeGoogleTv": boolean,
  "includeYoutubeVideoPartners": boolean
}

boolean

可选。是否定位到 YouTube 上的广告资源。这包括搜索、频道和视频。

boolean

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

boolean

是否定位到与 YouTube 遵循相同品牌保障标准的一系列合作伙伴网站和应用中的广告资源。

{
  "targetCount": string,
  "timeUnit": enum (TimeUnit),
  "timeUnitCount": integer
}

string (int64 format)

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

enum (TimeUnit)

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

适用的时间单位如下：

• TIME_UNIT_WEEKS

integer

目标频次的持续时间（以 timeUnit 为单位）。

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

• TIME_UNIT_WEEKS - 必须为 1

{
  "minimumDuration": enum (VideoAdSequenceMinimumDuration),
  "steps": [
    {
      object (VideoAdSequenceStep)
    }
  ]
}

enum (VideoAdSequenceMinimumDuration)

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

object (VideoAdSequenceStep)

序列包含的步骤。

{
  "stepId": string,
  "adGroupId": string,
  "previousStepId": string,
  "interactionType": enum (InteractionType)
}

string (int64 format)

步骤的 ID。

string (int64 format)

步骤中相应广告组的 ID。

string (int64 format)

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

enum (InteractionType)

上一步骤中可将观看者引导至此步骤的互动。第一个步骤没有 interactionType。