Method: advertisers.youtubeAdGroupAds.list

يسرد إعلانات المجموعة الإعلانية على YouTube.

طلب HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/youtubeAdGroupAds

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

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

المعلمات
advertiserId

string (int64 format)

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

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

المعلمات
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

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

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

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

الحقول المسموح بها:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

أمثلة:

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

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

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

نص الطلب

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

نص الاستجابة

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

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

object (YoutubeAdGroupAd)

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

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

nextPageToken

string

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

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

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

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

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