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 operasi response adalah SdfDownloadTask. Respons tidak akan menyertakan file download, yang harus diambil dengan media.download.

Status operasi dapat diambil dengan sdfdownloadtasks.operations.get.

Error apa pun dapat ditemukan di error.message. Perhatikan bahwa error.details diperkirakan akan kosong.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of mutually exclusive fields.
}
Kolom
version

enum (SdfVersion)

Wajib. Versi SDF file yang didownload. Jika ditetapkan ke SDF_VERSION_UNSPECIFIED, parameter 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.
Wajib. ID root menentukan konteks permintaan download. Hanya satu kolom yang harus ditetapkan. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
partnerId

string (int64 format)

ID partner yang SDF-nya akan didownload.
advertiserId

string (int64 format)

ID pengiklan yang SDF-nya akan didownload.
Akhir kolom yang saling eksklusif.
Wajib. Opsi yang menentukan jenis dan rentang entity yang akan didownload. Hanya satu kolom yang harus ditetapkan. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
parentEntityFilter

object (ParentEntityFilter)

Memfilter menurut jenis file yang dipilih. Entitas di setiap file difilter berdasarkan kumpulan entitas filter yang dipilih. Entitas filter harus memiliki jenis yang sama dengan, atau jenis induk dari, jenis file yang dipilih.
idFilter

object (IdFilter)

Memfilter entity berdasarkan ID entity-nya.
inventorySourceFilter

object (InventorySourceFilter)

Memfilter Sumber Inventaris berdasarkan ID-nya.
Akhir kolom yang saling eksklusif.

Isi respons

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

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

ParentEntityFilter

Opsi pemfilteran yang memfilter jenis file yang dipilih 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 entity yang diambil.
filterIds[]

string (int64 format)

ID jenis filter yang ditentukan. Hal ini digunakan untuk memfilter entity yang akan diambil. Jika jenis filter bukan FILTER_TYPE_NONE, minimal satu ID harus ditentukan.

FileType

Kemungkinan jenis file yang dapat didownload.

Enum
FILE_TYPE_UNSPECIFIED Nilai default jika 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.
FILE_TYPE_LINE_ITEM_QA Item Baris - Format QA.
FILE_TYPE_AD_GROUP_QA Grup Iklan YouTube - Format QA.

FilterType

Kemungkinan jenis yang dapat difilter.

Enum
FILTER_TYPE_UNSPECIFIED Nilai default jika jenis tidak ditentukan atau tidak diketahui dalam versi ini.
FILTER_TYPE_NONE Jika dipilih, tidak ada filter yang akan diterapkan ke 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_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA, 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_LINE_ITEM_QA,FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA, dan FILE_TYPE_AD.

IdFilter

Opsi pemfilteran yang memfilter entity berdasarkan ID entity-nya.

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

string (int64 format)

Kampanye yang akan didownload menurut ID. Semua ID harus termasuk dalam Advertiser atau Partner yang sama yang ditentukan di CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

Produk Media yang akan didownload berdasarkan ID. Semua ID harus termasuk dalam Advertiser atau Partner yang sama yang ditentukan di CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

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

string (int64 format)

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

string (int64 format)

Grup Iklan YouTube yang akan didownload berdasarkan ID. Semua ID harus termasuk dalam Advertiser atau Partner yang sama yang ditentukan di CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

Iklan YouTube yang akan didownload menurut ID. Semua ID harus termasuk dalam Advertiser atau Partner yang sama yang ditentukan di CreateSdfDownloadTaskRequest.
lineItemQaIds[]

string (int64 format)

Opsional. Item Baris, berdasarkan ID, yang akan didownload dalam format QA. Semua ID harus termasuk dalam Advertiser atau Partner yang sama yang ditentukan di CreateSdfDownloadTaskRequest.
adGroupQaIds[]

string (int64 format)

Opsional. Grup Iklan YouTube, berdasarkan ID, untuk didownload dalam format QA. Semua ID harus termasuk dalam Advertiser atau Partner yang sama yang ditentukan di CreateSdfDownloadTaskRequest.

InventorySourceFilter

Opsi pemfilteran untuk memfilter entity Sumber Inventaris.

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

string (int64 format)

Sumber Inventaris yang akan didownload menurut ID. Semua ID harus termasuk dalam Advertiser atau Partner yang sama yang ditentukan di CreateSdfDownloadTaskRequest. Biarkan kosong untuk mendownload semua Sumber Inventaris untuk Pengiklan atau Partner yang dipilih.