Method: sdfdownloadtasks.create

SDF İndirme Görevi oluşturur. Operation döndürür.

SDF İndirme Görevi, uzun süreli, eşzamansız bir işlemdir. Bu işlemin metadata türü SdfDownloadTaskMetadata. İstek başarılı olursa response işlemin 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.

Tüm hataları error.message içinde bulabilirsiniz. error.details sütununun 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 gövdesi, aşağıdaki yapıya sahip 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 ayar varsayılan olarak reklamveren veya iş ortağı tarafından root_id tarafından belirtilen sürüme ayarlanır. Reklamveren, aksi yapılandırılmadığı sürece SDF sürümünü iş ortağı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 şunlardan yalnızca biri olabilir:
partnerId

string (int64 format)

SDF'yi indirecek iş ortağının kimliği.
advertiserId

string (int64 format)

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

object (ParentEntityFilter)

Seçili dosya türlerinde filtreler. Her dosyadaki varlıklar, seçilen bir filtre varlıkları grubuna göre filtrelenir. Filtre varlıkları, seçilen dosya türleriyle aynı veya bunların ü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 filtreler.

Yanıt gövdesi

Başarılı olursa yanıt gövdesi, yeni oluşturulmuş bir Operation ö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 (OAuth 2.0'a Genel Bakış) sayfasına göz atın.

ParentEntityFilter

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

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. 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 belirtilmemişse veya bu sürümde bilinmiyorsa 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 - KG 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 belirtilmemişse veya bu sürümde bilinmiyorsa varsayılan değer.
FILTER_TYPE_NONE Seçilirse indirme işlemine herhangi bir filtre uygulanmaz. Yalnızca CreateSdfDownloadTaskRequest özelliğinde 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 için geçerli olan 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 öğesine ait medya ürün kimlikleri olmalıdır. Yalnızca FILE_TYPE_MEDIA_PRODUCT dosyasını 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 için olan 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 dosyalarını 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 dosyalarını indirmek için kullanılabilir.

IdFilter

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

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 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 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 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 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 Advertiser veya Partner öğesine ait olmalıdır.
adGroupAdIds[]

string (int64 format)

Kimliğe göre indirilecek YouTube Reklamları. Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen Advertiser veya Partner öğesine ait olmalıdır.
lineItemQaIds[]

string (int64 format)

İsteğe bağlı. KG biçiminde indirmek için kimliğe göre Satır Öğeleri. Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen Advertiser veya Partner öğesine ait olmalıdır.
adGroupQaIds[]

string (int64 format)

İsteğe bağlı. YouTube Reklam Grupları, KG biçiminde indirilir. Tüm kimlikler, CreateSdfDownloadTaskRequest içinde belirtilen Advertiser veya Partner öğesine ait olmalıdır.

InventorySourceFilter

Envanter Kaynağı varlıklarında filtreleme yapmak için 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 Advertiser veya Partner öğesine ait olmalıdır. Seçilen Reklamveren veya İş Ortağına ait tüm Envanter Kaynaklarını indirmek için boş bırakın.