Method: partners.channels.sites.list

تعرض هذه الطريقة المواقع الإلكترونية في قناة معيّنة.

طلب HTTP

GET https://displayvideo.googleapis.com/v5/partners/{partnerId}/channels/{channelId}/sites

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

مَعلمات المسار

المعلمات
channelId

string (int64 format)

الحقل مطلوب. رقم تعريف القناة الرئيسية التي تنتمي إليها المواقع الإلكترونية المطلوبة
الحقل مطلوب. تحدّد هذه السمة جهة "مساحة العرض والفيديو 360" التي تملك القناة الرئيسية. ويمكن أن يكون شريكًا أو معلِنًا. في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
partnerId

string (int64 format)

رقم تعريف الشريك الذي يملك القناة الرئيسية
نهاية الحقول التي يستبعد كلّ منها الآخر

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

المعلمات
pageSize

integer

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

string

رمز مميّز يحدّد صفحة النتائج التي يجب أن يعرضها الخادم.

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

string

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

  • urlOrAppId (تلقائي)

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

string

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

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

  • يمكن أن تحتوي تعبيرات الفلترة لاسترداد المواقع الإلكترونية على قيد واحد فقط كحد أقصى.
  • يكون شكل القيد {field} {operator} {value}.
  • يجب أن تستخدم جميع الحقول عامل التشغيل HAS (:).

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

  • urlOrAppId

أمثلة:

  • جميع المواقع الإلكترونية التي يتضمّن عنوان URL أو معرّف التطبيق الخاص بها كلمة "google": urlOrAppId : "google"

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

لمزيد من المعلومات، يُرجى الرجوع إلى دليل فلترة طلبات LIST.
الحقل مطلوب. تحدّد هذه السمة جهة "مساحة العرض والفيديو 360" التي تملك القناة الرئيسية. ويمكن أن يكون شريكًا أو معلِنًا. في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد:
advertiserId

string (int64 format)

رقم تعريف المعلِن الذي يملك القناة الرئيسية
نهاية الحقول التي يستبعد كلّ منها الآخر

نص الطلب

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال ListSitesResponse.

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

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

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

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