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 Transcoding.

גוף הבקשה

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

ייצוג ב-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 Overview.

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.
FILE_TYPE_LINE_ITEM_QA פריט – פורמט QA.
FILE_TYPE_AD_GROUP_QA קבוצת מודעות ב-YouTube – פורמט QA.

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_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA ו-FILE_TYPE_AD.
FILTER_TYPE_LINE_ITEM_ID מזהה פריט. אם בוחרים באפשרות הזו, כל מזהי המסננים צריכים להיות מזהי פריטים ששייכים ל-Advertiser או ל-Partner שצוינו ב-CreateSdfDownloadTaskRequest. אפשר להשתמש בה רק להורדה של FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA ו-FILE_TYPE_AD.

IdFilter

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

ייצוג ב-JSON 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ],
  "lineItemQaIds": [
    string
  ],
  "adGroupQaIds": [
    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.
lineItemQaIds[]

string (int64 format)

אופציונלי. פריטים, לפי מזהה, להורדה בפורמט QA. כל המזהים צריכים להיות שייכים לאותו Advertiser או Partner שצוין ב-CreateSdfDownloadTaskRequest.
adGroupQaIds[]

string (int64 format)

אופציונלי. קבוצות מודעות ב-YouTube, לפי מזהה, להורדה בפורמט QA. כל המזהים צריכים להיות שייכים לאותו Advertiser או Partner שצוין ב-CreateSdfDownloadTaskRequest.

InventorySourceFilter

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

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

string (int64 format)

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