Method: combinedAudiences.list

يسرد الجماهير المُجمَّعة.

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

طلب HTTP

GET https://displayvideo.googleapis.com/v2/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" الذي يتم تقديم الطلب ضمنه. لن يعرض طلب "القائمة" سوى كيانات الجمهور المُجمَّعة التي يمكن لكيان "مساحة العرض والفيديو 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.