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/v1/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. اتركه فارغًا لتنزيل جميع مصادر المستودع للمعلن أو الشريك المحدّد.