- 資源: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」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例: |
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 |
即時出價音訊廣告適用於多種環境。 |
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 之間 (含 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 |
這個委刊項廣告訂單的結束日期是過去的日期。委刊項不會放送。 |
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION |
這個委刊項使用 請在 2023 年 3 月 25 日前更新 API 整合,直接排除任何使用指定目標對象的第一方目標對象,以因應「 |
MobileApp
由行動應用程式安裝委刊項宣傳的行動應用程式。
JSON 表示法 |
---|
{
"appId": string,
"platform": enum ( |
欄位 | |
---|---|
appId |
必要欄位。平台商店提供的應用程式 ID。 Android 應用程式是透過 Android Play 商店使用的軟體包 ID 來識別,例如 iOS 應用程式是透過 Apple App Store (例如 |
platform |
僅供輸出。應用程式平台。 |
displayName |
僅供輸出。應用程式名稱。 |
publisher |
僅供輸出。應用程式發布商。 |
平台
可能的行動應用程式平台。
列舉 | |
---|---|
PLATFORM_UNSPECIFIED |
未指定平台。 |
IOS |
iOS 平台。 |
ANDROID |
Android 平台。 |
YoutubeAndPartnersSettings
YouTube 與合作夥伴委刊項的設定。
JSON 表示法 |
---|
{ "biddingStrategy": { object ( |
欄位 | |
---|---|
biddingStrategy |
必要欄位。YouTube 與合作夥伴委刊項的出價策略。 |
viewFrequencyCap |
委刊項的觀看展示頻率上限設定。 如要指派限制上限,必須使用這項設定物件的 |
thirdPartyMeasurementSettings |
選用設定。委刊項的第三方評估設定。 |
inventorySourceSettings |
這項設定可控管委刊項要指定的 YouTube 和合作夥伴廣告空間。 |
contentCategory |
也就是顯示 YouTube 及合作夥伴廣告的內容類型。 |
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_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 |
上一個步驟的互動可將觀眾導向這個步驟。第一個步驟沒有 engagementType。 |
InteractionType
步驟的互動類型。
列舉 | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
不明或不明 |
INTERACTION_TYPE_PAID_VIEW |
付費觀看。 |
INTERACTION_TYPE_SKIP |
觀眾已略過。 |
INTERACTION_TYPE_IMPRESSION |
廣告曝光一次 (已觀看)。 |
INTERACTION_TYPE_ENGAGED_IMPRESSION |
觀眾沒有立即略過,但也未達成可計費事件的廣告曝光。 |
方法 |
|
---|---|
|
大量編輯多個委刊項的指定目標選項。 |
|
列出各種指定類型中多個委刊項的指派指定目標選項。 |
|
更新多個委刊項。 |
|
建立新委刊項。 |
|
刪除委刊項。 |
|
複製委刊項。 |
|
建立新委刊項,採用沿用了廣告訂單和ENTITY_STATUS_DRAFT entity_status 的設定 (包括指定目標)。 |
|
取得委刊項。 |
|
列出廣告客戶中的委刊項。 |
|
更新現有的委刊項。 |