Method: advertisers.insertionOrders.list

يسرد طلبات الإدراج في المعلِن.

ويتم تحديد الترتيب من خلال المَعلمة orderBy. إذا لم يتم تحديد filter بحلول entityStatus، لن يتم تضمين طلبات الإدراج التي تتضمّن ENTITY_STATUS_ARCHIVED في النتائج.

طلب HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/insertionOrders

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

معلمات المسار

المَعلمات
advertiserId

string (int64 format)

مطلوبة. رقم تعريف المعلِن الذي تريد إدراج طلبات إدراج بشأنه.

معلمات طلب البحث

المَعلمات
pageSize

integer

حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين 1 و100. وفي حال عدم تحديد نوع السياسة، سيتم ضبط القيمة التلقائية على 100. لعرض رمز الخطأ INVALID_ARGUMENT إذا تم تحديد قيمة غير صالحة.
pageToken

string

يشير هذا المصطلح إلى رمز مميّز يحدّد صفحة من النتائج التي يجب أن يعرضها الخادم. عادةً ما تكون هذه هي قيمة nextPageToken التي تم عرضها من الاستدعاء السابق إلى طريقة insertionOrders.list. في حال عدم تحديد أي خيار، سيتم عرض الصفحة الأولى من النتائج.
orderBy

string

الحقل الذي سيتم ترتيب القائمة وفقًا له. القيم المقبولة هي:

  • "displayName" (تلقائي)
  • "entityStatus"
  • "updateTime"

يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي لأحد الحقول، يجب إضافة اللاحقة "تنازلي" إلى اسم الحقل. مثال: displayName desc
filter

string

تسمح بالفلترة حسب حقول طلب الإدراج.

البنية المتوافقة:

  • وتتكون تعبيرات الفلاتر من قيد واحد أو أكثر.
  • يمكن دمج القيود باستخدام عاملَي التشغيل المنطقي AND أو OR. تستخدم سلسلة من القيود AND بشكل ضمني.
  • يكون نوع القيود كالآتي {field} {operator} {value}.
  • يجب أن يستخدم الحقل updateTime عاملَي التشغيل GREATER THAN OR EQUAL TO (>=) أو LESS THAN OR EQUAL TO (<=).
  • يجب أن تستخدم جميع الحقول الأخرى عامل التشغيل EQUALS (=).

الحقول المتاحة:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (إدخال بتنسيق ISO 8601 أو YYYY-MM-DDTHH:MM:SSZ)

أمثلة:

  • كل طلبات الإدراج ضمن إحدى الحملات: campaignId="1234"
  • كل طلبات الإدراج التي يبلغ عددها ENTITY_STATUS_ACTIVE أو ENTITY_STATUS_PAUSED ضمن المعلِن: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • كل طلبات الإدراج التي يستغرق تعديلها أقل من أو يساوي 2020-11-04T18:54:47Z (بتنسيق ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • كلّ طلبات الإدراج التي يكون وقت التعديل فيها أكبر من 2020-11-04T18:54:47Z أو (تنسيق ISO 8601): updateTime>="2020-11-04T18:54:47Z"

يجب ألا يزيد طول هذا الحقل عن 500 حرف.

يمكنك الرجوع إلى دليل طلبات الفلاتر LIST للحصول على مزيد من المعلومات.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
الحقول
insertionOrders[]

object (InsertionOrder)

قائمة طلبات الإدراج

لن يتم إدخال هذه القائمة إذا كانت فارغة.
nextPageToken

string

رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في الاستدعاء التالي إلى طريقة insertionOrders.list لاسترداد الصفحة التالية من النتائج.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/display-video

لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.