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)

รหัสที่ไม่ซ้ำกันของผู้ลงโฆษณาที่เป็นเจ้าของโฆษณา
adGroupAdId

string (int64 format)

รหัสที่ไม่ซ้ำกันของโฆษณา ระบบกำหนด
adGroupId

string (int64 format)

รหัสที่ไม่ซ้ำกันของกลุ่มโฆษณาที่มีโฆษณาอยู่
displayName

string

ชื่อที่แสดงของโฆษณา

ต้องเข้ารหัส UTF-8 โดยมีขนาดสูงสุด 255 ไบต์
entityStatus

enum (EntityStatus)

สถานะเอนทิตีของโฆษณา
adUrls[]

object (AdUrl)

รายการ URL ที่โฆษณาใช้
ฟิลด์ Union ad_details รายละเอียดของโฆษณา ad_details ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
displayVideoSourceAd

object (DisplayVideoSourceAd)

รายละเอียดของโฆษณาที่มาจากครีเอทีฟโฆษณา Display & Video 360
mastheadAd

object (MastheadAd)

รายละเอียดของโฆษณาที่แสดงในฟีดบนหน้าแรกของ YouTube
inStreamAd

object (InStreamAd)

รายละเอียดของโฆษณาในสตรีมที่ข้ามได้หลังจากผ่านไป 5 วินาที ซึ่งใช้เพื่อวัตถุประสงค์ทางการตลาดด้านการรับรู้ถึงแบรนด์หรือการเข้าถึง
nonSkippableAd

object (NonSkippableAd)

รายละเอียดของโฆษณาวิดีโอในสตรีมแบบข้ามไม่ได้ที่เป็น Shorts ความยาวระหว่าง 6-15 วินาที ซึ่งใช้เพื่อวัตถุประสงค์ทางการตลาดด้านการเข้าถึง
bumperAd

object (BumperAd)

รายละเอียดของโฆษณาวิดีโอสั้นแบบข้ามไม่ได้ที่ยาวไม่เกิน 6 วินาทีซึ่งใช้เพื่อการเข้าถึง
audioAd

object (AudioAd)

รายละเอียดของโฆษณาเสียงที่ใช้เพื่อวัตถุประสงค์ทางการตลาดด้านการเข้าถึง
videoDiscoverAd

object (VideoDiscoveryAd)

รายละเอียดของโฆษณาที่โปรโมตวิดีโอซึ่งแสดงในที่ที่ผู้ใช้ค้นพบ
videoPerformanceAd

object (VideoPerformanceAd)

รายละเอียดของโฆษณาที่ใช้ในแคมเปญวิดีโอเพื่อกระตุ้นการกระทำเพื่อกระตุ้นการกระทำให้กับธุรกิจ บริการ หรือผลิตภัณฑ์

DisplayVideoSourceAd

โฆษณาที่มาจากครีเอทีฟโฆษณา DV360

การแสดง JSON 
{
  "creativeId": string
}
ช่อง
creativeId

string (int64 format)

รหัสของครีเอทีฟโฆษณาต้นทาง

MastheadAd

รายละเอียดสำหรับโฆษณา Masthead

การแสดง 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 ที่เล่นอัตโนมัติใน Masthead
autoplayVideoStartMillisecond

string (int64 format)

ระยะเวลาเป็นมิลลิวินาทีหลังจากที่วิดีโอจะเริ่มเล่น
autoplayVideoDuration

string (Duration format)

ระยะเวลาที่วิดีโอจะเล่นอัตโนมัติ

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย 's' เช่น "3.5s"
callToActionButtonLabel

string

ข้อความบนปุ่มกระตุ้นให้ดำเนินการ
callToActionFinalUrl

string

URL ปลายทางสำหรับปุ่มคำกระตุ้นการตัดสินใจ
callToActionTrackingUrl

string

URL การติดตามสำหรับปุ่มคำกระตุ้นให้ดำเนินการ
showChannelArt

boolean

เลือกว่าจะแสดงพื้นหลังหรือแบนเนอร์ที่ปรากฏที่ด้านบนของหน้า YouTube หรือไม่
companionYoutubeVideos[]

object (YoutubeVideoDetails)

วิดีโอที่ปรากฏข้างโฆษณา Masthead บนเดสก์ท็อป มีได้ไม่เกิน 2 รายการ

YoutubeVideoDetails

รายละเอียดของวิดีโอ YouTube

การแสดง JSON 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
ช่อง
id

string

รหัสวิดีโอ YouTube ซึ่งค้นหาได้ในหน้าเว็บ YouTube
unavailableReason

enum (VideoUnavailableReason)

เหตุผลที่ข้อมูลวิดีโอไม่พร้อมใช้งาน

VideoUnavailableReason

สาเหตุที่อาจทำให้วิดีโอไม่พร้อมใช้งาน

Enum
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED ไม่ทราบหรือไม่ระบุ
VIDEO_UNAVAILABLE_REASON_PRIVATE วิดีโอเป็นแบบส่วนตัว
VIDEO_UNAVAILABLE_REASON_DELETED วิดีโอถูกลบแล้ว

VideoAspectRatio

สัดส่วนภาพที่เป็นไปได้สำหรับวิดีโอ YouTube

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

พารามิเตอร์ที่กำหนดเองเพื่อส่งค่าที่กำหนดเองไปยังเทมเพลต URL การติดตาม

ออบเจ็กต์ที่มีรายการคู่ "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

ที่อยู่ URL ของหน้าเว็บที่ผู้ใช้จะเข้าถึงหลังจากคลิกโฆษณา
trackingUrl

string

ที่อยู่ URL ที่โหลดในเบื้องหลังเพื่อวัตถุประสงค์ในการติดตาม
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)

พารามิเตอร์ที่กำหนดเองเพื่อส่งค่าที่กำหนดเองไปยังเทมเพลต URL การติดตาม

ออบเจ็กต์ที่มีรายการคู่ "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

ที่อยู่ URL ของหน้าเว็บที่ผู้ใช้จะเข้าถึงหลังจากคลิกโฆษณา
trackingUrl

string

ที่อยู่ URL ที่โหลดในเบื้องหลังเพื่อวัตถุประสงค์ในการติดตาม
video

object (YoutubeVideoDetails)

วิดีโอ YouTube ของโฆษณา

VideoDiscoveryAd

รายละเอียดสำหรับโฆษณาวิดีโอ Discovery

การแสดง JSON 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
ช่อง
headline

string

บรรทัดแรกของโฆษณา
description1

string

ข้อความบรรทัดแรกสำหรับโฆษณา
description2

string

ข้อความบรรทัดที่ 2 สำหรับโฆษณา
video

object (YoutubeVideoDetails)

วิดีโอ YouTube ที่โฆษณาส่งเสริม
thumbnail

enum (Thumbnail)

รูปภาพปกที่ใช้ในโฆษณา

ภาพขนาดย่อ

ตัวเลือกภาพปกที่เป็นไปได้ในโฆษณา Video Discovery

Enum
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

ที่อยู่ URL ของหน้าเว็บที่ผู้ใช้จะเข้าถึงหลังจากคลิกโฆษณา
trackingUrl

string

ที่อยู่ URL ที่โหลดในเบื้องหลังเพื่อวัตถุประสงค์ในการติดตาม
actionButtonLabels[]

string

รายการชิ้นงานข้อความที่แสดงบนปุ่มกระตุ้นให้ดำเนินการ
headlines[]

string

รายการบรรทัดแรกที่แสดงในแบนเนอร์คำกระตุ้นให้ดำเนินการ
longHeadlines[]

string

รายการบรรทัดแรกเดี่ยวที่แสดงในแบนเนอร์คำกระตุ้นให้ดำเนินการ
descriptions[]

string

รายการคำอธิบายที่แสดงในแบนเนอร์คำกระตุ้นให้ดำเนินการ
displayUrlBreadcrumb1

string

ส่วนแรกหลังจากโดเมนใน URL ที่แสดง
displayUrlBreadcrumb2

string

ส่วนที่ 2 หลังจากโดเมนใน URL ที่แสดง
domain

string

โดเมนของ URL ที่แสดง
videos[]

object (YoutubeVideoDetails)

รายการชิ้นงานวิดีโอ YouTube ที่โฆษณานี้ใช้
customParameters

map (key: string, value: string)

พารามิเตอร์ที่กำหนดเองเพื่อส่งค่าที่กำหนดเองไปยังเทมเพลต URL การติดตาม

ออบเจ็กต์ที่มีรายการคู่ "key": value เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
companionBanners[]

object (ImageAsset)

รายการแบนเนอร์ที่แสดงร่วมกันซึ่งโฆษณานี้ใช้

AdUrl

URL เพิ่มเติมที่เกี่ยวข้องกับโฆษณา รวมถึงบีคอน

การแสดง JSON 
{
  "type": enum (AdUrlType),
  "url": string
}
ช่อง
type

enum (AdUrlType)

ประเภทของ URL โฆษณา
url

string

ค่าสตริง URL

AdUrlType

ประเภท URL ของโฆษณาที่เป็นไปได้

Enum
AD_URL_TYPE_UNSPECIFIED ไม่ทราบหรือไม่ระบุ
AD_URL_TYPE_BEACON_IMPRESSION พิกเซลการติดตามขนาด 1x1 เพื่อส่ง Ping เมื่อมีการแสดงผลครีเอทีฟโฆษณา
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION บีคอนการแสดงผลของ DCM ที่ขยายได้ เมื่อถึงเวลาแสดงโฆษณา ระบบจะขยายโฆษณาไปยังบีคอนหลายตัว
AD_URL_TYPE_BEACON_CLICK URL การติดตามที่จะปิงเมื่อมีการทริกเกอร์เหตุการณ์คลิก
AD_URL_TYPE_BEACON_SKIP URL ติดตามที่จะใช้คำสั่ง ping เมื่อมีการทริกเกอร์เหตุการณ์ข้าม

เมธอด

get

 รับโฆษณาของกลุ่มโฆษณา

list

 แสดงโฆษณาของกลุ่มโฆษณา