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 משתמשת בתחביר של Transcoding של 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 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 – פורמט של שאלות ותשובות.

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