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/v2/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:

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_AD_GROUP وFILE_TYPE_AD.
FILTER_TYPE_LINE_ITEM_ID رقم تعريف العنصر. في حال اختيارها، يجب أن تكون جميع أرقام تعريف الفلاتر هي معرّفات عناصر تنتمي إلى Advertiser أو Partner المحدّدة في CreateSdfDownloadTaskRequest. يمكن استخدامها فقط لتنزيل FILE_TYPE_LINE_ITEM وFILE_TYPE_AD_GROUP وFILE_TYPE_AD.

IdFilter

خيار فلترة يعمل على فلترة الكيانات حسب أرقام تعريف الكيانات الخاصة بها.

تمثيل JSON 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    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.

InventorySourceFilter

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

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

string (int64 format)

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