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)

مطلوب. إصدار "تنسيق بيانات Google" للملف الذي تم تنزيله في حال ضبطها على SDF_VERSION_UNSPECIFIED، سيتم تلقائيًا استخدام الإصدار الذي يحدّده المعلِن أو الشريك الذي تم التعرّف عليه من خلال root_id. يستمدّ المعلِن إصدار SDF من شريكه ما لم يتم ضبطه على نحوٍ آخر.
حقل الدمج root_id مطلوب. يحدّد المعرّف الجذر سياق طلب التنزيل. يجب ضبط حقل واحد بالضبط. يمكن أن تكون root_id إحدى القيم التالية فقط:
partnerId

string (int64 format)

معرّف الشريك الذي سيتم تنزيل "تنسيق بيانات Google" له
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

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

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

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

string (int64 format)

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

InventorySourceFilter

خيار فلترة لفلترة عناصر "مصدر المستودع الإعلاني"

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

string (int64 format)

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