Method: combinedAudiences.list

يُدرج شرائح الجمهور المجمّعة.

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

طلب HTTP

GET https://displayvideo.googleapis.com/v3/combinedAudiences

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

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

المعلمات
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • combinedAudienceId (تلقائي)
  • 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
{
  "combinedAudiences": [
    {
      object (CombinedAudience)
    }
  ],
  "nextPageToken": string
}
الحقول
combinedAudiences[]

object (CombinedAudience)

قائمة الجماهير المُجمَّعة.

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

nextPageToken

string

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

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

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

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

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