REST Resource: advertisers.creatives

{
  "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
}

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

必要欄位。廣告素材的顯示名稱。

必須是 UTF-8 編碼，且長度上限為 240 個位元組。

enum (EntityStatus)

必要欄位。控制廣告素材是否可以放送。

可接受的值如下：

• ENTITY_STATUS_ACTIVE
• ENTITY_STATUS_ARCHIVED
• ENTITY_STATUS_PAUSED

string (Timestamp format)

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

RFC3339 世界標準時間「Zulu」格式的時間戳記，解析度以奈秒為單位，小數點後最多 9 位。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

string (Timestamp format)

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

RFC3339 世界標準時間「Zulu」格式的時間戳記，解析度以奈秒為單位，小數點後最多 9 位。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

enum (CreativeType)

必要欄位。不可變動。廣告素材類型。

enum (HostingSource)

必要欄位。指出廣告素材的代管位置。

boolean

僅供輸出。表示廣告素材是否為動態廣告素材。

object (Dimensions)

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

• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_NATIVE_VIDEO

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。

string (Duration format)

僅供輸出。廣告素材的媒體時間長度。當 creativeType 為下列任一值時即適用：

• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_NATIVE_VIDEO
• CREATIVE_TYPE_PUBLISHER_HOSTED

持續時間以秒為單位，最多 9 個小數位數，結尾為「s」。例如："3.5s"。

enum (CreativeAttribute)

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

object (ReviewStatusInfo)

僅供輸出。廣告素材審查程序的目前狀態。

object (AssetAssociation)

必要欄位。與這個廣告素材相關聯的素材資源。

object (ExitEvent)

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

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

object (TimerEvent)

互動式多媒體廣告素材的計時器自訂事件。計時器會追蹤使用者觀看互動式多媒體廣告素材特定部分並進行互動的時間。廣告素材可有多個計時器事件，每個事件獨立計時。如果廣告素材僅包含圖片素材資源，請將此欄位留空或未設定。

object (CounterEvent)

互動式多媒體廣告素材的計數器事件。計數器會以指定方式 (滑鼠指向、滑鼠移出、點擊、輕觸、資料載入、鍵盤輸入)，追蹤使用者與互動式多媒體廣告素材任一部分互動的次數。廣告素材中可擷取的任何事件都可以記錄為計數器。如果廣告素材僅包含圖片素材資源，請將此欄位留空或未設定。

string

要附加至廣告素材代碼的第三方 HTML 追蹤代碼。

string

用來將這個廣告素材連結至外部系統的 ID 資訊。必須為 UTF-8 編碼，長度不得超過 10,000 個字元。

string

這個廣告素材的使用者備註。必須為 UTF-8 編碼，長度不得超過 20,000 個字元。

boolean

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

string (int64 format)

影片廣告素材的隨播廣告素材 ID。

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

廣告素材包含「additional dimensions」不得為隨播廣告素材。

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

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO

boolean

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

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

• CREATIVE_TYPE_VIDEO

object (AudioVideoOffset)

略過按鈕出現之前，影片需播放的時間長度。

如果 skippable 為 true，則此為必要欄位。

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

• CREATIVE_TYPE_VIDEO

object (AudioVideoOffset)

計算觀看次數之前，播放影片的時間長度。

如果 skippable 為 true，則此為必要欄位。

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

• CREATIVE_TYPE_VIDEO

object (UniversalAdId)

選用設定。由註冊資料庫提供的選用廣告素材 ID，在所有平台上均不得重複。

通用廣告 ID 是 VAST 4.0 標準的一部分。您可以在廣告素材建立完成後修改這項設定。

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

• CREATIVE_TYPE_VIDEO

object (ThirdPartyUrl)

來自第三方的追蹤網址，用於追蹤影片廣告素材的互動情形。

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

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_NATIVE_VIDEO

object (Transcode)

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

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

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

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

• CREATIVE_TYPE_VIDEO
• CREATIVE_TYPE_NATIVE_VIDEO
• CREATIVE_TYPE_AUDIO

string

分析服務供應商或第三方廣告技術供應商的追蹤網址。

網址開頭必須為 https (針對不需要與 SSL 相容的廣告空間除外)。如要在網址中使用巨集，請僅使用 Display & Video 360 支援的巨集。

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

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

• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE
• CREATIVE_TYPE_NATIVE_VIDEO

string

由支援的第三方驗證服務供應商 (ComScore、DoubleVerify、IAS、Moat) 提供的 JavaScript 評估網址。系統不支援 HTML 指令碼標記。

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

• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE
• CREATIVE_TYPE_NATIVE_VIDEO

object (CmTrackingAd)

與廣告素材相關聯的 Campaign Manager 360 追蹤廣告。

如果廣告客戶建立同時使用 Campaign Manager 360 和第三方廣告放送服務的廣告客戶，請使用下列creativeType (選用)：

• CREATIVE_TYPE_NATIVE
• CREATIVE_TYPE_NATIVE_SITE_SQUARE

僅適用於其他情況。

object (ObaIcon)

指定影片廣告素材的 OBA 圖示。

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

• CREATIVE_TYPE_VIDEO

string

選用設定。廣告素材所使用的原始第三方代碼。

此為必填欄位，且僅適用於第三方代碼廣告素材。

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

• HOSTING_SOURCE_THIRD_PARTY

加上下列 creativeType：

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

boolean

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

如果廣告素材需要透過行動裝置專用手勢 (例如滑動或輕觸) 才能進行互動，請設定這個選項。

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

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

• HOSTING_SOURCE_THIRD_PARTY

加上下列 creativeType：

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

boolean

選用設定。表示廣告素材須依賴 HTML5 才能正確顯示。

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

• HOSTING_SOURCE_THIRD_PARTY

加上下列 creativeType：

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_EXPANDABLE

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

enum (ExpandingDirection)

選用設定。用於指定廣告素材的展開方向。

必填且僅適用於第三方可展開式廣告素材。

第三方可展開式廣告素材會採用下列代管來源的廣告素材：

• HOSTING_SOURCE_THIRD_PARTY

加上下列 creativeType：

• CREATIVE_TYPE_EXPANDABLE

boolean

選用設定。表示廣告素材會在滑鼠遊標懸停時自動展開。

此為選填欄位，僅適用於第三方可展開式廣告素材。第三方可展開式廣告素材會採用下列代管來源的廣告素材：

• HOSTING_SOURCE_THIRD_PARTY

加上下列 creativeType：

• CREATIVE_TYPE_EXPANDABLE

string

選用設定。第三方 VAST 代碼廣告素材的 VAST 代碼網址。

必填且僅適用於第三方 VAST 代碼廣告素材。

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

• HOSTING_SOURCE_THIRD_PARTY

加上下列 creativeType：

• CREATIVE_TYPE_AUDIO
• CREATIVE_TYPE_VIDEO

boolean

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

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

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

• HOSTING_SOURCE_THIRD_PARTY

加上下列 creativeType：

• CREATIVE_TYPE_VIDEO

boolean

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

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

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

• HOSTING_SOURCE_THIRD_PARTY

加上下列 creativeType：

• CREATIVE_TYPE_VIDEO

string (int64 format)

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

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

boolean

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

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

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

• HOSTING_SOURCE_THIRD_PARTY

加上下列 creativeType：

• CREATIVE_TYPE_AUDIO

boolean

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

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

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

• HOSTING_SOURCE_THIRD_PARTY

加上下列 creativeType：

• CREATIVE_TYPE_AUDIO

{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}

enum (ApprovalStatus)

代表必須取得廣告素材的基本核准才能開始放送。creativeAndLandingPageReviewStatus 和 contentAndPolicyReviewStatus 摘要。

enum (ReviewStatus)

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

enum (ReviewStatus)

廣告素材的內容和政策審核狀態。

object (ExchangeReviewStatus)

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

object (PublisherReviewStatus)

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

{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}

enum (Exchange)

審核廣告素材的廣告交易平台。

enum (ReviewStatus)

廣告交易平台審查狀態。

{
  "publisherName": string,
  "status": enum (ReviewStatus)
}

string

發布商審核廣告素材。

enum (ReviewStatus)

發布者審查狀態。

{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}

object (Asset)

相關聯的資產。

enum (AssetRole)

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

{
  "mediaId": string,
  "content": string
}

string (int64 format)

所上傳資產的媒體 ID。這是資產的專屬 ID。這個 ID 可以傳遞至其他 API 呼叫，例如 creatives.create，用來連結該素材資源與廣告素材。

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

string

資產內容。已上傳的素材資源內容則是放送路徑。

{
  "type": enum (ExitEventType),
  "url": string,
  "name": string,
  "reportingName": string
}

enum (ExitEventType)

必要欄位。離開事件的類型。

string

必要欄位。離開事件的到達網址。在 type 為以下情形時，此為必要項目：

• EXIT_EVENT_TYPE_DEFAULT
• EXIT_EVENT_TYPE_BACKUP

string

離開事件的點擊代碼名稱。

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

如果廣告素材僅包含圖片素材資源，請將此欄位留空或未設定。

string

在報表中用於識別此事件的名稱。如果廣告素材僅包含圖片素材資源，請將此欄位留空或未設定。

{
  "name": string,
  "reportingName": string
}

string

必要欄位。計時器事件的名稱。

string

必要欄位。在報表中用於識別這個計時器事件的名稱。

{
  "name": string,
  "reportingName": string
}

string

必要欄位。計數器事件的名稱。

string

必要欄位。用於在報表中識別此計數器事件的名稱。

{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}

string (int64 format)

音訊或影片長度的偏移量。

string (int64 format)

從音訊或影片開頭的偏移值 (以秒為單位)。

{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}

string

專屬的廣告素材 ID。

enum (UniversalAdRegistry)

登錄檔會提供專屬的廣告素材 ID。

{
  "type": enum (ThirdPartyUrlType),
  "url": string
}

enum (ThirdPartyUrlType)

追蹤網址必須追蹤這種互動類型

string

用於追蹤互動的追蹤網址。

請提供開頭為 https: 的網址 (選用路徑或查詢字串)。例如 https://www.example.com/path

{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}

string

轉碼檔案的名稱。

string

已轉碼檔案的 MIME 類型。

boolean

指出轉碼是否成功。

object (Dimensions)

轉碼影片的尺寸。

string (int64 format)

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

number

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

string (int64 format)

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

string (int64 format)

轉碼影片音訊串流的取樣率，或轉碼音訊的取樣率 (以赫茲為單位)。

string (int64 format)

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

{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}

string (int64 format)

廣告活動管理員 360 追蹤廣告的刊登位置 ID。

string (int64 format)

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

string (int64 format)

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

{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}

string

OBA 圖示資源的網址。

string

OBA 圖示資源的 MIME 類型。

enum (ObaIconPosition)

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

object (Dimensions)

OBA 圖示的維度。

string

OBA 圖示的程式。例如：「AdChoices」。

string

必要欄位。OBA 圖示的到達網頁網址。

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

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

string

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

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

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

string

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

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

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