REST Resource: advertisers.creatives

資源：廣告素材

單一廣告素材。

JSON 表示法 
{
  "name": string,
  "advertiserId": string,
  "creativeId": string,
  "cmPlacementId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "createTime": string,
  "creativeType": enum (CreativeType),
  "hostingSource": enum (HostingSource),
  "dynamic": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "additionalDimensions": [
    {
      object (Dimensions)
    }
  ],
  "mediaDuration": string,
  "creativeAttributes": [
    enum (CreativeAttribute)
  ],
  "reviewStatus": {
    object (ReviewStatusInfo)
  },
  "assets": [
    {
      object (AssetAssociation)
    }
  ],
  "exitEvents": [
    {
      object (ExitEvent)
    }
  ],
  "timerEvents": [
    {
      object (TimerEvent)
    }
  ],
  "counterEvents": [
    {
      object (CounterEvent)
    }
  ],
  "appendedTag": string,
  "integrationCode": string,
  "notes": string,
  "iasCampaignMonitoring": boolean,
  "companionCreativeIds": [
    string
  ],
  "skippable": boolean,
  "skipOffset": {
    object (AudioVideoOffset)
  },
  "progressOffset": {
    object (AudioVideoOffset)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "thirdPartyUrls": [
    {
      object (ThirdPartyUrl)
    }
  ],
  "transcodes": [
    {
      object (Transcode)
    }
  ],
  "trackerUrls": [
    string
  ],
  "jsTrackerUrl": string,
  "cmTrackingAd": {
    object (CmTrackingAd)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "thirdPartyTag": string,
  "requireMraid": boolean,
  "requireHtml5": boolean,
  "requirePingForAttribution": boolean,
  "expandingDirection": enum (ExpandingDirection),
  "expandOnHover": boolean,
  "vastTagUrl": string,
  "vpaid": boolean,
  "html5Video": boolean,
  "lineItemIds": [
    string
  ],
  "mp3Audio": boolean,
  "oggAudio": boolean,
  "syntheticContentAttestationStatus": enum (SyntheticContentAttestationStatus)
}
欄位
name

string

僅供輸出。廣告素材的資源名稱。
advertiserId

string (int64 format)

僅供輸出。廣告素材所屬廣告主的專屬 ID。
creativeId

string (int64 format)

僅供輸出。廣告素材的專屬 ID。由系統指派。
cmPlacementId

string (int64 format)

僅供輸出。與廣告素材相關聯的 Campaign Manager 360 刊登位置專屬 ID。這個欄位僅適用於從 Campaign Manager 同步的廣告素材。
displayName

string

必填。廣告素材的顯示名稱。

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

enum (EntityStatus)

必填。控管廣告素材是否可放送。

可接受的值如下：

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
  • ENTITY_STATUS_PAUSED
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"。
createTime

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

enum (CreativeType)

必填。不可變動。廣告素材類型。
hostingSource

enum (HostingSource)

必填。指出廣告素材的代管位置。
dynamic

boolean

僅供輸出。指出廣告素材是否為動態。
dimensions

object (Dimensions)

必填。廣告素材的主要尺寸。適用於所有廣告素材類型。當 creativeType 為下列其中一個值時，widthPixels 和 heightPixels 的值預設為 0：

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

object (Dimensions)

(選用步驟) 其他尺寸。適用於 creativeType 為下列其中一項的情況：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_LIGHTBOX
  • CREATIVE_TYPE_PUBLISHER_HOSTED

如果指定這個欄位，則 widthPixels 和 heightPixels 都必須大於或等於 0。
mediaDuration

string (Duration format)

僅供輸出。廣告素材的媒體時間長度。適用於 creativeType 為下列其中一項的情況：

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_PUBLISHER_HOSTED

以秒為單位的時間長度，最多 9 個小數位數，結尾為「s」。示例："3.5s"。
creativeAttributes[]

enum (CreativeAttribute)

僅供輸出。系統產生的廣告素材屬性清單。
reviewStatus

object (ReviewStatusInfo)

僅供輸出。廣告素材審核程序的目前狀態。
assets[]

object (AssetAssociation)

必填。與這個廣告素材相關聯的素材資源。
exitEvents[]

object (ExitEvent)

必填。這個廣告素材的離開事件。離開事件 (亦稱為點擊廣告代碼) 是指廣告素材的特定區域，可讓使用者透過點擊或輕觸的方式開啟廣告主的到達網頁。每個廣告素材都必須包含至少一個離開事件。您可以透過下列任一方式，在廣告素材中新增離開網頁：

  • 使用 Google Web Designer 的輕觸區域。
  • 定義名為「clickTag」的 JavaScript 變數。
  • 使用啟用器 (Enabler.exit()) 追蹤互動式多媒體格式中的離開事件。
timerEvents[]

object (TimerEvent)

(選用步驟) 互動式多媒體廣告素材的計時器自訂事件。計時器會追蹤使用者觀看互動式多媒體廣告素材並與廣告素材的特定部分互動的時間。廣告素材可具有多個計時器事件，每個事件獨立計時。如果廣告素材只包含圖片素材資源，請留空或取消設定。
counterEvents[]

object (CounterEvent)

(選用步驟) 互動式多媒體廣告素材的計數器事件。計數器會追蹤使用者透過指定方式 (懸停滑鼠指標、移走滑鼠指標、點擊、輕觸、資料載入、鍵盤輸入等) 與互動式多媒體廣告素材的任何部分互動的次數。凡是廣告素材可擷取的任何事件，都可記錄為一個計數器。如果廣告素材只包含圖片素材資源，請留空或取消設定。
appendedTag

string

(選用步驟) 要附加至廣告素材代碼的第三方 HTML 追蹤代碼。
integrationCode

string

(選用步驟) 用於將這個廣告素材連結至外部系統的 ID 資訊。必須採用 UTF-8 編碼，長度不得超過 10,000 個半形字元。
notes

string

(選用步驟) 這個廣告素材的使用者附註。必須採用 UTF-8 編碼，長度不得超過 20,000 個字元。
iasCampaignMonitoring

boolean

(選用步驟) 指出是否已啟用 Integral Ad Science (IAS) 廣告活動監控功能。如要為廣告素材啟用這項功能，請確認 Advertiser.creative_config.ias_client_id 已設為 IAS 客戶 ID。
companionCreativeIds[]

string (int64 format)

(選用步驟) 影片廣告素材的隨播廣告素材 ID。

您可以指派現有的多媒體廣告素材 (內含圖片或 HTML5 素材資源)，在發布商的影片播放器周圍放送。影片播放時，系統會在影片播放器周圍顯示隨播廣告素材，且影片播畢後仍會繼續顯示。

含有 additional dimensions 的廣告素材不得為隨播廣告素材。

這個欄位僅支援下列 creativeType：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

(選用步驟) 使用者是否可以選擇略過影片廣告素材。

這個欄位僅支援下列 creativeType：

  • CREATIVE_TYPE_VIDEO
skipOffset

object (AudioVideoOffset)

(選用步驟) 設定影片需播放多久的時間，「略過」按鈕才會顯示。

如果 skippable 為 true，則必須填寫這個欄位。

這個欄位僅支援下列 creativeType：

  • CREATIVE_TYPE_VIDEO
progressOffset

object (AudioVideoOffset)

(選用步驟) 影片播放多久的時間，系統才會計為一次觀看。

如果 skippable 為 true，則必須填寫這個欄位。

這個欄位僅支援下列 creativeType：

  • CREATIVE_TYPE_VIDEO
universalAdId

object (UniversalAdId)

(選用步驟) 登錄機構提供的選用廣告素材 ID，在所有平台中都是專屬 ID。

通用廣告 ID 是 VAST 4.0 標準的一部分。建立素材資源後仍可修改。

這個欄位僅支援下列 creativeType：

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

(選用步驟) 第三方追蹤網址，用於追蹤影片廣告素材的互動。

這個欄位僅支援下列 creativeType：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
transcodes[]

object (Transcode)

僅供輸出。音訊/視訊轉碼。

Display & Video 360 會將主要素材資源轉碼成多個替代版本，這些版本採用不同的檔案格式或屬性 (解析度、音訊位元率和影片位元率)，每個版本都是供特定影片播放器或頻寬專用。

這些轉碼檔案可讓發布商系統為影片的每次曝光選擇合適的檔案，並確保系統會根據觀眾的連線速度和螢幕大小，放送適當的檔案。

這個欄位僅支援下列 creativeType：

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

(選用步驟) 分析服務供應商或第三方廣告技術廠商的追蹤網址。

網址開頭必須為 https: (不需符合 SSL 規定的廣告空間除外)。如要在網址中使用巨集，請務必使用 Display & Video 360 支援的巨集。

僅限標準網址，不得包含 IMG 或 SCRIPT 標記。

這個欄位只能在下列 creativeType 中寫入：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

(選用步驟) 支援的第三方驗證供應商 (ComScore、DoubleVerify、IAS、Moat) 提供的 JavaScript 評估網址。不支援 HTML 指令碼標記。

這個欄位只能在下列 creativeType 中寫入：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

(選用步驟) 與廣告素材相關聯的 Campaign Manager 360 追蹤廣告。

如果廣告主同時使用 Campaign Manager 360 和第三方廣告放送服務，則可選擇性為下列項目creativeType建立：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE

其他情況僅供輸出。
obaIcon

object (ObaIcon)

(選用步驟) 指定影片廣告素材的 OBA 圖示。

這個欄位僅支援下列 creativeType：

  • CREATIVE_TYPE_VIDEO
thirdPartyTag

string

(選用步驟) 用於廣告素材的原始第三方代碼。

這是必要欄位，且僅適用於第三方代碼廣告素材。

第三方代碼廣告素材是指具有下列hostingSource的廣告素材：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireMraid

boolean

(選用步驟) 表示廣告素材需要 MRAID (行動互動式多媒體廣告介面定義系統)。

如果廣告素材需要使用滑動或輕觸等行動裝置手勢才能互動，請設定這項屬性。

選填，僅適用於第三方代碼廣告素材。

第三方代碼廣告素材是指具有下列hostingSource的廣告素材：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireHtml5

boolean

(選用步驟) 指出廣告素材必須使用 HTML5 才能正常顯示。

選填，僅適用於第三方代碼廣告素材。第三方代碼廣告素材是指具有下列hostingSource的廣告素材：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requirePingForAttribution

boolean

(選用步驟) 表示廣告素材會等待歸因的回傳 Ping。

只有在搭配第三方廣告伺服器參數和 ${DC_DBM_TOKEN} 巨集使用 Campaign Manager 360 追蹤廣告時，這個巨集才有效。

選用，僅適用於第三方代碼廣告素材或第三方 VAST 代碼廣告素材。

第三方代碼廣告素材是指具有下列hostingSource的廣告素材：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE

第三方 VAST 代碼廣告素材是指具有下列特徵的廣告素材hostingSource：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
expandingDirection

enum (ExpandingDirection)

(選用步驟) 指定廣告素材的展開方向。

這是必填欄位，且僅適用於第三方可展開式廣告素材。

第三方可展開式廣告素材是指代管來源如下的廣告素材：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

(選用步驟) 表示廣告素材會在滑鼠懸停時自動展開。

選用，僅適用於第三方可展開式廣告素材。第三方可展開式廣告素材是指代管來源如下的廣告素材：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_EXPANDABLE
vastTagUrl

string

(選用步驟) 第三方 VAST 代碼廣告素材的 VAST 代碼網址。

這是必要屬性，且僅適用於第三方 VAST 代碼廣告素材。

第三方 VAST 代碼廣告素材是指具有下列特徵的廣告素材hostingSource：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
vpaid

boolean

僅供輸出。指出第三方 VAST 代碼廣告素材需要 VPAID (數位影片播放器廣告介面)。

僅供輸出，且僅適用於第三方 VAST 代碼廣告素材。

第三方 VAST 代碼廣告素材是指具有下列特徵的廣告素材hostingSource：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

僅供輸出。指出第三方 VAST 代碼廣告素材需要支援 HTML5 影片。

僅供輸出，且僅適用於第三方 VAST 代碼廣告素材。

第三方 VAST 代碼廣告素材是指具有下列特徵的廣告素材hostingSource：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_VIDEO
lineItemIds[]

string (int64 format)

僅供輸出。與這個廣告素材相關聯的委刊項 ID。

如要將廣告素材與委刊項建立關聯，請改用 LineItem.creative_ids。
mp3Audio

boolean

僅供輸出。指出第三方音訊廣告素材支援 MP3。

僅供輸出，且僅適用於第三方音訊廣告素材。

第三方音訊廣告素材是指具有下列hostingSource的廣告素材：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_AUDIO
oggAudio

boolean

僅供輸出。表示第三方音訊廣告素材支援 OGG。

僅供輸出，且僅適用於第三方音訊廣告素材。

第三方音訊廣告素材是指具有下列hostingSource的廣告素材：

  • HOSTING_SOURCE_THIRD_PARTY

並搭配下列 creativeType：

  • CREATIVE_TYPE_AUDIO
syntheticContentAttestationStatus

enum (SyntheticContentAttestationStatus)

(選用步驟) 在有當地 AI 標籤法規的地區放送時，是否要將廣告素材標示為使用 AI 生成或編輯。

HostingSource

廣告素材的可能代管來源。指出廣告素材的建立和代管位置。

列舉
HOSTING_SOURCE_UNSPECIFIED 這個版本未指定或不明主機來源。
HOSTING_SOURCE_CM

從 Campaign Manager 360 同步的廣告素材。

這個主機類型不支援建立和更新方法。
HOSTING_SOURCE_THIRD_PARTY

由第三方廣告伺服器 (3PAS) 代管的廣告素材。

如果 creativeType 屬於下列其中一種，這個代管類型就支援建立和更新方法：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

在 DV360 中建立，並由 Campaign Manager 360 代管的廣告素材。

如果 creativeType 屬於下列其中一種，這個代管類型就支援建立和更新方法：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

在 Studio 中建立並由 Campaign Manager 360 代管的互動式多媒體廣告素材。

這個主機類型不支援建立和更新方法。

CreativeAttribute

廣告素材的可能屬性。

列舉
CREATIVE_ATTRIBUTE_UNSPECIFIED 這個版本未指定或不明廣告素材屬性。
CREATIVE_ATTRIBUTE_VAST 廣告素材為 VAST 廣告素材。
CREATIVE_ATTRIBUTE_VPAID_LINEAR 廣告素材是線性 VPAID 廣告素材。
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR 廣告素材為非線性 VPAID 廣告素材。

ReviewStatusInfo

查看廣告素材的狀態。

JSON 表示法 
{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ]
}
欄位
approvalStatus

enum (ApprovalStatus)

代表廣告素材開始放送所需的基本核准。creativeAndLandingPageReviewStatus 和 contentAndPolicyReviewStatus 的摘要。
creativeAndLandingPageReviewStatus

enum (ReviewStatus)

廣告素材的廣告素材和到達網頁審查狀態。
contentAndPolicyReviewStatus

enum (ReviewStatus)

廣告素材的內容和政策審查狀態。
exchangeReviewStatuses[]

object (ExchangeReviewStatus)

廣告素材的廣告交易平台審查狀態。

ApprovalStatus

可能的核准狀態類型。這是 creativeAndLandingPageReviewStatus 和 contentAndPolicyReviewStatus 的摘要。

列舉
APPROVAL_STATUS_UNSPECIFIED 這個版本未指定類型值，或類型值不明。
APPROVAL_STATUS_PENDING_NOT_SERVABLE 廣告素材仍在審核中，因此無法放送。
APPROVAL_STATUS_PENDING_SERVABLE 廣告素材已通過廣告素材和到達網頁審查，可供放送，但尚待額外內容和政策審查。
APPROVAL_STATUS_APPROVED_SERVABLE 廣告素材與到達網頁審查和內容與政策審查都已通過。廣告素材可放送。
APPROVAL_STATUS_REJECTED_NOT_SERVABLE 廣告素材發生問題，必須先修正問題才能放送。

ReviewStatus

可能的審查狀態類型。

列舉
REVIEW_STATUS_UNSPECIFIED 這個版本未指定類型值，或類型值不明。
REVIEW_STATUS_APPROVED 廣告素材已獲准。
REVIEW_STATUS_REJECTED 廣告素材遭到拒登。
REVIEW_STATUS_PENDING 廣告素材待審核。

ExchangeReviewStatus

廣告素材的廣告交易平台審查狀態。

JSON 表示法 
{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}
欄位
exchange

enum (Exchange)

審查廣告素材的廣告交易平台。
status

enum (ReviewStatus)

廣告交易平台審查狀態。

AssetAssociation

廣告素材的素材資源關聯。

JSON 表示法 
{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}
欄位
asset

object (Asset)

(選用步驟) 相關聯的資產。
role

enum (AssetRole)

(選用步驟) 素材資源在廣告素材中的角色。

素材資源

單一資產。

JSON 表示法 
{
  "mediaId": string,
  "content": string
}
欄位
mediaId

string (int64 format)

上傳資產的媒體 ID。這是資產的專屬 ID。這個 ID 可傳遞至其他 API 呼叫 (例如 creatives.create)，將素材資源與廣告素材建立關聯。

媒體 ID 空間已於 2023 年 4 月 5 日更新。如要更新 2023 年 4 月 5 日前快取的媒體 ID，請從相關聯的廣告素材資源擷取新的媒體 ID，或重新上傳資產。
content

string

素材資源內容。如果是上傳的資產，內容就是放送路徑。

AssetRole

素材資源在廣告素材中的角色。

列舉
ASSET_ROLE_UNSPECIFIED 這個版本未指定或不明資產角色。
ASSET_ROLE_MAIN 素材資源是廣告素材的主要素材資源。
ASSET_ROLE_BACKUP 素材資源是廣告素材的備用素材資源。
ASSET_ROLE_POLITE_LOAD 素材資源是廣告素材的友善載入素材資源。
ASSET_ROLE_HEADLINE

原生廣告素材的標題。

content 必須採用 UTF-8 編碼，長度不得超過 25 個半形字元。

這個角色僅適用於下列 creativeType：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

原生廣告素材的長標題。

content 必須採用 UTF-8 編碼，長度不得超過 50 個半形字元。

這個角色僅適用於下列 creativeType：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

原生廣告素材的內文。

content 必須採用 UTF-8 編碼，長度不得超過 90 個半形字元。

這個角色僅適用於下列 creativeType：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

原生廣告素材的詳細內文。

content 必須採用 UTF-8 編碼，長度不得超過 150 個半形字元。

這個角色僅適用於下列 creativeType：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CAPTION_URL

簡單好記的到達網頁網址，會顯示在廣告素材中。這個網址可幫助使用者瞭解他們在點選廣告素材後會前往什麼網頁。

content 必須採用 UTF-8 編碼，長度不得超過 30 個半形字元。

舉例來說，如果到達網頁網址是「http://www.example.com/page」，說明文字網址可以是「example.com」。通訊協定 (http://) 為選填，但網址不得包含空格或特殊字元。

這個角色僅適用於下列 creativeType：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CALL_TO_ACTION

要在原生廣告素材的行動號召按鈕上使用的文字。

content 必須採用 UTF-8 編碼，長度不得超過 15 個半形字元。

這個角色僅適用於下列 creativeType：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

用來識別廣告主或品牌名稱的文字。

content 必須採用 UTF-8 編碼，長度不得超過 25 個半形字元。

這個角色僅適用於下列 creativeType：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

應用程式在 Google Play 商店或 iOS 應用程式商店的購買價格 (例如 $5.99 美元)。

請注意，這個值不會自動與商店中列出的實際值同步。這個值一律是儲存廣告素材時提供的值。

content 必須採用 UTF-8 編碼，長度不得超過 15 個半形字元。

這個角色的資產為唯讀。
ASSET_ROLE_ANDROID_APP_ID

Google Play 商店中 Android 應用程式的 ID。

您可以在應用程式的 Google Play 商店網址中找到這個 ID，也就是「id」後方的值。舉例來說，在 https://play.google.com/store/apps/details?id=com.company.appname 中，這個 ID 是 com.company.appname。

這個角色的資產為唯讀。
ASSET_ROLE_IOS_APP_ID

Apple App Store 中 iOS 應用程式的 ID。

這個 ID 號碼位於 Apple App Store 網址中，是「id」後方的數字字串。例如，在 https://apps.apple.com/us/app/gmail-email-by-google/id422689480 中，ID 為 422689480。

這個角色的資產為唯讀。
ASSET_ROLE_RATING

Google Play 商店或 iOS App Store 中的應用程式評分。

請注意，這個值不會自動與商店中的實際評分同步。這個值一律是儲存廣告素材時提供的值。

這個角色的資產為唯讀。
ASSET_ROLE_ICON

廣告素材的圖示。

這個角色僅適用於下列 creativeType，且為必要角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

原生影片廣告素材的封面圖片。

這個角色僅適用於下列 creativeType，且為必要角色：

  • CREATIVE_TYPE_VIDEO
ASSET_ROLE_BACKGROUND_COLOR

廣告素材中使用的主要顏色。

這個角色僅適用於下列 creativeType，且為必要角色：

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ACCENT_COLOR

廣告素材中使用的強調色。

這個角色僅適用於下列 creativeType，且為必要角色：

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_REQUIRE_IMAGE

廣告素材是否必須使用圖片素材資源。

這個角色僅適用於下列 creativeType，且為必要角色：

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE
ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS

素材資源強化功能是否可套用至廣告素材。

這個角色僅適用於下列 creativeType，且為必要角色：

  • CREATIVE_TYPE_ASSET_BASED_CREATIVE

ExitEvent

廣告素材的離開事件。

JSON 表示法 
{
  "type": enum (ExitEventType),
  "url": string,
  "name": string,
  "reportingName": string
}
欄位
type

enum (ExitEventType)

必填。離開事件的類型。
url

string

必填。離開事件的到達網址。如果 type 屬於下列情況，就必須提供這項屬性：

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

string

(選用步驟) 離開事件的點擊廣告代碼名稱。

名稱在一個廣告素材中不得重複。

如果廣告素材只包含圖片素材資源，請留空或取消設定。
reportingName

string

(選用步驟) 用於在報表中識別這個事件的名稱。如果廣告素材只包含圖片素材資源，請留空或取消設定。

ExitEventType

離開事件的類型。

列舉
EXIT_EVENT_TYPE_UNSPECIFIED 這個版本未指定或不明離開事件類型。
EXIT_EVENT_TYPE_DEFAULT 離開事件是預設事件。
EXIT_EVENT_TYPE_BACKUP 離開事件是備用離開事件。廣告素材中可能有多個備份離開事件。

TimerEvent

廣告素材的計時器事件。

JSON 表示法 
{
  "name": string,
  "reportingName": string
}
欄位
name

string

必填。計時器事件的名稱。
reportingName

string

必填。用來在報表中識別這個計時器事件的名稱。

CounterEvent

廣告素材的計數器事件。

JSON 表示法 
{
  "name": string,
  "reportingName": string
}
欄位
name

string

必填。計數器事件的名稱。
reportingName

string

必填。用於在報表中識別這個計數器事件的名稱。

AudioVideoOffset

音訊或影片的播放長度。

JSON 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "percentage": string,
  "seconds": string
  // End of mutually exclusive fields.
}
欄位
偏移值。以下列出互斥欄位。回應中最多會設定一個欄位：
percentage

string (int64 format)

(選用步驟) 音訊或影片長度的百分比偏移量。
seconds

string (int64 format)

(選用步驟) 與音訊或影片開頭的時差 (以秒為單位)。
互斥欄位的結尾。

UniversalAdId

由登錄機構提供的廣告素材 ID，在所有平台中都是專屬 ID。這是 VAST 4.0 標準的一部分。

JSON 表示法 
{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}
欄位
id

string

(選用步驟) 廣告素材的專屬 ID。
registry

enum (UniversalAdRegistry)

(選用步驟) 登錄機構會提供專屬的廣告素材 ID。

UniversalAdRegistry

登錄機構會在通用廣告 ID 中提供專屬廣告素材 ID。

列舉
UNIVERSAL_AD_REGISTRY_UNSPECIFIED 這個版本未指定或不明通用廣告登錄。
UNIVERSAL_AD_REGISTRY_OTHER 使用自訂供應商提供通用廣告 ID。
UNIVERSAL_AD_REGISTRY_AD_ID 使用 Ad-ID 提供通用廣告 ID。
UNIVERSAL_AD_REGISTRY_CLEARCAST 使用 clearcast.co.uk 提供通用廣告 ID。
UNIVERSAL_AD_REGISTRY_DV360 使用 Display & Video 360 提供通用廣告 ID。
UNIVERSAL_AD_REGISTRY_CM 使用 Campaign Manager 360 提供通用廣告 ID。

ThirdPartyUrl

第三方追蹤網址，用於追蹤音訊或影片廣告素材的互動。

JSON 表示法 
{
  "type": enum (ThirdPartyUrlType),
  "url": string
}
欄位
type

enum (ThirdPartyUrlType)

(選用步驟) 追蹤網址需要追蹤的互動類型
url

string

(選用步驟) 用於追蹤互動的追蹤網址。

請提供開頭為 https: 的網址，並視需要加入路徑或查詢字串。例如：https://www.example.com/path

ThirdPartyUrlType

第三方追蹤網址必須追蹤互動類型。

列舉
THIRD_PARTY_URL_TYPE_UNSPECIFIED 這個版本未指定或不明第三方網址類型。
THIRD_PARTY_URL_TYPE_IMPRESSION 用於在音訊或影片緩衝處理完成後，計算廣告素材的曝光次數。
THIRD_PARTY_URL_TYPE_CLICK_TRACKING 用於追蹤使用者點按音訊或影片的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START 用於追蹤使用者開始播放音訊或影片的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE 用於追蹤音訊或影片播放到總長 25% 的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT 用於追蹤音訊或影片播放到總長 50% 的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE 用於追蹤音訊或影片播放到總長 75% 的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE 用於追蹤音訊或影片廣告播完的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE 用於追蹤使用者將音訊或影片設為靜音的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE 用於追蹤使用者暫停音訊或影片的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND 用於追蹤使用者重播音訊或影片的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN 用於追蹤使用者將播放器展開至全螢幕大小的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP 用於追蹤使用者停止播放音訊或影片的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM 用於追蹤使用者進行自訂點擊 (例如點擊影片熱點) 的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP 用於追蹤音訊或影片遭略過的次數。
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS 用於追蹤音訊或影片播放到 progressOffset 所決定偏移量的次數。

轉碼

代表轉碼後的音訊或影片檔案相關資訊。

JSON 表示法 
{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}
欄位
name

string

(選用步驟) 轉碼後的檔案名稱。
mimeType

string

(選用步驟) 轉碼後檔案的 MIME 類型。
transcoded

boolean

(選用步驟) 指出轉碼是否成功。
dimensions

object (Dimensions)

(選用步驟) 轉碼後影片的尺寸。
bitRateKbps

string (int64 format)

(選用步驟) 轉碼後影片的轉碼位元率，以 Kbps 為單位。
frameRate

number

(選用步驟) 轉碼後影片的影格率，以每秒影格數為單位。
audioBitRateKbps

string (int64 format)

(選用步驟) 轉碼後影片音訊串流的位元率，或轉碼後音訊的位元率 (以 Kbps 為單位)。
audioSampleRateHz

string (int64 format)

(選用步驟) 轉碼後影片音訊串流的取樣率，或轉碼後音訊的取樣率 (以赫茲為單位)。
fileSizeBytes

string (int64 format)

(選用步驟) 轉碼後檔案的大小 (以位元組為單位)。

CmTrackingAd

Campaign Manager 360 追蹤廣告。

JSON 表示法 
{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}
欄位
cmPlacementId

string (int64 format)

(選用步驟) Campaign Manager 360 追蹤廣告的刊登位置 ID。
cmCreativeId

string (int64 format)

(選用步驟) Campaign Manager 360 追蹤廣告的廣告素材 ID。
cmAdId

string (int64 format)

(選用步驟) Campaign Manager 360 追蹤廣告的廣告 ID。

ObaIcon

廣告素材的 OBA 圖示

JSON 表示法 
{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}
欄位
resourceUrl

string

(選用步驟) OBA 圖示資源的網址。
resourceMimeType

string

(選用步驟) OBA 圖示資源的 MIME 類型。
position

enum (ObaIconPosition)

(選用步驟) 廣告素材中 OBA 圖示的位置。
dimensions

object (Dimensions)

(選用步驟) OBA 圖示的尺寸。
program

string

(選用步驟) OBA 圖示的計畫。例如「AdChoices」。
landingPageUrl

string

必填。OBA 圖示的到達網頁網址。

僅允許下列網域的網址：

  • https://info.evidon.com
  • https://l.betrad.com
clickTrackingUrl

string

必填。OBA 圖示的點擊追蹤網址。

僅允許下列網域的網址：

  • https://info.evidon.com
  • https://l.betrad.com
viewTrackingUrl

string

必填。OBA 圖示的瀏覽追蹤網址。

僅允許下列網域的網址：

  • https://info.evidon.com
  • https://l.betrad.com

ObaIconPosition

廣告素材中 OBA 圖示的位置。

列舉
OBA_ICON_POSITION_UNSPECIFIED 未指定 OBA 圖示位置。
OBA_ICON_POSITION_UPPER_RIGHT 在素材資源的右上角。
OBA_ICON_POSITION_UPPER_LEFT 位於素材資源左上角。
OBA_ICON_POSITION_LOWER_RIGHT 在廣告素材的右下角。
OBA_ICON_POSITION_LOWER_LEFT 廣告素材的左下側。

ExpandingDirection

第三方可展開式廣告素材的展開方向。

列舉
EXPANDING_DIRECTION_UNSPECIFIED 未指定展開方向。
EXPANDING_DIRECTION_NONE 不會朝任何方向展開。
EXPANDING_DIRECTION_UP 向上展開。
EXPANDING_DIRECTION_DOWN 向下展開。
EXPANDING_DIRECTION_LEFT 向左展開。
EXPANDING_DIRECTION_RIGHT 向右展開。
EXPANDING_DIRECTION_UP_AND_LEFT 向上和向左展開。
EXPANDING_DIRECTION_UP_AND_RIGHT 向上和向右展開。
EXPANDING_DIRECTION_DOWN_AND_LEFT 向下和向左展開。
EXPANDING_DIRECTION_DOWN_AND_RIGHT 向下和向右展開。
EXPANDING_DIRECTION_UP_OR_DOWN 向上或向下展開。
EXPANDING_DIRECTION_LEFT_OR_RIGHT 向左或向右展開。
EXPANDING_DIRECTION_ANY_DIAGONAL 可朝任何對角方向展開。

方法

create

 建立新的廣告素材。

delete

 刪除廣告素材。

get

 取得廣告素材。

list

 列出廣告主的廣告素材。

patch

 更新現有廣告素材。