REST Resource: advertisers.adGroupAds

資源：AdGroupAd

與廣告群組相關聯的單一廣告。

JSON 表示法 
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
欄位
name

string

廣告的資源名稱。
advertiserId

string (int64 format)

廣告所屬廣告客戶的專屬 ID。
adGroupAdId

string (int64 format)

廣告的專屬 ID。由系統指派。
adGroupId

string (int64 format)

廣告所屬廣告群組的專屬 ID。
displayName

string

廣告的顯示名稱。

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

enum (EntityStatus)

廣告的實體狀態。
adUrls[]

object (AdUrl)

廣告使用的網址清單。
聯集欄位 ad_details。廣告詳細資料。ad_details 只能是下列其中一項：
displayVideoSourceAd

object (DisplayVideoSourceAd)

來自 Display & Video 360 廣告素材的廣告詳細資料。
mastheadAd

object (MastheadAd)

在 YouTube 首頁推薦內容中放送的廣告詳細資料。
inStreamAd

object (InStreamAd)

串流內廣告在 5 秒後可略過的詳細資料，用於品牌知名度或觸及行銷目標。
nonSkippableAd

object (NonSkippableAd)

不可略過的短串流內影片廣告詳細資料：長度介於 6 到 15 秒，用於觸及行銷目標。
bumperAd

object (BumperAd)

不可略過的短片廣告詳細資料 (長度等於或少於 6 秒)，用於觸及。
audioAd

object (AudioAd)

用於達成行銷目標的音訊廣告詳細資料。
videoDiscoverAd

object (VideoDiscoveryAd)

在探索位置顯示的宣傳影片詳情。
videoPerformanceAd

object (VideoPerformanceAd)

在影片行動廣告活動中用來吸引使用者對商家、服務或產品採取行動的廣告詳細資料。

DisplayVideoSourceAd

來自 DV360 廣告素材的廣告。

JSON 表示法 
{
  "creativeId": string
}
欄位
creativeId

string (int64 format)

來源廣告素材的 ID。

MastheadAd

刊頭廣告的詳細資料。

JSON 表示法 
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
欄位
video

object (YoutubeVideoDetails)

廣告使用的 YouTube 影片。
headline

string

廣告標題。
description

string

廣告的說明。
videoAspectRatio

enum (VideoAspectRatio)

刊頭廣告中自動播放 YouTube 影片的顯示比例。
autoplayVideoStartMillisecond

string (int64 format)

影片開始播放的時間長度 (以毫秒為單位)。
autoplayVideoDuration

string (Duration format)

影片自動播放的時間長度。

時間長度以秒為單位，最多可有 9 個小數位數，並應以「s」結尾，例如："3.5s"。
callToActionButtonLabel

string

行動號召按鈕上的文字。
callToActionFinalUrl

string

行動號召按鈕的到達網頁網址。
callToActionTrackingUrl

string

行動號召按鈕的追蹤網址。
showChannelArt

boolean

是否顯示顯示於 YouTube 網頁頂端的背景或橫幅圖片。
companionYoutubeVideos[]

object (YoutubeVideoDetails)

顯示於電腦版刊頭廣告旁邊的影片。最多只能有兩個。

YoutubeVideoDetails

YouTube 影片的詳細資料。

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

string

可在 YouTube 網頁上搜尋的 YouTube 影片 ID。
unavailableReason

enum (VideoUnavailableReason)

無法提供影片資料的原因。

VideoUnavailableReason

影片無法播放的可能原因。

列舉
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED 不明或未指定。
VIDEO_UNAVAILABLE_REASON_PRIVATE 該影片不公開。
VIDEO_UNAVAILABLE_REASON_DELETED 影片已遭刪除。

VideoAspectRatio

YouTube 影片的可能顯示比例。

列舉
VIDEO_ASPECT_RATIO_UNSPECIFIED 未指定或不明。
VIDEO_ASPECT_RATIO_WIDESCREEN 影片會被拉長，頂端和底部會遭到裁剪。
VIDEO_ASPECT_RATIO_FIXED_16_9 影片採用固定的 16:9 顯示比例。

InStreamAd

串流內廣告的詳細資料。

JSON 表示法 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
欄位
commonInStreamAttribute

object (CommonInStreamAttribute)

常見的廣告屬性。
customParameters

map (key: string, value: string)

將自訂值傳遞至追蹤網址範本的自訂參數。

這個物件中包含 "key": value 組合的清單，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

CommonInStreamAttribute

串流內廣告、不可略過廣告和串場廣告的常見屬性。

JSON 表示法 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
欄位
displayUrl

string

與廣告一同顯示的網頁網址。
finalUrl

string

使用者按下廣告後，所前往網頁的網址。
trackingUrl

string

在背景載入的網址，用於追蹤目的。
actionButtonLabel

string

行動號召按鈕上的文字。
actionHeadline

string

行動號召橫幅的廣告標題。
video

object (YoutubeVideoDetails)

廣告的 YouTube 影片。
companionBanner

object (ImageAsset)

顯示在影片廣告旁的圖片。

ImageAsset

圖片素材資源的中繼資料。

JSON 表示法 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
欄位
mimeType

string

圖片素材資源的 MIME 類型。
fullSize

object (Dimensions)

這張圖片的原始大小中繼資料。
fileSize

string (int64 format)

圖片素材資源的檔案大小 (以位元組為單位)。

NonSkippableAd

不可略過廣告的詳細資料。

JSON 表示法 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
欄位
commonInStreamAttribute

object (CommonInStreamAttribute)

常見的廣告屬性。
customParameters

map (key: string, value: string)

將自訂值傳遞至追蹤網址範本的自訂參數。

這個物件中包含 "key": value 組合的清單，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

BumperAd

串場廣告的詳細資料。

JSON 表示法 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
欄位
commonInStreamAttribute

object (CommonInStreamAttribute)

一般廣告屬性。

AudioAd

音訊廣告的詳細資料。

JSON 表示法 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
欄位
displayUrl

string

與廣告一同顯示的網頁網址。
finalUrl

string

使用者按下廣告後，所前往網頁的網址。
trackingUrl

string

在背景載入的網址，用於追蹤目的。
video

object (YoutubeVideoDetails)

廣告的 YouTube 影片。

VideoDiscoveryAd

影片探索廣告的詳細資料。

JSON 表示法 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
欄位
headline

string

廣告標題。
description1

string

廣告的第一行文字。
description2

string

廣告的第二行文字。
video

object (YoutubeVideoDetails)

廣告宣傳的 YouTube 影片。
thumbnail

enum (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 (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
欄位
finalUrl

string

使用者按下廣告後，所前往網頁的網址。
trackingUrl

string

為了追蹤目的，在背景載入的網址。
actionButtonLabels[]

string

行動號召按鈕上顯示的文字素材資源清單。
headlines[]

string

行動號召橫幅中顯示的廣告標題清單。
longHeadlines[]

string

行動號召橫幅中顯示的單獨廣告標題清單。
descriptions[]

string

行動號召橫幅上顯示的說明清單。
displayUrlBreadcrumb1

string

顯示網址中網域後方的第一個片段。
displayUrlBreadcrumb2

string

顯示網址中網域後方的第二個片段。
domain

string

顯示網址的網域。
videos[]

object (YoutubeVideoDetails)

這則廣告使用的 YouTube 影片素材資源清單。
customParameters

map (key: string, value: string)

將自訂值傳送至追蹤網址範本的自訂參數。

這個物件中包含 "key": value 組合的清單，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
companionBanners[]

object (ImageAsset)

這則廣告使用的隨附橫幅廣告清單。

AdUrl

與廣告相關的其他網址，包括信標。

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

enum (AdUrlType)

廣告網址的類型。
url

string

網址字串值。

AdUrlType

可能的廣告網址類型。

列舉
AD_URL_TYPE_UNSPECIFIED 不明或未指定。
AD_URL_TYPE_BEACON_IMPRESSION 廣告素材曝光時會傳送的 1x1 追蹤像素。
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION 可展開式 DCM 曝光信標。在放送時間，會擴展為多個信標。
AD_URL_TYPE_BEACON_CLICK 點擊事件觸發時要查詢的追蹤網址。
AD_URL_TYPE_BEACON_SKIP 當略過事件觸發時，要傳送的追蹤網址。

方法

get

 取得廣告群組廣告。

list

 列出廣告群組廣告。