Method: sdfdownloadtasks.create

Bir SDF indirme görevi oluşturur. Operation değerini 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 sdfdownloadtask.operations.get ile alınabilir.

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

HTTP isteği

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

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

İstek içeriği

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

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

enum (SdfVersion)

Zorunlu. İndirilen dosyanın SDF sürümü. SDF_VERSION_UNSPECIFIED olarak ayarlanırsa bu, root_id ile tanımlanan reklamveren veya iş ortağı tarafından belirtilen sürüme varsayılan olarak ayarlanır. Aksi yapılandırılmadığı sürece reklamverenler, SDF sürümlerini iş ortaklarından devralır.
Birleştirme alanı root_id. Zorunlu. Kök kimlik, indirme isteğinin bağlamını belirler. Tam olarak bir alan ayarlanmalıdır. root_id yalnızca aşağıdakilerden biri olabilir:
partnerId

string (int64 format)

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

string (int64 format)

SDF'nin indirileceği reklamverenin kimliği.
Birleştirme alanı filtering_option. Zorunlu. İndirilecek varlık türlerini ve aralıklarını belirten seçenekler. Tam olarak bir alan ayarlanmalıdır. filtering_option yalnızca aşağıdakilerden biri olabilir:
parentEntityFilter

object (ParentEntityFilter)

Seçili dosya türlerine göre filtreler. Her dosyadaki öğeler, seçilen bir filtre öğeleri grubuyla filtrelenir. Filtre öğeleri, seçilen dosya türleriyle aynı türde veya seçilen dosya türlerinin üst türünde olmalıdır.
idFilter

object (IdFilter)

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

object (InventorySourceFilter)

Envanter kaynaklarını kimliklerine göre filtreleyin.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, Operation öğesinin yeni oluşturulmuş 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ına bakın.

ParentEntityFilter

Seçilen filtreleme öğeleri grubuna ait 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 öğeleri filtrelemek için kullanılan filtre türü.
filterIds[]

string (int64 format)

Belirtilen filtre türünün kimlikleri. Bu, getirilecek öğeleri 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 varsayılan değer.
FILE_TYPE_CAMPAIGN Kampanya'yı tıklayın.
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 - Soru-cevap biçimi.
FILE_TYPE_AD_GROUP_QA YouTube reklam grubu - QA 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ğer.
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, Partner içinde belirtilen CreateSdfDownloadTaskRequest'ya 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'a 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'ye 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 politikasında belirtilen Advertiser veya Partner'a 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 öğesine 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 öğesine 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 öğesine 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 öğesine 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 öğesine 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 öğesine ait olmalıdır.
adGroupAdIds[]

string (int64 format)

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

string (int64 format)

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

string (int64 format)

İsteğe bağlı. Kalite kontrolü biçiminde indirmek için kimliğe göre YouTube reklam grupları. Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen aynı Advertiser veya Partner öğesine ait olmalıdır.

InventorySourceFilter

Envanter kaynağı öğelerine göre 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 öğesine ait olmalıdır. Seçili reklamveren veya iş ortağı için tüm envanter kaynaklarını indirmek üzere boş bırakın.