REST Resource: advertisers.creatives

Resource: Materi iklan

Satu Materi Iklan.

Representasi JSON 
{
  "name": string,
  "advertiserId": string,
  "creativeId": string,
  "cmPlacementId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "createTime": string,
  "creativeType": enum (CreativeType),
  "hostingSource": enum (HostingSource),
  "dynamic": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "additionalDimensions": [
    {
      object (Dimensions)
    }
  ],
  "mediaDuration": string,
  "creativeAttributes": [
    enum (CreativeAttribute)
  ],
  "reviewStatus": {
    object (ReviewStatusInfo)
  },
  "assets": [
    {
      object (AssetAssociation)
    }
  ],
  "exitEvents": [
    {
      object (ExitEvent)
    }
  ],
  "timerEvents": [
    {
      object (TimerEvent)
    }
  ],
  "counterEvents": [
    {
      object (CounterEvent)
    }
  ],
  "appendedTag": string,
  "integrationCode": string,
  "notes": string,
  "iasCampaignMonitoring": boolean,
  "companionCreativeIds": [
    string
  ],
  "skippable": boolean,
  "skipOffset": {
    object (AudioVideoOffset)
  },
  "progressOffset": {
    object (AudioVideoOffset)
  },
  "universalAdId": {
    object (UniversalAdId)
  },
  "thirdPartyUrls": [
    {
      object (ThirdPartyUrl)
    }
  ],
  "transcodes": [
    {
      object (Transcode)
    }
  ],
  "trackerUrls": [
    string
  ],
  "jsTrackerUrl": string,
  "cmTrackingAd": {
    object (CmTrackingAd)
  },
  "obaIcon": {
    object (ObaIcon)
  },
  "thirdPartyTag": string,
  "requireMraid": boolean,
  "requireHtml5": boolean,
  "requirePingForAttribution": boolean,
  "expandingDirection": enum (ExpandingDirection),
  "expandOnHover": boolean,
  "vastTagUrl": string,
  "vpaid": boolean,
  "html5Video": boolean,
  "lineItemIds": [
    string
  ],
  "mp3Audio": boolean,
  "oggAudio": boolean
}
Kolom
name

string

Hanya output. Nama resource materi iklan.
advertiserId

string (int64 format)

Hanya output. ID unik pengiklan yang memiliki materi iklan.
creativeId

string (int64 format)

Hanya output. ID unik materi iklan. Ditetapkan oleh sistem.
cmPlacementId

string (int64 format)

Hanya output. ID unik penempatan Campaign Manager 360 yang terkait dengan materi iklan. Kolom ini hanya berlaku untuk materi iklan yang disinkronkan dari Campaign Manager.
displayName

string

Wajib. Nama tampilan materi iklan.

Harus dienkode dengan UTF-8 dengan ukuran maksimum 240 byte.
entityStatus

enum (EntityStatus)

Wajib. Mengontrol apakah materi iklan dapat ditayangkan atau tidak.

Nilai yang diterima adalah:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
  • ENTITY_STATUS_PAUSED
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat materi iklan terakhir diperbarui, baik oleh pengguna atau sistem (misalnya, peninjauan materi iklan). Ditetapkan oleh sistem.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat materi iklan dibuat. Ditetapkan oleh sistem.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
creativeType

enum (CreativeType)

Wajib. Tidak dapat diubah. Jenis materi iklan.
hostingSource

enum (HostingSource)

Wajib. Menunjukkan tempat materi iklan dihosting.
dynamic

boolean

Hanya output. Menunjukkan apakah materi iklan bersifat dinamis.
dimensions

object (Dimensions)

Wajib. Dimensi utama materi iklan. Berlaku untuk semua jenis materi iklan. Nilai widthPixels dan heightPixels ditetapkan secara default ke 0 jika creativeType adalah salah satu dari:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
additionalDimensions[]

object (Dimensions)

Dimensi tambahan. Berlaku jika creativeType adalah salah satu dari:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_LIGHTBOX
  • CREATIVE_TYPE_PUBLISHER_HOSTED

Jika kolom ini ditentukan, widthPixels dan heightPixels keduanya wajib diisi dan harus lebih besar dari atau sama dengan 0.
mediaDuration

string (Duration format)

Hanya output. Durasi media materi iklan. Berlaku jika creativeType adalah salah satu dari:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_PUBLISHER_HOSTED

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

enum (CreativeAttribute)

Hanya output. Daftar atribut materi iklan yang dihasilkan oleh sistem.
reviewStatus

object (ReviewStatusInfo)

Hanya output. Status proses peninjauan materi iklan saat ini.
assets[]

object (AssetAssociation)

Wajib. Aset yang terkait dengan materi iklan ini.
exitEvents[]

object (ExitEvent)

Wajib. Keluar dari peristiwa untuk materi iklan ini. Area keluar (disebut juga tag klik) adalah area dalam materi iklan Anda yang dapat diklik atau diketuk oleh seseorang untuk membuka halaman landing pengiklan. Setiap materi iklan harus menyertakan setidaknya satu exit. Anda dapat menambahkan exit ke materi iklan dengan salah satu cara berikut:

  • Gunakan area ketuk Google Web Designer.
  • Tentukan variabel JavaScript bernama "clickTag".
  • Gunakan Pengaktif (Enabler.exit()) untuk melacak keluar dalam format multimedia.
timerEvents[]

object (TimerEvent)

Peristiwa kustom penghitung waktu untuk materi iklan multimedia. Pengatur waktu melacak waktu saat pengguna melihat dan berinteraksi dengan bagian materi iklan multimedia tertentu. Materi iklan dapat memiliki beberapa peristiwa timer, masing-masing diatur waktu secara terpisah. Biarkan kosong atau tidak disetel untuk materi iklan yang berisi aset gambar saja.
counterEvents[]

object (CounterEvent)

Peristiwa penghitung untuk materi iklan multimedia. Penghitung melacak frekuensi pengguna berinteraksi dengan bagian mana pun dari materi iklan di multimedia dengan cara tertentu (mouse-over, mouse-out, klik, ketukan, pemuatan data, entri keyboard, dll.). Setiap peristiwa yang dapat direkam dalam materi iklan dapat dicatat sebagai penghitung. Biarkan kosong atau tidak disetel untuk materi iklan yang berisi aset gambar saja.
appendedTag

string

Tag pelacakan HTML pihak ketiga yang akan ditambahkan ke tag materi iklan.
integrationCode

string

Informasi ID yang digunakan untuk menautkan materi iklan ini ke sistem eksternal. Harus berenkode UTF-8 dengan panjang tidak lebih dari 10.000 karakter.
notes

string

Catatan pengguna untuk materi iklan ini. Harus berenkode UTF-8 dengan panjang tidak lebih dari 20.000 karakter.
iasCampaignMonitoring

boolean

Menunjukkan apakah pemantauan kampanye Integral Ad Science (IAS) diaktifkan. Untuk mengaktifkannya pada materi iklan, pastikan Advertiser.creative_config.ias_client_id telah ditetapkan ke client ID IAS Anda.
companionCreativeIds[]

string (int64 format)

ID materi iklan pengiring untuk materi iklan video.

Anda dapat menetapkan materi iklan display yang ada (dengan aset gambar atau HTML5) untuk ditayangkan di sekitar pemutar video penayang. Pengiring ditampilkan di sekitar pemutar video saat video diputar dan tetap ada setelah video selesai.

Materi iklan yang berisi additional dimensions tidak dapat menjadi materi iklan pengiring.

Kolom ini hanya didukung untuk creativeType berikut:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
skippable

boolean

Apakah pengguna dapat memilih untuk melewati materi iklan video.

Kolom ini hanya didukung untuk creativeType berikut:

  • CREATIVE_TYPE_VIDEO
skipOffset

object (AudioVideoOffset)

Jangka waktu untuk memutar video sebelum tombol lewati muncul.

Kolom ini wajib diisi jika skippable benar.

Kolom ini hanya didukung untuk creativeType berikut:

  • CREATIVE_TYPE_VIDEO
progressOffset

object (AudioVideoOffset)

Jangka waktu pemutaran video sebelum menghitung penayangan.

Kolom ini wajib diisi jika skippable benar.

Kolom ini hanya didukung untuk creativeType berikut:

  • CREATIVE_TYPE_VIDEO
universalAdId

object (UniversalAdId)

Opsional. ID materi iklan opsional yang diberikan oleh registry yang bersifat unik di semua platform.

ID Iklan Universal adalah bagian dari standar VAST 4.0. Dapat diubah setelah materi iklan dibuat.

Kolom ini hanya didukung untuk creativeType berikut:

  • CREATIVE_TYPE_VIDEO
thirdPartyUrls[]

object (ThirdPartyUrl)

Melacak URL dari pihak ketiga untuk melacak interaksi dengan materi iklan video.

Kolom ini hanya didukung untuk creativeType berikut:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
transcodes[]

object (Transcode)

Hanya output. Transcoding Audio/Video.

Display & Video 360 melakukan transcoding aset utama ke dalam sejumlah versi alternatif yang menggunakan format file berbeda atau memiliki properti yang berbeda (resolusi, kecepatan bit audio, dan kecepatan bit video), masing-masing dirancang untuk pemutar video atau bandwidth tertentu.

Transcoding ini memberikan lebih banyak opsi kepada sistem penayang untuk setiap tayangan pada video Anda dan memastikan bahwa file yang sesuai ditayangkan berdasarkan ukuran layar dan koneksi penonton.

Kolom ini hanya didukung di creativeType berikut:

  • CREATIVE_TYPE_VIDEO
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_AUDIO
trackerUrls[]

string

URL pelacakan untuk penyedia analisis atau vendor teknologi iklan pihak ketiga.

URL harus diawali dengan https (kecuali untuk inventaris yang tidak mewajibkan kepatuhan SSL). Jika menggunakan makro di URL, hanya gunakan makro yang didukung oleh Display & Video 360.

Hanya URL standar, tanpa tag IMG atau SCRIPT.

Kolom ini hanya dapat ditulis di creativeType berikut:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
jsTrackerUrl

string

URL pengukuran JavaScript dari penyedia verifikasi pihak ketiga yang didukung (ComScore, DoubleVerify, IAS, Moat). Tag skrip HTML tidak didukung.

Kolom ini hanya dapat ditulis di creativeType berikut:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
cmTrackingAd

object (CmTrackingAd)

Iklan pelacakan Campaign Manager 360 yang terkait dengan materi iklan.

Opsional untuk creativeType berikut saat dibuat oleh pengiklan yang menggunakan Campaign Manager 360 dan penayangan iklan pihak ketiga:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE

Output hanya untuk kasus lain.
obaIcon

object (ObaIcon)

Menentukan ikon OBA untuk materi iklan video.

Kolom ini hanya didukung di creativeType berikut:

  • CREATIVE_TYPE_VIDEO
thirdPartyTag

string

Opsional. Tag pihak ketiga asli yang digunakan untuk materi iklan.

Diperlukan dan hanya valid untuk materi iklan tag pihak ketiga.

Materi iklan tag pihak ketiga adalah materi iklan dengan hostingSource berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireMraid

boolean

Opsional. Menunjukkan bahwa materi iklan memerlukan MRAID (sistem Definisi Antarmuka Iklan Multimedia Seluler).

Setel ini jika materi iklan mengandalkan gestur seluler untuk interaktivitas, seperti menggeser atau mengetuk.

Opsional dan hanya valid untuk materi iklan tag pihak ketiga.

Materi iklan tag pihak ketiga adalah materi iklan dengan hostingSource berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requireHtml5

boolean

Opsional. Menunjukkan bahwa materi iklan bergantung pada HTML5 untuk dirender dengan benar.

Opsional dan hanya valid untuk materi iklan tag pihak ketiga. Materi iklan tag pihak ketiga adalah materi iklan dengan hostingSource berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE
requirePingForAttribution

boolean

Opsional. Menunjukkan bahwa materi iklan akan menunggu ping kembali untuk atribusi.

Hanya valid jika menggunakan iklan pelacakan Campaign Manager 360 dengan parameter server iklan pihak ketiga dan makro ${DC_DBM_TOKEN}.

Opsional dan hanya valid untuk materi iklan tag pihak ketiga atau materi iklan tag VAST pihak ketiga.

Materi iklan tag pihak ketiga adalah materi iklan dengan hostingSource berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_EXPANDABLE

Materi iklan tag VAST pihak ketiga adalah materi iklan dengan hostingSource berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
expandingDirection

enum (ExpandingDirection)

Opsional. Menentukan arah perluasan materi iklan.

Diperlukan dan hanya valid untuk materi iklan yang dapat diperluas pihak ketiga.

Materi iklan pihak ketiga yang dapat diperluas adalah materi iklan dengan sumber hosting berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_EXPANDABLE
expandOnHover

boolean

Opsional. Menunjukkan bahwa materi iklan akan diperluas secara otomatis saat kursor diarahkan ke atasnya.

Opsional dan hanya valid untuk materi iklan yang dapat diperluas pihak ketiga. Materi iklan pihak ketiga yang dapat diperluas adalah materi iklan dengan sumber hosting berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_EXPANDABLE
vastTagUrl

string

Opsional. URL tag VAST untuk materi iklan tag VAST pihak ketiga.

Diperlukan dan hanya valid untuk materi iklan tag VAST pihak ketiga.

Materi iklan tag VAST pihak ketiga adalah materi iklan dengan hostingSource berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_VIDEO
vpaid

boolean

Hanya output. Menunjukkan bahwa materi iklan tag VAST pihak ketiga memerlukan VPAID (Digital Video Player-Ad Interface).

Hanya output dan hanya valid untuk materi iklan tag VAST pihak ketiga.

Materi iklan tag VAST pihak ketiga adalah materi iklan dengan hostingSource berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_VIDEO
html5Video

boolean

Hanya output. Menunjukkan bahwa materi iklan tag VAST pihak ketiga memerlukan dukungan Video HTML5.

Hanya output dan hanya valid untuk materi iklan tag VAST pihak ketiga.

Materi iklan tag VAST pihak ketiga adalah materi iklan dengan hostingSource berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_VIDEO
lineItemIds[]

string (int64 format)

Hanya output. ID item baris yang terkait dengan materi iklan ini.

Untuk mengaitkan materi iklan ke item baris, gunakan LineItem.creative_ids sebagai gantinya.
mp3Audio

boolean

Hanya output. Menunjukkan bahwa materi iklan audio pihak ketiga mendukung MP3.

Hanya output dan hanya valid untuk materi iklan audio pihak ketiga.

Materi iklan audio pihak ketiga adalah materi iklan dengan hostingSource berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_AUDIO
oggAudio

boolean

Hanya output. Menunjukkan bahwa materi iklan audio pihak ketiga mendukung OGG.

Hanya output dan hanya valid untuk materi iklan audio pihak ketiga.

Materi iklan audio pihak ketiga adalah materi iklan dengan hostingSource berikut:

  • HOSTING_SOURCE_THIRD_PARTY

dikombinasikan dengan creativeType berikut:

  • CREATIVE_TYPE_AUDIO

HostingSource

Kemungkinan sumber hosting untuk materi iklan. Menunjukkan tempat materi iklan dibuat dan dihosting.

Enum
HOSTING_SOURCE_UNSPECIFIED Sumber hosting tidak ditentukan atau tidak diketahui dalam versi ini.
HOSTING_SOURCE_CM

Materi iklan yang disinkronkan dari Campaign Manager 360.

Metode pembuatan dan pembaruan tidak didukung untuk jenis hosting ini.
HOSTING_SOURCE_THIRD_PARTY

Materi iklan yang dihosting oleh server iklan pihak ketiga (3PAS).

Metode pembuatan dan pembaruan didukung untuk jenis hosting ini jika creativeType adalah salah satu dari yang berikut:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_EXPANDABLE
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_HOSTED

Materi iklan yang dibuat di DV360 dan dihosting oleh Campaign Manager 360.

Metode pembuatan dan pembaruan didukung untuk jenis hosting ini jika creativeType adalah salah satu dari yang berikut:

  • CREATIVE_TYPE_AUDIO
  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO
HOSTING_SOURCE_RICH_MEDIA

Materi iklan multimedia yang dibuat di Studio dan dihosting oleh Campaign Manager 360.

Metode pembuatan dan pembaruan tidak didukung untuk jenis hosting ini.

CreativeAttribute

Kemungkinan atribut materi iklan.

Enum
CREATIVE_ATTRIBUTE_UNSPECIFIED Atribut materi iklan tidak ditentukan atau tidak diketahui dalam versi ini.
CREATIVE_ATTRIBUTE_VAST Materi iklan merupakan materi iklan VAST.
CREATIVE_ATTRIBUTE_VPAID_LINEAR Materi iklan adalah materi iklan VPAID linear.
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR Materi iklan adalah materi iklan VPAID non-linear.

ReviewStatusInfo

Tinjau status untuk materi iklan.

Representasi JSON 
{
  "approvalStatus": enum (ApprovalStatus),
  "creativeAndLandingPageReviewStatus": enum (ReviewStatus),
  "contentAndPolicyReviewStatus": enum (ReviewStatus),
  "exchangeReviewStatuses": [
    {
      object (ExchangeReviewStatus)
    }
  ],
  "publisherReviewStatuses": [
    {
      object (PublisherReviewStatus)
    }
  ]
}
Kolom
approvalStatus

enum (ApprovalStatus)

Mewakili persetujuan dasar yang diperlukan agar materi iklan mulai ditayangkan. Ringkasan creativeAndLandingPageReviewStatus dan contentAndPolicyReviewStatus.
creativeAndLandingPageReviewStatus

enum (ReviewStatus)

Status peninjauan materi iklan dan halaman landing untuk materi iklan.
contentAndPolicyReviewStatus

enum (ReviewStatus)

Status pemeriksaan kebijakan dan konten untuk materi iklan.
exchangeReviewStatuses[]

object (ExchangeReviewStatus)

Status peninjauan Exchange untuk materi iklan.
publisherReviewStatuses[]
(deprecated)

object (PublisherReviewStatus)

Status peninjauan penayang untuk materi iklan.

ApprovalStatus

Kemungkinan jenis status persetujuan. Ini adalah ringkasan dari creativeAndLandingPageReviewStatus dan contentAndPolicyReviewStatus.

Enum
APPROVAL_STATUS_UNSPECIFIED Nilai jenis tidak ditentukan atau tidak diketahui dalam versi ini.
APPROVAL_STATUS_PENDING_NOT_SERVABLE Materi iklan masih dalam peninjauan dan tidak dapat ditayangkan.
APPROVAL_STATUS_PENDING_SERVABLE Materi iklan telah lulus peninjauan materi iklan & halaman landing dan dapat ditayangkan, namun sedang menunggu pemeriksaan konten & kebijakan tambahan.
APPROVAL_STATUS_APPROVED_SERVABLE Peninjauan materi iklan & halaman landing serta pemeriksaan konten & kebijakan disetujui. Materi iklan dapat ditayangkan.
APPROVAL_STATUS_REJECTED_NOT_SERVABLE Ada masalah dengan materi iklan yang harus diperbaiki sebelum dapat ditayangkan.

ReviewStatus

Kemungkinan jenis status peninjauan.

Enum
REVIEW_STATUS_UNSPECIFIED Nilai jenis tidak ditentukan atau tidak diketahui dalam versi ini.
REVIEW_STATUS_APPROVED Materi iklan disetujui.
REVIEW_STATUS_REJECTED Materi iklan ditolak.
REVIEW_STATUS_PENDING Materi iklan sedang menunggu peninjauan.

ExchangeReviewStatus

Status peninjauan bursa untuk materi iklan.

Representasi JSON 
{
  "exchange": enum (Exchange),
  "status": enum (ReviewStatus)
}
Kolom
exchange

enum (Exchange)

Bursa yang meninjau materi iklan.
status

enum (ReviewStatus)

Status peninjauan bursa.

PublisherReviewStatus

Status peninjauan penayang untuk materi iklan.

Representasi JSON 
{
  "publisherName": string,
  "status": enum (ReviewStatus)
}
Kolom
publisherName

string

Penayang yang meninjau materi iklan.
status

enum (ReviewStatus)

Status peninjauan penayang.

AssetAssociation

Pengaitan aset untuk materi iklan.

Representasi JSON 
{
  "asset": {
    object (Asset)
  },
  "role": enum (AssetRole)
}
Kolom
asset

object (Asset)

Aset terkait.
role

enum (AssetRole)

Peran aset ini untuk materi iklan.

Aset

Satu aset.

Representasi JSON 
{
  "mediaId": string,
  "content": string
}
Kolom
mediaId

string (int64 format)

ID media dari aset yang diupload. Ini adalah ID unik untuk aset. ID ini dapat diteruskan ke panggilan API lainnya, misalnya, creatives.create untuk mengaitkan aset dengan materi iklan.

Ruang ID Media diperbarui pada 5 April 2023. Perbarui ID media yang di-cache sebelum 5 April 2023 dengan mengambil ID media baru dari resource materi iklan terkait atau mengupload ulang aset.
content

string

Konten aset. Untuk aset yang diupload, kontennya adalah jalur penayangan.

AssetRole

Peran aset ini untuk materi iklan.

Enum
ASSET_ROLE_UNSPECIFIED Peran aset tidak ditentukan atau tidak diketahui dalam versi ini.
ASSET_ROLE_MAIN Aset adalah aset utama materi iklan.
ASSET_ROLE_BACKUP Aset adalah aset cadangan materi iklan.
ASSET_ROLE_POLITE_LOAD Aset adalah aset pemuatan terkendali dari materi iklan.
ASSET_ROLE_HEADLINE

Judul materi iklan native.

content harus dienkode dengan UTF-8 dengan panjang tidak lebih dari 25 karakter.

Peran ini hanya didukung di creativeType berikut:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_HEADLINE

Judul panjang materi iklan native.

content harus dienkode dengan UTF-8 dengan panjang tidak lebih dari 50 karakter.

Peran ini hanya didukung di creativeType berikut:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_BODY

Teks isi materi iklan native.

content harus dienkode dengan UTF-8 dengan panjang tidak lebih dari 90 karakter.

Peran ini hanya didukung di creativeType berikut:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_LONG_BODY

Teks isi panjang materi iklan native.

content harus dienkode dengan UTF-8 dengan panjang tidak lebih dari 150 karakter.

Peran ini hanya didukung di creativeType berikut:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CAPTION_URL

Versi URL halaman landing yang singkat dan mudah ditampilkan dalam materi iklan. URL ini memberikan gambaran kepada pengguna mengenai halaman yang akan mereka buka setelah mengklik materi iklan.

content harus dienkode dengan UTF-8 dengan panjang tidak lebih dari 30 karakter.

Misalnya, jika URL halaman landing adalah 'http://www.example.com/page', URL teks dapat berupa 'example.com'. Protokol (http://) bersifat opsional, tetapi URL tidak boleh berisi spasi atau karakter khusus.

Peran ini hanya didukung di creativeType berikut:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_CALL_TO_ACTION

Teks yang akan digunakan pada tombol pesan ajakan (CTA) materi iklan native.

content harus dienkode dengan UTF-8 dengan panjang tidak lebih dari 15 karakter.

Peran ini hanya didukung di creativeType berikut:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_ADVERTISER_NAME

Teks yang mengidentifikasi pengiklan atau nama merek.

content harus dienkode dengan UTF-8 dengan panjang tidak lebih dari 25 karakter.

Peran ini hanya didukung di creativeType berikut:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
  • CREATIVE_TYPE_NATIVE_VIDEO
ASSET_ROLE_PRICE

Harga pembelian aplikasi Anda di Google Play Store atau iOS App Store (misalnya, $5,99).

Perlu diperhatikan bahwa nilai ini tidak disinkronkan secara otomatis dengan nilai sebenarnya yang tercantum di app store. URL ini akan selalu disediakan saat menyimpan materi iklan.

content harus dienkode dengan UTF-8 dengan panjang tidak lebih dari 15 karakter.

Aset peran ini bersifat hanya baca.
ASSET_ROLE_ANDROID_APP_ID

ID aplikasi Android di Google Play Store.

Anda dapat menemukan ID ini di URL Google Play Store Aplikasi setelah ‘id’. Misalnya, di https://play.google.com/store/apps/details?id=com.company.appname, ID-nya adalah com.company.appname.

Aset peran ini bersifat hanya baca.
ASSET_ROLE_IOS_APP_ID

ID aplikasi iOS di Apple App Store.

Nomor ID ini dapat ditemukan di URL Apple App Store sebagai string angka tepat setelah "id". Misalnya, di https://apps.apple.com/us/app/gmail-email-by-google/id422689480, ID-nya adalah 422689480.

Aset peran ini bersifat hanya baca.
ASSET_ROLE_RATING

Rating aplikasi di Google Play Store atau iOS App Store.

Perlu diperhatikan bahwa nilai ini tidak disinkronkan secara otomatis dengan rating sebenarnya di Play Store. URL ini akan selalu disediakan saat menyimpan materi iklan.

Aset peran ini bersifat hanya baca.
ASSET_ROLE_ICON

Ikon materi iklan.

Peran ini hanya didukung dan diperlukan dalam creativeType berikut:

  • CREATIVE_TYPE_NATIVE
  • CREATIVE_TYPE_NATIVE_SITE_SQUARE
ASSET_ROLE_COVER_IMAGE

Gambar sampul materi iklan video native.

Peran ini hanya didukung dan diperlukan dalam creativeType berikut:

  • CREATIVE_TYPE_VIDEO

ExitEvent

Keluar dari materi iklan.

Representasi JSON 
{
  "type": enum (ExitEventType),
  "url": string,
  "name": string,
  "reportingName": string
}
Kolom
type

enum (ExitEventType)

Wajib. Jenis peristiwa keluar.
url

string

Wajib. URL klik-tayang dari peristiwa keluar. Ini diperlukan saat type:

  • EXIT_EVENT_TYPE_DEFAULT
  • EXIT_EVENT_TYPE_BACKUP
name

string

Nama tag klik untuk peristiwa keluar.

Nama harus unik dalam satu materi iklan.

Biarkan kosong atau tidak disetel untuk materi iklan yang berisi aset gambar saja.
reportingName

string

Nama yang digunakan untuk mengidentifikasi peristiwa ini dalam laporan. Biarkan kosong atau tidak disetel untuk materi iklan yang berisi aset gambar saja.

ExitEventType

Jenis peristiwa keluar.

Enum
EXIT_EVENT_TYPE_UNSPECIFIED Jenis peristiwa keluar tidak ditentukan atau tidak diketahui dalam versi ini.
EXIT_EVENT_TYPE_DEFAULT Peristiwa keluar adalah peristiwa default.
EXIT_EVENT_TYPE_BACKUP Peristiwa keluar adalah peristiwa keluar cadangan. Mungkin ada beberapa peristiwa keluar cadangan di materi iklan.

TimerEvent

Peristiwa timer materi iklan.

Representasi JSON 
{
  "name": string,
  "reportingName": string
}
Kolom
name

string

Wajib. Nama peristiwa timer.
reportingName

string

Wajib. Nama yang digunakan untuk mengidentifikasi peristiwa timer ini dalam laporan.

CounterEvent

Peristiwa penghitung materi iklan.

Representasi JSON 
{
  "name": string,
  "reportingName": string
}
Kolom
name

string

Wajib. Nama peristiwa penghitung.
reportingName

string

Wajib. Nama yang digunakan untuk mengidentifikasi peristiwa penghitung ini dalam laporan.

AudioVideoOffset

Durasi audio atau video yang telah diputar.

Representasi JSON 
{

  // Union field offset can be only one of the following:
  "percentage": string,
  "seconds": string
  // End of list of possible types for union field offset.
}
Kolom
Kolom union offset. Nilai offset. offset hanya ada berupa salah satu diantara berikut:
percentage

string (int64 format)

Offset dalam persentase durasi audio atau video.
seconds

string (int64 format)

Offset dalam hitungan detik dari awal audio atau video.

UniversalAdId

ID materi iklan yang diberikan oleh registry yang bersifat unik di semua platform. Ini adalah bagian dari standar VAST 4.0.

Representasi JSON 
{
  "id": string,
  "registry": enum (UniversalAdRegistry)
}
Kolom
id

string

ID materi iklan unik.
registry

enum (UniversalAdRegistry)

Registry memberikan ID materi iklan unik.

UniversalAdRegistry

Registry memberikan ID materi iklan unik di ID Iklan Universal.

Enum
UNIVERSAL_AD_REGISTRY_UNSPECIFIED Registry Iklan Universal tidak ditentukan atau tidak diketahui dalam versi ini.
UNIVERSAL_AD_REGISTRY_OTHER Gunakan penyedia kustom untuk memberikan ID Iklan Universal.
UNIVERSAL_AD_REGISTRY_AD_ID Gunakan ID Iklan untuk memberikan ID Iklan Universal.
UNIVERSAL_AD_REGISTRY_CLEARCAST Gunakan clearcast.co.uk untuk memberikan ID Iklan Universal.
UNIVERSAL_AD_REGISTRY_DV360 Gunakan Display & Video 360 untuk memberikan ID Iklan Universal.
UNIVERSAL_AD_REGISTRY_CM Gunakan Campaign Manager 360 untuk memberikan ID Iklan Universal.

ThirdPartyUrl

URL pelacakan dari pihak ketiga untuk melacak interaksi dengan materi iklan audio atau video.

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

enum (ThirdPartyUrlType)

Jenis interaksi harus dilacak oleh URL pelacakan
url

string

URL pelacakan yang digunakan untuk melacak interaksi.

Berikan URL dengan jalur opsional atau string kueri, dimulai dengan https:. Misalnya, https://www.example.com/path

ThirdPartyUrlType

Jenis interaksi harus dilacak oleh URL pelacakan pihak ketiga.

Enum
THIRD_PARTY_URL_TYPE_UNSPECIFIED Jenis URL pihak ketiga tidak ditentukan atau tidak diketahui dalam versi ini.
THIRD_PARTY_URL_TYPE_IMPRESSION Digunakan untuk menghitung tayangan materi iklan setelah buffering audio atau video selesai.
THIRD_PARTY_URL_TYPE_CLICK_TRACKING Digunakan untuk melacak klik pengguna pada audio atau video.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START Digunakan untuk melacak berapa kali pengguna memulai audio atau video.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE Digunakan untuk melacak frekuensi pemutaran audio atau video hingga 25% dari durasinya.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT Digunakan untuk melacak frekuensi pemutaran audio atau video hingga 50% dari durasinya.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE Digunakan untuk melacak frekuensi pemutaran audio atau video hingga 75% dari durasinya.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE Digunakan untuk melacak berapa kali audio atau video diputar hingga akhir.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE Digunakan untuk melacak berapa kali pengguna membisukan audio atau video.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE Digunakan untuk melacak berapa kali pengguna menjeda audio atau video.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND Digunakan untuk melacak berapa kali pengguna memutar ulang audio atau video.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN Digunakan untuk melacak berapa kali pengguna memperluas pemutar ke ukuran layar penuh.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP Digunakan untuk melacak berapa kali pengguna menghentikan audio atau video.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM Digunakan untuk melacak frekuensi pengguna melakukan klik kustom, seperti mengklik hot spot video.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP Digunakan untuk melacak berapa kali audio atau video dilewati.
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS Digunakan untuk melacak frekuensi pemutaran audio atau video ke offset yang ditentukan oleh progressOffset.

Transcode

Menampilkan informasi tentang file audio atau video yang di-transcoding.

Representasi JSON 
{
  "name": string,
  "mimeType": string,
  "transcoded": boolean,
  "dimensions": {
    object (Dimensions)
  },
  "bitRateKbps": string,
  "frameRate": number,
  "audioBitRateKbps": string,
  "audioSampleRateHz": string,
  "fileSizeBytes": string
}
Kolom
name

string

Nama file yang di-transcoding.
mimeType

string

Jenis MIME file yang di-transcoding.
transcoded

boolean

Menunjukkan apakah transcoding berhasil.
dimensions

object (Dimensions)

Dimensi video yang di-transcoding.
bitRateKbps

string (int64 format)

Kecepatan bit transcoding video yang di-transcoding, dalam kilobit per detik.
frameRate

number

Kecepatan frame video yang di-transcoding, dalam frame per detik.
audioBitRateKbps

string (int64 format)

Kecepatan bit untuk streaming audio dari video yang di-transcoding, atau kecepatan bit untuk audio yang di-transcoding, dalam kilobit per detik.
audioSampleRateHz

string (int64 format)

Frekuensi sampel untuk streaming audio dari video yang di-transcoding, atau frekuensi sampel untuk audio yang di-transcoding, dalam hertz.
fileSizeBytes

string (int64 format)

Ukuran file yang di-transcoding, dalam byte.

CmTrackingAd

Iklan pelacakan Campaign Manager 360.

Representasi JSON 
{
  "cmPlacementId": string,
  "cmCreativeId": string,
  "cmAdId": string
}
Kolom
cmPlacementId

string (int64 format)

ID penempatan Iklan pelacakan Campaign Manager 360.
cmCreativeId

string (int64 format)

ID materi iklan Iklan pelacakan Campaign Manager 360.
cmAdId

string (int64 format)

ID iklan Iklan pelacakan Campaign Manager 360.

ObaIcon

Ikon OBA untuk Materi Iklan

Representasi JSON 
{
  "resourceUrl": string,
  "resourceMimeType": string,
  "position": enum (ObaIconPosition),
  "dimensions": {
    object (Dimensions)
  },
  "program": string,
  "landingPageUrl": string,
  "clickTrackingUrl": string,
  "viewTrackingUrl": string
}
Kolom
resourceUrl

string

URL resource ikon OBA.
resourceMimeType

string

Jenis MIME resource ikon OBA.
position

enum (ObaIconPosition)

Posisi ikon OBA pada materi iklan.
dimensions

object (Dimensions)

Dimensi ikon OBA.
program

string

Program ikon OBA. Misalnya: “AdChoices”.
landingPageUrl

string

Wajib. URL halaman landing ikon OBA.

Hanya URL domain berikut yang diizinkan:
clickTrackingUrl

string

Wajib. URL pelacakan klik ikon OBA.

Hanya URL domain berikut yang diizinkan:
viewTrackingUrl

string

Wajib. URL pelacakan tampilan dari ikon OBA.

Hanya URL domain berikut yang diizinkan:

ObaIconPosition

Posisi ikon OBA pada materi iklan.

Enum
OBA_ICON_POSITION_UNSPECIFIED Posisi ikon OBA tidak ditentukan.
OBA_ICON_POSITION_UPPER_RIGHT Di sisi kanan atas materi iklan.
OBA_ICON_POSITION_UPPER_LEFT Di sisi kiri atas materi iklan.
OBA_ICON_POSITION_LOWER_RIGHT Di sisi kanan bawah materi iklan.
OBA_ICON_POSITION_LOWER_LEFT Di sisi kiri bawah materi iklan.

ExpandingDirection

Arah perluasan materi iklan pihak ketiga yang dapat diperluas.

Enum
EXPANDING_DIRECTION_UNSPECIFIED Arah perluasan tidak ditentukan.
EXPANDING_DIRECTION_NONE Tidak meluas ke segala arah.
EXPANDING_DIRECTION_UP Luaskan ke atas.
EXPANDING_DIRECTION_DOWN Meluaskan ke bawah.
EXPANDING_DIRECTION_LEFT Luaskan ke kiri.
EXPANDING_DIRECTION_RIGHT Luaskan ke kanan.
EXPANDING_DIRECTION_UP_AND_LEFT Luaskan ke atas dan ke sisi kiri.
EXPANDING_DIRECTION_UP_AND_RIGHT Luaskan ke atas dan ke sisi kanan.
EXPANDING_DIRECTION_DOWN_AND_LEFT Luaskan ke bawah dan ke sisi kiri.
EXPANDING_DIRECTION_DOWN_AND_RIGHT Luaskan ke bawah dan ke sisi kanan.
EXPANDING_DIRECTION_UP_OR_DOWN Meluaskan ke atas atau ke bawah.
EXPANDING_DIRECTION_LEFT_OR_RIGHT Luaskan ke sisi kiri atau kanan.
EXPANDING_DIRECTION_ANY_DIAGONAL Dapat diperluas ke arah diagonal mana pun.

Metode

create

 Membuat materi iklan baru.

delete

 Menghapus materi iklan.

get

 Mendapatkan materi iklan.

list

 Mencantumkan materi iklan dalam pengiklan.

patch

 Memperbarui materi iklan yang sudah ada.