Method: advertisers.list

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

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

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

طلب HTTP

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

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

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

المعلمات
partnerId

string (int64 format)

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

integer

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

string

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

string

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

  • 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.