Method: googleAudiences.list

تعرض هذه الطريقة شرائح جمهور Google.

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

طلب HTTP

GET https://displayvideo.googleapis.com/v5/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.
الحقل مطلوب. تحدّد هذه السمة جهة "مساحة العرض والفيديو 360" التي يتم تقديم الطلب من خلالها. لن يعرض طلب LIST سوى كيانات شرائح الجمهور من Google التي يمكن الوصول إليها من خلال كيان "مساحة العرض والفيديو 360" المحدّد ضمن 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.