Method: advertisers.reachForecast.retrievePlannableUserLists

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

طلب HTTP

GET https://displayvideo.googleapis.com/v5/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"
  • قوائم المستخدمين القابلة للتخطيط والتي تحتوي على الاسم المعروض "Shopping": 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 قائمة المستخدمين غير قابلة للتخطيط.