- 資源:LineItem
- LineItemType
- LineItemFlight
- LineItemFlightDateType
- LineItemBudget
- LineItemBudgetAllocationType
- PartnerRevenueModel
- PartnerRevenueModelMarkupType
- ConversionCountingConfig
- TrackingFloodlightActivityConfig
- LineItemWarningMessage
- MobileApp
- 平台
- YoutubeAndPartnersSettings
- YoutubeAndPartnersThirdPartyMeasurementSettings
- 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 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例: |
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 |
影片廣告可在多種環境中以千次曝光出價為依據進行銷售。 |
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 之間。 例如,若要追蹤 50% 的點擊後轉換,請將值設為 50000。 |
floodlightActivityConfigs[] |
用來追蹤轉換的 Floodlight 活動設定。 計入的轉換次數是這個欄位中指定的所有 Floodlight 活動 ID 所計入的轉換總數。 |
TrackingFloodlightActivityConfig
控管單一 Floodlight 活動設定行為的設定。
JSON 表示法 |
---|
{ "floodlightActivityId": string, "postClickLookbackWindowDays": integer, "postViewLookbackWindowDays": integer } |
欄位 | |
---|---|
floodlightActivityId |
必要欄位。Floodlight 活動的 ID。 |
postClickLookbackWindowDays |
必要欄位。使用者點擊廣告後可計算轉換的天數。必須介於 0 到 90 之間。 |
postViewLookbackWindowDays |
必要欄位。系統會在使用者瀏覽廣告後,於此天數內計算一次轉換。必須介於 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 |
這個委刊項的廣告訂單設定在過去。委刊項無法放送。 |
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION |
這個委刊項使用 為了避免 |
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 表示法 |
---|
{ "biddingStrategy": { object ( |
欄位 | |
---|---|
biddingStrategy |
必要欄位。YouTube 與合作夥伴委刊項的出價策略。 |
viewFrequencyCap |
委刊項的觀看展示頻率上限設定。 如要指派限制上限,必須使用這個設定物件中的 |
thirdPartyMeasurementSettings |
選用設定。委刊項的第三方評估設定。 |
inventorySourceSettings |
這項設定可用於控管委刊項要指定的 YouTube 和合作夥伴廣告空間。 |
contentCategory |
廣告會在哪些內容類型中顯示。 |
effectiveContentCategory |
僅供輸出。放送委刊項時要生效的內容類別。如果委刊項和廣告客戶都設定了內容類別,系統就會在委刊項放送時採用較嚴格的內容類別。 |
targetFrequency |
您希望這個委刊項中的廣告在特定時間範圍內向同一個人放送的平均次數。 |
linkedMerchantId |
連結至產品動態饋給委刊項的商家 ID。 |
relatedVideoIds[] |
在行動裝置上透過 YouTube 應用程式播放廣告時,影片 ID 會顯示在主要影片廣告下方。 |
leadFormId |
產生待開發客戶的表單 ID。 |
videoAdSequenceSettings |
VideoAdSequence 的相關設定。 |
YoutubeAndPartnersThirdPartyMeasurementSettings
控管哪些第三方供應商會評估特定委刊項指標的設定。
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 表示法 |
---|
{ "includeYoutubeSearch": boolean, "includeYoutubeVideos": boolean, "includeGoogleTv": boolean, "includeYoutubeVideoPartners": boolean } |
欄位 | |
---|---|
includeYoutubeSearch |
是否要指定 YouTube 搜尋結果網頁上的廣告空間。 |
includeYoutubeVideos |
指定 YouTube 頻道廣告空間和影片的廣告空間,以及內嵌在其他網站的 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 內容和影片合作夥伴的內容。 |
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 |
將觀眾導向這個步驟的上一步互動。第一個步驟沒有 InteractType。 |
InteractionType
步驟中互動類型。
列舉 | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
不明或不明 |
INTERACTION_TYPE_PAID_VIEW |
付費觀看。 |
INTERACTION_TYPE_SKIP |
觀眾略過的片段。 |
INTERACTION_TYPE_IMPRESSION |
廣告曝光 (已瀏覽) 次數。 |
INTERACTION_TYPE_ENGAGED_IMPRESSION |
觀眾沒有立即略過,但沒有達到可計費事件的曝光。 |
方法 |
|
---|---|
|
在多個委刊項底下編輯指定目標選項。 |
|
針對各種指定類型,列出多個委刊項的指定選項。 |
|
更新多個委刊項。 |
|
建立新的委刊項。 |
|
刪除委刊項。 |
|
複製委刊項。 |
|
建立新的委刊項,並沿用廣告訂單的設定 (包括指定目標) 和 ENTITY_STATUS_DRAFT entity_status 。 |
|
取得委刊項。 |
|
列出廣告客戶的委刊項。 |
|
更新現有的委刊項。 |