REST Resource: exchanges.orders.products

資源：Product

產品

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
欄位
name

string

產品的相對路徑名稱。由伺服器產生。例如：「exchanges/1234/orders/5678/products/abc」。僅供輸出。
displayName

string

產品的顯示名稱。

必須採用 UTF-8 編碼，大小上限為 240 個位元組。必填。
externalDealId

string

外部 ID。這是廣告交易平台系統中的交易 ID。最多 100 個字元。允許的字元包括英數字元、底線、連字號和半形句號。所有產品的 ID 不得重複。必填。
transactionType

enum (TransactionType)

產品交易類型。必填。
pricingType

enum (PricingType)

產品的定價類型。必填。
updateTime
(deprecated)

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"。
startTime

string (Timestamp format)

這項產品的啟用時間。必須早於結束時間。開始時間不得晚於 1 年後。必填。

使用 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)

這項產品停用的時間。目前不得晚於 2036 年。必填。

使用 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)

房價詳細資料。必填。
creativeConfig[]

object (CreativeConfig)

產品的廣告素材規定。預訂交易類型產品的必填欄位。
makegood
(deprecated)

boolean

指出產品是否為補償產品。
makegoodDetails
(deprecated)

object (MakegoodDetails)

產品的補償詳細資料。如果產品是補償商品，則為必填屬性。
creativeSource

enum (CreativeSource)

產品的廣告素材來源。選用，預設為 CREATIVE_SOURCE_ADVERTISER。產品建立後即無法變更。
mediumType

enum (MediumType)

產品的媒體類型。如果未指定，為確保回溯相容性，預設值為 DIGITAL。產品建立後即無法變更。
audienceTargetingConfig

object (AudienceTargetingConfig)

(選用步驟) 在 Exchange 中，已在交易層級套用所選的目標對象指定目標設定。
targetingCriteria

object (TargetingCriteria)

僅供輸出。產品指定條件參考資料。僅適用於即時交易情境。
forecastResult

object (ForecastResult)

產品預測結果。如果指定目標條件不為空白，且未提供預測，則必須提供此值。僅適用於即時交易情境。
errorDetails

object (ErrorDetails)

如果無法更新特定產品欄位，請務必指定錯誤詳細資料。如果指定目標條件導致無法提供預測結果，或無法更新產品，則必須提供這項資訊。僅適用於即時交易情境。
frequencyCap

object (FrequencyCap)

僅供輸出。買家選取的展示頻率上限。僅適用於即時交易情境。
etag

string

更新產品時必須指定的 ETag。只有在 etag 欄位不為空白時，才需要為更新指定這個欄位。僅適用於即時交易情境。

CreativeConfig

產品的廣告素材規定設定。

JSON 表示法 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
欄位
creativeType

enum (CreativeType)

廣告素材類型。必填。
dimensionCreativeConfig

object (DimensionCreativeConfig)

多媒體廣告素材的設定。

原生廣告素材 (CREATIVE_TYPE_NATIVE) 不支援這個欄位。
durationCreativeConfig

object (DurationCreativeConfig)

影片廣告素材的設定。

CreativeType

可能的廣告素材類型。

列舉
CREATIVE_TYPE_UNSPECIFIED 未指定廣告素材類型。輸入值無效。
CREATIVE_TYPE_DISPLAY 多媒體廣告素材類型。
CREATIVE_TYPE_VIDEO 影片的廣告素材類型。
CREATIVE_TYPE_AUDIO 音訊廣告素材類型。
CREATIVE_TYPE_NATIVE 原生廣告素材類型。

DimensionCreativeConfig

多媒體廣告素材的尺寸 (以像素為單位)。

JSON 表示法 
{
  "width": integer,
  "height": integer
}
欄位
width

integer

多媒體廣告素材寬度。必填。
height

integer

多媒體廣告素材高度。必填。

DurationCreativeConfig

廣告素材在時間長度內的設定。

JSON 表示法 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
欄位
duration

string (Duration format)

影片廣告素材的長度 (以秒為單位)。必填

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
durationMatchType

enum (DurationMatchType)

符合時間長度條件。
skippableMatchType

enum (SkippableMatchType)

影片廣告素材的可略過類型。

DurationMatchType

時間長度比對條件的可能格式。

列舉
DURATION_MATCH_TYPE_UNSPECIFIED 這個版本未指定或不明確指定時間長度比對條件。輸入值無效。
DURATION_MATCH_TYPE_EQUAL_TO 廣告素材時間長度必須與規定時間長度相同。
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO 廣告素材長度必須等於或小於所需長度。

SkippableMatchType

產品的可能格式。

列舉
SKIPPABLE_MATCH_TYPE_UNSPECIFIED 這個版本未指定或不明可略過類型。輸入值無效。
SKIPPABLE_MATCH_TYPE_SKIPPABLE 廣告素材必須可略過。
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE 廣告素材必須不可略過。
SKIPPABLE_MATCH_TYPE_ANY 廣告素材可分為可略過及不可略過兩種。

MakegoodDetails

補償詳細資料的設定。

JSON 表示法 
{
  "originalExternalDealId": string,
  "reason": string
}
欄位
originalExternalDealId

string

要求補償項的原始外部交易 ID。最多 100 個字元。允許的字元包括英數字元、底線、連字號和半形句號。必填。
reason

string

賣方發起的補償項原因。最多 250 個字元。必填。

CreativeSource

廣告素材來源：廣告素材的放送位置。

列舉
CREATIVE_SOURCE_UNSPECIFIED 這個版本未指定或不明廣告素材來源。輸入值無效。
CREATIVE_SOURCE_ADVERTISER 廣告素材將由 DV3 放送。
CREATIVE_SOURCE_PUBLISHER 廣告素材將由發布商放送。目前不支援發布商代管的廣告素材；任何嘗試將廣告素材來源設為 CREATIVE_SOURCE_PUBLISHER 的要求都會失敗。

AudienceTargetingConfig

目標對象指定目標的設定。

JSON 表示法 
{
  "audienceType": enum (AudienceType)
}
欄位
audienceType

enum (AudienceType)

目標對象類型。必填。

AudienceType

目標對象類型。

列舉
AUDIENCE_TYPE_UNSPECIFIED 未指定目標對象類型。輸入的內容無效。
AUDIENCE_TYPE_COMMERCE 商務目標對象類型。

TargetingCriteria

指定條件。

JSON 表示法 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
欄位
selectedTargetingOptions[]

object (SelectedTargetingOption)

所選選項。

SelectedTargetingOption

單一指定目標類型所選的指定目標選項。

JSON 表示法 
{
  "type": enum (TargetingType),

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
欄位
type

enum (TargetingType)

與所選選項相關聯的指定目標類型。
聯集欄位 value。只能加入一種選取類型。所選項目必須對應至「類型」欄位所選的 TargetingType。value 只能是下列其中一項：
audienceSelection

object (AudienceSelection)

選取的目標對象。
targetingSelection

object (TargetingSelection)

所選選項 ID 的一般集合。

TargetingType

指定類型。

列舉
TARGETING_TYPE_UNSPECIFIED 未指定指定目標類型，不適用於輸入內容。
TARGETING_TYPE_AUDIENCE 指定目標對象類型。
TARGETING_TYPE_COUNTRY 指定類型國家/地區。
TARGETING_TYPE_DMA 指定類型為行銷區域。
TARGETING_TYPE_PROGRAMMER 指定類型程式設計師。
TARGETING_TYPE_BRAND 指定類型品牌。
TARGETING_TYPE_CONTENT_GENRE 指定類型內容類型。
TARGETING_TYPE_DEVICE 指定類型裝置。
TARGETING_TYPE_OPERATING_SYSTEM 指定作業系統類型。
TARGETING_TYPE_RATING 指定類型評分。
TARGETING_TYPE_ENVIRONMENT 指定類型環境。
TARGETING_TYPE_LANGUAGE 指定類型語言。
TARGETING_TYPE_GEO 指定類型地理區域。
TARGETING_TYPE_AGE 指定類型年齡。
TARGETING_TYPE_GENDER 指定類型性別。
TARGETING_TYPE_CONTEXTUAL_SEGMENT 指定類型內容比對區隔。
TARGETING_TYPE_REQUEST_FORMAT 指定類型要求格式。
TARGETING_TYPE_PUBLISHER 指定類型發布商。
TARGETING_TYPE_INVENTORY_SIZE 指定類型大小。
TARGETING_TYPE_NETWORK 指定類型網路。
TARGETING_TYPE_PLATFORM 指定類型平台。
TARGETING_TYPE_VIDEO_DELIVERY_TYPE 指定目標類型影片放送類型。
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE 指定類型影片播放器大小下限。

AudienceSelection

選取的指定目標對象選項。

JSON 表示法 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
欄位
includedOrGroups[]

object (OrGroup)

內含的選項會以 AND 連接，每個內含的選項可以是個別選項，也可以是一組以 OR 連接的選項。
excludedOptionIds[]

string (int64 format)

排除的選項會以 OR 連結。

OrGroup

以 OR 連結的一組所選選項。

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

string (int64 format)

所選選項 ID。

TargetingSelection

一組或多組所選選項 ID，適用於大多數指定目標類型。

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

string (int64 format)

所選選項 ID。

ForecastResult

已指定預測結果。

JSON 表示法 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
欄位
forecasts[]

object (Forecast)

預測。針對指定的每個元素，「forecastCategory」不得重複。

預測

指定預測類別的預測。

JSON 表示法 
{
  "forecastCategory": enum (ForecastCategory),

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
欄位
forecastCategory

enum (ForecastCategory)

預測統計資料代表的指定預測類別。
聯集欄位 forecast_data。只能加入一種統計資料。填入的資料必須對應至「forecastCategory」欄位。forecast_data 只能是下列其中一項：
number

string (int64 format)

數字資料。
percentage

integer

百分比資料。
cpmPrice

object (Money)

千次曝光出價價格資料。
cpmRange

object (CpmRange)

千次曝光出價價格範圍資料。
forecastBreakdownData

object (ForecastBreakdownData)

預測細目資料。

ForecastCategory

預測類別。

列舉
FORECAST_CATEGORY_UNSPECIFIED 未指定類別。輸入的內容無效。
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES 商機總數。數字資料。
FORECAST_CATEGORY_TOTAL_AUDIENCE 目標對象總數。數字資料。
FORECAST_CATEGORY_DIGITAL_TRP 數位目標收視點數。百分比資料。
FORECAST_CATEGORY_SUGGESTED_CPM 建議千次曝光出價價格。千次曝光出價範圍或千次曝光出價資料。
FORECAST_CATEGORY_UNIQUE_REACH 預測不重複觸及數。數字資料。
FORECAST_CATEGORY_FORECAST_BREAKDOWN 預測細目。預測細目資料。

CpmRange

千次曝光出價範圍包含千次曝光出價的最小值和最大值。

JSON 表示法 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
欄位
minCpm

object (Money)

千次曝光出價範圍的下限。
maxCpm

object (Money)

千次曝光出價範圍的上限。

ForecastBreakdownData

預測細目資料包含預測細目清單。

JSON 表示法 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
欄位
forecastBreakdowns[]

object (ForecastBreakdown)

預測細目清單。

ForecastBreakdown

所選指定目標選項的預測細目。

JSON 表示法 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
欄位
selectedTargetingOption

object (SelectedTargetingOption)

單一指定目標類型所選的指定目標選項。
聯集欄位 breakdown_data。只能加入一種細分資料。breakdown_data 只能是下列其中一項：
impressions

string (int64 format)

預測曝光次數。

ErrorDetails

更新發生錯誤時指定的錯誤詳細資料。

JSON 表示法 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
欄位
message

string

訊息會說明更新發生錯誤的時間。
instantDealErrorStatus

enum (InstantDealErrorStatus)

即時交易更新發生錯誤時指定的錯誤狀態。

InstantDealErrorStatus

即時交易更新發生錯誤時指定的錯誤狀態。

列舉
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED 未指定的錯誤狀態。
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE 錯誤狀態表示無法提供庫存。
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE 錯誤狀態表示無法提供預報。
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT 錯誤狀態表示有輸入欄位無效。

FrequencyCap

在指定時間範圍內，同一位使用者看到同一則廣告的次數

JSON 表示法 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
欄位
timeUnit

enum (TimeUnit)

套用展示頻率上限的時間單位。
maxImpressions

string (int64 format)

在此期間內，使用者看到同一則廣告的次數上限。

TimeUnit

套用展示頻率上限的時間單位。

列舉
TIME_UNIT_UNSPECIFIED 未指定時間單位。
TIME_UNIT_LIFETIME 展示頻率上限會套用至整個生命週期。
TIME_UNIT_MONTHS 展示頻率上限會套用至多個月。
TIME_UNIT_WEEKS 展示頻率上限會套用數週。
TIME_UNIT_DAYS 系統會將展示頻率上限套用至指定天數。

方法

create

 建立產品。

get

 取得產品。

list

 列出產品。

patch

 更新產品。