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" (تلقائي)
  • "حالة الكيان"
  • "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.