REST Resource: inventorySources

資源：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)
    }
  ],
  "subSitePropertyId": string,
  "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，可用於識別廣告空間來源。

每個廣告交易平台中的買方名稱不得重複，但在不同廣告交易平台間可能會不同。
status

object (InventorySourceStatus)

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

enum (Exchange)

廣告空間來源所屬的廣告交易平台。
updateTime

string (Timestamp format)

僅供輸出。廣告空間來源上次更新時的時間戳記。由系統指派。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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 這個廣告空間來源會透過 Programmtic 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_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)

必要欄位。時間範圍的下限 (含首尾)。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

必要欄位。時間範圍的上限 (含首尾)。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

CreativeConfig

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

JSON 表示法 
{
  "creativeType": enum (CreativeType),

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}
欄位
creativeType

enum (CreativeType)

可指派給廣告空間來源的廣告素材類型。系統僅支援以下類型：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

聯集欄位 creative_config_scheme。適用於 creative_type 為以下任一種情況：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

可指派給廣告空間來源的廣告素材設定。creative_config_scheme 只能採用下列其中一種設定：
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 表示法 
{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}
欄位
聯集欄位 accessors。可存取廣告空間來源的夥伴或廣告主。accessors 只能是下列其中一項：
partner

object (PartnerAccessor)

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

object (AdvertiserAccessors)

可存取廣告空間來源的廣告客戶。所有廣告主都必須屬於相同的夥伴。

PartnerAccessor

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

JSON 表示法 
{
  "partnerId": string
}
欄位
partnerId

string (int64 format)

合作夥伴的 ID。

AdvertiserAccessors

可存取廣告空間來源的廣告客戶。

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

string (int64 format)

廣告客戶的 ID。

方法

create

 建立新的廣告空間來源。

editInventorySourceReadWriteAccessors

 編輯廣告空間來源的讀取/寫入存取者。

get

 取得廣告空間來源。

list

 列出目前使用者可存取的廣告空間來源。

patch

 更新現有的廣告空間來源。