Method: sdfdownloadtasks.create

SDF indirme görevi oluşturur. Operation döndürür.

SDF indirme görevi, uzun süren eşzamansız bir işlemdir. Bu işlemin metadata türü SdfDownloadTaskMetadata. İstek başarılı olursa işlemin response türü SdfDownloadTask olur. Yanıt, media.download ile alınması gereken indirme dosyalarını içermez.

İşlemin durumu sdfdownloadtasks.operations.get ile alınabilir.

Hataları error.message bölümünde bulabilirsiniz. error.details alanının boş olması gerektiğini unutmayın.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "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.
}
Alanlar
version

enum (SdfVersion)

Zorunlu. İndirilen dosyanın SDF sürümü. SDF_VERSION_UNSPECIFIED olarak ayarlanırsa bu, varsayılan olarak root_id tarafından tanımlanan reklamveren veya iş ortağı tarafından belirtilen sürüme ayarlanır. Reklamveren, aksi şekilde yapılandırılmadığı sürece SDF sürümünü iş ortağından devralır.
Zorunlu. Kök kimliği, indirme isteğinin bağlamını belirler. Tam olarak bir alan ayarlanmalıdır. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta alanlardan en fazla biri ayarlanır:
partnerId

string (int64 format)

SDF'nin indirileceği iş ortağının kimliği.
advertiserId

string (int64 format)

SDF'si indirilecek reklamverenin kimliği.
Birbirini hariç tutan alanların sonu.
Zorunlu. İndirilecek varlık türlerini ve aralıklarını belirten seçenekler. Tam olarak bir alan ayarlanmalıdır. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta alanlardan en fazla biri ayarlanır:
parentEntityFilter

object (ParentEntityFilter)

Seçili dosya türlerine göre filtreler. Her dosyadaki varlıklar, seçilen bir filtre varlıkları grubu tarafından filtrelenir. Filtre varlıkları, seçilen dosya türleriyle aynı türde veya bunların üst türü olmalıdır.
idFilter

object (IdFilter)

Varlıkları, varlık kimliklerine göre filtreler.
inventorySourceFilter

object (InventorySourceFilter)

Envanter kaynaklarını kimliklerine göre filtreler.
Birbirini hariç tutan alanların sonu.

Yanıt metni

Başarılıysa yanıt metni, Operation öğesinin yeni oluşturulan bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0 Overview sayfasını inceleyin.

ParentEntityFilter

Seçilen bir filtre varlıkları grubuna ait seçili dosya türlerini filtreleyen bir filtreleme seçeneği.

JSON gösterimi 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
Alanlar
fileType[]

enum (FileType)

Zorunlu. Döndürülecek dosya türleri.
filterType

enum (FilterType)

Zorunlu. Getirilen varlıkları filtrelemek için kullanılan filtre türü.
filterIds[]

string (int64 format)

Belirtilen filtre türünün kimlikleri. Bu, getirilecek varlıkları filtrelemek için kullanılır. Filtre türü FILTER_TYPE_NONE değilse en az bir kimlik belirtilmelidir.

FileType

İndirilebilecek olası dosya türleri.

Sıralamalar
FILE_TYPE_UNSPECIFIED Tür belirtilmediğinde veya bu sürümde bilinmediğinde kullanılan varsayılan değer.
FILE_TYPE_CAMPAIGN Kampanya.
FILE_TYPE_MEDIA_PRODUCT Medya Ürünü.
FILE_TYPE_INSERTION_ORDER Kampanya siparişi.
FILE_TYPE_LINE_ITEM Satır öğesi.
FILE_TYPE_AD_GROUP YouTube Reklam Grubu.
FILE_TYPE_AD YouTube reklamı.
FILE_TYPE_LINE_ITEM_QA Satır öğesi - Kalite güvencesi biçimi.
FILE_TYPE_AD_GROUP_QA YouTube reklam grubu - KG biçimi.

FilterType

Filtrelenebilecek olası türler.

Sıralamalar
FILTER_TYPE_UNSPECIFIED Tür belirtilmediğinde veya bu sürümde bilinmediğinde varsayılan değerdir.
FILTER_TYPE_NONE Seçilirse indirme işlemine filtre uygulanmaz. Yalnızca CreateSdfDownloadTaskRequest içinde bir Advertiser belirtilmişse kullanılabilir.
FILTER_TYPE_ADVERTISER_ID Reklamveren kimliği. Seçilirse tüm filtre kimlikleri, CreateSdfDownloadTaskRequest içinde belirtilen Partner öğesine ait reklamveren kimlikleri olmalıdır.
FILTER_TYPE_CAMPAIGN_ID Kampanya kimliği. Seçilirse tüm filtre kimlikleri, CreateSdfDownloadTaskRequest içinde belirtilen Advertiser veya Partner'ye ait kampanya kimlikleri olmalıdır.
FILTER_TYPE_MEDIA_PRODUCT_ID Medya ürün kimliği. Seçilirse tüm filtre kimlikleri, CreateSdfDownloadTaskRequest içinde belirtilen Advertiser veya Partner'e ait medya ürünü kimlikleri olmalıdır. Yalnızca FILE_TYPE_MEDIA_PRODUCT indirmek için kullanılabilir.
FILTER_TYPE_INSERTION_ORDER_ID Kampanya siparişi kimliği. Seçilirse tüm filtre kimlikleri, CreateSdfDownloadTaskRequest içinde belirtilen Advertiser veya Partner'e ait kampanya siparişi kimlikleri olmalıdır. Yalnızca FILE_TYPE_INSERTION_ORDER, FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA ve FILE_TYPE_AD indirmek için kullanılabilir.
FILTER_TYPE_LINE_ITEM_ID Satır öğesi kimliği. Seçilirse tüm filtre kimlikleri, CreateSdfDownloadTaskRequest içinde belirtilen Advertiser veya Partner'ye ait satır öğesi kimlikleri olmalıdır. Yalnızca FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA,FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA ve FILE_TYPE_AD indirmek için kullanılabilir.

IdFilter

Varlıkları varlık kimliklerine göre filtreleyen bir filtreleme seçeneği.

JSON gösterimi 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ],
  "lineItemQaIds": [
    string
  ],
  "adGroupQaIds": [
    string
  ]
}
Alanlar
campaignIds[]

string (int64 format)

Kimliğe göre indirilecek kampanyalar. Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen aynı Advertiser veya Partner değerine ait olmalıdır.
mediaProductIds[]

string (int64 format)

Kimliğe göre indirilecek medya ürünleri. Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen aynı Advertiser veya Partner değerine ait olmalıdır.
insertionOrderIds[]

string (int64 format)

Kimliğe göre indirilecek kampanya siparişleri. Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen aynı Advertiser veya Partner değerine ait olmalıdır.
lineItemIds[]

string (int64 format)

Kimliğe göre indirilecek satır öğeleri. Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen aynı Advertiser veya Partner değerine ait olmalıdır.
adGroupIds[]

string (int64 format)

Kimliğe göre indirilecek YouTube reklam grupları. Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen aynı Advertiser veya Partner değerine ait olmalıdır.
adGroupAdIds[]

string (int64 format)

YouTube reklamlarını kimliğe göre indirme Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen aynı Advertiser veya Partner değerine ait olmalıdır.
lineItemQaIds[]

string (int64 format)

İsteğe bağlıdır. Kalite güvencesi biçiminde indirilecek satır öğeleri (kimliğe göre). Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen aynı Advertiser veya Partner değerine ait olmalıdır.
adGroupQaIds[]

string (int64 format)

İsteğe bağlıdır. Kalite güvencesi biçiminde indirilecek YouTube reklam grupları (kimliğe göre). Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen aynı Advertiser veya Partner değerine ait olmalıdır.

InventorySourceFilter

Envanter kaynağı öğelerini filtrelemek için kullanılan bir filtreleme seçeneği.

JSON gösterimi 
{
  "inventorySourceIds": [
    string
  ]
}
Alanlar
inventorySourceIds[]

string (int64 format)

Kimliğe göre indirilecek envanter kaynakları. Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen aynı Advertiser veya Partner değerine ait olmalıdır. Seçilen reklamveren veya iş ortağı için tüm envanter kaynaklarını indirmek istiyorsanız boş bırakın.