مطلوبة. رقم تعريف المعلِن الذي تنتمي إليه المجموعات الإعلانية.
معلمات طلب البحث
المَعلمات
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_PAUSEDAD_GROUP_FORMAT_IN_STREAM ضمن أحد المعلنين: (entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"
رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في الاستدعاء التالي إلى طريقة adGroups.list لاسترداد الصفحة التالية من النتائج.