REST Resource: advertisers.inventorySources

Display & Video 360 API 第 5 版目前為 Beta 版。

• 資源：InventorySource
  • JSON 表示法
  • InventorySourceType
  • InventorySourceProductType
  • InventorySourceCommitment
  • InventorySourceDeliveryMethod
  • InventorySourceStatus
    • JSON 表示法
  • InventorySourceConfigStatus
  • RateDetails
    • JSON 表示法
  • InventorySourceRateType
  • Money
    • JSON 表示法
  • TimeRange
    • JSON 表示法
  • CreativeConfig
    • JSON 表示法
  • InventorySourceDisplayCreativeConfig
    • JSON 表示法
  • InventorySourceVideoCreativeConfig
    • JSON 表示法
  • InventorySourceAccessors
    • JSON 表示法
  • PartnerAccessor
    • JSON 表示法
  • AdvertiserAccessors
    • JSON 表示法
• 方法

資源：InventorySource

廣告空間來源。

JSON 表示法

{ "name": string, "inventorySourceId": string, "displayName": string, "inventorySourceType": enum (InventorySourceType), "inventorySourceProductType": enum (InventorySourceProductType), "commitment": enum (InventorySourceCommitment), "deliveryMethod": enum (InventorySourceDeliveryMethod), "dealId": string, "status": { object (InventorySourceStatus) }, "exchange": enum (Exchange), "updateTime": string, "rateDetails": { object (RateDetails) }, "publisherName": string, "timeRange": { object (TimeRange) }, "creativeConfigs": [ { object (CreativeConfig) } ], "guaranteedOrderId": string, "readWriteAccessors": { object (InventorySourceAccessors) }, "readAdvertiserIds": [ string ], "readPartnerIds": [ string ] }

欄位
name	string 僅供輸出。廣告空間來源的資源名稱。
inventorySourceId	string (int64 format) 僅供輸出。廣告空間來源的專屬 ID。由系統指派。
displayName	string 廣告空間來源的顯示名稱。 必須採用 UTF-8 編碼，大小上限為 240 個位元組。
inventorySourceType	enum (InventorySourceType) 表示廣告空間來源的類型。
inventorySourceProductType	enum (InventorySourceProductType) 僅供輸出。廣告空間來源的產品類型，表示銷售廣告空間的方式。
commitment	enum (InventorySourceCommitment) 廣告空間來源是否為保證或無保證放送。
deliveryMethod	enum (InventorySourceDeliveryMethod) 廣告空間來源的放送方式。 如果是無保證廣告空間來源，唯一可接受的值為 INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC。 如果是保證廣告空間來源，可接受的值為 INVENTORY_SOURCE_DELIVERY_METHOD_TAG 和 INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC。
dealId	string 廣告交易平台空間中用於識別廣告空間來源的專屬 ID。 在每個廣告交易平台中，買家 ID 不得重複，但不同廣告交易平台之間的買家 ID 可以重複。
status	object (InventorySourceStatus) 廣告空間來源的狀態設定。
exchange	enum (Exchange) 廣告空間來源所屬的廣告交易平台。
updateTime	string (Timestamp format) 僅供輸出。廣告空間來源上次更新的時間戳記。由系統指派。 使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
rateDetails	object (RateDetails) 必填。廣告空間來源的費率詳細資料。
publisherName	string 廣告空間來源的發布商/賣家名稱。
timeRange	object (TimeRange) 這個廣告空間來源開始和停止放送的時間範圍。
creativeConfigs[]	object (CreativeConfig) 廣告空間來源的廣告素材規定。 不適用於競價套裝方案。
guaranteedOrderId	string 不可變動。這個廣告空間來源所屬保證訂單的 ID。 只有在 commitment 為 INVENTORY_SOURCE_COMMITMENT_GUARANTEED 時才適用。
readWriteAccessors	object (InventorySourceAccessors) 具備廣告空間來源讀取/寫入權限的夥伴或廣告主。 只有在 commitment 為 INVENTORY_SOURCE_COMMITMENT_GUARANTEED 時才會輸出，在這種情況下，讀取/寫入存取子會沿用自上層保證訂單。 如果 commitment 為 INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED，則為必填。 如果 commitment 為 INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED，且這個欄位設有夥伴，則該夥伴底下的所有廣告主都會自動取得廣告空間來源的唯讀存取權。這些廣告主不會納入readAdvertiserIds。
readAdvertiserIds[]	string (int64 format) 僅供輸出。對廣告空間來源具備唯讀存取權的廣告主 ID。
readPartnerIds[]	string (int64 format) 僅供輸出。對廣告空間來源具備唯讀存取權的夥伴 ID。 這個欄位中夥伴的所有廣告主，都會沿用廣告空間來源的唯讀存取權。

InventorySourceType

可能的廣告空間來源類型。

列舉
INVENTORY_SOURCE_TYPE_UNSPECIFIED	未指定廣告空間來源類型，或這個版本不支援。
INVENTORY_SOURCE_TYPE_PRIVATE	私人廣告空間來源。
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE	競價套裝方案。

InventorySourceProductType

廣告空間來源可能的產品類型。

列舉
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED	未指定產品類型，或這個版本不支援。無法透過 API 修改這類產品類型的廣告空間來源。
PREFERRED_DEAL	廣告空間來源透過首選交易銷售廣告空間。
PRIVATE_AUCTION	廣告空間來源透過私下競價銷售廣告空間。
PROGRAMMATIC_GUARANTEED	廣告空間來源透過程式輔助保證銷售廣告空間。
TAG_GUARANTEED	廣告空間來源透過代碼保證交易銷售廣告空間。
YOUTUBE_RESERVE	廣告空間來源透過 YouTube Reserve 銷售廣告空間。
INSTANT_RESERVE	廣告空間來源透過即時預訂功能銷售廣告空間。無法透過 API 修改這類產品類型的廣告空間來源。
GUARANTEED_PACKAGE	廣告空間來源透過保證套裝方案銷售廣告空間。不支援透過 API 修改這類產品類型的廣告空間來源。
PROGRAMMATIC_TV	廣告空間來源透過程式輔助電視銷售廣告空間。無法透過 API 修改這類產品類型的廣告空間來源。
AUCTION_PACKAGE	廣告空間來源透過競價套裝方案銷售廣告空間。無法透過 API 修改這類產品類型的廣告空間來源。

InventorySourceCommitment

廣告空間來源可能的承諾類型。

列舉
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED	未指定承諾使用合約，或這個版本不支援。
INVENTORY_SOURCE_COMMITMENT_GUARANTEED	保證放送。
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED	承諾為無保證放送。

InventorySourceDeliveryMethod

廣告空間來源的可能放送方式。

列舉
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED	未指定或不清楚這個版本的傳送方式。
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC	放送方式為程式輔助。
INVENTORY_SOURCE_DELIVERY_METHOD_TAG	放送方式為代碼。

InventorySourceStatus

廣告空間來源的狀態相關設定。

JSON 表示法
{ "entityStatus": enum (EntityStatus), "entityPauseReason": string, "sellerStatus": enum (EntityStatus), "sellerPauseReason": string, "configStatus": enum (InventorySourceConfigStatus) }

欄位
entityStatus	enum (EntityStatus) 廣告空間來源是否可放送。 可接受的值為 ENTITY_STATUS_ACTIVE、ENTITY_STATUS_ARCHIVED 和 ENTITY_STATUS_PAUSED。預設值為 ENTITY_STATUS_ACTIVE。
entityPauseReason	string 使用者提供的暫停廣告空間來源原因。 不得超過 100 個字元。 只有在 entityStatus 設為 ENTITY_STATUS_PAUSED 時才適用。
sellerStatus	enum (EntityStatus) 僅供輸出。賣家為廣告空間來源設定的狀態。 僅適用於直接從發布商同步的廣告空間來源。可接受的值為 ENTITY_STATUS_ACTIVE 和 ENTITY_STATUS_PAUSED。
sellerPauseReason	string 僅供輸出。賣家提供的暫停廣告空間來源原因。 僅適用於直接從發布商同步處理的廣告空間來源，且 sellerStatus 設為 ENTITY_STATUS_PAUSED。
configStatus	enum (InventorySourceConfigStatus) 僅供輸出。廣告空間來源的設定狀態。 僅適用於保證廣告空間來源。可接受的值為 INVENTORY_SOURCE_CONFIG_STATUS_PENDING 和 INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED。 廣告空間來源必須先完成設定 (填寫必填欄位、選擇廣告素材，以及選取預設廣告活動)，才能放送。

InventorySourceConfigStatus

保證廣告空間來源的可能設定狀態。

列舉
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED	這個版本未指定或不清楚核准狀態。
INVENTORY_SOURCE_CONFIG_STATUS_PENDING	保證廣告空間來源的初始狀態。必須設定處於這個狀態的廣告空間來源。
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED	買方設定保證廣告空間來源後的狀態。

RateDetails

廣告空間來源的費率相關設定。

JSON 表示法
{ "inventorySourceRateType": enum (InventorySourceRateType), "rate": { object (Money) }, "unitsPurchased": string, "minimumSpend": { object (Money) } }

欄位
inventorySourceRateType	enum (InventorySourceRateType) 費率類型。 可接受的值為 INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED、INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR 和 INVENTORY_SOURCE_RATE_TYPE_CPD。
rate	object (Money) 廣告空間來源的費率。
unitsPurchased	string (int64 format) 保證廣告空間來源必須提供這項資訊。賣家保證的曝光次數。
minimumSpend	object (Money) 僅供輸出。買方承諾預先支付的廣告空間來源費用。 僅適用於保證廣告空間來源。

InventorySourceRateType

廣告空間來源可能使用的費率類型。

列舉
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED	未指定費率類型，或這個版本不支援。
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED	費率類型為千次曝光出價 (固定)。
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR	費率類型為千次曝光出價 (底價)。
INVENTORY_SOURCE_RATE_TYPE_CPD	費率類型為每日費用。
INVENTORY_SOURCE_RATE_TYPE_CPH	費率類型為每小時費用。
INVENTORY_SOURCE_RATE_TYPE_FLAT	費率類型為「固定」。

金額

代表金額與其貨幣類型。

JSON 表示法
{ "currencyCode": string, "units": string, "nanos": integer }

欄位
currencyCode	string ISO 4217 定義的三碼貨幣代碼。
units	string (int64 format) 金額的整數單位。舉例來說，如果 currencyCode 為 "USD"，則 1 個單位為 1 美元。
nanos	integer 金額的奈米 (10^-9) 單位數量。這個值必須介於 -999,999,999 和 +999,999,999 (含) 之間。如果 units 為正值，nanos 必須為正值或零。如果 units 為零，則 nanos 可為正值、零或負值。如果 units 為負值，nanos 就必須為負值或零。例如，$-1.75 美元的表式方式為 units=-1 和 nanos=-750,000,000。

TimeRange

日期範圍。

JSON 表示法
{ "startTime": string, "endTime": string }

欄位
startTime	string (Timestamp format) 必填。時間範圍的下限 (包含)。 使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
endTime	string (Timestamp format) 必填。時間範圍上限 (含)。 使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

CreativeConfig

廣告空間來源的廣告素材規定設定。

JSON 表示法
{ "creativeType": enum (CreativeType), // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "displayCreativeConfig": { object (InventorySourceDisplayCreativeConfig) }, "videoCreativeConfig": { object (InventorySourceVideoCreativeConfig) } // End of mutually exclusive fields. }

欄位
creativeType	enum (CreativeType) 可指派給廣告空間來源的廣告素材類型。僅支援下列類型： CREATIVE_TYPE_STANDARD CREATIVE_TYPE_VIDEO
適用於 creative_type 為下列其中一項時： CREATIVE_TYPE_STANDARD CREATIVE_TYPE_VIDEO 可指派給廣告空間來源的廣告素材設定。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位：
displayCreativeConfig	object (InventorySourceDisplayCreativeConfig) 多媒體廣告素材的設定。creativeType 為 CREATIVE_TYPE_STANDARD 時適用。
videoCreativeConfig	object (InventorySourceVideoCreativeConfig) 影片廣告素材的設定。creativeType 為 CREATIVE_TYPE_VIDEO 時適用。
互斥欄位結束。

InventorySourceDisplayCreativeConfig

多媒體廣告素材的設定。

JSON 表示法
{ "creativeSize": { object (Dimensions) } }

欄位
creativeSize	object (Dimensions) 可指派給廣告空間來源的多媒體廣告素材大小規定。

InventorySourceVideoCreativeConfig

影片廣告素材的設定。

JSON 表示法
{ "duration": string }

欄位
duration	string (Duration format) 可指派給廣告空間來源的影片廣告素材長度規定。 以秒為單位的時間長度，最多 9 個小數位數，結尾為「s」。例如："3.5s"。

InventorySourceAccessors

可存取廣告空間來源的夥伴或廣告主。

JSON 表示法
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "partner": { object (PartnerAccessor) }, "advertisers": { object (AdvertiserAccessors) } // End of mutually exclusive fields. }

欄位
可存取廣告空間來源的夥伴或廣告主。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位：
partner	object (PartnerAccessor) 可存取廣告空間來源的合作夥伴。
advertisers	object (AdvertiserAccessors) 可存取廣告空間來源的廣告主。所有廣告主都必須屬於同一個夥伴。
互斥欄位結束。

PartnerAccessor

可存取廣告空間來源的合作夥伴。

JSON 表示法
{ "partnerId": string }

欄位
partnerId	string (int64 format) 合作夥伴的 ID。

AdvertiserAccessors

可存取廣告空間來源的廣告主。

JSON 表示法
{ "advertiserIds": [ string ] }

欄位
advertiserIds[]	string (int64 format) 廣告主的 ID。

方法
get	取得廣告空間來源交易。
list	列出廣告空間來源交易。