Method: sdfdownloadtasks.create

SDF İndirme Görevi oluşturur. Bir 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 işlemin response türü SdfDownloadTask olur. Yanıt, media.download ile alınması gereken indirme dosyalarını içermez. İşlem durumu sdfdownloadtask.operations.get ile alınabilir.

Hatalar error.message bölümünde bulunabilir. error.details öğesinin 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ıyla birlikte veriler 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 değerine ayarlanırsa bu varsayılan olarak, reklamveren veya iş ortağı tarafından root_id tarafından tanımlanan sürüm olur. Aksi yapılandırılmadığı sürece bir reklamveren, iş ortağından SDF sürümünü devralır.
root_id alanı. Zorunlu. Kök kimliği, 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 indirilecek iş ortağının kimliği.
advertiserId

string (int64 format)

SDF'yi indirilecek reklamverenin kimliği.
filtering_option alanı. 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ürlerine göre filtreler. Her bir dosyadaki varlıklar, seçili filtre varlıkları grubuna göre filtrelenir. Filtre varlıkları, seçilen dosya türleriyle aynı türde 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şturulan 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'a Genel Bakış başlıklı makaleye bakın.

ParentEntityFilter

Belirli bir filtre varlıkları grubuna ait seçili dosya türlerine göre filtreleme yapan 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. 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 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'ni tıklayın.
FILE_TYPE_AD_GROUP YouTube Reklam Grubu.
FILE_TYPE_AD YouTube Reklamı.

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, indirmeye 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 politikasında belirtilen Partner öğesine ait reklamveren kimlikleri olmalıdır.
FILTER_TYPE_CAMPAIGN_ID Kampanya Kimliği. Seçilirse tüm filtre kimlikleri, CreateSdfDownloadTaskRequest öğesinde belirtilen Advertiser veya Partner öğesine 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 öğ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 öğesine ait Kampanya Siparişi kimlikleri olmalıdır. Yalnızca FILE_TYPE_INSERTION_ORDER, FILE_TYPE_LINE_ITEM, FILE_TYPE_AD_GROUP ve FILE_TYPE_AD verilerini 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_AD_GROUP ve FILE_TYPE_AD uygulamalarını 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
  ]
}
Alanlar
campaignIds[]

string (int64 format)

Kimliğe göre indirilecek kampanyalar. Tüm kimlikler, CreateSdfDownloadTaskRequest öğesinde 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 öğesinde 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 öğesinde 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 öğesinde 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 öğesinde belirtilen aynı Advertiser veya Partner öğesine ait olmalıdır.
adGroupAdIds[]

string (int64 format)

Kimliğe göre indirilecek YouTube Reklamları. Tüm kimlikler, CreateSdfDownloadTaskRequest öğesinde belirtilen aynı Advertiser veya Partner öğesine ait olmalıdır.

InventorySourceFilter

Envanter Kaynağı varlıklarında filtreleme 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 öğesinde belirtilen aynı 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.