- 資源:AdGroupAd
 - DisplayVideoSourceAd
 - MastheadAd
 - YoutubeVideoDetails
 - VideoUnavailableReason
 - VideoAspectRatio
 - InStreamAd
 - CommonInStreamAttribute
 - ImageAsset
 - NonSkippableAd
 - BumperAd
 - AudioAd
 - VideoDiscoveryAd
 - 縮圖
 - VideoPerformanceAd
 - AdUrl
 - AdUrlType
 - 方法
 
資源:AdGroupAd
與廣告群組相關聯的單一廣告。
| JSON 表示法 | 
|---|
{ "name": string, "advertiserId": string, "adGroupAdId": string, "adGroupId": string, "displayName": string, "entityStatus": enum (  | 
              
| 欄位 | |
|---|---|
name | 
                
                   
 廣告的資源名稱。  | 
              
advertiserId | 
                
                   
 廣告所屬廣告主的專屬 ID。  | 
              
adGroupAdId | 
                
                   
 廣告的專屬 ID。由系統指派。  | 
              
adGroupId | 
                
                   
 廣告所屬廣告群組的專屬 ID。  | 
              
displayName | 
                
                   
 廣告的顯示名稱。 必須採用 UTF-8 編碼,大小上限為 255 個位元組。  | 
              
entityStatus | 
                
                   
 廣告的實體狀態。  | 
              
adUrls[] | 
                
                   
 廣告使用的網址清單。  | 
              
聯集欄位 ad_details。廣告詳細資料。ad_details 只能是下列其中一項: | 
              |
displayVideoSourceAd | 
                
                   
 廣告詳細資料,來源為 Display & Video 360 廣告素材。  | 
              
mastheadAd | 
                
                   
  | 
              
inStreamAd | 
                
                   
 可略過的串流內廣告詳細資料,用於提升品牌知名度或達成觸及行銷目標。  | 
              
nonSkippableAd | 
                
                   
 不可略過的短串流內影片廣告詳細資料,長度介於 6 到 15 秒,用於觸及行銷目標。  | 
              
bumperAd | 
                
                   
 用於觸及的不可略過的短片廣告詳細資料,長度等於或短於 6 秒。  | 
              
audioAd | 
                
                   
 用於觸及行銷目標的音訊廣告詳細資料。  | 
              
videoDiscoverAd | 
                
                   
 宣傳影片的廣告詳細資料,會顯示在探索位置。  | 
              
videoPerformanceAd | 
                
                   
 影片行動廣告活動中使用的廣告詳細資料,可吸引使用者對商家、服務或產品採取行動。  | 
              
DisplayVideoSourceAd
廣告素材來自 DV360 廣告素材。
| JSON 表示法 | 
|---|
{ "creativeId": string }  | 
              
| 欄位 | |
|---|---|
creativeId | 
                
                   
 來源廣告素材的 ID。  | 
              
MastheadAd
刊頭廣告的詳細資料。
| JSON 表示法 | 
|---|
{ "video": { object (  | 
              
| 欄位 | |
|---|---|
video | 
                
                   
 廣告使用的 YouTube 影片。  | 
              
headline | 
                
                   
 廣告標題。  | 
              
description | 
                
                   
 廣告說明。  | 
              
videoAspectRatio | 
                
                   
 刊頭廣告中自動播放的 YouTube 影片長寬比。  | 
              
autoplayVideoStartMillisecond | 
                
                   
 影片開始播放的時間 (以毫秒為單位)。  | 
              
autoplayVideoDuration | 
                
                   
 影片自動播放的時間長度。 時間長度以秒為單位,最多可有 9 個小數位數,並應以「  | 
              
callToActionButtonLabel | 
                
                   
 行動號召按鈕上的文字。  | 
              
callToActionFinalUrl | 
                
                   
 行動號召按鈕的到達網頁網址。  | 
              
callToActionTrackingUrl | 
                
                   
 行動號召按鈕的追蹤網址。  | 
              
showChannelArt | 
                
                   
 是否顯示 YouTube 頁面頂端的背景或橫幅圖片。  | 
              
companionYoutubeVideos[] | 
                
                   
 顯示在電腦版刊頭廣告旁邊的影片。最多只能有兩個。  | 
              
YoutubeVideoDetails
YouTube 影片的詳細資料。
| JSON 表示法 | 
|---|
{
  "id": string,
  "unavailableReason": enum ( | 
              
| 欄位 | |
|---|---|
id | 
                
                   
 YouTube 影片 ID,可在 YouTube 網頁上搜尋。  | 
              
unavailableReason | 
                
                   
 影片資料無法使用的原因。  | 
              
VideoAspectRatio
YouTube 影片的顯示比例。
| 列舉 | |
|---|---|
VIDEO_ASPECT_RATIO_UNSPECIFIED | 
                未指定或不明。 | 
VIDEO_ASPECT_RATIO_WIDESCREEN | 
                影片會遭到拉伸,頂端和底部會遭到裁剪。 | 
VIDEO_ASPECT_RATIO_FIXED_16_9 | 
                影片採用固定 16:9 的顯示比例。 | 
InStreamAd
串流內廣告的詳細資料。
| JSON 表示法 | 
|---|
{
  "commonInStreamAttribute": {
    object ( | 
              
| 欄位 | |
|---|---|
commonInStreamAttribute | 
                
                   
 常見廣告屬性。  | 
              
customParameters | 
                
                   
 要將自訂值傳送至追蹤網址範本的自訂參數。 這個物件中包含   | 
              
CommonInStreamAttribute
串流內廣告、不可略過廣告和串場廣告的常見屬性。
| JSON 表示法 | 
|---|
{ "displayUrl": string, "finalUrl": string, "trackingUrl": string, "actionButtonLabel": string, "actionHeadline": string, "video": { object (  | 
              
| 欄位 | |
|---|---|
displayUrl | 
                
                   
 與廣告一起顯示的網頁網址。  | 
              
finalUrl | 
                
                   
 使用者點按廣告後前往的網頁網址。  | 
              
trackingUrl | 
                
                   
 系統會在背景載入這個網址,以利追蹤。  | 
              
actionButtonLabel | 
                
                   
 行動號召按鈕上的文字。  | 
              
actionHeadline | 
                
                   
 行動號召橫幅的標題。  | 
              
video | 
                
                   
 廣告的 YouTube 影片。  | 
              
companionBanner | 
                
                   
 顯示在影片廣告旁的圖片。  | 
              
ImageAsset
圖片素材資源的中繼資料。
| JSON 表示法 | 
|---|
{
  "mimeType": string,
  "fullSize": {
    object ( | 
              
| 欄位 | |
|---|---|
mimeType | 
                
                   
 圖片素材資源的 MIME 類型。  | 
              
fullSize | 
                
                   
 這張圖片原始大小的中繼資料。  | 
              
fileSize | 
                
                   
 圖片素材資源的檔案大小 (以位元組為單位)。  | 
              
NonSkippableAd
不可略過廣告的詳細資料。
| JSON 表示法 | 
|---|
{
  "commonInStreamAttribute": {
    object ( | 
              
| 欄位 | |
|---|---|
commonInStreamAttribute | 
                
                   
 常見廣告屬性。  | 
              
customParameters | 
                
                   
 要將自訂值傳送至追蹤網址範本的自訂參數。 這個物件中包含   | 
              
BumperAd
串場廣告的詳細資料。
| JSON 表示法 | 
|---|
{
  "commonInStreamAttribute": {
    object ( | 
              
| 欄位 | |
|---|---|
commonInStreamAttribute | 
                
                   
 常見廣告屬性。  | 
              
AudioAd
音訊廣告的詳細資料。
| JSON 表示法 | 
|---|
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object ( | 
              
| 欄位 | |
|---|---|
displayUrl | 
                
                   
 與廣告一起顯示的網頁網址。  | 
              
finalUrl | 
                
                   
 使用者點按廣告後前往的網頁網址。  | 
              
trackingUrl | 
                
                   
 系統會在背景載入這個網址,以利追蹤。  | 
              
video | 
                
                   
 廣告的 YouTube 影片。  | 
              
VideoDiscoveryAd
影片探索廣告的詳細資料。
| JSON 表示法 | 
|---|
{ "headline": string, "description1": string, "description2": string, "video": { object (  | 
              
| 欄位 | |
|---|---|
headline | 
                
                   
 廣告標題。  | 
              
description1 | 
                
                   
 廣告的第一行文字。  | 
              
description2 | 
                
                   
 廣告的第二行文字。  | 
              
video | 
                
                   
 廣告宣傳的 YouTube 影片。  | 
              
thumbnail | 
                
                   
 廣告中使用的縮圖。  | 
              
縮圖
影片探索廣告中可能的縮圖選項。
| 列舉 | |
|---|---|
THUMBNAIL_UNSPECIFIED | 
                不明或未指定。 | 
THUMBNAIL_DEFAULT | 
                預設縮圖可由系統自動產生,或由使用者上傳。 | 
THUMBNAIL_1 | 
                系統從影片生成的縮圖 1。 | 
THUMBNAIL_2 | 
                系統從影片生成的縮圖 2。 | 
THUMBNAIL_3 | 
                縮圖 3:從影片生成。 | 
VideoPerformanceAd
影片成效廣告的詳細資料。
| JSON 表示法 | 
|---|
{ "finalUrl": string, "trackingUrl": string, "actionButtonLabels": [ string ], "headlines": [ string ], "longHeadlines": [ string ], "descriptions": [ string ], "displayUrlBreadcrumb1": string, "displayUrlBreadcrumb2": string, "domain": string, "videos": [ { object (  | 
              
| 欄位 | |
|---|---|
finalUrl | 
                
                   
 使用者點按廣告後前往的網頁網址。  | 
              
trackingUrl | 
                
                   
 系統會在背景載入這個網址,以利追蹤。  | 
              
actionButtonLabels[] | 
                
                   
 行動號召按鈕上顯示的文字素材資源清單。  | 
              
headlines[] | 
                
                   
 行動號召橫幅上顯示的廣告標題清單。  | 
              
longHeadlines[] | 
                
                   
 行動號召橫幅上顯示的獨立廣告標題清單。  | 
              
descriptions[] | 
                
                   
 行動號召橫幅上顯示的說明清單。  | 
              
displayUrlBreadcrumb1 | 
                
                   
 顯示網址中網域後的第一個部分。  | 
              
displayUrlBreadcrumb2 | 
                
                   
 顯示網址中網域之後的第二個部分。  | 
              
domain | 
                
                   
 顯示網址的網域。  | 
              
videos[] | 
                
                   
 這則廣告使用的 YouTube 影片素材資源清單。  | 
              
customParameters | 
                
                   
 要將自訂值傳送至追蹤網址範本的自訂參數。 這個物件中包含   | 
              
companionBanners[] | 
                
                   
 這個廣告使用的隨播橫幅清單。  | 
              
AdUrl
與廣告相關的其他網址,包括信號。
| JSON 表示法 | 
|---|
{
  "type": enum ( | 
              
| 欄位 | |
|---|---|
type | 
                
                   
 廣告網址類型。  | 
              
url | 
                
                   
 網址字串值。  | 
              
AdUrlType
可能的廣告網址類型。
| 列舉 | |
|---|---|
AD_URL_TYPE_UNSPECIFIED | 
                不明或未指定。 | 
AD_URL_TYPE_BEACON_IMPRESSION | 
                廣告素材曝光時,系統會 ping 1x1 追蹤像素。 | 
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION | 
                可展開式 DCM 曝光信標。在放送時,系統會將其擴展為多個信標。 | 
AD_URL_TYPE_BEACON_CLICK | 
                點擊事件觸發時要 Ping 的追蹤網址。 | 
AD_URL_TYPE_BEACON_SKIP | 
                略過事件觸發時要 Ping 的追蹤網址。 | 
方法 | 
            |
|---|---|
                
 | 
              取得廣告群組廣告。 | 
                
 | 
              列出廣告群組廣告。 |