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 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："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 必須是 2037 年之前的 startDate。

{
  "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 時，這個欄位代表千次曝光出價標記 (以廣告客戶貨幣的百萬分之一表示)。例如 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)

廣告會在哪些內容類型中顯示。

enum (YoutubeAndPartnersContentCategory)

僅供輸出。放送委刊項時要生效的內容類別。如果委刊項和廣告客戶都設定了內容類別，系統就會在委刊項放送時採用較嚴格的內容類別。

object (TargetFrequency)

您希望這個委刊項中的廣告在特定時間範圍內向同一個人放送的平均次數。

string (int64 format)

連結至產品動態饋給委刊項的商家 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)

將觀眾導向這個步驟的上一步互動。第一個步驟沒有 InteractType。