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」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
createTime

string (Timestamp format)

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

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："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)

僅供輸出。音訊/影片轉碼。

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)。

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

這個屬性僅適用於第三方代碼廣告素材或第三方 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[]

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 日。請從相關聯的廣告素材資源擷取新的媒體 ID，或重新上傳素材資源，以便在 2023 年 4 月 5 日前更新快取的媒體 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.<應用程式名稱>。

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

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

您可以在 Apple App Store 網址中，直接以數字字串的形式在「id」後面找到這個 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

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，在各個平台上皆不得重複。這是 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 使用 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)

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

number

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

string (int64 format)

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

string (int64 format)

轉碼影片的音訊串流取樣率或轉碼音訊的取樣率 (在 Hertz 中)。
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)

廣告活動管理員 360 追蹤廣告的廣告素材 ID。
cmAdId

string (int64 format)

廣告活動管理員 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

 更新現有廣告素材。