REST Resource: advertisers.adGroupAds

Referensi: AdGroupAd

Satu iklan yang terkait dengan grup iklan.

Representasi 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.
}
Kolom
name

string

Nama resource iklan.
advertiserId

string (int64 format)

ID unik pengiklan yang memiliki iklan.
adGroupAdId

string (int64 format)

ID unik iklan. Ditetapkan oleh sistem.
adGroupId

string (int64 format)

ID unik grup iklan tempat iklan berada.
displayName

string

Nama tampilan iklan.

Harus berenkode UTF-8 dengan ukuran maksimum 255 byte.
entityStatus

enum (EntityStatus)

Status entitas iklan.
adUrls[]

object (AdUrl)

Daftar URL yang digunakan oleh iklan.
Kolom union ad_details. Detail iklan. ad_details hanya dapat berupa salah satu dari berikut:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Detail iklan yang bersumber dari kampanye Display & Materi iklan Video 360.
mastheadAd

object (MastheadAd)

Detail iklan yang ditayangkan di feed Beranda YouTube.
inStreamAd

object (InStreamAd)

Detail iklan in-stream yang dapat dilewati setelah 5 detik, yang digunakan untuk brand awareness atau mencapai tujuan pemasaran.
nonSkippableAd

object (NonSkippableAd)

Detail iklan video in-stream pendek yang tidak dapat dilewati, berdurasi antara 6 dan 15 detik, yang digunakan untuk tujuan pemasaran jangkauan.
bumperAd

object (BumperAd)

Detail iklan video singkat yang tidak dapat dilewati, yang sama dengan atau kurang dari 6 detik, yang digunakan untuk jangkauan.
audioAd

object (AudioAd)

Detail iklan audio yang digunakan untuk tujuan pemasaran jangkauan.
videoDiscoverAd

object (VideoDiscoveryAd)

Detail iklan yang mempromosikan video yang ditampilkan di tempat penemuan.
videoPerformanceAd

object (VideoPerformanceAd)

Detail iklan yang digunakan dalam kampanye tindakan video untuk mendorong tindakan terhadap bisnis, layanan, atau produk.

DisplayVideoSourceAd

Iklan berasal dari materi iklan DV360.

Representasi JSON 
{
  "creativeId": string
}
Kolom
creativeId

string (int64 format)

ID materi iklan sumber.

MastheadAd

Detail untuk Iklan Masthead.

Representasi 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)
    }
  ]
}
Kolom
video

object (YoutubeVideoDetails)

Video YouTube yang digunakan oleh iklan.
headline

string

Judul iklan.
description

string

Deskripsi iklan.
videoAspectRatio

enum (VideoAspectRatio)

Rasio aspek video YouTube yang diputar otomatis di Masthead.
autoplayVideoStartMillisecond

string (int64 format)

Jumlah waktu dalam milidetik sebelum video mulai diputar.
autoplayVideoDuration

string (Duration format)

Durasi waktu video akan diputar otomatis.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
callToActionButtonLabel

string

Teks di tombol pesan ajakan (CTA).
callToActionFinalUrl

string

URL tujuan untuk tombol pesan ajakan (CTA).
callToActionTrackingUrl

string

URL pelacakan untuk tombol pesan ajakan (CTA).
showChannelArt

boolean

Apakah akan menampilkan latar belakang atau banner yang muncul di bagian atas halaman YouTube.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

Video yang muncul di samping Iklan Masthead di desktop. Tidak boleh lebih dari dua.

YoutubeVideoDetails

Detail video YouTube.

Representasi JSON 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
Kolom
id

string

ID video YouTube yang dapat ditelusuri di halaman web YouTube.
unavailableReason

enum (VideoUnavailableReason)

Alasan data video tidak tersedia.

VideoUnavailableReason

Kemungkinan alasan video tidak tersedia.

Enum
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Tidak diketahui atau tidak ditentukan.
VIDEO_UNAVAILABLE_REASON_PRIVATE Video disetel ke pribadi.
VIDEO_UNAVAILABLE_REASON_DELETED Video dihapus.

VideoAspectRatio

Kemungkinan rasio aspek untuk video YouTube.

Enum
VIDEO_ASPECT_RATIO_UNSPECIFIED Tidak ditentukan atau tidak diketahui.
VIDEO_ASPECT_RATIO_WIDESCREEN Video direntangkan serta bagian atas dan bawah dipangkas.
VIDEO_ASPECT_RATIO_FIXED_16_9 Video menggunakan rasio aspek tetap 16:9.

InStreamAd

Detail untuk iklan in-stream.

Representasi JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Kolom
commonInStreamAttribute

object (CommonInStreamAttribute)

Atribut iklan umum.
customParameters

map (key: string, value: string)

Parameter kustom untuk meneruskan nilai kustom ke template URL pelacakan.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CommonInStreamAttribute

Atribut umum untuk iklan in-stream, yang tidak dapat dilewati, dan bumper.

Representasi JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
Kolom
displayUrl

string

Alamat halaman web yang ditampilkan bersama iklan.
finalUrl

string

Alamat URL halaman web yang dibuka orang setelah mengklik iklan.
trackingUrl

string

Alamat URL yang dimuat di latar belakang untuk tujuan pelacakan.
actionButtonLabel

string

Teks di tombol pesan ajakan (CTA).
actionHeadline

string

Judul banner pesan ajakan.
video

object (YoutubeVideoDetails)

Video YouTube iklan.
companionBanner

object (ImageAsset)

Gambar yang ditampilkan di samping iklan video.

ImageAsset

Data meta aset gambar.

Representasi JSON 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
Kolom
mimeType

string

Jenis MIME dari aset gambar.
fullSize

object (Dimensions)

Metadata untuk gambar ini dalam ukuran aslinya.
fileSize

string (int64 format)

Ukuran file aset gambar dalam byte.

NonSkippableAd

Detail untuk iklan yang tidak dapat dilewati.

Representasi JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Kolom
commonInStreamAttribute

object (CommonInStreamAttribute)

Atribut iklan umum.
customParameters

map (key: string, value: string)

Parameter kustom untuk meneruskan nilai kustom ke template URL pelacakan.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BumperAd

Detail untuk iklan bumper.

Representasi JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
Kolom
commonInStreamAttribute

object (CommonInStreamAttribute)

Atribut iklan umum.

AudioAd

Detail untuk iklan audio.

Representasi JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
Kolom
displayUrl

string

Alamat halaman web yang ditampilkan bersama iklan.
finalUrl

string

Alamat URL halaman web yang dibuka orang setelah mengklik iklan.
trackingUrl

string

Alamat URL yang dimuat di latar belakang untuk tujuan pelacakan.
video

object (YoutubeVideoDetails)

Video YouTube iklan.

VideoDiscoveryAd

Detail untuk iklan video discovery.

Representasi JSON 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
Kolom
headline

string

Judul iklan.
description1

string

Baris teks pertama iklan.
description2

string

Baris teks kedua untuk iklan.
video

object (YoutubeVideoDetails)

Video YouTube yang dipromosikan iklan.
thumbnail

enum (Thumbnail)

Gambar thumbnail yang digunakan di iklan.

Thumbnail

Kemungkinan opsi thumbnail di Iklan Discovery Video.

Enum
THUMBNAIL_UNSPECIFIED Tidak diketahui atau tidak ditentukan.
THUMBNAIL_DEFAULT Thumbnail default, dapat dibuat secara otomatis atau diupload pengguna.
THUMBNAIL_1 Thumbnail 1, yang dibuat dari video.
THUMBNAIL_2 Thumbnail 2, yang dibuat dari video.
THUMBNAIL_3 Thumbnail 3 yang dibuat dari video.

VideoPerformanceAd

Detail untuk iklan performa video.

Representasi 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)
    }
  ]
}
Kolom
finalUrl

string

Alamat URL halaman web yang dibuka orang setelah mengklik iklan.
trackingUrl

string

Alamat URL yang dimuat di latar belakang untuk tujuan pelacakan.
actionButtonLabels[]

string

Daftar aset teks yang ditampilkan di tombol pesan ajakan (CTA).
headlines[]

string

Daftar judul yang ditampilkan di banner pesan ajakan (CTA).
longHeadlines[]

string

Daftar judul tunggal yang ditampilkan di banner pesan ajakan (CTA).
descriptions[]

string

Daftar deskripsi yang ditampilkan di banner pesan ajakan (CTA).
displayUrlBreadcrumb1

string

Bagian pertama setelah domain dalam URL yang ditampilkan.
displayUrlBreadcrumb2

string

Bagian kedua setelah domain di URL yang ditampilkan.
domain

string

Domain URL yang ditampilkan.
videos[]

object (YoutubeVideoDetails)

Daftar aset video YouTube yang digunakan oleh iklan ini.
customParameters

map (key: string, value: string)

Parameter kustom untuk meneruskan nilai kustom ke template URL pelacakan.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
companionBanners[]

object (ImageAsset)

Daftar banner pengiring yang digunakan iklan ini.

AdUrl

URL tambahan yang terkait dengan iklan, termasuk beacon.

Representasi JSON 
{
  "type": enum (AdUrlType),
  "url": string
}
Kolom
type

enum (AdUrlType)

Jenis URL Iklan.
url

string

Nilai string URL.

AdUrlType

Kemungkinan jenis URL iklan.

Enum
AD_URL_TYPE_UNSPECIFIED Tidak diketahui atau tidak ditentukan.
AD_URL_TYPE_BEACON_IMPRESSION Piksel pelacakan 1x1 untuk melakukan ping saat tayangan materi iklan ditayangkan.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Suar tayangan DCM yang dapat diperluas. Pada waktu inferensi, fitur ini diperluas menjadi beberapa beacon.
AD_URL_TYPE_BEACON_CLICK URL pelacakan yang akan di-ping saat peristiwa klik dipicu.
AD_URL_TYPE_BEACON_SKIP URL pelacakan yang akan di-ping saat peristiwa lewati dipicu.

Metode

get

 Mendapatkan iklan grup iklan.

list

 Mencantumkan iklan di grup iklan.