Method: advertisers.reachForecast.retrievePlannableUserLists

تعرض هذه الطريقة قوائم المستخدمين التابعة للطرف الأول والجهات الخارجية والمتاحة للتوقّع.

طلب HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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

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

المعلمات
advertiserId

string (int64 format)

الحقل مطلوب. رقم تعريف المعلِن الذي سيتم استرداد قوائم المستخدمين القابلة للتخطيط له.

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

المعلمات
pageSize

integer

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

string

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

string

اختياريّ. تتيح هذه السمة الفلترة حسب خصائص قائمة المستخدمين القابلة للتخطيط.

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

  • تتكوّن عبارات الفلتر من قيد واحد أو أكثر.
  • يمكن دمج القيود باستخدام عوامل التشغيل المنطقية AND أو OR.
  • يكون الحظر على شكل {field} {operator} {value}.
  • يجب أن يستخدم الحقل displayName عامل التشغيل HAS (:).
  • يجب أن تستخدم جميع الحقول الأخرى عامل التشغيل EQUALS (=).

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

  • plannableStatus
  • displayName
  • userListType
  • name

أمثلة:

  • جميع قوائم المستخدمين القابلة للتخطيط: plannableStatus="PLANNABLE"
  • قوائم المستخدمين القابلة للتخطيط التي يتضمّن الاسم المعروض فيها "التسوّق": plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • قوائم المستخدِمين التابعة للطرف الأول: userListType="FIRST_PARTY"

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

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

نص الطلب

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

نص الاستجابة

الردّ بخصوص reachForecast.retrievePlannableUserLists.

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

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

object (PlannableUserList)

النتائج فقط. قائمة قوائم المستخدمين القابلة للتخطيط
nextPageToken

string

النتائج فقط. رمز مميّز لاسترداد الصفحة التالية من النتائج.

نطاقات الأذونات

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

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

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

PlannableUserList

قائمة مستخدمين يمكن التخطيط لها وتُستخدَم لتوقّع مدى الوصول.

تمثيل JSON 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
الحقول
displayName

string

النتائج فقط. الاسم المعروض لقائمة المستخدمين.
userListType

enum (UserListType)

النتائج فقط. نوع قائمة المستخدمين
name

string

النتائج فقط. اسم المورد الذي يحدّد قائمة المستخدِمين.

التنسيق: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

النتائج فقط. حالة إمكانية التخطيط لقائمة المستخدمين

UserListType

أنواع قوائم المستخدمين

عمليات التعداد
USER_LIST_TYPE_UNSPECIFIED نوع قائمة مستخدمين غير محدّد
FIRST_PARTY قائمة مستخدمين تابعة للطرف الأول
THIRD_PARTY قائمة مستخدمين تابعة لجهة خارجية

PlannableStatus

الحالة التي تشير إلى ما إذا كانت القائمة قابلة للتخطيط أم لا.

عمليات التعداد
PLANNABLE_STATUS_UNSPECIFIED حالة التخطيط غير محدَّدة.
PLANNABLE يمكن التخطيط لقائمة المستخدمين.
UNPLANNABLE لا يمكن التخطيط لقائمة المستخدمين.