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)
    }
  ],
  "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 不得重複，但不同交易平台之間則不一定。
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_FLAT 費率類型為「固定」。

金額

代表金額與其貨幣類型。

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

string

ISO 4217 定義的貨幣代碼，由 3 個字母組成。
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),

  // 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

 更新現有廣告空間來源。