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/v1/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

סוגי הקבצים האפשריים שאפשר להוריד.

טיפוסים בני מנייה (enum)
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

סוגים אפשריים שלפיהם אפשר לסנן.

טיפוסים בני מנייה (enum)
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. אם רוצים להוריד את כל המקורות של מלאי שטחי הפרסום עבור המפרסם או השותף שנבחרו, צריך להשאיר את השדה ריק.