Method: advertisers.insertionOrders.list

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

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

طلب HTTP

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

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

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

المعلمات
advertiserId

string (int64 format)

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

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

المعلمات
pageSize

integer

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

string

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

string

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

  • "displayName" (تلقائي)
  • "حالة الكيان"
  • "updateTime"

يكون ترتيب الفرز التلقائي تصاعديًا. لتحديد الترتيب التنازلي لحقل معيّن، يجب إضافة اللاحقة "desc" إلى اسم الحقل. مثال: 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.