Method: advertisers.youtubeAdGroups.list

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

طلب HTTP

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

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

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

المَعلمات
advertiserId

string (int64 format)

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

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

المَعلمات
pageSize

integer

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

string

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

string

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

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

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

string

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

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

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

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

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

أمثلة:

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

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

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

نص الطلب

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

نص الاستجابة

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

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

object (YoutubeAdGroup)

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

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

string

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

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

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

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

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