Method: advertisers.list

تعرض هذه السمة قائمة بالمعلِنين الذين يمكن للمستخدم الحالي الوصول إليهم.

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

يجب إدخال partnerId واحد. لا تتوفّر ميزة عرض بيانات الشركاء المتعدّدين.

طلب HTTP

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

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

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

المعلمات
partnerId

string (int64 format)

الحقل مطلوب. رقم تعريف الشريك الذي يجب أن ينتمي إليه جميع المعلِنين الذين تمّ استرجاعهم لا يتيح النظام إدراج المعلِنين لأكثر من شريك واحد في المرة الواحدة.
pageSize

integer

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

string

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

string

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

  • advertiserId (تلقائي)
  • displayName
  • entityStatus
  • updateTime

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

string

تتيح هذه السمة الفلترة حسب حقول المعلِن.

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

  • تتكوّن عبارات الفلتر من قيد واحد أو أكثر.
  • يمكن دمج القيود باستخدام عوامل التشغيل المنطقية AND أو OR.
  • يكون الحظر على شكل {field} {operator} {value}.
  • يجب أن يستخدم الحقل updateTime عاملَي التشغيل GREATER THAN OR EQUAL TO (>=) أو LESS THAN OR EQUAL TO (<=).
  • يجب أن تستخدم جميع الحقول الأخرى عامل التشغيل EQUALS (=).

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

  • advertiserId
  • displayName
  • entityStatus
  • ‫updateTime (الإدخال بتنسيق ISO 8601 أو YYYY-MM-DDTHH:MM:SSZ)

أمثلة:

  • جميع المعلِنين النشطين لدى أحد الشركاء: entityStatus="ENTITY_STATUS_ACTIVE"
  • جميع المعلِنين الذين لديهم وقت تعديل أقل من أو يساوي ‎2020-11-04T18:54:47Z (تنسيق ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • جميع المعلِنين الذين لديهم وقت تعديل أكبر من أو يساوي ‎2020-11-04T18:54:47Z (تنسيق ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

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

نص الطلب

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

نص الاستجابة

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

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

object (Advertiser)

قائمة المعلِنين

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

string

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

نطاقات الأذونات

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

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

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