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