Method: sdfdownloadtasks.create

יצירת משימה של הורדת SDF. הפונקציה מחזירה את הערך Operation.

משימת הורדת SDF היא פעולה אסינכרונית ממושכת. הסוג metadata של הפעולה הזו הוא SdfDownloadTaskMetadata. אם הבקשה תצליח, סוג הפעולה response הוא SdfDownloadTask. התגובה לא תכלול את הקבצים להורדה, שיש לאחזר באמצעות media.download. ניתן לאחזר את מצב הפעולה באמצעות sdfdownloadtask.operations.get.

אם יש שגיאות, הן יופיעו בerror.message. חשוב לשים לב שהשדה error.details צפוי להיות ריק.

בקשת HTTP

POST https://displayvideo.googleapis.com/v3/sdfdownloadtasks

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "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.
}
שדות
version

enum (SdfVersion)

חובה. גרסת SDF של הקובץ שהורד. אם המדיניות מוגדרת לערך SDF_VERSION_UNSPECIFIED, ברירת המחדל תהיה הגרסה שצוינה על ידי המפרסם או השותף שזוהו על ידי root_id. המפרסם יורש את גרסת SDF שלו מהשותף שלו, אלא אם הוגדר אחרת.
שדה איחוד root_id. חובה. מזהה הבסיס קובע את ההקשר של בקשת ההורדה. יש להגדיר שדה אחד בדיוק. הערך של root_id יכול להיות רק אחת מהאפשרויות הבאות:
partnerId

string (int64 format)

מזהה השותף שעבורו יש להוריד את SDF.
advertiserId

string (int64 format)

המזהה של המפרסם שעבורו יש להוריד SDF.
שדה איחוד filtering_option. חובה. אפשרויות שמציינות את סוגי הישויות והטווחים להורדה. יש להגדיר שדה אחד בדיוק. הערך של filtering_option יכול להיות רק אחת מהאפשרויות הבאות:
parentEntityFilter

object (ParentEntityFilter)

מסננים לפי סוגי הקבצים שנבחרו. הישויות בכל קובץ מסוננות על ידי קבוצה נבחרת של ישויות סינון. ישויות הסינון צריכות להיות מאותו הסוג, או סוג הורה של סוגי הקבצים שנבחרו.
idFilter

object (IdFilter)

מסננים של ישויות לפי מזהה הישות שלהן.
inventorySourceFilter

object (InventorySourceFilter)

מסננים במקורות של מלאי שטחי פרסום לפי המזהים שלהם.

גוף התגובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע חדש של Operation שנוצר.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/display-video

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

ParentEntityFilter

אפשרות סינון שמסננת לפי סוגי קבצים נבחרים ששייכים לקבוצה נבחרת של ישויות סינון.

ייצוג JSON 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
שדות
fileType[]

enum (FileType)

חובה. סוגי הקבצים שיוחזרו.
filterType

enum (FilterType)

חובה. סוג המסנן המשמש לסינון ישויות שנשלפו.
filterIds[]

string (int64 format)

המזהים של סוג המסנן שצוין. משמש לסינון ישויות לאחזור. אם סוג המסנן הוא לא FILTER_TYPE_NONE, צריך לציין לפחות מזהה אחד.

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[]

string (int64 format)

קמפיינים להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם Advertiser או Partner שצוינו ב-CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

מוצרי מדיה להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם Advertiser או Partner שצוינו ב-CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

הזמנות קמפיין להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם Advertiser או Partner שצוינו ב-CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

פריטים להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם Advertiser או Partner שצוינו ב-CreateSdfDownloadTaskRequest.
adGroupIds[]

string (int64 format)

קבוצות של מודעות YouTube להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם Advertiser או Partner שצוינו ב-CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

מודעות YouTube להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם Advertiser או Partner שצוינו ב-CreateSdfDownloadTaskRequest.

InventorySourceFilter

אפשרות סינון לסינון ישויות של מקור מלאי.

ייצוג JSON 
{
  "inventorySourceIds": [
    string
  ]
}
שדות
inventorySourceIds[]

string (int64 format)

מקורות של מלאי שטחי פרסום להורדה לפי מזהה. כל המזהים חייבים להשתייך לאותם Advertiser או Partner שצוינו ב-CreateSdfDownloadTaskRequest. כדי להוריד את כל המקורות של מלאי שטחי הפרסום של המפרסם או השותף שנבחרו, יש להשאיר את השדה ריק.