- Permintaan HTTP
- Isi Permintaan
- Isi respons
- Cakupan otorisasi
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- Cobalah!
Membuat Tugas Download SDF. Menampilkan Operation
.
Tugas Download SDF adalah operasi asinkron yang berjalan lama. Jenis metadata
operasi ini adalah SdfDownloadTaskMetadata
. Jika permintaan berhasil, jenis operasi response
adalah SdfDownloadTask
. Respons tidak akan menyertakan file yang didownload, yang harus diambil dengan media.download
. Status operasi dapat diambil dengan sdfdownloadtask.operations.get
.
Error dapat ditemukan di error.message
. Perhatikan bahwa error.details
diharapkan kosong.
Permintaan HTTP
POST https://displayvideo.googleapis.com/v2/sdfdownloadtasks
URL menggunakan sintaksis gRPC Transcoding.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "version": enum ( |
Kolom | |
---|---|
version |
Wajib. Versi SDF dari file yang didownload. Jika ditetapkan ke |
Kolom union root_id . Wajib. ID root menentukan konteks permintaan download. Hanya satu kolom yang harus ditetapkan. root_id hanya dapat berupa salah satu dari berikut: |
|
partnerId |
ID partner yang akan didownload SDF. |
advertiserId |
ID pengiklan yang akan didownload SDF. |
Kolom union filtering_option . Wajib. Opsi yang menentukan jenis dan rentang entitas yang akan didownload. Hanya satu kolom yang harus ditetapkan. filtering_option hanya dapat berupa salah satu dari berikut: |
|
parentEntityFilter |
Filter pada jenis file yang dipilih. Entitas di setiap file difilter menurut kumpulan entitas filter yang dipilih. Entitas filter harus sama dengan jenis file atau jenis induk dari jenis file yang dipilih. |
idFilter |
Filter pada entitas berdasarkan ID entitasnya. |
inventorySourceFilter |
Filter pada Sumber Inventaris menurut ID-nya. |
Isi respons
Jika berhasil, isi respons memuat instance Operation
yang baru dibuat.
Cakupan otorisasi
Memerlukan cakupan OAuth berikut:
https://www.googleapis.com/auth/display-video
Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
ParentEntityFilter
Opsi pemfilteran yang memfilter jenis file yang dipilih yang termasuk dalam kumpulan entitas filter yang dipilih.
Representasi JSON |
---|
{ "fileType": [ enum ( |
Kolom | |
---|---|
fileType[] |
Wajib. Jenis file yang akan ditampilkan. |
filterType |
Wajib. Jenis filter yang digunakan untuk memfilter entity yang diambil. |
filterIds[] |
ID jenis filter yang ditentukan. Atribut ini digunakan untuk memfilter entity yang akan diambil. Jika jenis filter bukan |
FileType
Kemungkinan jenis file yang dapat didownload.
Enum | |
---|---|
FILE_TYPE_UNSPECIFIED |
Nilai default saat jenis tidak ditentukan atau tidak diketahui dalam versi ini. |
FILE_TYPE_CAMPAIGN |
Kampanye. |
FILE_TYPE_MEDIA_PRODUCT |
Produk Media. |
FILE_TYPE_INSERTION_ORDER |
Pesanan Pemasangan Iklan. |
FILE_TYPE_LINE_ITEM |
Item Baris. |
FILE_TYPE_AD_GROUP |
Grup Iklan YouTube. |
FILE_TYPE_AD |
Iklan YouTube. |
FilterType
Jenis yang mungkin dapat difilter.
Enum | |
---|---|
FILTER_TYPE_UNSPECIFIED |
Nilai default saat jenis tidak ditentukan atau tidak diketahui dalam versi ini. |
FILTER_TYPE_NONE |
Jika dipilih, tidak ada filter yang akan diterapkan pada download. Hanya dapat digunakan jika Advertiser ditentukan dalam CreateSdfDownloadTaskRequest . |
FILTER_TYPE_ADVERTISER_ID |
ID Pengiklan. Jika dipilih, semua ID filter harus berupa ID Pengiklan yang memiliki Partner yang ditentukan di CreateSdfDownloadTaskRequest . |
FILTER_TYPE_CAMPAIGN_ID |
ID kampanye. Jika dipilih, semua ID filter harus berupa ID Kampanye yang menjadi bagian dari Advertiser atau Partner yang ditentukan dalam CreateSdfDownloadTaskRequest . |
FILTER_TYPE_MEDIA_PRODUCT_ID |
ID Produk Media. Jika dipilih, semua ID filter harus berupa ID Produk Media yang termasuk dalam Advertiser atau Partner yang ditentukan di CreateSdfDownloadTaskRequest . Hanya dapat digunakan untuk mendownload FILE_TYPE_MEDIA_PRODUCT . |
FILTER_TYPE_INSERTION_ORDER_ID |
ID Pesanan Pemasangan Iklan. Jika dipilih, semua ID filter harus berupa ID Perjanjian Pemasangan Iklan yang menjadi milik Advertiser atau Partner yang ditentukan dalam CreateSdfDownloadTaskRequest . Hanya dapat digunakan untuk mendownload FILE_TYPE_INSERTION_ORDER , FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP , dan FILE_TYPE_AD . |
FILTER_TYPE_LINE_ITEM_ID |
ID Item Baris. Jika dipilih, semua ID filter harus berupa ID Item Baris yang menjadi bagian dari Advertiser atau Partner yang ditentukan dalam CreateSdfDownloadTaskRequest . Hanya dapat digunakan untuk mendownload FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP , dan FILE_TYPE_AD . |
IdFilter
Opsi pemfilteran yang memfilter entitas berdasarkan ID entitasnya.
Representasi JSON |
---|
{ "campaignIds": [ string ], "mediaProductIds": [ string ], "insertionOrderIds": [ string ], "lineItemIds": [ string ], "adGroupIds": [ string ], "adGroupAdIds": [ string ] } |
Kolom | |
---|---|
campaignIds[] |
Kampanye yang akan didownload menurut ID. Semua ID harus milik |
mediaProductIds[] |
Produk Media yang akan didownload menurut ID. Semua ID harus milik |
insertionOrderIds[] |
Perjanjian Pemasangan Iklan untuk didownload menurut ID. Semua ID harus milik |
lineItemIds[] |
Item Baris yang akan didownload menurut ID. Semua ID harus milik |
adGroupIds[] |
Grup Iklan YouTube untuk didownload menurut ID. Semua ID harus milik |
adGroupAdIds[] |
Iklan YouTube yang akan didownload menurut ID. Semua ID harus milik |
InventorySourceFilter
Opsi pemfilteran untuk memfilter entitas Sumber Inventaris.
Representasi JSON |
---|
{ "inventorySourceIds": [ string ] } |
Kolom | |
---|---|
inventorySourceIds[] |
Sumber Inventaris yang akan didownload menurut ID. Semua ID harus milik |