Method: advertisers.adGroupAds.list

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

طلب HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroupAds

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

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

المعلمات
advertiserId

string (int64 format)

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

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

المعلمات
pageSize

integer

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

string

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

string

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

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

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

string

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

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

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

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

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

أمثلة:

  • جميع إعلانات المجموعة الإعلانية ضِمن مجموعة إعلانية: adGroupId="1234"
  • جميع إعلانات المجموعة الإعلانية ضمن مجموعة إعلانية تحمل قيمة entityStatus ‏ENTITY_STATUS_ACTIVE أو ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

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

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

نص الطلب

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

نص الاستجابة

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

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

object (AdGroupAd)

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

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

string

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

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

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

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

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