Method: sdfdownloadtasks.create

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

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

אפשר לאחזר את מצב הפעולה באמצעות sdfdownloadtasks.operations.get.

אפשר למצוא את השגיאות בerror.message. חשוב לזכור שהשדה error.details אמור להיות ריק.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

גוף הבקשה

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

ייצוג ב-JSON 
{
  "version": enum (SdfVersion),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of mutually exclusive fields.
}
שדות
version

enum (SdfVersion)

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

string (int64 format)

מזהה השותף שעבורו רוצים להוריד קובץ SDF.
advertiserId

string (int64 format)

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