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

الأنواع المحتملة من الملفات التي يمكن تنزيلها.

عمليات التعداد
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 تنسيق "العنصر" - تنسيق "الجودة"
FILE_TYPE_AD_GROUP_QA مجموعة إعلانية على YouTube - تنسيق الأسئلة والأجوبة

FilterType

الأنواع المحتملة التي يمكن الفلترة وفقًا لها.

عمليات التعداد
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)

اختياريّ. العناصر حسب رقم التعريف لتنزيلها بتنسيق تأكيد الجودة. يجب أن تكون جميع أرقام التعريف تابعة لنفس Advertiser أو Partner المحدَّدَين في CreateSdfDownloadTaskRequest.
adGroupQaIds[]

string (int64 format)

اختياريّ. مجموعات إعلانية على YouTube، حسب رقم التعريف، لتنزيلها بتنسيق QA يجب أن تكون جميع أرقام التعريف تابعة لنفس Advertiser أو Partner المحدَّدَين في CreateSdfDownloadTaskRequest.

InventorySourceFilter

خيار فلترة للفلترة حسب كيانات مصدر المستودع

تمثيل JSON 
{
  "inventorySourceIds": [
    string
  ]
}
الحقول
inventorySourceIds[]

string (int64 format)

مصادر المستودع المطلوب تنزيلها حسب رقم التعريف. يجب أن تكون جميع أرقام التعريف تابعة لنفس Advertiser أو Partner المحدَّدَين في CreateSdfDownloadTaskRequest. يمكنك ترك هذا الحقل فارغًا لتنزيل جميع مصادر المستودع للمعلِن أو الشريك المحدّد.