Method: advertisers.lineItems.list

يسرد العناصر في أحد المعلنين.

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

طلب HTTP

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

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

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

المَعلمات
advertiserId

string (int64 format)

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

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

المَعلمات
pageSize

integer

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

string

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

string

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

  • displayName (تلقائي)
  • entityStatus
  • flight.dateRange.endDate
  • updateTime

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

string

تسمح بالفلترة حسب خصائص العنصر.

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

  • تتألف تعبيرات الفلترة من قيد واحد أو أكثر.
  • يمكن دمج القيود من خلال عاملَي التشغيل المنطقي AND أو OR. تستخدم سلسلة من القيود السمة AND ضمنيًا.
  • ويكون للقيود الشكل {field} {operator} {value}.
  • يجب أن يكون عامل التشغيل المستخدَم في flight.dateRange.endDate أقل من (<).
  • يجب أن يكون عامل التشغيل المستخدَم في updateTime هو GREATER THAN OR EQUAL TO (>=) أو LESS THAN OR EQUAL TO (<=).
  • يجب أن يكون عامل التشغيل المستخدَم في warningMessages هو HAS (:).
  • يجب أن تكون عوامل التشغيل المُستخدَمة في جميع الحقول الأخرى EQUALS (=).
  • السمات المسموح بها:
    • campaignId
    • displayName
    • insertionOrderId
    • entityStatus
    • lineItemId
    • lineItemType
    • flight.dateRange.endDate (إدخال بالتنسيق YYYY-MM-DD)
    • warningMessages
    • flight.triggerId
    • updateTime (إدخال بتنسيق ISO 8601، أو YYYY-MM-DDTHH:MM:SSZ)
    • targetedChannelId
    • targetedNegativeKeywordListId

أمثلة:

  • جميع العناصر ضمن طلب إدراج: 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"
  • جميع العناصر التي تنتهي تواريخ إطلاقها قبل 28 آذار (مارس) 2019: flight.dateRange.endDate<"2019-03-28"
  • جميع العناصر التي تحتوي على NO_VALID_CREATIVE في warningMessages: warningMessages:"NO_VALID_CREATIVE"
  • جميع البنود التي لها وقت تعديل أقل من أو يساوي 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • جميع البنود التي لها وقت تعديل أكبر من أو يساوي 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z"
  • جميع العناصر التي تستخدم كلاً من القناة المحدّدة وقائمة الكلمات الرئيسية السلبية المحدّدة في عملية الاستهداف: targetedNegativeKeywordListId=789 AND targetedChannelId=12345

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

نص الطلب

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

نص الاستجابة

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

تمثيل 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.