Method: firstPartyAndPartnerAudiences.list

يسرد شرائح جمهور الطرف الأول والشركاء.

يتم تحديد الترتيب من خلال المَعلمة orderBy.

طلب HTTP

GET https://displayvideo.googleapis.com/v4/firstPartyAndPartnerAudiences

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

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

المعلمات
pageSize

integer

اختياريّ. حجم الصفحة المطلوب يجب أن تتراوح بين 1 و5000. إذا لم يتم تحديد هذه القيمة، تكون القيمة التلقائية هي 5000. تُعرِض رمز الخطأ INVALID_ARGUMENT في حال تحديد قيمة غير صالحة.

pageToken

string

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

orderBy

string

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

  • FirstPartyAndPartnerAudienceId (تلقائي)
  • displayName

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

filter

string

اختياريّ. يسمح بالفلترة حسب حقول جمهور الطرف الأول والشريك.

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

  • لا يمكن أن تحتوي عبارات الفلترة لشرائح جمهور الطرف الأول والشركاء على أكثر من قيد واحد كحد أقصى.
  • يكون قيد المحتوى على شكل {field} {operator} {value}.
  • يجب أن تستخدم جميع الحقول عامل التشغيل HAS (:).

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

  • displayName

أمثلة:

  • جميع شرائح جمهور الطرف الأول والشركاء التي يحتوي اسمها المعروض على "Google": displayName:"Google".

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

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

مَعلمة الائتلاف accessor. مطلوب. لتحديد كيان "مساحة العرض والفيديو 360" الذي يتم تقديم الطلب من خلاله. لن يعرض طلب LIST سوى عناصر شرائح جمهور الطرف الأول والشركاء التي يمكن الوصول إليها من خلال عنصر "مساحة العرض والفيديو 360" المحدّد في accessor. يمكن أن يكون accessor واحدًا فقط مما يلي:
partnerId

string (int64 format)

رقم تعريف الشريك الذي يمكنه الوصول إلى شرائح جمهور الطرف الأول والشركاء التي تم جلبها.

advertiserId

string (int64 format)

رقم تعريف المعلِن الذي يمكنه الوصول إلى شرائح جمهور الطرف الأول والشركاء التي تم جلبها.

نص الطلب

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

نص الاستجابة

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

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

object (FirstPartyAndPartnerAudience)

قائمة شرائح جمهور الطرف الأول والشركاء ولن يتم تضمين خصائص حجم الجمهور.

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

nextPageToken

string

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

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

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

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

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