- HTTP isteği
- İstek metni
- Yanıt metni
- Yetkilendirme kapsamları
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- Deneyin.
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/v2/sdfdownloadtasks
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
İstek içeriği
İsteğin gövdesi, aşağıdaki yapıya sahip veriler içerir:
JSON gösterimi |
---|
{ "version": enum ( |
Alanlar | |
---|---|
version |
Zorunlu. İndirilen dosyanın SDF sürümü. Bu politika |
Birleştirme alanı root_id . 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 |
SDF'yi indirilecek iş ortağının kimliği. |
advertiserId |
SDF'yi indirilecek 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 |
Seçili dosya türlerinde 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ünde olmalıdır. |
idFilter |
Varlıkları varlık kimliklerine göre filtreler. |
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 ( |
Alanlar | |
---|---|
fileType[] |
Zorunlu. Döndürülecek dosya türleri. |
filterType |
Zorunlu. Getirilen varlıkları filtrelemek için kullanılan filtre türü. |
filterIds[] |
Belirtilen filtre türünün kimlikleri. Bu, getirilecek varlıkları filtrelemek için kullanılır. Filtre türü |
FileType
İndirilebilecek olası dosya türleri.
Sıralamalar | |
---|---|
FILE_TYPE_UNSPECIFIED |
Bu sürümde tür belirtilmemişse veya 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
Filtre uygulanabilecek olası türler.
Sıralamalar | |
---|---|
FILTER_TYPE_UNSPECIFIED |
Bu sürümde tür belirtilmemişse veya 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 kimliğine ait reklamveren kimlikleri olmalıdır. |
FILTER_TYPE_CAMPAIGN_ID |
Kampanya Kimliği. Seçilirse tüm filtre kimlikleri, CreateSdfDownloadTaskRequest politikasında belirtilen Advertiser veya Partner etiketine ait Kampanya Kimlikleri olmalıdır. |
FILTER_TYPE_MEDIA_PRODUCT_ID |
Medya Ürünü Kimliği. Seçilirse tüm filtre kimlikleri, CreateSdfDownloadTaskRequest politikasında 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 öğelerini indirmek için kullanılabilir. |
FILTER_TYPE_LINE_ITEM_ID |
Satır Öğesi Kimliği. Seçilirse tüm filtre kimlikleri, CreateSdfDownloadTaskRequest politikasında 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 öğelerini 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[] |
Kimliğe göre indirilecek kampanyalar. Tüm kimlikler, |
mediaProductIds[] |
Kimliğe göre indirilecek Medya Ürünleri. Tüm kimlikler, |
insertionOrderIds[] |
Kimliğe göre indirilecek Kampanya Siparişleri. Tüm kimlikler, |
lineItemIds[] |
Kimliğe göre indirilecek Satır Öğeleri. Tüm kimlikler, |
adGroupIds[] |
Kimliğe göre indirilecek YouTube Reklam Grupları. Tüm kimlikler, |
adGroupAdIds[] |
Kimliğe göre indirilecek YouTube Reklamları. Tüm kimlikler, |
InventorySourceFilter
Envanter Kaynağı varlıklarında filtreleme için bir filtreleme seçeneği.
JSON gösterimi |
---|
{ "inventorySourceIds": [ string ] } |
Alanlar | |
---|---|
inventorySourceIds[] |
Kimliğe göre indirilecek Envanter Kaynakları. Tüm kimlikler, |