Method: advertisers.adGroups.list

يُدرج المجموعات الإعلانية.

طلب HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroups

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

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

المعلمات
advertiserId

string (int64 format)

مطلوب. رقم تعريف المعلِن الذي تنتمي إليه المجموعات الإعلانية.

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

المعلمات
pageSize

integer

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

string

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

string

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

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

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

string

اختياريّ. تتيح الفلترة حسب حقول المجموعات الإعلانية المخصّصة.

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

  • تتألّف عبارات الفلاتر من قيد واحد أو أكثر.
  • يمكن الجمع بين القيود باستخدام AND وOR. تستخدم تسلسلاً من القيود AND بشكل ضمني.
  • يكون قيد المحتوى على شكل {field} {operator} {value}.
  • يجب أن تستخدم جميع الحقول عامل التشغيل EQUALS (=).

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

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

أمثلة:

  • جميع المجموعات الإعلانية ضمن عنصر: lineItemId="1234"
  • جميع المجموعات الإعلانية ENTITY_STATUS_ACTIVE أو ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM ضمن حساب معلِن: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

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

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

نص الطلب

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

نص الاستجابة

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

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

object (AdGroup)

قائمة المجموعات الإعلانية

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

string

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

نطاقات التفويض

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

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

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