Method: sdfdownloadtasks.create

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

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

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

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

طلب HTTP

POST https://displayvideo.googleapis.com/v4/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)

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