Method: sdfdownloadtasks.create

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 response operasi adalah SdfDownloadTask. Responsnya tidak akan menyertakan file yang didownload, yang harus diambil dengan media.download. Status operasi dapat diambil dengan sdfdownloadtask.operations.get.

Semua error dapat ditemukan di error.message. Perlu diperhatikan bahwa error.details seharusnya kosong.

Permintaan HTTP

POST https://displayvideo.googleapis.com/v1/sdfdownloadtasks

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "version": enum (SdfVersion),

  // Union field root_id can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field root_id.

  // Union field filtering_option can be only one of the following:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of list of possible types for union field filtering_option.
}
Kolom
version

enum (SdfVersion)

Wajib. Versi SDF file yang didownload. Jika ditetapkan ke SDF_VERSION_UNSPECIFIED, versi ini akan ditetapkan secara default ke versi yang ditentukan oleh pengiklan atau partner yang diidentifikasi oleh root_id. Pengiklan mewarisi versi SDF dari partnernya kecuali jika dikonfigurasi lain.
Kolom union root_id. Wajib. ID root menentukan konteks permintaan download. Hanya satu kolom yang harus ditetapkan. root_id hanya ada berupa salah satu diantara berikut:
partnerId

string (int64 format)

ID partner untuk mendownload SDF.
advertiserId

string (int64 format)

ID pengiklan untuk mendownload SDF.
Kolom union filtering_option. Wajib. Opsi yang menentukan jenis dan rentang entity yang akan didownload. Hanya satu kolom yang harus ditetapkan. filtering_option hanya ada berupa salah satu diantara berikut:
parentEntityFilter

object (ParentEntityFilter)

Filter pada jenis file yang dipilih. Entitas dalam setiap file difilter menurut kumpulan entitas filter yang dipilih. Entitas filter harus sama jenisnya dengan, atau merupakan jenis induk dari, jenis file yang dipilih.
idFilter

object (IdFilter)

Memfilter entitas menurut ID entitasnya.
inventorySourceFilter

object (InventorySourceFilter)

Memfilter Sumber Inventaris menurut ID-nya.

Isi respons

Jika berhasil, isi respons memuat instance Operation yang baru dibuat.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/display-video

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

ParentEntityFilter

Opsi pemfilteran yang memfilter jenis file tertentu yang termasuk dalam kumpulan entitas filter yang dipilih.

Representasi JSON 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
Kolom
fileType[]

enum (FileType)

Wajib. Jenis file yang akan ditampilkan.
filterType

enum (FilterType)

Wajib. Jenis filter yang digunakan untuk memfilter entitas yang diambil.
filterIds[]

string (int64 format)

ID jenis filter yang ditentukan. Ini digunakan untuk memfilter entity yang akan diambil. Jika jenis filter bukan FILTER_TYPE_NONE, setidaknya satu ID harus ditentukan.

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

Kemungkinan jenis yang 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 hasil download. Hanya dapat digunakan jika Advertiser ditentukan di CreateSdfDownloadTaskRequest.
FILTER_TYPE_ADVERTISER_ID ID Pengiklan. Jika dipilih, semua ID filter harus berupa ID Pengiklan yang termasuk dalam Partner yang ditentukan di CreateSdfDownloadTaskRequest.
FILTER_TYPE_CAMPAIGN_ID ID kampanye. Jika dipilih, semua ID filter harus berupa ID Kampanye yang termasuk dalam Advertiser atau Partner yang ditentukan di 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 Pesanan Pemasangan Iklan yang termasuk dalam Advertiser atau Partner yang ditentukan di 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 termasuk dalam Advertiser atau Partner yang ditentukan di CreateSdfDownloadTaskRequest. Hanya dapat digunakan untuk mendownload FILE_TYPE_LINE_ITEM, FILE_TYPE_AD_GROUP, dan FILE_TYPE_AD.

IdFilter

Opsi pemfilteran yang memfilter entitas menurut ID entitasnya.

Representasi JSON 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ]
}
Kolom
campaignIds[]

string (int64 format)

Kampanye yang akan didownload menurut ID. Semua ID harus berasal dari Advertiser atau Partner yang sama seperti yang ditentukan di CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

Produk Media untuk didownload menurut ID. Semua ID harus berasal dari Advertiser atau Partner yang sama seperti yang ditentukan di CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

Pesanan Pemasangan Iklan yang akan didownload menurut ID. Semua ID harus berasal dari Advertiser atau Partner yang sama seperti yang ditentukan di CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

Item Baris yang akan didownload menurut ID. Semua ID harus berasal dari Advertiser atau Partner yang sama seperti yang ditentukan di CreateSdfDownloadTaskRequest.
adGroupIds[]

string (int64 format)

Grup Iklan YouTube yang akan didownload menurut ID. Semua ID harus berasal dari Advertiser atau Partner yang sama seperti yang ditentukan di CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

Iklan YouTube yang akan didownload menurut ID. Semua ID harus berasal dari Advertiser atau Partner yang sama seperti yang ditentukan di CreateSdfDownloadTaskRequest.

InventorySourceFilter

Opsi pemfilteran untuk memfilter entitas Sumber Inventaris.

Representasi JSON 
{
  "inventorySourceIds": [
    string
  ]
}
Kolom
inventorySourceIds[]

string (int64 format)

Sumber Inventaris untuk didownload menurut ID. Semua ID harus berasal dari Advertiser atau Partner yang sama seperti yang ditentukan di CreateSdfDownloadTaskRequest. Biarkan kosong untuk mendownload semua Sumber Inventaris untuk Pengiklan atau Partner yang dipilih.