Method: googleAudiences.list

تعرض هذه السمة جماهير Google.

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

طلب HTTP

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

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

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

المعلمات
pageSize

integer

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

string

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

string

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

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

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

string

تتيح هذه السمة الفلترة حسب حقول الجمهور في Google.

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

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

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

  • displayName

أمثلة:

  • جميع شرائح جمهور Google التي يتضمّن الاسم المعروض لها كلمة "Google": displayName:"Google".

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

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

string (int64 format)

رقم تعريف الشريك الذي يمكنه الوصول إلى شرائح جمهور Google التي تم استرجاعها
advertiserId

string (int64 format)

معرّف المعلِن الذي لديه إذن الوصول إلى شرائح جمهور Google التي تمّ استرجاعها

نص الطلب

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

نص الاستجابة

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

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

object (GoogleAudience)

قائمة شرائح الجمهور على Google

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

string

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

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

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

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

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