REST Resource: advertisers.youtubeAdGroupAds

แหล่งข้อมูล: YouTubeAdGroupAd

โฆษณาเดียวที่เชื่อมโยงกับกลุ่มโฆษณา YouTube

การแสดง 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 ที่โฆษณาใช้
ฟิลด์สหภาพ 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)

รายละเอียดของโฆษณาวิดีโอสั้นๆ แบบข้ามไม่ได้ที่ใช้เพื่อการเข้าถึง
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

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

การแสดง 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)

รูปภาพขนาดย่อที่ใช้ในโฆษณา

ภาพปก

ตัวเลือกภาพขนาดย่อที่ใช้ได้ในโฆษณา 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

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

string

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

string

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

string

รายการคำอธิบายที่แสดงในแบนเนอร์คำกระตุ้นให้ดำเนินการ (Call-To-Action)
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 ติดตามผลที่ใช้คำสั่ง ping เมื่อมีการทริกเกอร์กิจกรรมการคลิก
AD_URL_TYPE_BEACON_SKIP URL ติดตามผลที่ใช้คำสั่ง ping เมื่อมีการทริกเกอร์เหตุการณ์การข้าม

วิธีการ

get

 รับโฆษณาในกลุ่มโฆษณา YouTube

list

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