- 資源:LineItem
- LineItemType
- LineItemFlight
- LineItemFlightDateType
- LineItemBudget
- LineItemBudgetAllocationType
- PartnerRevenueModel
- PartnerRevenueModelMarkupType
- ConversionCountingConfig
- TrackingFloodlightActivityConfig
- LineItemWarningMessage
- MobileApp
- 平台
- YoutubeAndPartnersSettings
- ThirdPartyMeasurementConfigs
- 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 |
僅供輸出。委刊項的資源名稱。 |
advertiser |
僅供輸出。委刊項所屬廣告主的專屬 ID。 |
campaign |
僅供輸出。委刊項所屬的廣告活動專屬 ID。 |
insertion |
必要欄位。不可變動。委刊項所屬的廣告訂單專屬 ID。 |
line |
僅供輸出。項目的不重複 ID。由系統指派。 |
display |
必要欄位。委刊項的顯示名稱。 必須採用 UTF-8 編碼,且大小上限為 240 個位元組。 |
line |
必要欄位。不可變動。委刊項的類型。 |
entity |
必要欄位。控制委刊項是否可支出預算,以及對廣告空間出價。
|
update |
僅供輸出。明細項目上次更新的時間戳記。由系統指派。 RFC3339 世界標準時間「Zulu」格式的時間戳記,精確度達奈秒單位,最多九個小數位數。範例: |
partner |
與委刊項相關聯的夥伴費用。 如果 |
flight |
必要欄位。委刊項檔期的開始和結束時間。 |
budget |
必要欄位。委刊項的預算分配設定。 |
pacing |
必要欄位。委刊項的預算支出速度設定。 |
frequency |
必要欄位。委刊項的曝光展示頻率上限設定。 如果要指派限制上限,就必須使用這個設定物件中的 |
partner |
必要欄位。委刊項的夥伴收益模式設定。 |
conversion |
委刊項的轉換追蹤設定。 |
creative |
與委刊項相關聯的廣告素材 ID。 |
bid |
必要欄位。委刊項的出價策略。 |
integration |
委刊項的整合詳細資料。 |
targeting |
委刊項的最佳化指定目標對象設定。 這項設定僅適用於採用自動出價且明確指定符合資格的目標對象名單的多媒體、影片或音訊委刊項。 |
warning |
僅供輸出。委刊項產生的警告訊息。這些警告不會阻止您儲存委刊項,但有些警告可能會阻止委刊項放送。 |
mobile |
委刊項所宣傳的行動應用程式。 這項設定僅適用於 |
reservation |
僅供輸出。委刊項的預訂類型。 |
exclude |
是否要排除新廣告交易平台,以免委刊項自動指定這些廣告交易平台。這個欄位的預設值為 false。 |
youtube |
僅供輸出。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 ( |
欄位 | |
---|---|
flight |
必要欄位。委刊項檔期的類型。 |
date |
委刊項的檔期開始和結束日期。系統會根據上層廣告主的時區解析這些資訊。
|
LineItemFlightDateType
委刊項檔期的可能類型。
列舉 | |
---|---|
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED |
這個版本未指定類型值或不明。 |
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED |
委刊項的檔期會沿用其上層廣告訂單。 |
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM |
委刊項會使用本身的自訂檔期。 |
LineItemBudget
控管預算分配方式的設定。
JSON 表示法 |
---|
{ "budgetAllocationType": enum ( |
欄位 | |
---|---|
budget |
必要欄位。預算分配類型。
|
budget |
僅供輸出。預算單位會指定預算是以貨幣或曝光為依據。這個值會沿用自父項廣告訂單。 |
max |
委刊項的預算上限金額。必須大於 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 ( |
欄位 | |
---|---|
markup |
必要欄位。夥伴收益模式的加價類型。 |
markup |
必要欄位。夥伴收益模式的加成金額。必須大於或等於 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 ( |
欄位 | |
---|---|
post |
要計算的瀏覽後轉換百分比,以毫秒 (1/1000 的百分比) 為單位。必須介於 0 至 100000 之間。 舉例來說,如要追蹤 50% 的點擊後轉換,請將值設為 50000。 |
floodlight |
用來追蹤轉換的 Floodlight 活動設定。 計入的轉換次數是這個欄位中指定的所有 Floodlight 活動 ID 所計入的轉換總數。 |
TrackingFloodlightActivityConfig
控管單一 Floodlight 活動設定行為的設定。
JSON 表示法 |
---|
{ "floodlightActivityId": string, "postClickLookbackWindowDays": integer, "postViewLookbackWindowDays": integer } |
欄位 | |
---|---|
floodlight |
必要欄位。Floodlight 活動的 ID。 |
post |
必要欄位。廣告點擊後,系統可能會計入轉換的天數。必須介於 0 到 90 之間。 |
post |
必要欄位。廣告觀看後,系統可能會計入轉換的天數。必須介於 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 ( |
欄位 | |
---|---|
app |
必要欄位。平台商店提供的應用程式 ID。 Android 應用程式會透過 Android 的 Play 商店所使用的軟體包 ID 進行識別,例如 iOS 應用程式可透過 Apple App Store 使用的 9 位數應用程式 ID 進行識別,例如 |
platform |
僅供輸出。應用程式平台。 |
display |
僅供輸出。應用程式名稱。 |
publisher |
僅供輸出。應用程式發布商。 |
平台
可能的行動應用程式平台。
列舉 | |
---|---|
PLATFORM_UNSPECIFIED |
未指定平台。 |
IOS |
iOS 平台。 |
ANDROID |
Android 平台。 |
YoutubeAndPartnersSettings
YouTube 與合作夥伴委刊項的設定。
JSON 表示法 |
---|
{ "viewFrequencyCap": { object ( |
欄位 | |
---|---|
view |
委刊項的觀看頻率上限設定。 如果要指派限制上限,就必須使用這個設定物件中的 |
third |
選用設定。委刊項的第三方評估設定。 |
inventory |
用於控制委刊項指定的 YouTube 和合作夥伴廣告空間。 |
content |
廣告會在哪些內容類型中顯示。 |
effective |
僅供輸出。放送委刊項時生效的內容類別。如果委刊項和廣告主都設定了內容類別,系統會在放送委刊項時採用限制較嚴格的類別。 |
target |
選用設定。在特定時間內,您希望這個委刊項的廣告向同一位使用者顯示的平均次數。 |
linked |
選用設定。與產品動態饋給明細項目相關聯的商家 ID。 |
related |
選用設定。在行動裝置上透過 YouTube 應用程式播放廣告時,主要影片廣告下方會顯示影片 ID。 |
lead |
選用設定。產生待開發客戶的表單 ID。 |
video |
選用設定。VideoAdSequence 的相關設定。 |
ThirdPartyMeasurementConfigs
控管第三方供應商評估特定委刊項指標的設定。
JSON 表示法 |
---|
{ "viewabilityVendorConfigs": [ { object ( |
欄位 | |
---|---|
viewability |
選用設定。評估可視度的第三方供應商。 以下為適用的第三方供應商:
|
brand |
選用設定。評估品牌安全的第三方供應商。 適用的第三方供應商如下:
|
reach |
選用設定。評估觸及數的第三方供應商。 適用的第三方供應商如下:
|
brand |
選用設定。評估品牌提升的第三方供應商。 適用的第三方供應商如下:
|
ThirdPartyVendorConfig
控制第三方評估供應商設定方式的設定。
JSON 表示法 |
---|
{
"vendor": enum ( |
欄位 | |
---|---|
vendor |
第三方評估服務供應商。 |
placement |
第三方供應商平台用來識別委刊項的 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 表示法 |
---|
{ "includeYoutube": boolean, "includeGoogleTv": boolean, "includeYoutubeVideoPartners": boolean } |
欄位 | |
---|---|
include |
選用設定。是否指定 YouTube 廣告空間。包括搜尋、頻道和影片。 |
include |
選用設定。指定適用於 Google TV 影片應用程式的廣告空間。 |
include |
是否要在一組遵循與 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 ( |
欄位 | |
---|---|
target |
平均來說,廣告會在 |
time |
目標頻率的時間單位。 以下為適用的時間單位:
|
time |
目標頻率持續的 根據
|
VideoAdSequenceSettings
與 VideoAdSequence 相關的設定。
JSON 表示法 |
---|
{ "minimumDuration": enum ( |
欄位 | |
---|---|
minimum |
同一使用者再次看到這個序列前的最短時間間隔。 |
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 ( |
欄位 | |
---|---|
step |
步驟的 ID。 |
ad |
步驟對應廣告群組的 ID。 |
previous |
上一個步驟的 ID。第一個步驟沒有前一個步驟。 |
interaction |
將觀眾導向這個步驟的上一步互動。第一個步驟沒有 interactionType。 |
InteractionType
步驟上的互動類型。
列舉 | |
---|---|
INTERACTION_TYPE_UNSPECIFIED |
未指定或不明 |
INTERACTION_TYPE_PAID_VIEW |
付費觀看。 |
INTERACTION_TYPE_SKIP |
觀眾略過。 |
INTERACTION_TYPE_IMPRESSION |
廣告曝光次數 (已觀看)。 |
INTERACTION_TYPE_ENGAGED_IMPRESSION |
觀眾並未立即略過廣告曝光,但也未達到可計費事件。 |
方法 |
|
---|---|
|
在多個委刊項底下編輯指定目標選項。 |
|
列出多個委刊項在各指定類型中指派的指定目標選項。 |
|
更新多個委刊項。 |
|
建立新的委刊項。 |
|
刪除委刊項。 |
|
複製委刊項。 |
|
建立新的委刊項,其中的設定 (包括指定目標) 會繼承自廣告訂單和 ENTITY_STATUS_DRAFT entity_status 。 |
|
取得委刊項。 |
|
列出廣告客戶的委刊項。 |
|
更新現有委刊項。 |