- בקשת 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/v1/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[] |
מקורות של מלאי שטחי פרסום להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם |