Package google.ads.drx.video.v1

Indeks

AdBreakNotificationService

Layanan API yang memungkinkan penayang membuat Jeda Iklan dalam live stream.

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

untuk membuat Jeda Iklan dalam live stream.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
ListAdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

API untuk mencantumkan Jeda Iklan dalam live stream.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

VideoContentIngestionService

Layanan API untuk penyerapan konten yang memungkinkan pembuatan atau update konten video dan metadata terkaitnya di Google Ad Manager.

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API untuk membuat konten baru atau memperbarui metadatanya jika konten sudah ada di Ad Manager. Menampilkan konten jika berhasil atau google.rpc.Code jika gagal.

Contoh permintaan terlihat seperti:

{
   "status": "ACTIVE",
   "title": "Best video ever",
   "updateTime": "2019-01-24T01:30:15.01Z",
   "duration": "230s",
   "cuePoints": ["55.532s", "192s"],
   "publishTime": "2019-01-24T01:30:15.01Z",
   "thumbnailUrl": "http://www.domain.com/tn.jpg",
   "metadata": {
       "keyValues": {
           "category": "sports",
           "tag": ["soccer", "messi"],
       }
   }
}
Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

AdBreak

Metadata jeda iklan yang digunakan untuk menentukan iklan untuk jeda iklan dalam acara video live.

Kolom
name

string

Hanya output. Nama resource Jeda Iklan. Kolom ini akan memiliki format "networks//assets//adBreaks/".

network_code adalah kode jaringan di Google Ad Manager yang menjadi bagian dari konten ini.

asset_key adalah kunci Peristiwa Live Stream di Google Ad Manager tempat Jeda Iklan dibuat.

ad_break_id adalah kunci Jeda Iklan. HANYA OUTPUT.
expected_duration

Duration

Wajib. Durasi jeda yang diharapkan.
custom_params

string

Pasangan nilai kunci yang akan disertakan dalam permintaan iklan untuk jeda ini bagi penargetan kriteria kustom di Ad Manager. Contoh: 'key1=value&key2=value2,value22'
scte_35_cue_out

string

Data yang dienkode menggunakan base 64 dari isyarat scte35 keluar. Dapat mencakup perintah splice_insert() atau time_signal(). Contoh: - dengan time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - dengan splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
pod_template_name

string

Nama template pod Google Ad Manager.
break_state

BreakState

Status Jeda Iklan saat ini.

BreakState

Status Jeda Iklan.

Enum
BREAK_STATE_UNSPECIFIED Status Jeda Iklan tidak diketahui.
BREAK_STATE_DECISIONED Pengambilan keputusan Jeda Iklan dimulai, tetapi belum ditayangkan kepada pengguna.
BREAK_STATE_COMPLETE Jeda Iklan ditayangkan kepada pengguna.

ClosedCaptionFormat

Format file teks tertutup.

Enum
CLOSED_CAPTION_FORMAT_UNSPECIFIED Format teks tertutup tidak ditentukan.
TTML application/ttaf+xml
WEB_VTT text/vtt

ClosedCaptionUrlInfo

Metadata untuk satu file teks tertutup.

Kolom
language_code

string

Kode bahasa IETF BCP-47 yang merepresentasikan bahasa file teks tertutup.
closed_caption_format

ClosedCaptionFormat

Format file teks tertutup.
url

string

URL ke file teks tertutup.

CreateAdBreakRequest

Meminta AdBreakNotificationService.CreateAdBreak.

Kolom
parent

string

Kolom ini mengidentifikasi LiveStreamEvent yang harus dikaitkan dengan jeda iklan ini menggunakan kunci aset live stream. Formatnya harus "networks/{network_code}/assets/{asset_code}"
custom_parent

string

Kolom ini mengidentifikasi LiveStreamEvent yang harus dikaitkan dengan jeda iklan ini menggunakan kunci aset kustom. Aset tersebut harus memiliki format "networks/{network_code}/customAssets/{asset_code}"
content

string

Ini adalah cara alternatif untuk mengidentifikasi LiveStreamEvent, jika dikaitkan dengan bagian konten dalam GAM. Formatnya harus "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"
ad_break

AdBreak

Wajib. Jeda iklan yang sebenarnya.
ad_break_id

string

Ini adalah ad_break_id yang dapat diberikan pengguna melalui permintaan.

DynamicAdInsertionInfo

Informasi terkait Penyisipan Iklan Dinamis.

Kolom
video_ingest_url_info

VideoIngestUrlInfo

Link ke file m3u8 master yang digunakan untuk pengondisian dan pembuatan playlist.
media_update_time

Timestamp

Waktu file video yang dirujuk di video_ingest_url_info terakhir diubah.
closed_caption_url_info[]

ClosedCaptionUrlInfo

URL ke file subtitel/teks tertutup.
fw_caid

string

ID aset kustom Freewheel yang digunakan untuk penargetan iklan.

GracenoteMetadata

Metadata Gracenote untuk konten.

Kolom
gracenote_id

string

Wajib. Mengacu pada ID Gracenote untuk konten. Harus memiliki salah satu awalan yang valid berikut: 1. 'EP' - episode dari serial 2. 'MV' - film 3. 'SP' - acara olahraga
gracenote_series_id

string

Opsional. Kolom ini merujuk pada ID seri Gracenote. Harus diawali dengan 'SH'.

ListAdBreaksRequest

Meminta AdBreakNotificationService.ListAdBreaks.

Kolom
parent

string

Opsional. Kolom ini mengidentifikasi LiveStreamEvent yang jeda iklan ini harus dikaitkan dengan menggunakan kunci aset live stream. Formatnya harus "networks/{network_code}/assets/{asset_code}"
custom_parent

string

Opsional. Kolom ini mengidentifikasi LiveStreamEvent yang jeda iklan ini harus dikaitkan dengan menggunakan kunci aset kustom. Aset tersebut harus memiliki format "networks/{network_code}/customAssets/{asset_code}"
content

string

Opsional. Ini adalah cara alternatif untuk mengidentifikasi LiveStreamEvent, jika dikaitkan dengan bagian konten dalam GAM. Formatnya harus "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"
page_size

int32

Opsional. Jumlah maksimum jeda iklan yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, maksimal 10 jeda iklan akan ditampilkan. Nilai maksimumnya adalah 100; nilai di atas 100 akan dikonversi menjadi 100.
page_token

string

Opsional. Token halaman, diterima dari panggilan ListAdBreaks sebelumnya. Berikan ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk ListAdBreaks harus sesuai dengan panggilan yang memberikan token halaman.

ListAdBreaksResponse

Respons untuk AdBreakNotificationService.ListAdBreaks.

Kolom
ad_breaks[]

AdBreak

Hanya output. Daftar Jeda Iklan yang cocok dengan LiveStreamEvent yang diminta.
next_page_token

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak ada halaman berikutnya.

Metadata

Metadata kustom konten.

Kolom
key_values

map<string, Value>

Mengidentifikasi metadata kustom konten sebagai pasangan nilai kunci. Hanya string atau daftar string yang diterima untuk nilai.

SyndicatedVideoContentNames

Daftar nama semua konten yang didistribusikan secara offline.

Kolom
syndicated_video_content[]

string

Kolom berulang dari nama konten yang didistribusikan. Formatnya harus "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" dan harus berasal dari jaringan yang sama dengan konten yang berisi kolom ini.

UpdateVideoContentRequest

Permintaan untuk [VideoContentIngestionService.UpdateVideoContentRequest][].

Kolom
video_content

VideoContent

Wajib. Metadata konten.

Konten Video

Metadata konten.

Kolom
name

string

Hanya output. Nama resource konten video. Kolom ini memiliki format: 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'

network_code adalah kode jaringan di Google Ad Manager yang memiliki konten ini.

content_source_id adalah ID sumber konten di Google Ad Manager tempat konten ini seharusnya berada.

cms_content_id adalah ID konten CMS di Google Ad Manager, yang dibuat sebagai bagian permintaan iklan untuk mengidentifikasi iklan mana yang dapat ditayangkan oleh Ad Manager pada video yang sesuai. Nilai ini dapat berupa numerik atau alfanumerik.
status

VideoContentStatus

Status konten. Jika dihilangkan, nilai default akan aktif.
title

string

Wajib. Judul konten.
update_time

Timestamp

Wajib. Waktu perubahan terakhir pada konten.
publish_time

Timestamp

Waktu publikasi konten. Kolom ini wajib diisi, jika video didesain untuk disertakan dalam Aturan Iklan yang menentukan waktu mulai dan berakhir.
duration

Duration

Durasi konten. Durasi didukung hingga ke tingkat milidetik.
cue_points[]

Duration

Mengidentifikasi titik tanda. Titik tanda adalah penempatan waktu saat iklan disisipkan dalam video. Titik tanda didukung hingga tingkat milidetik. Kolom ini wajib diisi, jika video berisi jeda iklan mid-roll.
thumbnail_url

string

URL thumbnail konten.
metadata

Metadata

Mengidentifikasi metadata kustom konten.
gracenote_metadata

GracenoteMetadata

Metadata terkait Gracenote dari konten.
syndication_metadata

VideoContentSyndicationInfo

Metadata terkait distribusi konten.
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

Metadata terkait Penyisipan Iklan Dinamis pada konten.

VideoContentStatus

Opsi status untuk menayangkan atau tidak menayangkan iklan bertarget untuk suatu konten.

Enum
ACTIVE Iklan yang ditargetkan berdasarkan konten akan ditayangkan.
BLOCKED Iklan tidak akan ditayangkan di konten ini jika statusnya DIBLOKIR.
DELETED Konten akan diarsipkan di Ad Manager. Jika Ad Manager menerima permintaan iklan untuk konten yang ditandai sebagai DIHAPUS, iklan internal atau iklan yang ditargetkan ke unit inventaris atau kriteria penargetan lainnya tetap dapat ditayangkan. Untuk memblokir iklan, tetapkan status ke DIBLOKIR.

VideoContentSyndicationInfo

Metadata untuk menentukan hubungan antara konten kanonis dan konten yang disindikasikan.

Kolom
Kolom union syndication. VideoContentSyndiationMetadata hanya dapat berisi salah satu dari hal berikut. syndication hanya dapat berupa salah satu dari berikut:
canonical_video_content

string

Nama konten kanonis. ID tersebut harus memiliki format "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" dan harus berada di jaringan yang sama dengan konten yang berisi kolom ini.
syndicated_video_content_names

SyndicatedVideoContentNames

Kumpulan konten yang didistribusikan secara offline

VideoFormat

Format yang dapat mengenkode konten video.

Enum
VIDEO_FORMAT_UNSPECIFIED Format video belum ditentukan.
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

Metadata yang menentukan link ke file m3u8 yang digunakan untuk pengondisian dan pembuatan playlist.

Kolom
video_format

VideoFormat

Format video.
video_preconditioned

VideoPreconditioned

Untuk menunjukkan apakah konten sudah dikondisikan untuk iklan mid-roll atau belum, yang berarti segmen Anda sudah dipisah saat jeda iklan.
url

string

Link ke file m3u8.

VideoPreconditioned

Status kondisi konten video.

Enum
NO Belum dikondisikan.
YES Video telah dikondisikan/dibagi.