Method: advertisers.lineItems.list

تعرض هذه السمة تفاصيل الإعلانات في حساب المعلِن.

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

طلب HTTP

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

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

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

المعلمات
advertiserId

string (int64 format)

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

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

المعلمات
pageSize

integer

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

string

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

string

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

  • displayName (تلقائي)
  • entityStatus
  • 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
  • insertionOrderId
  • lineItemId
  • lineItemType
  • updateTime (يجب إدخال التاريخ والوقت بتنسيق ISO 8601 أو YYYY-MM-DDTHH:MM:SSZ)

أمثلة:

  • جميع العناصر ضمن طلب إدراج: insertionOrderId="1234"
  • جميع تفاصيل الإعلانات من النوع ENTITY_STATUS_ACTIVE أو ENTITY_STATUS_PAUSED وLINE_ITEM_TYPE_DISPLAY_DEFAULT ضمن المعلِن: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • جميع العناصر التي تم تعديلها في وقت أقصر من أو يساوي ‎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 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
الحقول
lineItems[]

object (LineItem)

قائمة العناصر

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

string

رمز مميّز لاسترداد الصفحة التالية من النتائج نقْل هذه القيمة في حقل pageToken في الطلب اللاحق لطريقة lineItems.list لاسترداد الصفحة التالية من النتائج.

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.