مطلوبة. رقم تعريف المعلن الذي تنتمي إليه المجموعات الإعلانية.
معلمات طلب البحث
المَعلمات
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_PAUSEDYOUTUBE_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"
رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في الاستدعاء التالي إلى طريقة youtubeAdGroups.list لاسترداد الصفحة التالية من النتائج.