Method: advertisers.list

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

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

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

طلب HTTP

GET https://displayvideo.googleapis.com/v5/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.