- 資源:LineItem
- LineItemType
- LineItemFlight
- LineItemFlightDateType
- LineItemBudget
- LineItemBudgetAllocationType
- PartnerRevenueModel
- PartnerRevenueModelMarkupType
- ConversionCountingConfig
- TrackingFloodlightActivityConfig
- LineItemWarningMessage
- MobileApp
- 平台
- YoutubeAndPartnersSettings
- ThirdPartyMeasurementConfigs
- ThirdPartyVendorConfig
- ThirdPartyVendor
- YoutubeAndPartnersInventorySourceConfig
- YoutubeAndPartnersContentCategory
- TargetFrequency
- VideoAdSequenceSettings
- VideoAdSequenceMinimumDuration
- VideoAdSequenceStep
- InteractionType
- VideoAdInventoryControl
- 方法
資源: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 |
僅供輸出。明細項目上次更新的時間戳記。由系統指派。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
partnerCosts[] |
與委刊項相關的合作夥伴費用。 如果 |
flight |
必要欄位。委刊項檔期的開始和結束時間。 |
budget |
必要欄位。委刊項的預算分配設定。 |
pacing |
必要欄位。委刊項的預算支出速度設定。 |
frequencyCap |
必要欄位。委刊項的曝光展示頻率上限設定。 如要指派上限,必須使用這個設定物件中的 |
partnerRevenueModel |
必要欄位。委刊項的夥伴收益模式設定。 |
conversionCounting |
委刊項的轉換追蹤設定。 |
creativeIds[] |
與委刊項相關聯的廣告素材 ID。 |
bidStrategy |
必要欄位。委刊項的出價策略。 |
integrationDetails |
委刊項的整合詳細資料。 |
targetingExpansion |
委刊項的最佳化指定目標設定。 這項設定僅適用於採用自動出價,並指定符合資格目標對象名單的多媒體、影片或音訊委刊項。 |
warningMessages[] |
僅供輸出。委刊項產生的警告訊息。這些警告不會阻礙儲存委刊項,但部分警告可能會導致委刊項無法放送。 |
mobileApp |
委刊項宣傳的行動應用程式。 只有在 |
reservationType |
僅供輸出。委刊項的預訂類型。 |
excludeNewExchanges |
是否要排除委刊項自動指定的新廣告交易平台。這個欄位預設為 false。 |
youtubeAndPartnersSettings |
僅供輸出。YouTube 和合作夥伴委刊項專屬設定。 |
containsEuPoliticalAds |
這個委刊項是否會放送歐盟政治廣告。 如果父項廣告主已將 |
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 的委刊項。 |
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 |
根據固定千次曝光出價計算合作夥伴收益。 |
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 之間 (含 0 和 100000)。 舉例來說,如要追蹤 50% 的點擊後轉換,請將值設為 50000。 |
floodlightActivityConfigs[] |
用於追蹤轉換的 Floodlight 活動設定。 系統會將這個欄位中指定的所有 Floodlight 活動 ID 所計入的轉換次數加總,做為轉換次數。 如果委刊項已指派自訂出價演算法,則無法更新這個欄位。如果您設定這個欄位,並在同一個要求中指派自訂出價演算法,則 Floodlight 活動必須與自訂出價演算法使用的活動相符。 |
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 使用的九位數應用程式 ID,例如 |
platform |
僅供輸出。應用程式平台。 |
displayName |
僅供輸出。應用程式名稱。 |
publisher |
僅供輸出。應用程式發布商。 |
平台
可能的行動應用程式平台。
列舉 | |
---|---|
PLATFORM_UNSPECIFIED |
未指定平台。 |
IOS |
iOS 平台。 |
ANDROID |
Android 平台。 |
YoutubeAndPartnersSettings
YouTube 與合作夥伴委刊項的設定。
JSON 表示法 |
---|
{ "viewFrequencyCap": { object ( |
欄位 | |
---|---|
viewFrequencyCap |
委刊項的觀看展示頻率上限設定。 如要指派上限,必須使用這個設定物件中的 |
thirdPartyMeasurementConfigs |
(選用步驟) 委刊項的第三方評估設定。 |
inventorySourceSettings |
控制委刊項指定 YouTube 和合作夥伴廣告空間的設定。 |
contentCategory |
僅供輸出。YouTube 和合作夥伴廣告顯示的內容類型。 |
effectiveContentCategory |
僅供輸出。放送委刊項時生效的內容類別。如果委刊項和廣告主都設定了內容類別,放送委刊項時,系統會採用限制較嚴格的類別。 新的委刊項只會沿用廣告主層級設定。 |
targetFrequency |
(選用步驟) 您希望這個委刊項的廣告在特定時間內,向同一位使用者顯示的平均次數。 |
linkedMerchantId |
(選用步驟) 與產品動態饋給明細項目連結的商家 ID。 |
relatedVideoIds[] |
(選用步驟) 當行動裝置上的 YouTube 應用程式播放廣告時,主要影片廣告下方會顯示影片 ID。 |
leadFormId |
(選用步驟) 用於產生待開發客戶的表單 ID。 |
videoAdSequenceSettings |
(選用步驟) 與 VideoAdSequence 相關的設定。 |
videoAdInventoryControl |
(選用步驟) 用來控管這個委刊項可使用的廣告空間設定。 |
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。 |
THIRD_PARTY_VENDOR_TRANSUNION |
TransUnion。 |
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 |
觀眾未立即略過廣告曝光,但廣告曝光也未達到可計費事件。 |
VideoAdInventoryControl
用於特定 YouTube 委刊項類型的影片廣告空間控管。
JSON 表示法 |
---|
{ "allowInStream": boolean, "allowInFeed": boolean, "allowShorts": boolean } |
欄位 | |
---|---|
allowInStream |
(選用步驟) 廣告是否能以串流內格式放送。 |
allowInFeed |
(選用步驟) 廣告是否能以動態內格式放送。 |
allowShorts |
(選用步驟) 廣告是否可做為 Shorts 格式。 |
方法 |
|
---|---|
|
大量編輯多個委刊項的指定目標選項。 |
|
列出多個委刊項在各指定類型中指派的指定選項。 |
|
更新多個委刊項。 |
|
建立新的委刊項。 |
|
刪除委刊項。 |
|
複製委刊項。 |
|
建立新的委刊項,並沿用廣告訂單的設定 (包括指定目標) 和 ENTITY_STATUS_DRAFT entity_status 。 |
|
取得委刊項。 |
|
列出廣告主中的委刊項。 |
|
更新現有的委刊項。 |