Method: advertisers.adGroups.list

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

طلب HTTP

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