Method: sdfdownloadtasks.create

تنشئ هذه الطريقة مهمة تنزيل ملفات تعريف البيانات (SDF). تعرض Operation.

"مهمّة تنزيل ملفات بيانات منظَّمة" هي عملية غير متزامنة تستغرق وقتًا طويلاً. نوع metadata لهذه العملية هو SdfDownloadTaskMetadata. إذا نجح الطلب، يكون نوع العملية response هو SdfDownloadTask. لن يتضمّن الردّ ملفات التنزيل التي يجب استردادها باستخدام media.download.

يمكن استرداد حالة العملية باستخدام sdfdownloadtasks.operations.get.

يمكن العثور على أي أخطاء في error.message. يُرجى العِلم أنّه من المتوقّع أن يكون الحقل error.details فارغًا.

طلب HTTP

POST https://displayvideo.googleapis.com/v5/sdfdownloadtasks

يستخدِم عنوان URL بنية تحويل الترميز إلى gRPC.

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "version": enum (SdfVersion),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of mutually exclusive fields.
}
الحقول
version

enum (SdfVersion)

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

string (int64 format)

رقم تعريف الشريك المطلوب تنزيل ملفات SDF له
advertiserId

string (int64 format)

رقم تعريف المعلِن المطلوب تنزيل ملفات SDF له
نهاية الحقول التي يستبعد كلّ منها الآخر
الحقل مطلوب. الخيارات التي تحدّد أنواع الكيانات والنطاقات المطلوب تنزيلها يجب ضبط حقل واحد بالضبط. في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
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 Line Item - QA format.
FILE_TYPE_AD_GROUP_QA YouTube Ad Group - QA format.

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