- 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. İşlemin durumu sdfdownloadtask.operations.get
ile alınabilir.
Hataları error.message
dosyasında bulabilirsiniz. error.details
değerinin 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 ( |
Alanlar | |
---|---|
version |
Zorunlu. İndirilen dosyanın SDF sürümü. |
Birlik 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: |
|
partner |
SDF'nin indirileceği iş ortağının kimliği. |
advertiser |
SDF'yi indirecek reklamverenin kimliği. |
Birlik 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: |
|
parent |
Seçilen dosya türlerine göre filtreler. Her dosyanın öğeleri, seçilen bir filtre öğesi grubuna göre filtrelenir. Filtre varlıkları, seçilen dosya türleriyle aynı veya bunların üst türünde olmalıdır. |
id |
Varlıkları varlık kimliklerine göre filtreler. |
inventory |
Envanter kaynaklarını kimliklerine göre filtreler. |
Yanıt gövdesi
Başarılı olursa yanıt metni, 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'a Genel Bakış başlıklı makaleyi inceleyin.
ParentEntityFilter
Seçilen filtre öğeleri grubuna ait seçili dosya türlerini filtreleyen bir filtreleme seçeneği.
JSON gösterimi |
---|
{ "fileType": [ enum ( |
Alanlar | |
---|---|
file |
Zorunlu. Döndürülecek dosya türleri. |
filter |
Zorunlu. Getirilen öğeleri filtrelemek için kullanılan filtre türü. |
filter |
Belirtilen filtre türünün kimlikleri. Bu, getirilecek öğeleri filtrelemek için kullanılır. Filtre türü |
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. |
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 - QA biçimi. |
FILE_TYPE_AD_GROUP_QA |
YouTube Reklam Grubu - QA biçimi. |
FilterType
Filtre uygulanabilecek 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 herhangi bir filtre uygulanmaz. Yalnızca CreateSdfDownloadTaskRequest öğesinde 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çiliyse tüm filtre kimlikleri, CreateSdfDownloadTaskRequest 'de 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 öğ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 politikasında belirtilen Advertiser veya Partner alanına 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 | |
---|---|
campaign |
Kimliğe göre indirilecek kampanyalar. Tüm kimlikler, |
media |
Kimliğe göre indirilecek medya ürünleri. Tüm kimlikler, |
insertion |
Kimliğe göre indirilecek Kampanya Siparişleri. Tüm kimlikler, |
line |
Kimliğe göre indirilecek satır öğeleri. Tüm kimlikler, |
ad |
Kimliğe göre indirilecek YouTube reklam grupları. Tüm kimlikler, |
ad |
Kimliğe göre indirilecek YouTube Reklamları. Tüm kimlikler, |
line |
İsteğe bağlı. QA biçiminde indirilecek satır öğeleri (kimliğe göre). Tüm kimlikler, |
ad |
İsteğe bağlı. QA biçiminde indirilecek YouTube reklam grupları (kimliğe göre). Tüm kimlikler, |
InventorySourceFilter
Envanter Kaynağı öğelerini filtrelemek için bir filtreleme seçeneği.
JSON gösterimi |
---|
{ "inventorySourceIds": [ string ] } |
Alanlar | |
---|---|
inventory |
Kimliğe göre indirilecek envanter kaynakları. Tüm kimlikler, |