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
}
欄位
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)

僅供輸出。使用者或系統 (例如廣告素材審核) 上次更新廣告素材的時間戳記。由系統指派。

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

string (Timestamp format)

僅供輸出。廣告素材的建立時間戳記。由系統指派。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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 是 VAST 4.0 標準的一部分。您可以在素材資源建立後修改這項設定。

這個欄位僅適用於下列 creativeType：

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

追蹤第三方網址，以便追蹤與影片廣告素材的互動情形。

這個欄位僅適用於下列 creativeType：

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
transcodes[]

object (Transcode)

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

將主要素材資源轉碼成採用不同格式或包含不同屬性 (如解析度、音訊位元率和影片位元率) 的數個替代版本，每個版本都是供特定影片播放器或頻寬專用。

這些轉碼檔案可讓發布商的系統在每次影片曝光時，有更多選項可選擇，進而確保放送適用於觀眾連線速度和螢幕大小的正確檔案。

這個欄位僅支援下列 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

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)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}
欄位
approvalStatus

enum (ApprovalStatus)

代表廣告素材是否已獲核准放送。creativeAndLandingPageReviewStatus 和 contentAndPolicyReviewStatus 摘要。
creativeAndLandingPageReviewStatus

enum (ReviewStatus)

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

enum (ReviewStatus)

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

object (ExchangeReviewStatus)

廣告素材的廣告交易平台審查狀態。
publisherReviewStatuses[]
(deprecated)

object (PublisherReviewStatus)

廣告素材的發布商審查狀態。

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)

廣告交易平台審查狀態。

PublisherReviewStatus

廣告素材的發布商審查狀態。

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

string

發布商審核廣告素材。
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

iOS 應用程式在 Apple 應用程式商店中的 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 應用程式商店中的評分。

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

這個角色的資產處於唯讀狀態。
ASSET_ROLE_ICON

廣告素材的圖示。

這個角色僅在下列 creativeType 中受支援，且為必要角色：

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

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

只有下列creativeType支援且必須提供這個角色：

  • CREATIVE_TYPE_VIDEO

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 表示法 
{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}
欄位
聯集欄位 offset。偏移值。offset 只能是下列其中一項：
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 請使用廣告 ID 提供通用廣告 ID。
UNIVERSAL_AD_REGISTRY_CLEARCAST 使用 clearcast.co.uk 提供通用廣告 ID。
UNIVERSAL_AD_REGISTRY_DV360 使用多媒體和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)

轉碼後的影片轉碼位元率 (以 kbit/秒為單位)。
frameRate

number

經過轉碼的影片影格速率，以每秒影格數為單位。
audioBitRateKbps

string (int64 format)

轉碼影片音訊串流的位元率，或轉碼音訊的位元率 (以 kbit/秒為單位)。
audioSampleRateHz

string (int64 format)

轉碼影片的音訊串流取樣率，或轉碼音訊的取樣率 (赫茲)。
fileSizeBytes

string (int64 format)

轉碼檔案的大小，以位元組為單位。

CmTrackingAd

Campaign Manager 360 追蹤廣告。

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

string (int64 format)

廣告活動管理員 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 圖示的到達網頁網址。

系統僅允許下列網域的網址：
clickTrackingUrl

string

必要欄位。OBA 圖示的點擊追蹤網址。

系統只接受下列網域的網址：
viewTrackingUrl

string

必要欄位。OBA 圖示的瀏覽追蹤網址。

系統只接受下列網域的網址：

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

 更新現有的廣告素材。