- בקשת HTTP
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- רוצים לנסות?
יצירת משימה להורדת SDF. הפונקציה מחזירה את הערך Operation
.
משימת הורדת SDF היא פעולה אסינכרונית וממושכת. סוג הmetadata
של הפעולה הזו הוא SdfDownloadTaskMetadata
. אם הבקשה תתבצע בהצלחה, סוג response
של הפעולה הוא SdfDownloadTask
. התגובה לא תכלול את הקבצים להורדה, שיש לאחזר באמצעות media.download
. אפשר לאחזר את מצב הפעולה באמצעות sdfdownloadtask.operations.get
.
אם יש שגיאות, אפשר למצוא אותן בerror.message
. חשוב לזכור שהשדה error.details
אמור להיות ריק.
בקשת HTTP
POST https://displayvideo.googleapis.com/v2/sdfdownloadtasks
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "version": enum ( |
שדות | |
---|---|
version |
חובה. גרסת SDF של הקובץ שהורדתם. אם המדיניות מוגדרת לערך |
שדה איחוד root_id . חובה. מזהה הבסיס קובע את ההקשר של בקשת ההורדה. יש להגדיר שדה אחד בדיוק. root_id יכול להיות רק אחד מהבאים: |
|
partnerId |
המזהה של השותף שעבורו רוצים להוריד את SDF. |
advertiserId |
המזהה של המפרסם שעבורו רוצים להוריד SDF. |
שדה איחוד filtering_option . חובה. אפשרויות שמציינות את סוגי הישויות והטווחים להורדה. יש להגדיר שדה אחד בדיוק. filtering_option יכול להיות רק אחד מהבאים: |
|
parentEntityFilter |
מסננים לפי סוגי הקבצים שנבחרו. הישויות בכל קובץ מסוננות לפי קבוצה נבחרת של ישויות סינון. ישויות הסינון צריכות להיות מאותו הסוג או מסוג הורה של סוגי הקבצים שנבחרו. |
idFilter |
מסננים של ישויות לפי מזהי הישויות שלהן. |
inventorySourceFilter |
מסננים במקורות של מלאי שטחי הפרסום לפי המזהים שלהם. |
גוף התשובה
אם הפעולה בוצעה בהצלחה, גוף התגובה מכיל מופע חדש של Operation
שנוצר.
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/display-video
למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.
ParentEntityFilter
אפשרות סינון שמסננת לפי סוגי קבצים נבחרים השייכים לקבוצה נבחרת של ישויות סינון.
ייצוג JSON |
---|
{ "fileType": [ enum ( |
שדות | |
---|---|
fileType[] |
חובה. סוגי הקבצים שיוחזרו. |
filterType |
חובה. סוג המסנן שמשמש לסינון הישויות שאוחזרו. |
filterIds[] |
המזהים של סוג המסנן שצוין. משמש לסינון ישויות לאחזור. אם סוג המסנן הוא לא |
FileType
סוגי קבצים אפשריים שניתן להוריד.
טיפוסים בני מנייה (enums) | |
---|---|
FILE_TYPE_UNSPECIFIED |
ערך ברירת המחדל כשהסוג לא צוין או לא ידוע בגרסה הזו. |
FILE_TYPE_CAMPAIGN |
קמפיין. |
FILE_TYPE_MEDIA_PRODUCT |
מוצר מדיה. |
FILE_TYPE_INSERTION_ORDER |
סדר הכנסה. |
FILE_TYPE_LINE_ITEM |
פריט. |
FILE_TYPE_AD_GROUP |
בקבוצת מודעות YouTube. |
FILE_TYPE_AD |
מודעת YouTube. |
FilterType
סוגים אפשריים שלפיהם ניתן לסנן.
טיפוסים בני מנייה (enums) | |
---|---|
FILTER_TYPE_UNSPECIFIED |
ערך ברירת המחדל כשהסוג לא צוין או לא ידוע בגרסה הזו. |
FILTER_TYPE_NONE |
אם האפשרות תיבחר, לא יופעל אף מסנן על ההורדה. ניתן להשתמש רק אם צוין Advertiser ב-CreateSdfDownloadTaskRequest . |
FILTER_TYPE_ADVERTISER_ID |
מזהה המפרסם. אם האפשרות הזו מסומנת, כל מזהי המסננים חייבים להיות מזהי מפרסמים ששייכים ל-Partner שצוין ב-CreateSdfDownloadTaskRequest . |
FILTER_TYPE_CAMPAIGN_ID |
מזהה הקמפיין. אם האפשרות הזו מסומנת, כל מזהי המסננים חייבים להיות מזהי קמפיינים ששייכים ל-Advertiser או ל-Partner שצוינו ב-CreateSdfDownloadTaskRequest . |
FILTER_TYPE_MEDIA_PRODUCT_ID |
מזהה מוצר מדיה. אם האפשרות הזו מסומנת, כל מזהי המסננים חייבים להיות מזהי מוצרי מדיה ששייכים ל-Advertiser או ל-Partner שצוינו ב-CreateSdfDownloadTaskRequest . אפשר להשתמש רק בהורדה של FILE_TYPE_MEDIA_PRODUCT . |
FILTER_TYPE_INSERTION_ORDER_ID |
מזהה הזמנת הקמפיין. אם האפשרות הזו מסומנת, כל מזהי המסננים חייבים להיות מזהים של הזמנות קמפיינים ששייכים לאמצעי Advertiser או Partner שצוינו ב-CreateSdfDownloadTaskRequest . אפשר להשתמש באפשרות הזו רק להורדה של FILE_TYPE_INSERTION_ORDER , FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP ו-FILE_TYPE_AD . |
FILTER_TYPE_LINE_ITEM_ID |
מזהה הפריט. אם האפשרות הזו מסומנת, כל מזהי המסננים חייבים להיות מזהי פריטים ששייכים ל-Advertiser או ל-Partner שצוינו ב-CreateSdfDownloadTaskRequest . אפשר להשתמש רק בהורדה של FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP ו-FILE_TYPE_AD . |
IdFilter
אפשרות סינון שמסננת ישויות לפי מזהי הישויות שלהן.
ייצוג JSON |
---|
{ "campaignIds": [ string ], "mediaProductIds": [ string ], "insertionOrderIds": [ string ], "lineItemIds": [ string ], "adGroupIds": [ string ], "adGroupAdIds": [ string ] } |
שדות | |
---|---|
campaignIds[] |
קמפיינים להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם |
mediaProductIds[] |
מוצרי מדיה להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם |
insertionOrderIds[] |
סדרי הכנסה להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם |
lineItemIds[] |
פריטים להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם |
adGroupIds[] |
קבוצות של מודעות YouTube להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם |
adGroupAdIds[] |
מודעות YouTube להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם |
InventorySourceFilter
אפשרות סינון לסינון הישויות של מקור המלאי.
ייצוג JSON |
---|
{ "inventorySourceIds": [ string ] } |
שדות | |
---|---|
inventorySourceIds[] |
מקורות של מלאי שטחי פרסום להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם |