REST Resource: advertisers.lineItems

資源：LineItem

單一委刊項。

JSON 表示法 
{
  "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)
  },
  "inventorySourceIds": [
    string
  ],
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean
}
欄位
name

string

僅供輸出。委刊項的資源名稱。
advertiserId

string (int64 format)

僅供輸出。委刊項所屬廣告主的專屬 ID。
campaignId

string (int64 format)

僅供輸出。委刊項所屬的廣告活動專屬 ID。
insertionOrderId

string (int64 format)

必要欄位。不可變動。委刊項所屬的廣告訂單專屬 ID。
lineItemId

string (int64 format)

僅供輸出。委刊項的專屬 ID。由系統指派。
displayName

string

必要欄位。委刊項的顯示名稱。

必須是 UTF-8 編碼，且長度上限為 240 個位元組。
lineItemType

enum (LineItemType)

必要欄位。不可變動。委刊項的類型。
entityStatus

enum (EntityStatus)

必要欄位。控制委刊項是否能將預算和出價用於廣告空間。

  • 如為 lineItems.create 方法，則只能使用 ENTITY_STATUS_DRAFT。如要啟用委刊項，請使用 lineItems.patch 方法，並在建立後將狀態更新為 ENTITY_STATUS_ACTIVE。
  • 委刊項無法從任何其他狀態改回「ENTITY_STATUS_DRAFT」狀態。
  • 如果委刊項的上層廣告訂單未啟用，即使其狀態為 ENTITY_STATUS_ACTIVE，委刊項也無法支出預算。
updateTime

string (Timestamp format)

僅供輸出。委刊項上次更新時間的時間戳記。由系統指派。

RFC3339 世界標準時間「Zulu」的時間戳記格式，解析度為奈秒，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
partnerCosts[]

object (PartnerCost)

與委刊項相關聯的夥伴費用。

如果 lineItems.create 方法中未提供或空白，新建立的委刊項會沿用上層廣告訂單的夥伴費用。
flight

object (LineItemFlight)

必要欄位。委刊項檔期的開始和結束時間。
budget

object (LineItemBudget)

必要欄位。委刊項的預算分配設定。
pacing

object (Pacing)

必要欄位。委刊項的預算支出速度設定。
frequencyCap

object (FrequencyCap)

必要欄位。委刊項的曝光展示頻率上限設定。

如要指派限制上限，必須使用這個設定物件中的 maxImpressions 欄位。
partnerRevenueModel

object (PartnerRevenueModel)

必要欄位。委刊項的夥伴收益模式設定。
conversionCounting

object (ConversionCountingConfig)

委刊項的轉換追蹤設定。
creativeIds[]

string (int64 format)

與委刊項相關聯的廣告素材 ID。
bidStrategy

object (BiddingStrategy)

必要欄位。委刊項的出價策略。
integrationDetails

object (IntegrationDetails)

委刊項的整合詳細資料。
inventorySourceIds[]

string (int64 format)

指派給委刊項的私人廣告空間來源 ID。
targetingExpansion

object (TargetingExpansionConfig)

委刊項的最佳化指定目標對象設定。

這項設定僅適用於採用自動出價且明確指定符合資格的目標對象名單的多媒體、影片或音訊委刊項。
warningMessages[]

enum (LineItemWarningMessage)

僅供輸出。委刊項產生的警告訊息。這類警告並不會妨礙儲存委刊項，但有些可能會妨礙委刊項放送。
mobileApp

object (MobileApp)

委刊項所宣傳的行動應用程式。

這僅適用於 lineItemType 為 LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL 或 LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL 的情況。
reservationType

enum (ReservationType)

僅供輸出。委刊項的預訂類型。
excludeNewExchanges

boolean

是否要排除新的廣告交易平台，避免委刊項自動指定這些廣告交易平台。根據預設，這個欄位為 false。

LineItemType

可能的委刊項類型。

委刊項類型會決定適用的設定和選項，例如廣告或指定目標選項的格式。

列舉
LINE_ITEM_TYPE_UNSPECIFIED

未指定類型值，或這個版本中的類型值不明。

無法使用 API 建立或更新這種類型的委刊項及其指定目標。
LINE_ITEM_TYPE_DISPLAY_DEFAULT 圖片、HTML5、原生或互動式多媒體廣告。
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL 可促成應用程式安裝的多媒體廣告。
LINE_ITEM_TYPE_VIDEO_DEFAULT 影片廣告可在多種環境中以千次曝光出價為依據進行銷售。
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 廣告訂單中出現 over-the-top 廣告。這個類型僅適用於廣告訂單為 insertionOrderType (OVER_THE_TOP) 的委刊項。

LineItemFlight

控制委刊項有效時間長度的設定。

JSON 表示法 
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  },
  "triggerId": string
}
欄位
flightDateType

enum (LineItemFlightDateType)

必要欄位。委刊項的檔期類型。
dateRange

object (DateRange)

委刊項的檔期開始和結束日期。系統會根據上層廣告客戶的時區進行解析。

  • 如果 flightDateType 為 LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM，則為必要欄位。如不符合上述條件，則只能輸出。
  • 建立新航班時，startDate 和 endDate 都必須是未來的日期。
  • 過去具有 startDate 的現有航班有可變動的 endDate，但不可變動的 startDate。
  • endDate 必須是 2037 年之前的 startDate。
triggerId

string (int64 format)

與委刊項相關聯的手動觸發條件 ID。

  • 如果 flightDateType 為 LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER，則為必要欄位。不得另行設定。
  • 設定後，委刊項的檔期會沿用其上層廣告訂單。
  • 當所選觸發條件在上層廣告訂單的檔期內啟用時，有效委刊項就會支出。

警告：使用手動觸發條件的委刊項不會再於 Display &Video 360 中放送Video 360。這個欄位將於 2023 年 8 月 1 日停用。詳情請參閱功能淘汰公告。

LineItemFlightDateType

委刊項適用的檔期類型。

列舉
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED 未指定類型值，或這個版本中的類型值不明。
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED 委刊項的檔期會沿用其上層廣告訂單。
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM 委刊項會使用本身的自訂檔期。
LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER

委刊項使用了觸發條件。

警告：使用手動觸發條件的委刊項不會再於 Display &Video 360 中放送Video 360。這個值將於 2023 年 8 月 1 日停用。詳情請參閱功能淘汰公告。

LineItemBudget

控制預算分配方式的設定。

JSON 表示法 
{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}
欄位
budgetAllocationType

enum (LineItemBudgetAllocationType)

必要欄位。預算分配的類型。

您必須為上層廣告訂單啟用自動預算分配功能，才能使用「LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC」。
budgetUnit

enum (BudgetUnit)

僅供輸出。預算單位會決定預算是以貨幣或曝光為基礎。這個值會沿用自上層廣告訂單。
maxAmount

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，這個欄位不適用，系統會忽略這個欄位。

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 (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
欄位
markupType

enum (PartnerRevenueModelMarkupType)

必要欄位。夥伴收益模式的加成類型。
markupAmount

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)。

PartnerRevenueModelMarkupType

夥伴收益模式可能的加成類型。

列舉
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED 未指定類型值，或這個版本中的類型值不明。
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM 根據固定千次曝光出價計算夥伴收益。
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP

根據媒體費用的附加百分比計算夥伴收益。
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP 根據媒體費用總額附加百分比計算夥伴收益，包括所有夥伴費用和資料費用。

ConversionCountingConfig

控制轉換計算方式的設定。

所有的點擊後轉換都會列入計算。您可以設定瀏覽後轉換計數的百分比值。

JSON 表示法 
{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}
欄位
postViewCountPercentageMillis

string (int64 format)

要計數的瀏覽後轉換次數百分比，以千分之一 (百分比的 1/1000) 為單位。必須介於 0 至 100000 之間。

例如，若要追蹤 50% 的點擊後轉換，請將值設為 50000。
floodlightActivityConfigs[]

object (TrackingFloodlightActivityConfig)

用來追蹤轉換的 Floodlight 活動設定。

計入的轉換次數是這個欄位中指定的所有 Floodlight 活動 ID 所計入的轉換總數。

TrackingFloodlightActivityConfig

控管單一 Floodlight 活動設定行為的設定。

JSON 表示法 
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
欄位
floodlightActivityId

string (int64 format)

必要欄位。Floodlight 活動的 ID。
postClickLookbackWindowDays

integer

必要欄位。使用者點擊廣告後可計算轉換的天數。必須介於 0 到 90 之間。
postViewLookbackWindowDays

integer

必要欄位。系統會在使用者瀏覽廣告後，於此天數內計算一次轉換。必須介於 0 到 90 之間。

TargetingExpansionConfig

控管委刊項最佳化指定目標對象設定的設定。

JSON 表示法 
{
  "targetingExpansionLevel": enum (TargetingExpansionLevel),
  "excludeFirstPartyAudience": boolean
}
欄位
targetingExpansionLevel

enum (TargetingExpansionLevel)

必要欄位。是否已啟用最佳化指定目標對象。

這個欄位支援下列值：

  • NO_EXPANSION：已停用最佳化指定目標對象
  • LEAST_EXPANSION：已啟用最佳化指定目標對象

如果將這個欄位設為任何其他值，則會自動設為「LEAST_EXPANSION」。

「NO_EXPANSION」是該欄位的預設值，如未設定這個欄位，系統會自動指派該值。
excludeFirstPartyAudience
(deprecated)

boolean

是否要在擴展指定目標中排除第一方目標對象。

隨著最佳化指定目標對象推出，這個欄位已遭淘汰。

這個欄位會設為 false。如果這個欄位在淘汰時設為「true」，則指派給這個委刊項的所有正面第一方指定目標對象，都會替換成某個第一方目標對象的排除指定目標，以確保這些目標對象會繼續排除。

TargetingExpansionLevel

最佳化指定目標對象設定。

列舉
TARGETING_EXPANSION_LEVEL_UNSPECIFIED 未指定最佳化指定目標對象設定，或此版本不支援不明設定。
NO_EXPANSION 最佳化指定目標對像已關閉。
LEAST_EXPANSION 已啟用最佳化指定目標對象。
SOME_EXPANSION

如果使用，系統會自動設為 LEAST_EXPANSION。
BALANCED_EXPANSION

如果使用，系統會自動設為 LEAST_EXPANSION。
MORE_EXPANSION

如果使用，系統會自動設為 LEAST_EXPANSION。
MOST_EXPANSION

如果使用，系統會自動設為 LEAST_EXPANSION。

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 這個委刊項的廣告訂單設定在過去。委刊項無法放送。
NO_POSITIVE_AUDIENCE_LIST_TARGETED 這個委刊項並未指定任何目標對象名單，這可能會導致預算的支出速度過快。
APP_INSTALL_NO_CONVERSION_PIXEL 這個應用程式安裝委刊項未設定任何轉換像素。
TARGETING_REVOKED_OR_CLOSED_USER_LIST 這個委刊項指定了一或多份已無法使用的使用者名單。日後，這會導致委刊項無法放送，因此建議您從指定目標中移除這些名單。
APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY 這個應用程式安裝委刊項沒有最佳出價策略。
CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS 這個委刊項指定的交易接受目前未使用的廣告素材大小。這可能會限制委刊項的放送或成效。
NO_CREATIVE_FOR_TARGETED_DEALS 這個委刊項不含任何指定交易的廣告素材。
TARGETING_DEPRECATED_GEO_TARGET 這個委刊項指定的指定地理區域已不適用。
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

這個委刊項使用 excludeFirstPartyAudience 設定。該設定已淘汰，預計在 2023 年 3 月 25 日後停用。

為了避免 excludeFirstPartyAudience 欄位遭停用，請在 2023 年 3 月 25 日前更新 API 整合，直接排除任何使用指定目標對像功能的第一方目標對象。

MobileApp

透過行動應用程式安裝委刊項宣傳的行動應用程式。

JSON 表示法 
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
欄位
appId

string

必要欄位。平台商店提供的應用程式 ID。

Android 應用程式會透過 Android Play 商店使用的軟體包 ID 進行識別，例如 com.google.android.gm。

iOS 應用程式可透過 Apple App Store 使用的 9 位數應用程式 ID 進行識別，例如 422689480。
platform

enum (Platform)

僅供輸出。應用程式平台。
displayName

string

僅供輸出。應用程式名稱。
publisher

string

僅供輸出。應用程式發布商。

平台

可能的行動應用程式平台。

列舉
PLATFORM_UNSPECIFIED 未指定平台。
IOS iOS 平台。
ANDROID Android 平台

方法

bulkEditLineItemAssignedTargetingOptions

 單一委刊項底下的大量編輯指定目標選項。

bulkListLineItemAssignedTargetingOptions

 列出委刊項在不同指定類型下的指定選項。

create

 建立新的委刊項。

delete

 刪除委刊項。

generateDefault

 建立新的委刊項，並沿用廣告訂單的設定 (包括指定目標) 和 ENTITY_STATUS_DRAFT entity_status。

get

 取得委刊項。

list

 列出廣告客戶的委刊項。

patch

 更新現有的委刊項。